Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Body

application/json

Request Body

customer
string | null
required

Customer associated with the load

Example:

"ABC Logistics"

mc_number
string
required

Motor Carrier number for the shipment

Example:

"Armitage"

load_id
string | null

Unique identifier for the load

Example:

"LD-987654"

load_pay
string<decimal> | null

Payment amount for the load

Example:

"5000.00"

weight
string | null

Weight of the goods being transported

Example:

"2000kg"

goods
string | null

Type of goods being transported

Example:

"Furniture"

rate_confirmation
string | null

Rate confirmation document in base64 format or use global url of the file)

Example:

"base64_encoded_string"

stops
object[] | null

List of stops along the route

Response

Successful order creation response

id
integer
required

Unique order ID

Example:

12345

shipment_id
string
required

Shipment identifier

Example:

"SHIP-987654"

customer
string
required

Customer associated with the shipment

Example:

"ABC Logistics"

status
string
required

Current status of the load

Example:

"In Progress"

mc_number
string
required

Motor Carrier number for the shipment

Example:

"Armitage"

load_id
string
required

Unique identifier for the load

Example:

"LD-987654"

references_id
string
required

Reference ID for the load

Example:

"REF-123456"

load_pay
string<decimal>
required

Total payment amount for the load

Example:

"5000.00"

total_miles
string<decimal>
required

Total miles covered for the load

Example:

"1500.75"

tags
object[]
required

List of tags associated with the order

per_mile_revenue
string<decimal> | null

Revenue per mile (optional)

Example:

"3.25"

special_instruction
string | null

Any special instructions for the load

Example:

"Handle with care"