Skip to navigation
EndpointsLoads

Batch create loads

Create multiple freight loads in a single request. Each load is processed independently. Accepts API-key or session/bearer auth so both integrations and the web app (CSV upload) can call it.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Organization-IDstring or nullOptional
X-CSV-Import-IDstring or nullOptional

Browser-generated UUID correlating every chunk of one CSV import attempt

X-CSV-Chunk-Indexstring or nullOptional

1-based position of this chunk within the import

X-CSV-Chunk-Countstring or nullOptional
Total number of chunks in the import
Idempotency-KeystringOptional<=255 characters

A unique key (up to 255 printable ASCII characters, e.g. a UUID) that makes a retry of this request safe. Envoy stores the response for 24 hours; a retry with the same key and the same request returns it again with Idempotent-Replayed: true instead of running twice. The same key with a different request returns 422 idempotency_key_reused; while the first request is still running, 409 idempotency_key_in_progress. 5xx and 429 responses are not stored.

Request

This endpoint expects an object.
loadslist of objectsRequired

List of TMS loads to ingest (max 1000 per batch)

generate_demo_carriersbooleanOptionalDefaults to false

Generate deterministic carrier and lane-preference demo data for successfully ingested loads

Response

Successful Response
successboolean
True if at least one load was processed successfully
total_loadsinteger
Total number of loads in the batch
successfulinteger
Number of loads processed successfully
failedinteger
Number of loads that failed to process
createdinteger
Number of new loads created
updatedinteger
Number of existing loads updated
resultslist of objects
Detailed results for each load
processed_atdatetime
Timestamp when batch was processed
generationobjectOptional

Carrier and lane-preference generation results

backend_duration_msdouble or nullOptional>=0
Server processing time for this CSV import chunk, when correlation headers are supplied
datalist of objectsOptional
One result per submitted load, in request order
summaryobject or nullOptional
Counts by outcome, with skipped rows separate

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error