Cancel a purchase order nothing was received against

A sent purchase order releases its incoming stock reservations and its vendor contacts are emailed unless notifyVendor is false. A draft is cancelled without an email; one that was sent before can only be cancelled (it is never deleted), and whatever incoming stock it still holds from that time is released. A cancelled purchase order owes nothing: payableTotal is 0, it has no balance due date, and its balance due is 0 minus what was paid, so money that was paid shows as a balance below zero until its refund is recorded. Once units were received the purchase order is closed short instead (409 here).

Scope: outgoing-purchase-orders:write, channel:write or admin. A permission group made before the Channel API scopes existed grants it as inventory:manage or supply-chain: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 64

The purchase order's uuid or 24-hex id.

Body Params
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