Skip to main content
GET
/
orders
/
{pk}
Retrieve an Order
curl --request GET \
  --url https://{company}.datatruck.io/api/v1/openapi/orders/{pk} \
  --header 'Authorization: <api-key>'
{
  "id": 12345,
  "load_id": "LD-987654",
  "shipment_id": "SHIP-123456",
  "status": "In Progress",
  "load_pay": "5000.00",
  "total_miles": "1500.75",
  "created_datetime": "2025-02-06T12:00:00Z",
  "created_by__full_name": "John Doe",
  "total_other_pay": "200.00",
  "total_pay": "5200.00",
  "per_mile_revenue": "3.25",
  "tags": [
    {
      "name": "Urgent"
    }
  ],
  "dispatcher__full_name": "Alice Johnson",
  "customer__company_name": "ABC Logistics",
  "mc_number__company_name": "XYZ Carriers",
  "office__office_name": "Dallas Office",
  "pickup_appointment_time": "2025-02-06T08:30:00Z",
  "delivery_appointment_time": "2025-02-07T15:00:00Z",
  "pickup_time": "2025-02-06T09:00:00Z",
  "delivery_time": "2025-02-07T16:30:00Z",
  "stops": [
    {
      "id": 123,
      "stop_type": "<string>",
      "reference_id": "<string>",
      "proof_of_delivery": "<string>"
    }
  ],
  "equipment_type": "Refrigerated",
  "equipment_type_child": [
    "Chilled Storage"
  ],
  "transportation_mode": "Truckload",
  "driver_requirements": [
    "<string>"
  ],
  "additional_equipments": [
    "<string>"
  ],
  "freight_requirements": [
    "<string>"
  ],
  "freight_requirements_min_temperature": "2.0",
  "freight_requirements_max_temperature": "8.0",
  "estimated_mile": "1200.50",
  "estimated_time": 10,
  "eta_detail": {
    "on_time": true,
    "eta_datetime": "2023-11-07T05:31:56Z"
  },
  "trip": {},
  "batch_orders": {},
  "assigned_driver_n_truck": {
    "driver_full_name": "<string>",
    "truck_unit_number": "<string>"
  },
  "assigned_carrier": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.datatruck.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Path Parameters

​
pk
integer
required

The unique identifier of the order

Response

Successfully retrieved the order

​
id
integer

Unique order ID

Example:

12345

​
load_id
string | null

Load identifier

Example:

"LD-987654"

​
shipment_id
string | null

Shipment identifier

Example:

"SHIP-123456"

​
status
string

Current status of the load

Example:

"In Progress"

​
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_datetime
string<date-time>

Order creation timestamp

Example:

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

​
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"

​
tags
object[]

List of tags associated with the order

​
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"

​
stops
object[]

Stops along the order route

​
equipment_type
string

Equipment type used for transportation

Example:

"Refrigerated"

​
equipment_type_child
string[]

List of child equipment types

​
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"

​
estimated_mile
string<decimal>

Estimated miles for the trip

Example:

"1200.50"

​
estimated_time
integer

Estimated travel time in hours

Example:

10

​
eta_detail
object
​
trip
object
​
batch_orders
object
​
assigned_driver_n_truck
object
​
assigned_carrier
string | null