CarrierCloud (v1) - Universal Transportation API

Customers (1.0.1)

Endpoint:https://qa.carriercloud.ai

Cloud Network Endpoints for Customer Access

Orders - Get Orders

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders

Get a list of orders (trip) for a specific partner.

Orders - Get Orders › path Parameters

partnercodestring · required
Partner code identifier

Orders - Get Orders › query Parameters

pageinteger · int32
Page number to return results
refNumberstring · minLength: 1 · maxLength: 100
Filter orders by exact reference number match. The reference number must match exactly (case-sensitive).
statusstring · minLength: 1 · maxLength: 100
Filter orders by exact status match. The status must match exactly (case-sensitive).
billTostring · minLength: 1 · maxLength: 100
Filter orders by bill-to customer code. The Customer ID must match exactly (case-sensitive).
sortstring · enum
Optional sort for order results. Default is by Order Id.
Enum values:
DateLastActivity
CreatedAt

Orders - Get Orders › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Create Order Booking

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders

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

Orders - Create Order Booking › path Parameters

partnercodestring · required
Partner code identifier

Orders - Create Order Booking › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Create Order Booking › Request Body

Stopsobject[] · minItems: 2 · required
Array of stops (pickup and delivery locations)

OrderNumberstring · maxLength: 100
Unique order number for tracking
EquipmentSelectionstring · maxLength: 50
Equipment type abbreviation for the order
ServiceTypestring · maxLength: 50
Service type abbreviation for the order
Driver1string · maxLength: 200
Primary driver name for brokered carrier
Driver2string · maxLength: 200
Secondary driver name for brokered carrier
DriverPhonestring · maxLength: 50
Driver phone number for brokered carrier
Tractorstring · maxLength: 100
Tractor identifier for brokered carrier
Trailerstring · maxLength: 100
Trailer identifier for brokered carrier
FreightDetailsobject[]
Details about the freight being transported
RefNumbersobject[]
Reference numbers (BOL, PRO, etc.)
billToCompanyIdstring
Company ID for billing
specialInstructionsstring · maxLength: 5000
Special handling instructions

Orders - Create Order Booking › Responses

Order successfully created

statusstring
Result status
messsagestring
Human-readable result message
objectIdstring
Unique identifier for the created order card
orderIdstring
Unique identifier for the created order (same value as objectId)
orderGuidstring
GUID identifier for the order
orderNumberstring
Order number
createdAtstring · date-time
Timestamp when order was created
warningsstring[]
Permission or field warnings when the order was created with partial field updates

Locations - Get Locations

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/locations

Get a paginated list of location cards for a partner. Optionally filter by companyId (case-sensitive).

Locations - Get Locations › path Parameters

partnercodestring · required
Partner code identifier

Locations - Get Locations › query Parameters

pageinteger · int32
Page number to return results
companyIdstring
Filter by companyId (case-sensitive). Omit or leave blank for no filter.

Locations - Get Locations › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Get Locations › Responses

Locations retrieved successfully

statusstring
Result status
pageinteger · int32
Current page number
pageSizeinteger · int32
Number of locations returned per page
totalCountinteger · int32
Total number of matching locations
locationsobject[]
Location cards for the current page

Locations - Create Location

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/locations

Create a new location card for a partner. Optional role-specific data may be supplied under Roles (Shipper, Consignee, BillTo, Terminal, TruckStop, Agent, WashFacility). Partner-network role permissions determine which fields may be set on the created card.

Locations - Create Location › path Parameters

partnercodestring · required
Partner code identifier

Locations - Create Location › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Create Location › Request Body

titlestring · maxLength: 200 · required

boardIdstring
listIdstring
descriptionstring · maxLength: 2000
CompanyIdstring · maxLength: 100
CompanyNamestring · maxLength: 200
Contactstring · maxLength: 200
Address1string · maxLength: 200
Address2string · maxLength: 200
Citystring · maxLength: 100
Statestring · maxLength: 50
ZipCodestring · maxLength: 20
PrimaryPhonestring · maxLength: 50
SecondaryPhonestring · maxLength: 50
Faxstring · maxLength: 50
Emailstring · maxLength: 200
Latitudestring · maxLength: 50
Longitudestring · maxLength: 50
ExternalIdstring · maxLength: 100
HoursOfOperationobject[]
Rolesobject

