CarrierCloud (v1) - Universal Transportation API

Customers

Download schema

Operations a customer or shipper performs with a partner: orders, quotes, locations, documents and tracking.

Orders - Get Orders

GET

https://carriercloud.ai

/v1/partner/{partnercode}/orders

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

Orders - Get Orders › path Parameters

partnercode

string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Orders - Get Orders › query Parameters

page

integer · int32

Page number to return, starting at 1. Omit for the first page.

refNumber

string · minLength: 1 · maxLength: 100

Filter orders by exact reference number match. The reference number must match exactly (case-sensitive).

orderNumber

string · minLength: 1 · maxLength: 100

Filter orders by exact order number match. The order number must match exactly (case-sensitive).

status

string · minLength: 1 · maxLength: 100

Filter orders by exact status match. The status must match exactly (case-sensitive).

billTo

string · minLength: 1 · maxLength: 100

Filter orders by bill-to customer code. The Customer ID must match exactly (case-sensitive).

sort

string · enum

Optional sort for order results. Default is by Order Id.

Enum values:

DateLastActivity

CreatedAt

Orders - Get Orders › Headers

Authorization

string · 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 Orders › Responses

Orders for the partner, newest activity first, 100 per page.

object[]

An order (trip) as seen by a customer or partner, with its stops and freight. Returned by Get Orders.

ID

string

Order identifier. Use it as orderid on Get Order Detail, Update Order Booking and Cancel Order Booking.

TripId

string | null

Order number.

Company

string

Always empty.

Carrier

string

Always empty.

CarrierName

string

Always empty.

object[]

ProNumber

string

Always empty.

BookedDate

string | null · date-time

Date-time the order was created.

TripStatus

string | null

Order status.

BillTo

string | null

Identifier of the bill-to company.

LastUpdated

string | null · date-time

Date-time of the last activity on the order.

OriginEarliest

string | null · date-time

OriginLatest

string | null · date-time

OriginCity

string | null

OriginState

string | null

OriginRegion

string | null

Origin country.

DestinationEarliest

string | null · date-time

DestinationLatest

string | null · date-time

DestinationCity

string | null

DestinationState

string | null

DestinationRegion

string | null

Destination country.

Driver1

string | null

Primary driver name.

Driver2

string | null

Always null.

Tractor

string | null

Tractor number.

Trailer

string | null

Always null.

NextEventDateTime

string | null · date-time

NextEventDateFlag

string | null

OriginZipCode

string | null

DestinationZipCode

string | null

PercentCompleted

number | null

StopsCompleted

integer | null

TotalStops

integer | null

ProximityDescription

string | null

Last known position as text, when tracking is available.

ProximityLatitude

number | null

ProximityLongitude

number | null

OriginCompanyId

string | null

OriginCompanyName

string | null

DestinationCompanyId

string | null

DestinationCompanyName

string | null

object[]

Driver1Name

string | null

Driver2Name

string | null

GET/v1/partner/{partnercode}/orders

