Update shipment
Endpoint: PUT /v10/shipments/{shipmentId}
Prioritize a shipment, mark it to be held, or lock, delay or reopen it, for example when a customer asks for their order to be rushed or held back. Get the shipmentId from Get order fulfillment status or Get shipments.
Only priority, hold, status and delayed_date can be changed. At least one of them must be given.
| Parameter | Required | Default | Description |
|---|---|---|---|
shipment.priority | true to prioritize the shipment in the warehouse | ||
shipment.hold | true to mark the shipment as on hold after packing, false to remove the mark | ||
shipment.status | Possible values: open, locked, delayed. See shipment statuses | ||
shipment.delayed_date | The date (YYYY-MM-DD) a delayed shipment opens for picking. Required to delay a shipment, unless the shipment already has a date |
Changing the status
lockedstops the shipment from being picked until it is set toopenagain.delayedstops the shipment from being picked untildelayed_date. On that date the shipment changes toopen.openreleases a locked, delayed or claimed shipment for picking. If the shipment was locked and a 3PL is set up, it is pushed to the 3PL.
A completed, cancelled or already picked shipment cannot change status. A shipment that has already been sent to a 3PL cannot be locked or delayed.
| Error code | Description |
|---|---|
630001 | The shipment has been sent to a 3PL and cannot be locked |
630002 | The shipment has been sent to a 3PL and cannot be delayed |
630003 | The shipment cannot be delayed without a delayed_date |
Data of response
| Parameter | Required | Default | Description |
|---|---|---|---|
shipment.* | Yes | A shipment object |
Request examples
PUT /v10/shipments/55
{
"shipment": {
"priority": true
}
}
PUT /v10/shipments/55
{
"shipment": {
"status": "delayed",
"delayed_date": "2026-11-20"
}
}