Skip to navigation
EndpointsAPI

Do Not Use a carrier for a shipper

Block this carrier for one customer’s freight, on every lane — the case a lane block cannot express, since a shipper’s freight moves on lanes created after the block was set. Matched on a normalized form of customer_name, so a block set from ‘ACME Corp’ also catches ‘ACME Corp.’. Re-sending edits the existing block’s reason rather than creating a second one. Requires dnu_reason. Admin-only.

Authentication: Bearer token required.

Authentication

AuthorizationBearer

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

Path parameters

carrier_idstringRequiredformat: "uuid"

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.
reasonenumRequired

Constrained reason code; see AuditLogReason for the value set.

customer_namestringRequired1-255 characters

Shipper/customer name as it appears on the load

dnu_reasonstringRequired1-500 characters
Why this carrier must never be booked for this shipper.
reason_notestring or nullOptional<=2000 characters

Response

Successful Response
idstringformat: "uuid"
carrier_idstringformat: "uuid"
shipper_labelstring
dnu_reasonstring or nullOptional
dnu_set_atdatetime or nullOptional
dnu_set_by_idstring or nullOptionalformat: "uuid"

Errors

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