Update Load

PUT /v2/tms-api/loads/{external_reference_id}

Update an existing load by its external reference ID.

API Reference

Path Parameters

external_reference_idstringrequired

The load's external reference ID

Request Body

All fields are optional. Only provided fields will be updated.

statusstring

Load status (**LoadStatus** enum — see “Allowed enum values” below)

equipment_typestring

Equipment type (**EquipmentType** enum — see “Allowed enum values” below)

transport_modestring

Shipping method (**ShippingMethod** enum — `FTL`, `PTL`, `LTL`)

stopsarray

Updated stops. If provided, you should include the full desired stops array. `stop_type` is **StopType**.

financial_ratesarray

Updated financial rates. `rate_entity` is **RateEntity** (`CUSTOMER` or `CARRIER`).

Allowed enum values

LoadStatus (status)

• ACTIVE
• TENDERED
• TENDER_ACCEPTED
• SPOT
• COVERED
• DISPATCHED
• AT_SHIPPER
• EN_ROUTE
• AT_RECEIVER
• DELIVERED
• PAYMENT_PROCESSING
• ACCOUNTING_REVIEW
• COMPLETED
• CANCELLED
• TENDER_REJECTED
• INACTIVE
• ON_HOLD

EquipmentType (equipment_type)

• DRY_VAN
• REEFER
• FLATBED
• FLATBED_CONESTOGA
• STEPDECK
• STEPDECK_CONESTOGA
• LOWBOY
• REMOVABLE_GOOSENECK
• TANKER
• INTERMODAL
• STRAIGHT
• SPRINTER
• HOTSHOT
• POWER_ONLY
• BULK_DRY_HOPPER
• BULK_DRY_PNEUMATIC
• BULK_DRY_DUMP

ShippingMethod (transport_mode)

• FTL (Full Truckload)
• PTL (Partial Truckload)
• LTL (Less Than Truckload)

StopType (stops[].stop_type)

• PICKUP
• DELIVERY
• BOTH

RateEntity (financial_rates[].rate_entity)

• CUSTOMER
• CARRIER

Request Example

curl -X PUT "https://api.mentium.io/v2/tms-api/loads/LOAD-001" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "COVERED",
    "carrier_external_reference_id": "CARRIER-MIDWEST-001"
  }'

Response

200 OK

Returns the updated load object.

404 Not Found

{
  "detail": "Load with external_reference_id 'LOAD-001' not found"
}