Line status derived from the quantities
2026-11-14 · Breaking change · Upcoming: not yet in production
lineStatus of GET /api/v1/orders/{id} and of the line POST /api/v1/orders/{id}/lines
returns has seven fixed values instead of free strings: Open, PartiallyShipped, Shipped,
Delivered, PartiallyReturned, Returned and Cancelled, never null.
What changed
- It is derived from the line's quantities:
Cancelledwhen all ordered is cancelled; otherwise the first that holds:Returnedwhen returned equals shipped and is above 0,PartiallyReturnedwhen returned is above 0,DeliveredorShippedwhen delivered or shipped equals ordered minus cancelled,PartiallyShippedwhen shipped is above 0, elseOpen. Invoiced never affects it. - Every existing line got the status its quantities give, and its old value is kept in the order
timeline as
order.line_status_migratedwithorderLineId,previousLineStatusandlineStatus. - Added with this change, not breaking:
quantities.remaining(ordered minus cancelled minus shipped, never below 0), andorders.line_quantities_changed.v1in the order timeline for every change of a line's quantities. It is not a webhook.
Affected operations
GET /api/v1/orders/{id}POST /api/v1/orders/{id}/linesGET /api/v1/orders/{id}/timeline
What you do
- Read the seven values, and stop reading
Activeor your own values.
How breaking changes are announced and how long a deprecated endpoint stays: see the versioning policy.