Get Load

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

Retrieve details for a specific load using its external reference ID.

API Reference

Path Parameters

external_reference_idstringrequired

The load's external reference ID (from your system)

Request Example

curl -X GET "https://api.mentium.io/v2/tms-api/loads/LOAD-001" \
  -H "X-API-Key: your_api_key_here"

Response

200 OK

{
  "id": "load_abc123",
  "external_reference_id": "LOAD-001",
  "status": "ACTIVE",
  "equipment_type": "DRY_VAN",
  "transport_mode": "FTL",
  "description": "Electronics shipment",
  "customer_id": "cust_xyz789",
  "customer_external_reference_id": "CUST-ACME-001",
  "customer_name": "Acme Corporation",
  "total_distance": 285,
  "max_buy_rate": 2200,
  "stops": [
    {
      "id": "stop_001",
      "stop_number": 1,
      "stop_type": "Pickup",
      "location_external_reference_id": "LOC-CHICAGO-001",
      "location_name": "Chicago Distribution Center",
      "early_arrival": "2026-02-01T08:00:00Z",
      "late_arrival": "2026-02-01T16:00:00Z"
    },
    {
      "id": "stop_002",
      "stop_number": 2,
      "stop_type": "Delivery",
      "location_external_reference_id": "LOC-DETROIT-001",
      "location_name": "Detroit Receiving Facility",
      "early_arrival": "2026-02-02T08:00:00Z",
      "late_arrival": "2026-02-02T16:00:00Z"
    }
  ],
  "created_at": "2026-01-29T10:30:00Z",
  "updated_at": "2026-01-29T14:20:00Z"
}

404 Not Found

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