Skip to main content
POST
cURL recipe

Authorizations

Authorization
string
header
required

Authorization: Bearer

Path Parameters

partner_reference
string
required

The reference you submitted to POST /api/v1/orders, exactly as you sent it. Letters, digits, dot, underscore, hyphen; max 64 characters. A reference outside that shape does not match this route at all and answers 404 route_not_found.

Maximum string length: 64
Pattern: ^[A-Za-z0-9._-]{1,64}$
Example:

"PARTNER-ORDER-100245"

Body

application/json

Optional. Send no body at all if you have nothing to add — an empty request is valid. If you do send one it must be a JSON object.

reason
string | null

Free text recorded against the cancellation; trimmed, whitespace-only stored as null. Max 500 characters (characters, not bytes).

Maximum string length: 500
Example:

"Customer requested cancellation"

Response

The order is cancelled. already_cancelled says whether THIS call did it (false) or found it already done (true) — both are successes.

status
enum<string>
required
Available options:
success
status_code
integer
required
Example:

200

message
string
required
Example:

"OK"

data
object
required

One key named after the resource (products / product / states / categories / attributes / order / validation).

meta
object | null
required
error
object | null
required