curl https://carriercloud.ai/v1/partner/:partnercode/orders \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "ID": "Tyc24gHSx2SHShYma",
    "TripId": "1049822",
    "Company": "",
    "Carrier": "",
    "CarrierName": "",
    "RefNumbers": [
      {
        "ID": null,
        "DataGUID": "ref-PO-448812",
        "RefType": "PO",
        "Expires": null,
        "RefNumber": "PO-448812",
        "RefKey": null,
        "RefSequence": 1,
        "UserDefined": false,
        "LastUpdated": "2026-09-29T14:02:11.000Z"
      },
      {
        "ID": null,
        "DataGUID": "ref-BOL-99120",
        "RefType": "BOL",
        "Expires": null,
        "RefNumber": "BOL-99120",
        "RefKey": null,
        "RefSequence": 1,
        "UserDefined": false,
        "LastUpdated": "2026-09-29T14:02:11.000Z"
      }
    ],
    "ProNumber": "",
    "BookedDate": "2026-09-29T13:58:40.000Z",
    "TripStatus": "Dispatched",
    "BillTo": "billto-7731",
    "LastUpdated": "2026-09-30T11:20:00.000Z",
    "OriginEarliest": "2026-09-30T12:00:00.000Z",
    "OriginLatest": "2026-09-30T14:00:00.000Z",
    "OriginCity": "Perrysburg",
    "OriginState": "OH",
    "OriginRegion": "USA",
    "DestinationEarliest": "2026-10-01T08:00:00.000Z",
    "DestinationLatest": "2026-10-01T10:00:00.000Z",
    "DestinationCity": "Columbus",
    "DestinationState": "OH",
    "DestinationRegion": "USA",
    "Driver1": "J. Smith",
    "Driver2": null,
    "Tractor": "1412",
    "Trailer": null,
    "NextEventDateTime": "2026-10-01T08:00:00.000Z",
    "NextEventDateFlag": "Latest",
    "OriginZipCode": "43551",
    "DestinationZipCode": "43232",
    "PercentCompleted": 50,
    "StopsCompleted": 1,
    "TotalStops": 2,
    "ProximityDescription": "3.2mi S of Findlay, OH",
    "ProximityLatitude": 40.996,
    "ProximityLongitude": -83.65,
    "OriginCompanyId": "loc-1",
    "OriginCompanyName": "Perrysburg DC",
    "DestinationCompanyId": "loc-2",
    "DestinationCompanyName": "Columbus Receiving",
    "Stops": [
      {
        "TripId": "1049822",
        "OrderNumber": "1049822",
        "DataGUID": "stop-1",
        "StopId": "S1",
        "LegId": "L1",
        "FreightId": "F1",
        "StopType": "Pickup",
        "StopEvent": "LLD",
        "StopStatus": "Completed",
        "Sequence": 1,
        "EarliestDate": "2026-09-30T12:00:00.000Z",
        "LatestDate": "2026-09-30T14:00:00.000Z",
        "ScheduledEarliestDate": "2026-09-30T12:00:00.000Z",
        "ScheduledLatestDate": "2026-09-30T14:00:00.000Z",
        "ArrivalDate": "2026-09-30T12:00:00.000Z",
        "CustomerRequestDate": "2026-09-30T12:00:00.000Z",
        "Arrived": true,
        "DepartureDate": "2026-09-30T14:00:00.000Z",
        "Completed": true,
        "ReasonLate": null,
        "IsLate": false,
        "Weight": 38500,
        "WeightUnit": "lbs",
        "IsHazardous": false,
        "LoTemp": null,
        "HiTemp": null,
        "Description": "Palletized consumer goods",
        "Count": 22,
        "CountUnit": "pallets",
        "CompanyId": "loc-1",
        "Company": "Perrysburg DC",
        "Address1": "28000 Oregon Rd",
        "Address2": null,
        "CityCode": null,
        "City": "Perrysburg",
        "State": "OH",
        "ZipCode": "43551",
        "Country": "USA",
        "PODSent": true,
        "LastUpdated": "2026-09-30T11:20:00.000Z",
        "Latitude": 41.5335,
        "Longitude": -83.6236,
        "RefNumbers": [
          {
            "ID": null,
            "DataGUID": "ref-PO-448812",
            "RefType": "PO",
            "Expires": null,
            "RefNumber": "PO-448812",
            "RefKey": null,
            "RefSequence": 1,
            "UserDefined": false,
            "LastUpdated": "2026-09-29T14:02:11.000Z"
          }
        ]
      },
      {
        "TripId": "1049822",
        "OrderNumber": "1049822",
        "DataGUID": "stop-2",
        "StopId": "S2",
        "LegId": "L1",
        "FreightId": "F1",
        "StopType": "Delivery",
        "StopEvent": "LUL",
        "StopStatus": "Pending",
        "Sequence": 2,
        "EarliestDate": "2026-10-01T08:00:00.000Z",
        "LatestDate": "2026-10-01T10:00:00.000Z",
        "ScheduledEarliestDate": "2026-10-01T08:00:00.000Z",
        "ScheduledLatestDate": "2026-10-01T10:00:00.000Z",
        "ArrivalDate": null,
        "CustomerRequestDate": "2026-10-01T08:00:00.000Z",
        "Arrived": false,
        "DepartureDate": null,
        "Completed": false,
        "ReasonLate": null,
        "IsLate": false,
        "Weight": 38500,
        "WeightUnit": "lbs",
        "IsHazardous": false,
        "LoTemp": null,
        "HiTemp": null,
        "Description": "Palletized consumer goods",
        "Count": 22,
        "CountUnit": "pallets",
        "CompanyId": "loc-2",
        "Company": "Columbus Receiving",
        "Address1": "4200 Groves Rd",
        "Address2": null,
        "CityCode": null,
        "City": "Columbus",
        "State": "OH",
        "ZipCode": "43232",
        "Country": "USA",
        "PODSent": false,
        "LastUpdated": "2026-09-30T11:20:00.000Z",
        "Latitude": 39.9612,
        "Longitude": -82.8988,
        "RefNumbers": []
      }
    ],
    "FreightDetails": [
      {
        "DataGUID": "frt-1",
        "StopDataGUID": "stop-1",
        "Sequence": 1,
        "ExternalLoadId": null,
        "ExternalStopID": null,
        "FreightBillNum": "1049822",
        "FreightAction": null,
        "IsUrgent": false,
        "ItemCount": 22,
        "Length": 48,
        "PalletCount": 22,
        "SequenceId": null,
        "SpecialInstructions": "Dock 14, call on arrival",
        "TMSLoadId": null,
        "TMSStopId": null,
        "OrderedVolume": null,
        "OrderedWeight": 38500,
        "Volume": null,
        "Volume2": null,
        "VolumeUnit": null,
        "Weight": 38500,
        "Width": 40,
        "WidthUnit": "in",
        "WeightUnit": "lbs",
        "Commodity": "GENERAL",
        "Height": 48,
        "HeightUnit": "in",
        "Pieces": 0,
        "PiecesUnit": null,
        "Hazardous": false,
        "HazardStandard": null,
        "HazardId": null,
        "HazardClass": null,
        "CommodityCode": "GENERAL",
        "Description": "Palletized consumer goods",
        "FreightClass": "70",
        "FreightDescriptino": "Palletized consumer goods",
        "ItemCountUnit": "pallets",
        "ShipperDetails": null,
        "ConsigneeDetails": null,
        "TemperatureControlled": false,
        "MinimumTemperature": null,
        "MaximumTemperature": null,
        "FreightNmfc": null
      }
    ],
    "Driver1Name": "J. Smith",
    "Driver2Name": null
  }
]

