Cloud Network Endpoints for Customer Access
Orders - Get Orders
Get a list of orders (trip) for a specific partner.
path Parameters
partnercodestring · requiredPartner code identifier
query Parameters
pageinteger · int32Page number to return results
refNumberstring · minLength: 1 · maxLength: 100Filter orders by exact reference number match. The reference number must match exactly (case-sensitive).
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Orders - Create Order Booking
Create (book) a new transportation order with a partner. This endpoint allows customers to book orders that will be made available to carriers in the partner network. The order must include at least two stops (pickup or delivery location) with required location information. Optional freight details, reference numbers, and special instructions can be included to provide complete order information. X
path Parameters
partnercodestring · requiredPartner code identifier
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
OrderNumberstring · maxLength: 100Unique order number for tracking
Stopsobject[] · minItems: 2Array of stops (pickup and delivery locations)
FreightDetailsobject[]Details about the freight being transported
RefNumbersobject[]Reference numbers (BOL, PRO, etc.)
billToCompanyIdstringCompany ID for billing
specialInstructionsstring · maxLength: 5000Special handling instructions
Responses
Order successfully created
orderIdstringUnique identifier for the created order
orderGuidstringGUID identifier for the order
orderNumberstringOrder number
statusstringCurrent status of the order
createdAtstring · date-timeTimestamp when order was created
Orders - Get Order Detail
Get details of a specific order.
path Parameters
partnercodestring · requiredPartner code identifier
orderidstring · requiredOrder identifier
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Orders - Cancel Order Booking
Cancel an order booking and remove it from the system.
path Parameters
partnercodestring · requiredPartner code identifier
orderidstring · requiredOrder identifier
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Orders - Get Order Documents
Get Documents and Images for a specific order.
path Parameters
partnercodestring · requiredPartner code identifier
orderidstring · requiredOrder identifier
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Orders - Get GPS Positions
Get GPS tracking history for a given order
path Parameters
partnercodestring · requiredPartner code identifier
orderguidstring · requiredOrder GUID identifier
query Parameters
pageinteger · int32Page number to return results
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.