Skip to main content
GET
Retrieve an Order

Authorizations

Authorization
string
header
required

Path Parameters

pk
integer
required

The unique identifier of the order

Response

Successfully retrieved the order

id
integer
required

Unique order ID

Example:

12345

status
string
required

Current status of the load

Example:

"In Progress"

created_datetime
string<date-time>
required

Order creation timestamp

Example:

"2025-02-06T12:00:00Z"

tags
object[]
required

List of tags associated with the order

stops
object[]
required

Stops along the order route

equipment_type
string
required

Equipment type used for transportation

Example:

"Refrigerated"

equipment_type_child
string[]
required

List of child equipment types

estimated_mile
string<decimal>
required

Estimated miles for the trip

Example:

"1200.50"

estimated_time
integer
required

Estimated travel time in hours

Example:

10

eta_detail
object
required
trip
object | null
required
batch_orders
object | null
required
assigned_driver_n_truck
object
required
assigned_carrier
string | null
required
is_flagged
boolean
required

Whether the order has been flagged for attention.

Example:

false

documents
object[]
required

Documents attached to the order (rate confirmation, bill of lading, proof of delivery, commercial invoice).

load_id
string | null

Load identifier

Example:

"LD-987654"

shipment_id
string | null

Shipment identifier

Example:

"SHIP-123456"

load_pay
string<decimal> | null

Total payment amount for the load

Example:

"5000.00"

total_miles
string<decimal> | null

Total miles covered for the load

Example:

"1500.75"

created_by__full_name
string | null

Full name of the order creator

Example:

"John Doe"

total_other_pay
string<decimal> | null

Additional payments related to the order

Example:

"200.00"

total_pay
string<decimal> | null

Total payout for the order

Example:

"5200.00"

per_mile_revenue
string<decimal> | null

Revenue per mile (optional)

Example:

"3.25"

dispatcher__full_name
string | null

Full name of the dispatcher

Example:

"Alice Johnson"

customer__company_name
string | null

Customer's company name

Example:

"ABC Logistics"

mc_number__company_name
string | null

Motor carrier company name

Example:

"XYZ Carriers"

office__office_name
string | null

Office handling the order

Example:

"Dallas Office"

pickup_appointment_time
string<date-time> | null

Scheduled pickup appointment time

Example:

"2025-02-06T08:30:00Z"

delivery_appointment_time
string<date-time> | null

Scheduled delivery appointment time

Example:

"2025-02-07T15:00:00Z"

pickup_time
string<date-time> | null

Actual pickup time

Example:

"2025-02-06T09:00:00Z"

delivery_time
string<date-time> | null

Actual delivery time

Example:

"2025-02-07T16:30:00Z"

transportation_mode
string | null

Mode of transportation

Example:

"Truckload"

driver_requirements
string[]

Driver-specific requirements

additional_equipments
string[]

Additional equipment required

freight_requirements
string[]

Freight-specific requirements

freight_requirements_min_temperature
string<decimal> | null

Minimum temperature requirement

Example:

"2.0"

freight_requirements_max_temperature
string<decimal> | null

Maximum temperature requirement

Example:

"8.0"

flagging_reason
string | null

Reason the order was flagged, if applicable.

Example:

null