json

application/json

Orders - Create Order Booking

POST

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

partnercode

string · required

Orders - Create Order Booking › Headers

Authorization

string · 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

CreateOrderRequest

OrderStop[] · minItems: 2 · required

Array of stops (pickup and delivery locations)

OrderNumber

string · maxLength: 100

Unique order number for tracking

EquipmentSelection

string · maxLength: 50

Equipment type abbreviation for the order

ServiceType

string · maxLength: 50

Service type abbreviation for the order

Driver1

string · maxLength: 200

Primary driver name for brokered carrier

Driver2

string · maxLength: 200

Secondary driver name for brokered carrier

DriverPhone

string · maxLength: 50

Driver phone number for brokered carrier

Tractor

string · maxLength: 100

Tractor identifier for brokered carrier

Trailer

string · maxLength: 100

Trailer identifier for brokered carrier

FreightDetail[]

Details about the freight being transported

ReferenceNumber[]

Reference numbers (BOL, PRO, etc.)

BillToCompanyId

string · maxLength: 100

Company ID for billing

specialInstructions

string · maxLength: 5000

Special handling instructions

Orders - Create Order Booking › Responses

Order successfully created

OrderResponse

status

string

Result status

messsage

string

Human-readable result message

objectId

string

Unique identifier for the created order card

orderId

string

Unique identifier for the created order (same value as objectId)

orderGuid

string

GUID identifier for the order

orderNumber

string

Order number

createdAt

string · date-time

Timestamp when order was created

warnings

string[]

Permission or field warnings when the order was created with partial field updates

POST/v1/partner/{partnercode}/orders

