/shipments

Create shipments and optionally a tour. When a property definition with an external validator applies to shipments or loads, the request is limited to 40 shipments and behaves per row unless a tour is requested: each shipment is validated and created independently, rejected rows are reported in the response's failed list with their zero-based request index, and all other rows are created (partial success). With a tour creation strategy the request stays one all-or-nothing booking. Without an external validator the request is unchanged: all-or-nothing, no row limit. Set matchShipperAddresses to true to match each stop against the assigned shipper's saved address book. Saved-address references sent on a stop (shipperAddressId, shipperAddressContactId, shipperAddressLoadingPoint) are always checked against the assigned shipper: with matchShipperAddresses true a reference that does not belong to that shipper is rejected with 400, otherwise it is removed and the shipment is created without it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

request to create shipments and optionally a tour

shipments
array of objects
required
shipments*
string
enum

Selects the naive tour builder, which orders stops in the order the shipments are given. This is the default when omitted.

Allowed:
tourDetails
object
string

Internal Shipper id (UUID) to assign all created shipments to. On its own this is a complete assignment; shipperTeamId and shipperUserId only narrow it. When omitted, a uniform per-shipment shipperId supplies the assignment instead.

string

Internal ShipperTeam id (UUID) narrowing the assignment to a team within the assigned shipper. Requires shipperId (400 without it); the per-shipment copies must match it.

string

Internal ShipperUser id (UUID) narrowing the assignment to a single user within the assigned shipper. Requires shipperId (400 without it); the per-shipment copies must match it.

boolean

When true, each stop address is matched against the assigned shipper's saved address book: a match overwrites the address fields with the saved values and fills in shipperAddressId, opening hours, properties and a matching contact, while an unmatched stop is stored as sent. Defaults to false and requires an assigned shipper: the request-level shipperId, or the same shipperId on every shipment. shipperTeamId and shipperUserId narrow that assignment but do not affect matching, which always runs against the shipper's whole address book. A stop already carrying a valid shipperAddressId is left as sent. Saved-address references are always validated: with this flag an unknown reference is rejected with status 400, without it the reference is removed and the shipment is still created (see the endpoint description for details).

Responses

400

bad request

401

unauthorized

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json