Shipments
To fulfill an order, the partner must create one or more shipments, each linked to specific order lines.
Shipments are initially created in the packed state. Further updates to a shipment's status are made using the Update Shipment endpoint.
Shipment Lifecycle
There are two possible shipment workflows:
- Standard delivery flow: shipment moves through the following states: packed → shipped → delivered
- Canceled before shipment: shipment is canceled before it leaves the warehouse: packed → canceled
Cancellation Restriction
A shipment which has already transitioned to the shipped state cannot be canceled anymore.
Shipment State Timestamps
Every shipment state must include the actual timestamp when the event occurred:
| Shipment state | Required field |
|---|---|
| packed | packed_at |
| shipped | shipped_at |
| delivered | delivered_at |
| canceled | canceled_at |
Tracking Information
While optional at the time of shipment creation, the following fields must be provided when updating a shipment to the shipped state:
carrier: must be a valid carrier name, such asUSPS,UPS,FedEx, etc.tracking_number: must be unique in the systemtracking_url: should also include thetracking_number
Tracking Update Window
Tracking information can be updated via the API only during the packed → shipped transition.