Delete an order and everything that belongs to it (amendment 23)

Refused (409 state_conflict) when shipments or captured payments exist, or a purchase order was accepted into it: cancel it instead. Otherwise one unit removes its fulfillment orders (open reservations released), its invoices and payments, then the order; nothing is orphaned. Answers the order as it was.

Scope: orders:write, channel:write or admin. A permission group made before the Channel API scopes existed grants it as orders:manage.

Idempotency: send Idempotency-Key; a retry with the same key replays the first answer.

Rate limit: write class, 1,200 requests per minute per tenant by default (read class 6,000). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Path Params
string
required
length between 1 and 300

The uuid, a legacy 24-hex id, or ext:: (URL-encoded).

Headers
string
length between 7 and 50

Any string of 7 to 50 characters that identifies this request (an order number, a webhook id). A retry with the same key and the same body answers the first result with Idempotent-Replayed: true; the same key with a different body is 422 idempotency_key_reused; a concurrent request with the same key is 409 in_progress with Retry-After. Recommended on every write.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json