Skip to main content
POST
Create Load
load_ref must be unique for your organization. The carrier, vehicle and driver objects are optional; send the details you know.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Load create model.

load_ref
string
required

The partner's own unique reference for this load (e.g. a load or BOL number)

Maximum string length: 255
estimated_departure_at
string<date-time>
required

When the load is expected to depart the origin. Must include a UTC offset.

estimated_arrival_at
string<date-time>
required

When the load is expected to arrive at the destination. Must include a UTC offset.

origin
Origin · object
required

Where the load is picked up. This is the first stop of the journey.

Example:
destination
Destination · object
required

Where the load is delivered. This is the last stop of the journey.

Example:
carrier
LoadCarrier · object | null

The carrier assigned to a load. Send whichever identifiers you know.

vehicle
LoadVehicle · object | null

The vehicle assigned to a load. Send whichever identifiers you know.

driver
LoadDriver · object | null

The driver assigned to a load. Send whichever details you know.

stops
LoadIntermediateStopCreate · object[]

Planned stops between origin and destination, in travel order. Each can say what it is for.

Response

Successful Response

Load read model.

load_ref
string
required

The partner's own unique reference for this load (e.g. a load or BOL number)

Maximum string length: 255
estimated_departure_at
string<date-time>
required

When the load is expected to depart the origin. Must include a UTC offset.

estimated_arrival_at
string<date-time>
required

When the load is expected to arrive at the destination. Must include a UTC offset.

id
string<uuid>
required
partner_id
string<uuid>
required

The ID of the partner that owns this load

created_at
string<date-time>
required

When the load was created

updated_at
string<date-time>
required

When the load last changed

carrier
LoadCarrier · object | null

The carrier assigned to a load. Send whichever identifiers you know.

vehicle
LoadVehicle · object | null

The vehicle assigned to a load. Send whichever identifiers you know.

driver
LoadDriver · object | null

The driver assigned to a load. Send whichever details you know.

stops
LoadStopRead · object[]

The journey in travel order. Sequence 0 is the origin and the highest sequence is the destination.