Locations - Create Location › Responses

Location successfully created

statusstring
Result status when present
_idstring
Location card identifier
locationIdstring
Location card identifier (207 partial-success responses)
boardIdstring
cardtypestring
carddataobject
warningsstring[]
Permission warnings when some requested fields were not set

Orders - Get Order Detail

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderid}

Get details of a specific order.

Orders - Get Order Detail › path Parameters

partnercodestring · required
Partner code identifier
orderidstring · required
Order identifier

Orders - Get Order Detail › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Update Order Booking

PUT

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderid}

Update an existing transportation order for a partner. Nested stop, reference, and freight updates require the _id or DataGUID values from the existing order. Partner-network role permissions determine which fields may be updated.

Orders - Update Order Booking › path Parameters

partnercodestring · required
Partner code identifier
orderidstring · required
Order identifier

Orders - Update Order Booking › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Update Order Booking › Request Body

EquipmentSelectionstring · maxLength: 50
ServiceTypestring · maxLength: 50
Driver1string · maxLength: 200
Driver2string · maxLength: 200
DriverPhonestring · maxLength: 50
Tractorstring · maxLength: 100
Trailerstring · maxLength: 100
Stopsobject[]
RefNumbersobject[]
FreightDetailsobject[]

Orders - Update Order Booking › Responses

Order successfully updated

statusstring
Result status
warningsstring[]
Permission warnings when some requested fields were not updated

Orders - Cancel Order Booking

DELETE

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderid}

Cancel an order booking and remove it from the system.

Orders - Cancel Order Booking › path Parameters

partnercodestring · required
Partner code identifier
orderidstring · required
Order identifier

Orders - Cancel Order Booking › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Quotes - Create Order Quote

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/quotes

Create a quote for a tentative or pending shipment.

Quotes - Create Order Quote › path Parameters

partnercodestring · required
Partner code identifier

Quotes - Create Order Quote › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Get Order Documents

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderid}/documents

Get Documents and Images for a specific order.

Orders - Get Order Documents › path Parameters

partnercodestring · required
Partner code identifier
orderidstring · required
Order identifier

Orders - Get Order Documents › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Quotes - Get Quote Details

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/quotes/{quoteid}

Get Quote details by Quote ID.

Quotes - Get Quote Details › path Parameters

partnercodestring · required
Partner code identifier
quoteidstring · required
Quote identifier

Quotes - Get Quote Details › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Get GPS Positions

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderguid}/positions

Get GPS tracking history for a given order

Orders - Get GPS Positions › path Parameters

partnercodestring · required
Partner code identifier
orderguidstring · required
Order GUID identifier

Orders - Get GPS Positions › query Parameters

pageinteger · int32
Page number to return results

Orders - Get GPS Positions › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Update Location

PUT

https://qa.carriercloud.ai

/v1/partner/{partnercode}/locations/{id}

Update a location card by id. Optional role-specific data may be supplied under Roles (Shipper, Consignee, BillTo, Terminal, TruckStop, Agent, WashFacility). Partner-network role permissions determine which fields may be updated.

Locations - Update Location › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The location card id

Locations - Update Location › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Update Location › Request Body

boardIdstring
listIdstring
titlestring · maxLength: 200
descriptionstring · maxLength: 2000
CompanyIdstring · maxLength: 100
CompanyNamestring · maxLength: 200
Contactstring · maxLength: 200
Address1string · maxLength: 200
Address2string · maxLength: 200
Citystring · maxLength: 100
Statestring · maxLength: 50
ZipCodestring · maxLength: 20
PrimaryPhonestring · maxLength: 50
SecondaryPhonestring · maxLength: 50
Faxstring · maxLength: 50
Emailstring · maxLength: 200
Latitudestring · maxLength: 50
Longitudestring · maxLength: 50
ExternalIdstring · maxLength: 100
HoursOfOperationobject[]
Rolesobject

