Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Loads

Update a load

Update load fields.

Note: To manage carriers, use the carrier-specific endpoints.

patch/loads/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Request body

mode'TL' | 'LTL' | 'AIR' | 'OCEAN' | 'RAIL' | 'INTERMODAL' | 'DRAYAGE'

Transportation mode.

  • TL: Full Truckload
  • LTL: Less than Truckload
  • AIR: Air freight
  • OCEAN: Ocean freight
  • RAIL: Rail freight
  • INTERMODAL: Intermodal (multiple modes)
  • DRAYAGE: Drayage/cartage

Response

Load updated successfully

idstring uuid required
keystring nullable

Human-readable load ID

shipmentIdstring uuid

Parent shipment

shipmentKeystring nullable

Parent shipment friendly ID

mode'TL' | 'LTL' | 'AIR' | 'OCEAN' | 'RAIL' | 'INTERMODAL' | 'DRAYAGE'

Transportation mode.

  • TL: Full Truckload
  • LTL: Less than Truckload
  • AIR: Air freight
  • OCEAN: Ocean freight
  • RAIL: Rail freight
  • INTERMODAL: Intermodal (multiple modes)
  • DRAYAGE: Drayage/cartage
status'SOURCING' | 'BOOKED' | 'DISPATCHED' | 'LOADING' | 'PICKED_UP' | 'IN_TRANSIT' | 'UNLOADING' | 'DELIVERED' | 'CANCELED' required

Current status of the load.

Pre-transit:

  • SOURCING: Looking for carrier
  • BOOKED: Carrier booked
  • DISPATCHED: Dispatched to carrier

In-transit:

  • LOADING: Loading at pickup
  • PICKED_UP: Picked up
  • IN_TRANSIT: In transit
  • UNLOADING: Unloading at delivery

Final:

  • DELIVERED: Delivered
  • CANCELED: Canceled
totalCostnumber nullable

Total carrier costs

createdAtstring date-time required
updatedAtstring date-time nullable
pickedUpAtstring date-time nullable
deliveredAtstring date-time nullable

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "LD-12345",
  "stops": [
    {
      "address": {
        "line1": "123 Main St",
        "line2": "Suite 400",
        "city": "Chicago",
        "country": "USA",
        "market": "CHI",
        "latitude": "41.8781",
        "longitude": "-87.6298",
        "isSmartyValidated": true,
        "obeysDst": true
      }
    }
  ],
  "carriers": [
    {
      "carrier": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-CARRIER-SWIFT",
        "name": "Swift Transportation",
        "phoneNumber": "+1-555-987-6543",
        "email": "dispatch@swifttrans.com",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "charges": [
        {
          "chargeCode": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-USER-12345"
          }
        }
      ]
    }
  ]
}