v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Loads

Bounce carrier

Mark carrier as bounced (rejected load without payment).

What happens

  • LoadCarrier status changes to BOUNCED
  • Carrier is removed from active execution
  • No payment is recorded

When to use

Use bounce when carrier rejects the load before dispatch, or fails to show up without prior notice.

For carriers who were dispatched but cancelled, use TONU instead.

post/loads/{loadId}/carriers/{carrierId}/bounce

Path parameters

loadIdstring required
carrierIdstring required

Request body

reason'TONU' | 'BOUNCED' | 'RATE_DISPUTE' | 'EQUIPMENT_ISSUE' | 'DRIVER_ISSUE' | 'TIMING_ISSUE' | 'OTHER'

Reason for removing a carrier from a load

reasonTextstring

Additional reason details

Response

Carrier bounced successfully

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
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"
  },
  "charges": [
    {
      "chargeCode": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345"
      }
    }
  ]
}