curl https://carriercloud.ai/v1/partner/:partnercode/orders \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "orderNumber": "ORD-2024-001",
  "Stops": [
    {
      "StopType": "Pickup",
      "Sequence": 1,
      "ScheduledEarliestDate": "2024-01-15T08:00:00Z",
      "ScheduledLatestDate": "2024-01-15T17:00:00Z",
      "CompanyId": "COMP123",
      "Company": "ABC Shipping",
      "Address1": "123 Main St",
      "City": "Chicago",
      "State": "IL",
      "ZipCode": "60601",
      "Country": "US"
    },
    {
      "StopType": "Delivery",
      "Sequence": 2,
      "ScheduledEarliestDate": "2024-01-16T08:00:00Z",
      "ScheduledLatestDate": "2024-01-16T17:00:00Z",
      "CompanyId": "COMP456",
      "Company": "XYZ Distribution",
      "Address1": "456 Oak Ave",
      "City": "Detroit",
      "State": "MI",
      "ZipCode": "48201",
      "Country": "US"
    }
  ],
  "FreightDetails": [
    {
      "Weight": 15000,
      "WeightUnit": "lbs",
      "Volume": 1200,
      "VolumeUnit": "gal",
      "CommodityCode": "GENERAL",
      "Description": "General freight",
      "ItemCount": 50
    }
  ],
  "RefNumbers": [
    {
      "RefType": "BL#",
      "RefNumber": "BOL-12345"
    }
  ]
}'

Example Request Body

{
  "orderNumber": "ORD-2024-001",
  "Stops": [
    {
      "StopType": "Pickup",
      "Sequence": 1,
      "ScheduledEarliestDate": "2024-01-15T08:00:00Z",
      "ScheduledLatestDate": "2024-01-15T17:00:00Z",
      "CompanyId": "COMP123",
      "Company": "ABC Shipping",
      "Address1": "123 Main St",
      "City": "Chicago",
      "State": "IL",
      "ZipCode": "60601",
      "Country": "US"
    },
    {
      "StopType": "Delivery",
      "Sequence": 2,
      "ScheduledEarliestDate": "2024-01-16T08:00:00Z",
      "ScheduledLatestDate": "2024-01-16T17:00:00Z",
      "CompanyId": "COMP456",
      "Company": "XYZ Distribution",
      "Address1": "456 Oak Ave",
      "City": "Detroit",
      "State": "MI",
      "ZipCode": "48201",
      "Country": "US"
    }
  ],
  "FreightDetails": [
    {
      "Weight": 15000,
      "WeightUnit": "lbs",
      "Volume": 1200,
      "VolumeUnit": "gal",
      "CommodityCode": "GENERAL",
      "Description": "General freight",
      "ItemCount": 50
    }
  ],
  "RefNumbers": [
    {
      "RefType": "BL#",
      "RefNumber": "BOL-12345"
    }
  ]
}

json

application/json

Example Responses

{
  "status": "ok",
  "messsage": "Order successfully booked.",
  "objectId": "6Wu3bXeRByQqGnFAx",
  "orderId": "6Wu3bXeRByQqGnFAx"
}

json

application/json

Locations - Get Locations

GET

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

partnercode

string · required

Locations - Get Locations › query Parameters

page

integer · int32

Page number to return, starting at 1. Omit for the first page.

companyId

string

Filter by companyId (case-sensitive). Omit or leave blank for no filter.

Locations - Get Locations › Headers

Authorization

string · 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

status

string

Result status

page

integer · int32

Current page number

pageSize

integer · int32

Number of locations returned per page

totalCount

integer · int32

Total number of matching locations

object[]

Location cards for the current page

Locations - Create Location

POST

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

partnercode

string · required

Locations - Create Location › Headers

Authorization

string · 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

title

string · maxLength: 200 · required

boardId

string

listId

string

description

string · maxLength: 2000

CompanyId

string · maxLength: 100

CompanyName

string · maxLength: 200

Contact

string · maxLength: 200

Address1

string · maxLength: 200

Address2

string · maxLength: 200

City

string · maxLength: 100

State

string · maxLength: 50

