Cancel a completed order

Cancels the order with an optional reason. Requires a master token and an admin user. Order must be completed.

Authorization

AuthorizationBearer <token>

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

In: header

X-Nimbu-Site<token>

Identifier of the site context when authenticating with a personal access token.

In: header

order_id*string

Order identifier

application/json

Cancel options

TypeScript Definitions

Use the request body type in TypeScript.

cancel_reason?string

Cancellation reason (defaults to customer if invalid)

notify?boolean

Send the cancellation notification (default true)

curl -X POST "https://example.com/orders/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'

{
  "status": "string",
  "state": "string"
}