Sales Management

Cancel a sale

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.

post/salesManagement/orgs/{orgId}/sales/{saleId}/cancel

Request

  • Base URL: https://api.flipdish.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.flipdish.co/salesManagement/orgs/{orgId}/sales/{saleId}/cancel
  • Auth: HTTP bearer

Path parameters

orgIdstring required

Organization ID in standard format

Example:org123
saleIdstring required

Sale ID - a unique identifier for the sale

Example:AF34FV

Request body

salesChannelIdstring required

Sales Channel ID in standard format

cancellationReason'Cancelled by customer' | 'Cancelled by restaurant' | 'Cancelled by marketplace' | 'Cancelled by integration partner' | 'Cancelled by system' | 'Other' required

Sale cancellation reason

cancellationNotesstring

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

Example request

{
  "salesChannelId": "sc123",
  "cancellationReason": "Cancelled by customer",
  "cancellationNotes": "Customer requested cancellation via phone"
}

Response

Sale cancelled successfully

Changes

No recorded changes to this operation across all 1 revision of this API.