CarrierCloud (v1) - Universal Transportation API

Carriers

Operations a carrier performs on the loads it hauls for a partner: offers, loads, stops, positions, notes and attachments.

Offers - Get Active Offers

GET

https://carriercloud.ai

/v1/partner/{partnercode}/offers

List the load offers currently open for the partner. Each offer references a load that can be accepted or rejected.

Offers - Get Active Offers › 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.

Offers - Get Active Offers › query Parameters

partnerid

string · required

Id of partner

starttime

string · required

Start Time in UTC

Offers - Get Active Offers › 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.

Offers - Get Active Offers › Responses

Open offers for the partner since starttime.

object[]

A platform card as the Partner API returns it: root fields plus `carddata`. Only the fields your partner role may see are present.

_id

string

Card identifier (load id).

title

string | null

cardtype

string | null

boardId

string | null

listId

string | null

companyId

string | null

Owning company.

createdAt

string | null · date-time

dateLastActivity

string | null · date-time

showAcceptReject

boolean | null

True while the offer is open for accept / reject.

archived

boolean | null

object

Load fields: TripId, OrderNumber, TripStatus, Company, Carrier, CarrierName, Customer*, Origin* and Destination* (CompanyId, Company, Address1/2, City, State, ZipCode, Country, Contact, Phone, Email, Earliest, Latest), FreightDetails[].

GET/v1/partner/{partnercode}/offers

curl 'https://carriercloud.ai/v1/partner/:partnercode/offers?partnerid=<string>&starttime=1605-11-05T13:37:00' \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "_id": "Tyc24gHSx2SHShYma",
    "title": "1049822",
    "cardtype": "order",
    "boardId": "board-ops",
    "listId": "list-offers",
    "companyId": "cmp-mist",
    "createdAt": "2026-09-29T13:58:40.000Z",
    "dateLastActivity": "2026-09-30T11:20:00.000Z",
    "showAcceptReject": true,
    "archived": false,
    "carddata": {
      "TripId": "1049822",
      "OrderNumber": "1049822",
      "TripStatus": "Offered",
      "Customer": "Northwind Traders",
      "OriginCompany": "Perrysburg DC",
      "OriginCity": "Perrysburg",
      "OriginState": "OH",
      "OriginZipCode": "43551",
      "OriginEarliest": "2026-09-30T12:00:00.000Z",
      "OriginLatest": "2026-09-30T14:00:00.000Z",
      "DestinationCompany": "Columbus Receiving",
      "DestinationCity": "Columbus",
      "DestinationState": "OH",
      "DestinationZipCode": "43232",
      "DestinationEarliest": "2026-10-01T08:00:00.000Z",
      "DestinationLatest": "2026-10-01T10:00:00.000Z",
      "FreightDetails": [
        {
          "Description": "Palletized consumer goods",
          "Weight": 38500,
          "WeightUnit": "lbs"
        }
      ]
    }
  }
]

json

application/json

Offers - Accept an Offer

GET

https://carriercloud.ai

/v1/partner/{partnercode}/offers/{loadid}/accept

Accept an open load offer on behalf of the partner. Although this is an HTTP GET, it changes the state of the offer and the load.

Offers - Accept an Offer › path Parameters

partnercode

string · required

loadid

string · required

Load identifier as returned by Get Loads (the id field of a load). For segment routes the same value is used as segmentid.

Offers - Accept an Offer › 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.

Offers - Accept an Offer › Responses

Offer accepted. The response has no body; the load's status becomes Accepted and the offer closes.

No data returned

Offers - Reject an Offer

GET

https://carriercloud.ai

/v1/partner/{partnercode}/offers/{loadid}/reject

Reject an open load offer on behalf of the partner. Although this is an HTTP GET, it changes the state of the offer.

Offers - Reject an Offer › path Parameters

partnercode

string · required

loadid

string · required

Load identifier as returned by Get Loads (the id field of a load). For segment routes the same value is used as segmentid.

Offers - Reject an Offer › 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.

Offers - Reject an Offer › Responses

Offer rejected. The response has no body; the load's status becomes Declined and the offer closes.

No data returned

Loads - Update Position

POST

https://carriercloud.ai

/v1/partner/{partnercode}/loads/{loadid}/updategps

Record a GPS position for the load. Use this when the position comes from your own tracking source rather than a connected telematics provider.

Loads - Update Position › path Parameters

partnercode

string · required

loadid

string · required

Load identifier as returned by Get Loads (the id field of a load). For segment routes the same value is used as segmentid.

Loads - Update Position › 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.

Loads - Update Position › Request Body optional

updateGps

lat

string

lng

string

eventDateTime

string · date-time

ISO-8601 UTC timestamp. Must be in UTC and end with 'Z' (e.g. 2025-01-26T18:45:00Z)

city

string

state

string

zip

string

proximity

string

trackingStatus

string

trackingMsg

string

heading

number

Loads - Update Position › Responses

Position recorded.

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.