ZipCode

string · maxLength: 20

PrimaryPhone

string · maxLength: 50

SecondaryPhone

string · maxLength: 50

Fax

string · maxLength: 50

Email

string · maxLength: 200

Latitude

string · maxLength: 50

Longitude

string · maxLength: 50

ExternalId

string · maxLength: 100

object[]

object

Locations - Create Location › Responses

Location successfully created

status

string

Result status when present

_id

string

Location card identifier

locationId

string

Location card identifier (207 partial-success responses)

boardId

string

cardtype

string

object

warnings

string[]

Permission warnings when some requested fields were not set

POST/v1/partner/{partnercode}/locations

curl https://carriercloud.ai/v1/partner/:partnercode/locations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "boardId": "",
  "listId": "",
  "title": "Casey'\''s",
  "CompanyId": "CASEY01",
  "CompanyName": "Casey'\''s",
  "Address1": "500 North St",
  "City": "Hannibal",
  "State": "MO",
  "ZipCode": "63401",
  "PrimaryPhone": "573-555-5555",
  "Roles": {
    "Shipper": {
      "CompanyName": "Casey'\''s",
      "CompanyId": "CASEY01",
      "Address1": "500 North St",
      "City": "Hannibal",
      "State": "MO",
      "ZipCode": "63401",
      "PrimaryPhone": "573-555-5555"
    }
  }
}'

Example Request Body

{
  "boardId": "",
  "listId": "",
  "title": "Casey's",
  "CompanyId": "CASEY01",
  "CompanyName": "Casey's",
  "Address1": "500 North St",
  "City": "Hannibal",
  "State": "MO",
  "ZipCode": "63401",
  "PrimaryPhone": "573-555-5555",
  "Roles": {
    "Shipper": {
      "CompanyName": "Casey's",
      "CompanyId": "CASEY01",
      "Address1": "500 North St",
      "City": "Hannibal",
      "State": "MO",
      "ZipCode": "63401",
      "PrimaryPhone": "573-555-5555"
    }
  }
}

json

application/json

Example Responses

{
  "status": "ok",
  "_id": "_id",
  "locationId": "locationId",
  "boardId": "boardId",
  "cardtype": "cardtype",
  "carddata": {},
  "warnings": [
    "string"
  ]
}

json

application/json

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

partnercode

string · required

orderid

string · required

Order identifier as returned by Get Orders or Create Order Booking.

Orders - Get Order Detail › Headers

Authorization

string · 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 › Responses

The order as a one-element array of stored card documents (empty array when the id is unknown).

object[]

A platform card as stored, returned without reshaping. `_source.carddata` holds the card's fields; its keys depend on the card type (order, customerorder, truck, trailer, driver).

_id

string

Card identifier.

object

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

curl https://carriercloud.ai/v1/partner/:partnercode/orders/:orderid \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "_id": "Tyc24gHSx2SHShYma",
    "_source": {
      "_id": "Tyc24gHSx2SHShYma",
      "cardtype": "order",
      "boardId": "board-ops",
      "createdAt": "2026-09-29T13:58:40.000Z",
      "dateLastActivity": "2026-09-30T11:20:00.000Z",
      "carddata": {
        "OrderNumber": "1049822",
        "TripStatus": "Dispatched",
        "OriginCity": "Perrysburg",
        "OriginState": "OH",
        "OriginEarliest": "2026-09-30T12:00:00.000Z",
        "DestinationCity": "Columbus",
        "DestinationState": "OH",
        "DestinationLatest": "2026-10-01T10:00:00.000Z",
        "DriverName": "J. Smith",
        "Tractor": "1412",
        "PercentCompleted": 50,
        "StopsCompleted": 1,
        "TotalStops": 2,
        "Stops": [
          {
            "StopId": "S1",
            "StopType": "Pickup",
            "City": "Perrysburg",
            "State": "OH",
            "Completed": true
          },
          {
            "StopId": "S2",
            "StopType": "Delivery",
            "City": "Columbus",
            "State": "OH",
            "Completed": false
          }
        ],
        "FreightDetails": [
          {
            "Description": "Palletized consumer goods",
            "Weight": 38500,
            "WeightUnit": "lbs"
          }
        ],
        "RefNumbers": [
          {
            "RefType": "PO",
            "RefNumber": "PO-448812"
          }
        ],
        "Tracking": {
          "proximity": "3.2mi S of Findlay, OH",
          "currentLat": 40.996,
          "currentLng": -83.65
        }
      }
    }
  }
]

