Load object

{
  "externalId": "456293",
  "externalCustomerId": "ACMECORP",
  "trailerRequirements": {
    "allowedTypes": [
      "DRY_VAN_53"
    ],
    "maxAgeYears": 123,
    "highCube": true,
    "spaceSaver": true,
    "foodGrade": true,
    "logisticPost": true,
    "extendable": true,
    "liftGate": true,
    "minAxles": 123,
    "metalEdgeProtectors": true,
    "airChute": true,
    "ctpatCompliant": true,
    "floorTypes": []
  },
  "carrierRequirements": {
    "ctpatCertified": true,
    "oeaCertified": true,
    "pipCertified": true,
    "fastCertified": true,
    "internationalCarrierBonded": true,
    "internationalCarrierBondedUS": true,
    "internationalCarrierBondedCA": true,
    "internationalCarrierBondedMX": true,
    "has247CustomerService": true,
    "minCargoInsurance": {
      "amount": 500000000
    }
  },
  "driverRequirements": {
    "twicCard": true,
    "tankerEndorsed": true,
    "cdl": true
  },
  "id": "load_c6ee2dff-f35f-4880-b7a6-9b2a1fa1476e",
  "stops": [
    {
      "type": "PICKUP",
      "externalId": "27924_1",
      "location": {
        "place": {
          "type": "ADDRESS",
          "street": "123 Main St",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "98335",
          "neighborhood": "Valle Oriente"
        },
        "isCtpatCertified": true,
        "isPipCertified": true,
        "isOeaCertified": true,
        "timezone": "America/Chicago"
      },
      "appointment": {
        "type": "UNSPECIFIED"
      },
      "referenceNumbers": [
        {
          "label": "Shipment #",
          "value": "1234234"
        }
      ],
      "inboundTransitRequirements": {
        "maximumExpectedMinutes": 123,
        "teamDriverRequired": true,
        "trackingRequired": true
      },
      "dropDurationHours": 24,
      "fumigation": {
        "requiredBefore": true,
        "requiredAfter": true
      },
      "scaleTicket": {
        "requiredBefore": true,
        "requiredAfter": true
      },
      "driverAssistRequired": true
    }
  ],
  "externalDisplayId": "ORD-2024-001",
  "externalWorkspaceId": "<string>",
  "referenceNumbers": [
    {
      "label": "Shipment #",
      "value": "1234234"
    }
  ],
  "commodities": [
    {
      "hazmatDetails": {
        "isHazmat": true,
        "classification": "CLASS_3_FLAMMABLE_LIQUIDS",
        "unNumber": "1263",
        "packingGroup": "II"
      },
      "name": "Crude Oil",
      "dimensions": {
        "length": {
          "value": 576,
          "unit": "INCHES"
        },
        "width": {
          "value": 120,
          "unit": "INCHES"
        },
        "height": {
          "value": 72,
          "unit": "INCHES"
        }
      },
      "weight": {
        "type": "APPROXIMATE",
        "value": 123
      },
      "temperatureRequirements": {
        "minimum": 10,
        "maximum": 20,
        "unit": "CELSIUS"
      },
      "pieces": {
        "type": "PALLET",
        "stackable": true,
        "perPieceVolume": {
          "value": 100,
          "unit": "GALLONS"
        },
        "perPieceDimensions": {
          "length": {
            "value": 576,
            "unit": "INCHES"
          },
          "width": {
            "value": 120,
            "unit": "INCHES"
          },
          "height": {
            "value": 72,
            "unit": "INCHES"
          }
        },
        "count": 10
      }
    }
  ],
  "requiredEquipment": [
    {
      "quantity": 500.5
    }
  ],
  "metadata": {
    "tmsOrderId": "1314234",
    "customerName": "Acme Corp",
    "weight": 4200,
    "expedited": true
  },
  "roundTrip": true,
  "linearFeet": 123,
  "maxBuy": {
    "amount": 500000000
  },
  "targetRate": {
    "amount": 500000000
  },
  "externalOwnerCoverageUserId": "user_12345",
  "externalOwnerCoverageTeamId": "team_67890",
  "assignedCarrier": {
    "carrier": {
      "id": "<string>",
      "displayName": "<string>",
      "dotNumber": "<string>",
      "mcNumber": "<string>",
      "mxNumber": "<string>",
      "rfcNumber": "<string>",
      "cvorNumber": "<string>",
      "nirNumber": "<string>",
      "nscNumber": "<string>",
      "scac": "<string>",
      "contactName": "<string>",
      "contactPhone": "<string>",
      "contactEmail": "<string>",
      "externalId": "<string>"
    },
    "price": {
      "lineItems": [
        {
          "type": "<string>",
          "value": {
            "amount": 500000000
          },
          "externalId": "<string>",
          "externalCode": "<string>",
          "externalDescription": "<string>"
        }
      ]
    }
  }
}

