Create a document on a shipment

SecurityAuthToken

Request

path Parameters

shipmentId

required

string <uuid>

The id of the shipment

Request Body schema: multipart/form-data

description required	string
file required	string <binary>
is_carrier_document required	boolean
type required	string

Responses

201

Successfully create a document

Response Schema: application/json

created_at	string or null <date-time>
created_by_id	string or null <uuid>
created_by_name	string or null
description	string or null
file	string or null URL to file. URLs have timed access tokens and expire in 30 minutes.
filename	string or null Filename of file
id	string or null <uuid>
updated_at	string or null <date-time>
company	string or null
driver	string or null <uuid> Id of the driver who created the document, if one exists
is_carrier_document	boolean
shipment	string or null <uuid>
type	string or null Enum: "BOL" "FUEL" "LUMPER" "HOS" "SIGNATURE" "RATE_CONFIRMATION" "CUSTOMER_TENDER" "DELIVERY_RECEIPT" "WEIGHT_CERTIFICATE" "OVERAGES_SHORTAGES_AND_DAMAGES" "RENDITION_INVOICE_PACKET" "INVENTORY_RELEASE" "INVOICE" "INSURANCE" "SHIPPING_LABEL" "CUSTOMS_PAPERWORK" "PACKING_SLIPS" "OTHER"

default

Default error response

post/shipments/{shipmentId}/documents/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

201
default

application/json

{"created_at": "2019-08-24T14:15:22Z",
"created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
"created_by_name": "string",
"description": "string",
"file": "https://files.example.com/...",
"filename": "Bill_of_Lading.pdf",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"company": "string",
"driver": "ef731cbb-90ac-4a46-9655-0609f31cd17a",
"is_carrier_document": true,
"shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
"type": "BOL"
}