POST/v1/partner/{partnercode}/loads/{loadid}/updategps

curl https://carriercloud.ai/v1/partner/:partnercode/loads/:loadid/updategps \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "lat": "41.563080",
  "lng": "-83.589710",
  "eventDateTime": "2025-01-26T18:45:00Z",
  "city": "Perrysburg",
  "state": "OH",
  "zip": "43551",
  "proximity": "1.6mi N of Perrysburg, OH",
  "trackingStatus": "1.6mi N of Perrysburg, OH",
  "trackingMsg": "1.6mi N of Perrysburg, OH"
}'

Example Request Body

{
  "lat": "41.563080",
  "lng": "-83.589710",
  "eventDateTime": "2025-01-26T18:45:00Z",
  "city": "Perrysburg",
  "state": "OH",
  "zip": "43551",
  "proximity": "1.6mi N of Perrysburg, OH",
  "trackingStatus": "1.6mi N of Perrysburg, OH",
  "trackingMsg": "1.6mi N of Perrysburg, OH"
}

json

Example Responses

{}

json

application/json

Loads - Get Load Detail

GET

https://carriercloud.ai

/v1/partner/{partnercode}/loads/{loadid}

Get details of a specific load segment.

Loads - Get Load Detail › path Parameters

partnercode

string · required

loadid

string · required

Load identifier as returned by Get Loads (the id field of a load). For segment routes the same value is used as segmentid.

Loads - Get Load 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.

Loads - Get Load Detail › Responses

The load 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}/loads/{loadid}

curl https://carriercloud.ai/v1/partner/:partnercode/loads/:loadid \
  --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

Segments - Update Segment

PUT

https://carriercloud.ai

/v1/partner/{partnercode}/segments/{segmentid}

Update an existing segment (load) card for a partner. Nested stop, reference, and freight updates require the _id or DataGUID values from the existing segment. Partner-network role permissions determine which fields may be updated. The segmentid is the same card identifier used as loadid on loads routes.

Segments - Update Segment › path Parameters

partnercode

string · required

segmentid

string · required

Segment card identifier (same value as loadid on loads routes)

Segments - Update Segment › 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.

Segments - Update Segment › Request Body

UpdateSegmentRequest

EquipmentSelection

string · maxLength: 50

ServiceType

string · maxLength: 50

TripStatus

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[]

Segments - Update Segment › Responses

Segment successfully updated

UpdateSegmentResponse

status

string

Result status

warnings

string[]

Permission warnings when some requested fields were not updated

PUT/v1/partner/{partnercode}/segments/{segmentid}

curl https://carriercloud.ai/v1/partner/:partnercode/segments/:segmentid \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "EquipmentSelection": "EquipmentSelection",
  "ServiceType": "ServiceType",
  "TripStatus": "TripStatus",
  "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",
  "TripStatus": "TripStatus",
  "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

Loads - Arrive Stop

PUT

https://carriercloud.ai

/v1/partner/{partnercode}/loads/{loadid}/stops/{stopid}/arrive

Arrive a specified stop on a Load.

Loads - Arrive Stop › path Parameters

partnercode

string · required

loadid

string · required

Unique guid of the load

stopid

string · required

Unique guid of the stop to arrive

Loads - Arrive Stop › query Parameters

arrivalTime

string · date-time · required

Date and time that the stop was arrived in local time (format YYYY-MM-ddTHH:mm:ss)

Loads - Arrive Stop › 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.

Loads - Arrive Stop › Responses

Arrival recorded.

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.

Loads - Add Attachment

POST

https://carriercloud.ai

/v1/partner/{partnercode}/loads/{loadid}/attachments/

Add an attachment to a specified load.

Loads - Add Attachment › path Parameters

partnercode

string · required

loadid

string · required

Unique guid of the load

Loads - Add Attachment › 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.

Loads - Add Attachment › Request Body

Provide either `fileUrl` or base-64 `data`, not both.

docType

string · required

Document type for the attachment.

mimeType

string · minLength: 1 · maxLength: 10000 · required

Mime type for the file.

fileUrl

string · minLength: 1 · maxLength: 10000

URL to the file attachment. Should not be used with data.

data

string · minLength: 1 · maxLength: 10000

Base-64 encoded copy of the file. Should not be used with fileUrl.

Loads - Add Attachment › Responses

Attachment stored on the load.

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.

Loads - Add Note

POST

https://carriercloud.ai

/v1/partner/{partnercode}/loads/{loadid}/notes/

Add a note to a specific load.

Loads - Add Note › path Parameters

partnercode

string · required

loadid

string · required

Load identifier as returned by Get Loads (the id field of a load). For segment routes the same value is used as segmentid.

Loads - Add Note › 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.

Loads - Add Note › Request Body

noteType

string · required

Type/category of the note.

noteBody

string · minLength: 1 · maxLength: 10000 · required

Full note text.

Loads - Add Note › Responses

Note added to the load.

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.

Loads - Update Load

PUT

https://carriercloud.ai

