POST

Cancel an order

https://api.kustom.co/ordermanagement/v1/orders/{order_id}/cancel

Cancel order. Read more on Cancelling an order

Parameters2 fields

order_idstring · uuidrequiredin path
Order id
Klarna-Idempotency-Keystringoptionalin header
This header will guarantee the idempotency of the operation. The key should be unique and is recommended to be a UUID version 4. Retries of requests are safe to be applied in case of errors such as network errors, socket errors and timeouts. Input values of the operation are disregarded when evaluating the idempotency of the operation, only the key matters.

204

Response0 fields

Order was cancelled.

No response body — this status returns headers only.

403

Response3 fields

Cancel not allowed (e.g. order has captures or is closed)

404

Response3 fields

Not Found

409

Response0 fields

Conflict

No response body — this status returns headers only.

Code	Status	What it means	Retry
`CANCEL_NOT_ALLOWED`	403	The order has captures, so it can only be refunded. Needs `AUTHORIZED`.	Never retry
`NO_SUCH_ORDER`	404	The order_id does not exist, or belongs to the other environment.	Never retry

POST https://api.kustom.co/ordermanagement/v1/orders/{order_id}/cancel

Response 204· Order was cancelled.

No response body.

This status returns headers only — there is nothing to parse.

—

Response 403· Cancel not allowed (e.g. order has captures or is closed)

{
  "correlation_id": "66782175-ae05-44fc-9eb3-eeceadbad271",
  "error_code": "CANCEL_NOT_ALLOWED",
  "error_messages": [
    "<string>"
  ]
}

7 lines

Response 404· Not Found

{
  "correlation_id": "<string>",
  "error_code": "INTERNAL_ERROR",
  "error_messages": [
    "<string>"
  ]
}

7 lines

Response 409· Conflict

"<string>"

1 lines

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.