Locations - Update Location › Responses

Location successfully updated

statusstring

Carriers Partners

CarrierCloud (v1) - Universal Transportation API

Customers (1.0.1)

Endpoint:https://qa.carriercloud.ai

Cloud Network Endpoints for Customer Access

Orders - Get Orders

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders

Get a list of orders (trip) for a specific partner.

Orders - Get Orders › path Parameters

partnercodestring · required
Partner code identifier

Orders - Get Orders › query Parameters

pageinteger · int32
Page number to return results
refNumberstring · minLength: 1 · maxLength: 100
Filter orders by exact reference number match. The reference number must match exactly (case-sensitive).
statusstring · minLength: 1 · maxLength: 100
Filter orders by exact status match. The status must match exactly (case-sensitive).
billTostring · minLength: 1 · maxLength: 100
Filter orders by bill-to customer code. The Customer ID must match exactly (case-sensitive).
sortstring · enum
Optional sort for order results. Default is by Order Id.
Enum values:
DateLastActivity
CreatedAt

Orders - Get Orders › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Create Order Booking

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders

Orders - Create Order Booking › path Parameters

partnercodestring · required
Partner code identifier

Orders - Create Order Booking › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Create Order Booking › Request Body

Stopsobject[] · minItems: 2 · required
Array of stops (pickup and delivery locations)

OrderNumberstring · maxLength: 100
Unique order number for tracking
EquipmentSelectionstring · maxLength: 50
Equipment type abbreviation for the order
ServiceTypestring · maxLength: 50
Service type abbreviation for the order
Driver1string · maxLength: 200
Primary driver name for brokered carrier
Driver2string · maxLength: 200
Secondary driver name for brokered carrier
DriverPhonestring · maxLength: 50
Driver phone number for brokered carrier
Tractorstring · maxLength: 100
Tractor identifier for brokered carrier
Trailerstring · maxLength: 100
Trailer identifier for brokered carrier
FreightDetailsobject[]
Details about the freight being transported
RefNumbersobject[]
Reference numbers (BOL, PRO, etc.)
billToCompanyIdstring
Company ID for billing
specialInstructionsstring · maxLength: 5000
Special handling instructions

Orders - Create Order Booking › Responses

Order successfully created

statusstring
Result status
messsagestring
Human-readable result message
objectIdstring
Unique identifier for the created order card
orderIdstring
Unique identifier for the created order (same value as objectId)
orderGuidstring
GUID identifier for the order
orderNumberstring
Order number
createdAtstring · date-time
Timestamp when order was created
warningsstring[]
Permission or field warnings when the order was created with partial field updates

Locations - Get Locations

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/locations

Get a paginated list of location cards for a partner. Optionally filter by companyId (case-sensitive).

Locations - Get Locations › path Parameters

partnercodestring · required
Partner code identifier

Locations - Get Locations › query Parameters

pageinteger · int32
Page number to return results
companyIdstring
Filter by companyId (case-sensitive). Omit or leave blank for no filter.

Locations - Get Locations › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Get Locations › Responses

Locations retrieved successfully

statusstring
Result status
pageinteger · int32
Current page number
pageSizeinteger · int32
Number of locations returned per page
totalCountinteger · int32
Total number of matching locations
locationsobject[]
Location cards for the current page

Locations - Create Location

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/locations

Locations - Create Location › path Parameters

partnercodestring · required
Partner code identifier

Locations - Create Location › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Create Location › Request Body

titlestring · maxLength: 200 · required

