sale status updated v1

wbhk

sale.status.updated.v1

Emitted when any Flipdish sale transitions to a new lifecycle status, regardless of channel (POS, kiosk, web, marketplace, or API). Read the Sale events guide to understand how sale.status.updated.v1 differs from other sale events. Beta feature: this event is in closed beta — request access by emailing [email protected].

Payload

orgId

string

required

^org\d+$

Org ID in standard format

brandId

string

required

length ≥ 1

Brand ID string. Most brands use the format br (e.g. br123). Legacy brands may use the fd format (e.g. fd123) or a plain alphanumeric slug (e.g. mexicancafe). No format is enforced — any non-empty string is accepted.

propertyId

string

required

^p\d+$

Property ID in standard format

salesChannelId

string

required

length ≥ 1

Sales channel ID string. Most sales channels use the format sc (e.g. sc123). Legacy sales channels may be a plain integer without the sc prefix (e.g. 123). No format is enforced — any non-empty string is accepted.

salesChannelType

string

enum

required

Identifies the platform that originated the sale (e.g. UberEats, FlipdishKIOSK, POS).

saleId

string

required

Flipdish sale identifier (Crockford base32 encoding of a global counter, e.g. 3N356).

externalId

string

Partner/platform's own identifier for the sale, when supplied (e.g. an UberEats order ID).

status

string

enum

required

The sale was cancelled.

Allowed:

cancellationReason

string

enum

required

Reason the sale was cancelled.

Allowed:

cancellationNotes

string

Optional free-text notes accompanying the cancellation.

cancelledBy

string

required

Identifier of the actor (user, system, or partner) that cancelled the sale.

Response

200

Your server must return a 2xx to acknowledge