Cancels a sale. Requires the salesChannelId and a cancellationReason (from the documented enum). Optional cancellationNotes (max 255 characters) may be provided.

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

Cancels a sale. Requires the salesChannelId and a cancellationReason (from the documented enum). Optional cancellationNotes (max 255 characters) may be provided.

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
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json