json

application/json

Orders - Update Order Booking

PUT

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

partnercode

string · required

orderid

string · required

Order identifier as returned by Get Orders or Create Order Booking.

Orders - Update Order Booking › Headers

Authorization

string · 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

UpdateOrderRequest

EquipmentSelection

string · maxLength: 50

ServiceType

string · maxLength: 50

Driver1

string · maxLength: 200

Driver2

string · maxLength: 200

DriverPhone

string · maxLength: 50

Tractor

string · maxLength: 100

Trailer

string · maxLength: 100

UpdateOrderStop[]

UpdateOrderRefNumber[]

UpdateOrderFreightDetail[]

Orders - Update Order Booking › Responses

Order successfully updated

UpdateOrderResponse

status

string

Result status

warnings

string[]

Permission warnings when some requested fields were not updated

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

curl https://carriercloud.ai/v1/partner/:partnercode/orders/:orderid \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "EquipmentSelection": "EquipmentSelection",
  "ServiceType": "ServiceType",
  "Driver1": "Driver1",
  "Driver2": "Driver2",
  "DriverPhone": "DriverPhone",
  "Tractor": "Tractor",
  "Trailer": "Trailer",
  "Stops": [
    {
      "_id": "_id",
      "StopType": "Pickup",
      "ScheduledEarliestDate": "2024-08-25T15:00:00Z",
      "ScheduledLatestDate": "2024-08-25T15:00:00Z",
      "Company": "Company",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "Contact": "Contact",
      "PrimaryPhone": "PrimaryPhone",
      "Email": "Email"
    }
  ],
  "RefNumbers": [
    {
      "DataGUID": "DataGUID",
      "RefType": "BL#",
      "RefNumber": "RefNumber"
    }
  ],
  "FreightDetails": [
    {
      "DataGUID": "DataGUID",
      "Weight": 0,
      "WeightUnit": "WeightUnit",
      "Volume": 0,
      "VolumeUnit": "VolumeUnit",
      "ItemCount": 0,
      "ItemCountUnit": "ItemCountUnit",
      "Description": "Description",
      "CommodityCode": "CommodityCode"
    }
  ]
}'

Example Request Body

{
  "EquipmentSelection": "EquipmentSelection",
  "ServiceType": "ServiceType",
  "Driver1": "Driver1",
  "Driver2": "Driver2",
  "DriverPhone": "DriverPhone",
  "Tractor": "Tractor",
  "Trailer": "Trailer",
  "Stops": [
    {
      "_id": "_id",
      "StopType": "Pickup",
      "ScheduledEarliestDate": "2024-08-25T15:00:00Z",
      "ScheduledLatestDate": "2024-08-25T15:00:00Z",
      "Company": "Company",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "Contact": "Contact",
      "PrimaryPhone": "PrimaryPhone",
      "Email": "Email"
    }
  ],
  "RefNumbers": [
    {
      "DataGUID": "DataGUID",
      "RefType": "BL#",
      "RefNumber": "RefNumber"
    }
  ],
  "FreightDetails": [
    {
      "DataGUID": "DataGUID",
      "Weight": 0,
      "WeightUnit": "WeightUnit",
      "Volume": 0,
      "VolumeUnit": "VolumeUnit",
      "ItemCount": 0,
      "ItemCountUnit": "ItemCountUnit",
      "Description": "Description",
      "CommodityCode": "CommodityCode"
    }
  ]
}

json

Example Responses

{
  "status": "ok"
}

json

application/json

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

partnercode

string · required

orderid

string · required

Order identifier as returned by Get Orders or Create Order Booking.

Orders - Cancel Order Booking › Headers

Authorization

string · 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 › Responses

Order booking cancelled (archived).