A load in the Cargado system.

externalId

string

required

The unique ID for the load in your TMS. This identifier will not be displayed outside your organization. Examples: "456293", "TMS232423"

Required string length: 1 - 255

Example:

"456293"

externalCustomerId

string

required

The unique ID of your customer in your TMS. This will not be displayed outside your organization. This should not change for the lifetime of the load. Examples: "ACMECORP", "ASHIPPERCO"

Required string length: 1 - 255

Example:

"ACMECORP"

status

enum<string>

required

The status of the load.

Available options:

ON_HOLD,

AVAILABLE,

ASSIGNED,

BOOKED,

CANCELLED,

COMPLETED

trailerRequirements

object

required

The trailer requirements for the load.

Show child attributes

carrierRequirements

object

required

The requirements for the carrier.

Show child attributes

driverRequirements

object

required

The requirements for the driver.

Show child attributes

string

required

The unique id for the load in the Cargado system. This is a UUID prefixed with load_.

Example:

"load_c6ee2dff-f35f-4880-b7a6-9b2a1fa1476e"

stops

object[]

required

The list of stops for the load. The first stop is the origin and the last stop is the destination.

Required array length: 2 - 64 elements

A pickup stop where goods are loaded.

Option 1
Option 2
Option 3

Show child attributes

externalDisplayId

string | null

A customizable display ID for the load. This field allows organizations to configure how their load IDs are displayed in Cargado. If not provided, the externalId will be used as the display ID. Examples: "ORD-2024-001", "SHIP-456293", "LOAD-TMS232423"

Required string length: 1 - 255

Example:

"ORD-2024-001"

externalWorkspaceId

string | null

The ID used to map your freight to team/user workspaces in Cargado. If not provided, the freight will be created in your organization's default workspace.

referenceNumbers

object[] | null

Reference numbers associated with the load.

Show child attributes

commodities

object[]

The commodities for the load. Usually required, but can be omitted for power only loads that are load-out or tow-away.

Maximum array length: 128

Show child attributes

requiredEquipment

object[] | null

A list of standalone equipment required for the load.

Show child attributes

metadata

object | null

Set of key-value pairs (string or number values) attached to the load.

Show child attributes

Example:

{
  "tmsOrderId": "1314234",
  "customerName": "Acme Corp",
  "weight": 4200,
  "expedited": true
}

truckload

enum<string> | null

Whether the load is full truckload or partial truckload.

Available options:

FULL,

PARTIAL

roundTrip

boolean | null

Whether the load is a round trip.

linearFeet

number<double> | null

Linear feet is the amount of floor space cargo occupies in a trailer. This is primarily relevant for partial truckload shipments. If not provided for partial loads, it will be automatically calculated based on commodity dimensions.

maxBuy

object | null

The maximum buy amount for the load. Typically used to inform team members of what rate they can cover the freight at without manager approval. This value is not used directly, but can be referenced when setting up posting rules.

Show child attributes

targetRate

object | null

The target rate for the load. Typically used to inform team members of what rate they should target when covering freight. This value is not used directly, but can be referenced when setting up posting rules.

Show child attributes

externalOwnerCoverageUserId

string | null

The external ID of the user responsible for coverage of this load in your TMS. This should match the externalId set on a user via the user sync endpoint. Used to automatically assign coverage when the load is posted.

Maximum string length: 255

Example:

"user_12345"

externalOwnerCoverageTeamId

string | null

The external ID of the team responsible for coverage of this load in your TMS. This should match the externalId set on a team via the team sync endpoint. Used to automatically assign coverage when the load is posted.

Maximum string length: 255

Example:

"team_67890"

assignedCarrier

object | null

The carrier assigned to this load, including carrier identity and pricing.

Show child attributes

Concepts

Loads

Rates

Border Crossings

Carrier Relationships

Bids

Users

Teams

Webhooks

Webhook Events