Skip to main content
POST
Attach BOL to an order

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

order_id
string
required

The ID of the order to attach the BOL to

Body

application/json
file_content
string
required

Base 64 encoded PDF

Example:

"JVBERi0xL..."

file_name
string
required

Name of the file

Example:

"bol.pdf"

bill_of_lading_number
string
required

Bill of Lading number

Example:

"12345689"

pro_number
string
required

Pro Number

Example:

"123-4567890"

carrier
string
required

Carrier

Example:

"UPS FREIGHT"

carrier_alpha_code
string
required

Carrier Alpha Code

Example:

"EXLA"

scheduled_delivery_date
string

Scheduled delivery date in format: YYYY-MM-DD HH:mm:ss

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
Example:

"2024-10-19 07:00:00"

external_load_number
string

External Load ID

Example:

"LOAD-1234"

Response

Successfully uploaded BOL

message
string

Success message