Result returned by the processing workflow. Its fields depend on the partner's configuration; treat the HTTP status as the outcome and the body as informational.

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

partnercode

string · required

Quotes - Create Order Quote › Headers

Authorization

string · 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 › Responses

The created quote.

Upstream result; the field set is not published and may change. Treat the HTTP status as the outcome.

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

partnercode

string · required

orderid

string · required

Order identifier as returned by Get Orders or Create Order Booking.

Orders - Get Order Documents › Headers

Authorization

string · 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 › Responses

Documents attached to the order that your partner role may see.

object[]

A document attached to the order. Keys beyond the two below depend on how the document was stored.

name

string

documentTypeAbbr

string

Document type code, for example BOL or POD.

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

partnercode

string · required

quoteid

string · required

Quote identifier as returned by Create Order Quote.

Quotes - Get Quote Details › Headers

Authorization

string · 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 › Responses

The quote.

Upstream result; the field set is not published and may change. Treat the HTTP status as the outcome.

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

partnercode

string · required

orderguid

string · required

Order identifier as returned by Get Orders or Create Order Booking.

Orders - Get GPS Positions › query Parameters

page

integer · int32

Page number to return, starting at 1. Omit for the first page.

Orders - Get GPS Positions › Headers

Authorization

string · 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 › Responses

Positions recorded for the order's load.

object[] · required

Newest positions, at most 100 per call.

moreAvailable

boolean · required

True when more positions exist than were returned; narrow the time window to see them.

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

curl https://carriercloud.ai/v1/partner/:partnercode/orders/:orderguid/positions \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "positions": [
    {
      "EquipmentType": 3,
      "EquipmentId": "1412",
      "Driver": null,
      "PosDescription": "3.2mi S of Findlay, OH",
      "PosDateTime": "2026-10-01T13:42:10.000Z",
      "TimeZoneOffset": "+00:00",
      "Latitude": "40.99600",
      "Longitude": "-83.65000",
      "GPSMileage": 412887,
      "Speed": 62,
      "SpeedUnit": "mph",
      "NetworkId": null,
      "FuelLevelPct": null,
      "FuelPctType": null,
      "PosDescriptionCity": "Findlay",
      "PosDescriptionState": "OH"
    },
    {
      "EquipmentType": 3,
      "EquipmentId": "1412",
      "Driver": null,
      "PosDescription": "1.0mi N of Bowling Green, OH",
      "PosDateTime": "2026-10-01T13:27:10.000Z",
      "TimeZoneOffset": "+00:00",
      "Latitude": "41.21100",
      "Longitude": "-83.65400",
      "GPSMileage": 412887,
      "Speed": 64,
      "SpeedUnit": "mph",
      "NetworkId": null,
      "FuelLevelPct": null,
      "FuelPctType": null,
      "PosDescriptionCity": "Bowling Green",
      "PosDescriptionState": "OH"
    }
  ],
  "moreAvailable": false
}

json

application/json

Locations - Update Location

PUT

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

partnercode

string · required

id

string · required

The location card id

Locations - Update Location › Headers

Authorization

string · 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

boardId

string

listId

string

title

string · maxLength: 200

description

string · maxLength: 2000

CompanyId

string · maxLength: 100

CompanyName

string · maxLength: 200

Contact

string · maxLength: 200

Address1

string · maxLength: 200

Address2

string · maxLength: 200

City

string · maxLength: 100

State

string · maxLength: 50

ZipCode

string · maxLength: 20

PrimaryPhone

string · maxLength: 50

SecondaryPhone

string · maxLength: 50

Fax

string · maxLength: 50

Email

string · maxLength: 200

Latitude

string · maxLength: 50

Longitude

string · maxLength: 50

ExternalId

string · maxLength: 100

object[]

object

Locations - Update Location › Responses

Location successfully updated

status

string

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

