CarrierCloud (v1) - Universal Transportation API

Customers (1.0.1)

Endpoint:https://carriercloud.ai

Cloud Network Endpoints for Customer Access

Orders - Create Order Booking

POST

https://carriercloud.ai

/v1/partner/{partnercode}/orders

Create (book) an order with a partner.

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 - Get Order Detail

GET

https://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 - Cancel Order Booking

DELETE

https://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://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://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://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://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.

Carriers Partners

CarrierCloud (v1) - Universal Transportation API

Customers (1.0.1)

Endpoint:https://carriercloud.ai

Cloud Network Endpoints for Customer Access

Orders - Create Order Booking

POST

https://carriercloud.ai

/v1/partner/{partnercode}/orders

Create (book) an order with a partner.

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 - Get Order Detail

GET

https://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 - Cancel Order Booking

DELETE

https://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://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://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://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://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.

Carriers Partners