Skip to navigation
EndpointsAPI

Batch create carrier lane preferences

Batch create or update carrier lane preferences (e.g. CSV upload). Accepts API-key or session/bearer auth so both integrations and the web app can call it. Returns per-batch created/updated/failed counts + row errors.

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
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.
carrier_lane_preferenceslist of objectsRequired

Lane preferences (max 1000)

Response

Successful Response
successboolean
total_recordsinteger
successfulinteger
failedinteger
createdintegerOptionalDefaults to 0
updatedintegerOptionalDefaults to 0
errorslist of maps from strings to anyOptional

Errors

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