Cancel a completed order
POST
/orders/{order_id}/cancel
Cancels the order with an optional reason. Requires a master token and an admin user. Order must be completed.
Authorizations
bearerToken|siteContext +
bearerToken
Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.
TypeHTTP (bearer)
siteContext
Identifier of the site context when authenticating with a personal access token.
TypeAPI Key (header: X-Nimbu-Site)
or
siteToken
Site-scoped API token that already encodes the site context.
TypeHTTP (bearer)
Request Body
application/json
JSON
{
"cancel_reason": "string",
"notify": true
}
Responses
order canceled
application/json
JSON
{
"status": "string",
"state": "string"
}