menu item snoozed v1

wbhk

menu.item.snoozed.v1

Emitted when a menu item is snoozed

Payload

orgId

string

required

Unique ID of the client's Org (the top-level entity that groups Brands, Properties, and Sales Channels).

brandId

string

required

length ≥ 1

Unique ID of the client's Brand.

propertyId

string

required

Unique ID of a Property, representing a physical restaurant location under an Org.

salesChannelId

string

required

length ≥ 1

Unique ID of a Sales Channel, a digital channel tied to a Property and Brand (e.g., kiosk, web, mobile app).

salesChannelType

string

enum

required

Type of sales channel

menuId

uuid

required

Unique ID of the Menu on which the menu item is snoozed or un-snoozed.

menuRevisionId

number

required

The revision ID of the menu on which the menu item is snoozed or un-snoozed - increments with each update

menuItemType

string

enum

required

Type of menu item that is snoozed or un-snoozed

Allowed:

menuItemId

string

required

Unique ID of the menu item that is snoozed or un-snoozed

expiry

date-time | null

required

The expiry datetime of the snooze in ISO-8601 UTC format. Null if the snooze is indefinite.

Response

200

Your server must return a 2xx to acknowledge

Loading…