Skip to main content

Bulk create or update shipments

POST 
/v2/orders/shipments/bulk

Creates or updates multiple shipments in a single operation. Existing shipments are updated, new ones are created based on provided data.

Shipments are matched to existing ones in two ways:

  • By id: when a shipment in the payload carries an id, that shipment is updated. An explicit id always takes precedence over source matching.
  • By sources: when a shipment has no id but carries source pairs (name + id), and an existing shipment of the tenant already contains one of those pairs, the existing shipment is updated instead of creating a duplicate.

For shipments matched by sources, items are matched to existing items by orderItemId and track and traces by code, so re-sending the same payload is idempotent.

On update, source pairs are merged by name with the existing sources instead of replacing them. Source pairs are unique per tenant: a payload where two shipments carry the same source pair is rejected.

Request​

Responses​

Bulk shipment operation completed successfully