boardIdstring
listIdstring
descriptionstring · maxLength: 2000
CompanyIdstring · maxLength: 100
CompanyNamestring · maxLength: 200
Contactstring · maxLength: 200
Address1string · maxLength: 200
Address2string · maxLength: 200
Citystring · maxLength: 100
Statestring · maxLength: 50
ZipCodestring · maxLength: 20
PrimaryPhonestring · maxLength: 50
SecondaryPhonestring · maxLength: 50
Faxstring · maxLength: 50
Emailstring · maxLength: 200
Latitudestring · maxLength: 50
Longitudestring · maxLength: 50
ExternalIdstring · maxLength: 100
HoursOfOperationobject[]
Rolesobject

Locations - Create Location › Responses

Location successfully created

statusstring
Result status when present
_idstring
Location card identifier
locationIdstring
Location card identifier (207 partial-success responses)
boardIdstring
cardtypestring
carddataobject
warningsstring[]
Permission warnings when some requested fields were not set

Orders - Get Order Detail

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderid}

Get details of a specific order.

Orders - Get Order Detail › path Parameters

partnercodestring · required
Partner code identifier
orderidstring · required
Order identifier

Orders - Get Order Detail › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Update Order Booking

PUT

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderid}

Orders - Update Order Booking › path Parameters

partnercodestring · required
Partner code identifier
orderidstring · required
Order identifier

Orders - Update Order Booking › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Update Order Booking › Request Body

EquipmentSelectionstring · maxLength: 50
ServiceTypestring · maxLength: 50
Driver1string · maxLength: 200
Driver2string · maxLength: 200
DriverPhonestring · maxLength: 50
Tractorstring · maxLength: 100
Trailerstring · maxLength: 100
Stopsobject[]
RefNumbersobject[]
FreightDetailsobject[]

Orders - Update Order Booking › Responses

Order successfully updated

statusstring
Result status
warningsstring[]
Permission warnings when some requested fields were not updated

Orders - Cancel Order Booking

DELETE

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderid}

Cancel an order booking and remove it from the system.

Orders - Cancel Order Booking › path Parameters

partnercodestring · required
Partner code identifier
orderidstring · required
Order identifier

Orders - Cancel Order Booking › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Quotes - Create Order Quote

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/quotes

Create a quote for a tentative or pending shipment.

Quotes - Create Order Quote › path Parameters

partnercodestring · required
Partner code identifier

Quotes - Create Order Quote › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Get Order Documents

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderid}/documents

Get Documents and Images for a specific order.

Orders - Get Order Documents › path Parameters

partnercodestring · required
Partner code identifier
orderidstring · required
Order identifier

Orders - Get Order Documents › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Quotes - Get Quote Details

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/quotes/{quoteid}

Get Quote details by Quote ID.

Quotes - Get Quote Details › path Parameters

partnercodestring · required
Partner code identifier
quoteidstring · required
Quote identifier

Quotes - Get Quote Details › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Orders - Get GPS Positions

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/orders/{orderguid}/positions

Get GPS tracking history for a given order

Orders - Get GPS Positions › path Parameters

partnercodestring · required
Partner code identifier
orderguidstring · required
Order GUID identifier

Orders - Get GPS Positions › query Parameters

pageinteger · int32
Page number to return results

Orders - Get GPS Positions › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Update Location

PUT

https://qa.carriercloud.ai

/v1/partner/{partnercode}/locations/{id}

Locations - Update Location › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The location card id

Locations - Update Location › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Update Location › Request Body

boardIdstring
listIdstring
titlestring · maxLength: 200
descriptionstring · maxLength: 2000
CompanyIdstring · maxLength: 100
CompanyNamestring · maxLength: 200
Contactstring · maxLength: 200
Address1string · maxLength: 200
Address2string · maxLength: 200
Citystring · maxLength: 100
Statestring · maxLength: 50
ZipCodestring · maxLength: 20
PrimaryPhonestring · maxLength: 50
SecondaryPhonestring · maxLength: 50
Faxstring · maxLength: 50
Emailstring · maxLength: 200
Latitudestring · maxLength: 50
Longitudestring · maxLength: 50
ExternalIdstring · maxLength: 100
HoursOfOperationobject[]
Rolesobject

Locations - Update Location › Responses

Location successfully updated

statusstring

Carriers Partners