cancel sales order
Cancels an order Tightly owns and releases every unit it was holding, so the stock is sellable again in the same request. A reason is optional and is kept on the document.
Allowed from draft, open and allocated, and from fulfilment_requested only while the warehouse request is still queued or has failed, or once the warehouse confirms the cancel.
An order that came from a connected channel is cancelled in the channel, not here; an order a warehouse already holds is refused until the warehouse answers.
Scope: orders:write, which includes orders:read.
Request
- Base URL: https://api.app.tightly.io
- URL: https://api.app.tightly.io/api/v1/sales/orders/{order_id}/cancel
- Auth: HTTP bearer
Path parameters
The order's id.
Headers
The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.
A string of your own, up to 255 characters, that makes this write safe to retry. Send the same key twice and the second request is answered with the first one's status and body instead of writing again, so a client that retried after a timeout ends holding the record's id rather than creating a second one. Reusing a key with a different body, or while the first request is still running, is refused 409. A write that failed releases its key. Keys answer for 24 hours and belong to the API key that used them. A key longer than 255 characters is ignored and the write goes ahead without the guarantee.
Request body
Response
The order, cancelled.
Changes
No recorded changes to this operation across all 1 revision of this API.