Batch Loads

POST /v2/tms-api/batch/loads

Create, update, or upsert multiple loads in a single request.

Historical Loads for Recommendations

Include historical DELIVERED loads with carriers to build lane history for recommendations. Active loads on the same lane will then show carrier recommendations.

Operation enum (authoritative)

operation is validated as a BatchOperation enum in the request schema, and supports:

• create
• update
• upsert
• delete

For delete, omit the load object.

API Reference

Request Body

itemsarrayrequired

Array of load items. Each item must have: - `operation`: `create`, `update`, `upsert`, or `delete` - `external_reference_id`: Load external reference ID - `load`: Load data object

Request Example

curl -X POST "https://api.mentium.io/v2/tms-api/batch/loads" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "operation": "create",
        "external_reference_id": "LOAD-001",
        "load": {
          "external_reference_id": "LOAD-001",
          "status": "ACTIVE",
          "equipment_type": "DRY_VAN",
          "transport_mode": "FTL",
          "customer_external_reference_id": "CUST-ACME-001",
          "stops": [
            {
              "stop_number": 1,
              "stop_type": "Pickup",
              "location_external_reference_id": "LOC-CHICAGO-001",
              "early_arrival": "2026-02-01T08:00:00Z",
              "late_arrival": "2026-02-01T16:00:00Z"
            },
            {
              "stop_number": 2,
              "stop_type": "Delivery",
              "location_external_reference_id": "LOC-DETROIT-001",
              "early_arrival": "2026-02-02T08:00:00Z",
              "late_arrival": "2026-02-02T16:00:00Z"
            }
          ]
        }
      }
    ]
  }'

Response

{
  "success_count": 1,
  "error_count": 0,
  "results": [
    {
      "external_reference_id": "LOAD-001",
      "operation": "create",
      "success": true,
      "id": "load_abc123"
    }
  ]
}

Limits

Limit	Value
Maximum items per batch	100
Request timeout	60 seconds