Skip to main content
PATCH
Advance a shipment one step along the delivery path. You cannot skip statuses, go backwards, or set cancelled here — use cancel for that.

Allowed transitions

string
required
Shipment reference, for example SHP-12345.
string
required
The next delivery status. Must be the single allowed next value for the shipment’s current status.
Returns 200 with the shipment wrapped in data. A shipment that belongs to another workspace returns 404. An invalid jump (for example pending to delivered) returns 422:
Payment status is separate. Marking a shipment awaiting_pickup through this endpoint does not collect payment. Use it when your own process (or a rider) needs to move delivery state.