menu published v1

wbhk

menu.published.v1

Emitted when an org publishes a menu (new or updated), making it available to sales channels and integrations.

Payload

Common properties included with menu-related events.

orgId

string

required

^org\d+$

Unique ID of the client's Org that owns this menu (the top-level entity that groups Brands, Properties, and Sales Channels). This ID remains the same for subsequent updates / revisions of the same menu.

brandId

string

Unique ID of the client’s Brand that owns this menu. This ID remains the same for subsequent updates / revisions of the same menu.

propertyId

string

Unique ID of a Property, representing a physical restaurant location under an Org. This ID remains the same for subsequent updates / revisions of the same menu.

salesChannelId

string

Unique ID of a Sales Channel, a digital channel tied to a Property and Brand (e.g., kiosk, web, mobile app). This ID remains the same for subsequent updates / revisions of the same menu.

propertyCountryCode

string

length between 2 and 2

The ISO 3166-1 alpha-2 country code of the property

referencePriceDispatchType

string

enum

Reference Price Dispatch Type. The dispatchType price from the pricing profile to be considered in case sales channel only support one price.

Allowed:

salesChannelType

string

enum

Type of channel where orders are captured

charges

array of objects | null

Breakdown of charges applied to orders on this menu (e.g., service fees, delivery charges, packaging fees). Ensures correct reporting and settlement.

charges

menuId

uuid

required

Unique ID of the Menu being published. Used to fetch menu details and link revisions. This ID remains the same for subsequent updates / revisions of the same menu.

menuRevisionId

number

required

The revision ID of the menu - increments with each update

menuPublishId

uuid

Unique identifier for the menu publish event. A new ID is generated for each publish of a menu.

currency

string | null

enum

The currency of the menu

object | null

The menu payload. Optionally included in the event

priceBandId

uuid

The price band ID selected on Sales channel for referring menu pricing profile

Response

200

Your server must return a 2xx to acknowledge