Sign in
latestOpenAPI 3.1.0Proprietary2026-08-21180410901.1 KB

7af4e91459ca

Loads

Get load carrier

Retrieve a specific carrier assignment for a load.

get/loads/{loadId}/carriers/{carrierId}

Path parameters

loadIdstring required

Load ID

carrierIdstring required

LoadCarrier ID

Response

Load carrier retrieved

idstring uuid
status'ACTIVE' | 'TONU' | 'BOUNCED'

Status of the carrier assignment.

  • ACTIVE: Carrier is actively assigned
  • TONU: Truck Ordered Not Used (carrier dispatched but cancelled)
  • BOUNCED: Carrier bounced/rejected load
billingStatus'AWAITING_INVOICE' | 'INVOICE_IN_REVIEW' | 'APPROVED_TO_PAY' | 'PAID'

Billing status for the load (AP side).

  • AWAITING_INVOICE: Waiting for carrier invoice
  • INVOICE_IN_REVIEW: Invoice received, under review
  • APPROVED_TO_PAY: Approved for payment
  • PAID: Paid to carrier
bookedAtstring date-time nullable
dispatchedAtstring date-time nullable
removedAtstring date-time nullable

When this assignment was removed from the load (bounce, TONU, rebook). Removed assignments stay in carriers as history but their charges are excluded from the load totalCost.

totalCostnumber nullable

Sum of all charges

driverNamestring nullable
driverPhonestring nullable
truckNumberstring nullable
trailerNumberstring nullable
createdAtstring date-time
updatedAtstring date-time nullable

Example response

{
  "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"
  }
}