curl https://carriercloud.ai/v1/partner/:partnercode/locations/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "boardId": "boardId",
  "listId": "listId",
  "title": "title",
  "description": "description",
  "CompanyId": "CompanyId",
  "CompanyName": "CompanyName",
  "Contact": "Contact",
  "Address1": "Address1",
  "Address2": "Address2",
  "City": "City",
  "State": "State",
  "ZipCode": "ZipCode",
  "PrimaryPhone": "PrimaryPhone",
  "SecondaryPhone": "SecondaryPhone",
  "Fax": "Fax",
  "Email": "Email",
  "Latitude": "Latitude",
  "Longitude": "Longitude",
  "ExternalId": "ExternalId",
  "HoursOfOperation": [
    {}
  ],
  "Roles": {
    "Shipper": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true
    },
    "Consignee": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true
    },
    "BillTo": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true,
      "AccountStatus": "open",
      "InvoiceType": "Master Bill",
      "CreditStatus": "None",
      "AvailableCredit": "AvailableCredit",
      "AvailablePrePay": "AvailablePrePay",
      "MinimumMargin": "MinimumMargin",
      "DefaultMargin": "DefaultMargin",
      "CreditTerms": "CreditTerms",
      "PaymentTerms": "PaymentTerms",
      "Taxable": true,
      "InsuranceMinimumMargin": 0,
      "InsuranceDefaultMargin": 0,
      "InsuranceCost": 0,
      "SalesRep": "SalesRep"
    },
    "Terminal": {
      "CarrierId": "CarrierId",
      "Carrier": "Carrier",
      "CarrierMC": "CarrierMC",
      "UseLocationDetailsHours": true
    },
    "TruckStop": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true
    },
    "Agent": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true
    },
    "WashFacility": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "Email": "Email",
      "WashServices": [
        "string"
      ],
      "WashTypes": [
        "string"
      ],
      "UseLocationDetailsHours": true
    }
  }
}'

Example Request Body

{
  "boardId": "boardId",
  "listId": "listId",
  "title": "title",
  "description": "description",
  "CompanyId": "CompanyId",
  "CompanyName": "CompanyName",
  "Contact": "Contact",
  "Address1": "Address1",
  "Address2": "Address2",
  "City": "City",
  "State": "State",
  "ZipCode": "ZipCode",
  "PrimaryPhone": "PrimaryPhone",
  "SecondaryPhone": "SecondaryPhone",
  "Fax": "Fax",
  "Email": "Email",
  "Latitude": "Latitude",
  "Longitude": "Longitude",
  "ExternalId": "ExternalId",
  "HoursOfOperation": [
    {}
  ],
  "Roles": {
    "Shipper": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true
    },
    "Consignee": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true
    },
    "BillTo": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true,
      "AccountStatus": "open",
      "InvoiceType": "Master Bill",
      "CreditStatus": "None",
      "AvailableCredit": "AvailableCredit",
      "AvailablePrePay": "AvailablePrePay",
      "MinimumMargin": "MinimumMargin",
      "DefaultMargin": "DefaultMargin",
      "CreditTerms": "CreditTerms",
      "PaymentTerms": "PaymentTerms",
      "Taxable": true,
      "InsuranceMinimumMargin": 0,
      "InsuranceDefaultMargin": 0,
      "InsuranceCost": 0,
      "SalesRep": "SalesRep"
    },
    "Terminal": {
      "CarrierId": "CarrierId",
      "Carrier": "Carrier",
      "CarrierMC": "CarrierMC",
      "UseLocationDetailsHours": true
    },
    "TruckStop": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true
    },
    "Agent": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "SecondaryPhone": "SecondaryPhone",
      "Fax": "Fax",
      "Email": "Email",
      "Directions": "Directions",
      "UseLocationDetailsHours": true
    },
    "WashFacility": {
      "CompanyName": "CompanyName",
      "CompanyId": "CompanyId",
      "Contact": "Contact",
      "Address1": "Address1",
      "Address2": "Address2",
      "City": "City",
      "State": "State",
      "ZipCode": "ZipCode",
      "PrimaryPhone": "PrimaryPhone",
      "Email": "Email",
      "WashServices": [
        "string"
      ],
      "WashTypes": [
        "string"
      ],
      "UseLocationDetailsHours": true
    }
  }
}

json

Example Responses

{
  "status": "ok"
}

json

application/json

Carriers Partners