/v1/partner/{partnercode}/loads/{loadid}/

Update the details of a specific load segment by ID.

Loads - Update Load › path Parameters

partnercode

string · required

loadid

string · required

Load identifier as returned by Get Loads (the id field of a load). For segment routes the same value is used as segmentid.

Loads - Update Load › 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.

Loads - Update Load › Request Body

title

string

Title of the load segment (optional)

object

Load segment card data payload.

hasError

boolean

Indicates that the load segment has an error message. (optional)

errorMsg

string

Display text of the error message if hasError is true. (optional)

errorType

string

Error type.

refType

string

Type of reference number.

refNumber

string · minLength: 1 · maxLength: 32

Full reference number.

Loads - Update Load › Responses

Load updated.

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.

PUT/v1/partner/{partnercode}/loads/{loadid}/

curl https://carriercloud.ai/v1/partner/:partnercode/loads/:loadid \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "title": "26054002 - test",
  "carddata": {
    "OriginCity": "| City |",
    "OriginState": "| State |",
    "OriginZipCode": "",
    "LineHaul": 0,
    "DestinationCity": "| City |",
    "DestinationState": "| State |",
    "DestinationZipCode": "",
    "EquipmentType": "",
    "OriginCountry": "",
    "DestinationCountry": "",
    "DestinationCompany": "",
    "DestinationCompanyId": null,
    "DestinationEarliest": "2026-02-24T04:23:16.000Z",
    "DestinationLatest": "2026-02-24T04:23:16.000Z",
    "DestinationPhone": "",
    "FlatRate": 0,
    "OriginCompany": "",
    "OriginCompanyId": null,
    "OriginEarliest": "2026-02-24T04:23:16.000Z",
    "OriginLatest": "2026-02-24T04:23:16.000Z",
    "OriginPhone": "",
    "DeclaredValue": 0,
    "PriceMargin": "0.00",
    "PriceMarginPercentToggle": "USD",
    "SegmentCost": 0,
    "TargetPrice": 0
  },
  "errorMsg": "Destination must have an address",
  "errorType": "Error",
  "hasError": false
}'

Example Request Body

{
  "title": "26054002 - test",
  "carddata": {
    "OriginCity": "| City |",
    "OriginState": "| State |",
    "OriginZipCode": "",
    "LineHaul": 0,
    "DestinationCity": "| City |",
    "DestinationState": "| State |",
    "DestinationZipCode": "",
    "EquipmentType": "",
    "OriginCountry": "",
    "DestinationCountry": "",
    "DestinationCompany": "",
    "DestinationCompanyId": null,
    "DestinationEarliest": "2026-02-24T04:23:16.000Z",
    "DestinationLatest": "2026-02-24T04:23:16.000Z",
    "DestinationPhone": "",
    "FlatRate": 0,
    "OriginCompany": "",
    "OriginCompanyId": null,
    "OriginEarliest": "2026-02-24T04:23:16.000Z",
    "OriginLatest": "2026-02-24T04:23:16.000Z",
    "OriginPhone": "",
    "DeclaredValue": 0,
    "PriceMargin": "0.00",
    "PriceMarginPercentToggle": "USD",
    "SegmentCost": 0,
    "TargetPrice": 0
  },
  "errorMsg": "Destination must have an address",
  "errorType": "Error",
  "hasError": false
}

json

application/json

Example Responses

{}

json

application/json

Loads - Get Loads

GET

https://carriercloud.ai

/v1/partner/{partnercode}/loads

Get a list of load segments for a specific partner.

Loads - Get Loads › path Parameters

partnercode

string · required

Loads - Get Loads › query Parameters

page

integer · int32

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

refNumber

string · minLength: 1 · maxLength: 100

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

Loads - Get Loads › 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.

Loads - Get Loads › Responses

Loads (segments) for the partner as stored card documents, 100 per page.

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}/loads

curl https://carriercloud.ai/v1/partner/:partnercode/loads \
  --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

Loads - Depart Stop

PUT

https://carriercloud.ai

/v1/partner/{partnercode}/loads/{loadid}/stops/{stopid}/depart

Depart a specified stop on a Load.

Loads - Depart Stop › path Parameters

partnercode

string · required

loadid

string · required

Unique guid of the load

stopid

string · required

Unique guid of the stop to depart

Loads - Depart Stop › query Parameters

departureTime

string · date-time · required

Date and time that the stop was departed in local time (format YYYY-MM-ddTHH:mm:ss)

Loads - Depart Stop › 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.

Loads - Depart Stop › Responses

Departure recorded.

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.

Loads - Update Stop

PUT

https://carriercloud.ai

/v1/partner/{partnercode}/loads/{loadid}/stops/{stopid}

Update a specified stop on a Load.

Loads - Update Stop › path Parameters

partnercode

string · required

loadid

string · required

Unique guid of the load

stopid

string · required

Unique guid of the stop to update

Loads - Update Stop › 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.

Loads - Update Stop › Responses

Stop updated.

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.

Customers