Changelog

Every change to the public API surface, newest first.

October 2026: returns#

• New Returns endpoints: GET /v1/returns (filter by status, retailer_id, reason, from, to, q), GET /v1/returns/summary, GET /v1/returns/pieces (returned stock, or view=repairs), GET /v1/returns/{id} and PATCH /v1/returns/pieces/{id} for the condition, repairs and the outcome.
• Returns now have pieces. status is outstanding, received or resolved; the old awaiting_inspection, restocked and written_off are still accepted as filters and by PATCH /v1/returns/{id}, which now answers with status: resolved.
• POST /v1/returns takes barcodes (several pieces) and a condition; barcode and description still work.
• POST /v1/scan on a stock station receives returned pieces: new outcomes return_condition_required, return_received and bad_condition, and new fields return_condition, return_note and unexpected_return. See Scanning.
• New webhooks: return.requested, return.received and return.resolved.

v1 launch#

The API, at /v1: orders, labels, production lists, stock and racks, loads, scanning from your own hardware with station tokens, and signed webhooks for every state change. This reference replaces the previous interactive explorer at /docs, which now redirects here.