Cancel a sale

⚠️ Beta Notice: This endpoint is currently in beta and may change or be deprecated at any time without notice.

Marks an existing sale as cancelled on the specified sales channel. Use this endpoint when a customer cancels their order, the store is unable to fulfil it, or the sale was created in error. Supply a cancellationReason from the documented enum and, optionally, a free-text cancellationNotes value (max 255 characters) to record additional context for reporting and audit. Cancellation is final: a cancelled sale cannot be reactivated, so submit a new sale if the customer reorders.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Organization ID in standard format

string
required
length ≥ 1

Sale ID - a unique identifier for the sale

Body Params
string
required

Sales Channel ID in standard format

string
enum
required

Sale cancellation reason

Allowed:
string
length ≤ 255

Optional free-text notes about the cancellation (max 255 characters)

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json