...
This endpoint is used when the vendor needs the menu content for populating various touchpoints. Some examples of these touchpoints are the aggregator platforms and Kiosk(e.g. Uber Eats) or kiosks.
The menu response after calling this endpoint has a flat JSON, that which means it doesn't have nested structures. All fields are root level properties, so you can refer to them simply by ID. The below example is a walk-through from menu to modifier.
Tenders example | Type | ID | Name |
|---|---|---|---|
Menu | Group | menu_1 | Menu |
Section | Group | 4763b543-2d04-40a6-8b95-d55750ec554a | Tenders |
Picker | Group | xdgrygmaqSf78Pjdh6UrTF | 3Pc Tenders Meal |
picker_pickerAspect | Group | xdgrygmaqSf78Pjdh6UrTF-76b9c2d3-536e-46bb-a060-f805a63b0063 | Choose a Size |
picker_pickerAspectOption | Group | xdgrygmaqSf78Pjdh6UrTF-medium | Large Combo |
picker_pickerAspect_pickerAspectOption_pickerAspect | Group | xdgrygmaqSf78Pjdh6UrTF-76b9c2d3-536e-46bb-a060-f805a63b0063-medium-b376ee07-5ba9-464d-a3b0-e79ad3643e2a | Choice of Tenders Preparation |
picker_pickerAspectOption_pickerAspectOption2 | Group | xdgrygmaqSf78Pjdh6UrTF-medium-spicy | Spicy |
combo | Combo | 00cc6fc6-5ce7-4361-aa95-9d6d726b5bbd | 3Pc Tenders Medium Combo - Spicy |
comboSlot | Group | group_item_40961 | Main Item |
comboSlotOption | Group | option_group_item_40961 | N/A |
item | Item | item_40961 | 3Pc Tenders - Spicy |
modifierGroup | Group | ModifierGroup_60 | Sauces - 1 Included |
modifier | Modifier | modifierMultiplier_1-00-163758 |
...
Menu Content Updated events are dispatched when there are changes to content in the CMS Content Management System (Sanity). This webhook provides information with what ids were created, updated or deleted considering the menu entries, configOffersEntries, systemWideOffersEntries and rewardEntries.
...
| Info |
|---|
Since the content is not store nor serviceMode service mode specific, the storeId/serviceMode store id or service mode aren’t present in the payload. |
...
To ensure guests are seeing the correct pricing and availability, the POS must send us the PLU-price key/value pair, indicating whether indicate whether each PLU is available or not for the specific each store and service mode (delivery or pickup). If the PLU is available, the POS must provide a price for it.
Receiving data for each service mode is needed even for POS where availability of menu items are not managed differently for service modes on restaurant-levelin all cases, even if the POS does not manage delivery and pickup availability separately.
| Info |
|---|
Note that the in-restaurant menu uses the same PLUs as what’s being referred to as Pick-Up menu in the API documentation. Pick-up Service Mode Group is the same as In-restaurant. |
...
This endpoint retrieves price & availability for all entries in the store's menu by PLU, as well as additional version metadata referring to the latest version of the menu.
The plus attribute within query parameter in the endpoint allows users you to specify a list of plus (array of stringsPLUs (e.g. plus=1000&plus=1001) to filter the results in case the whole store menu is not needed.
Additionally, the endpoint includes the path parametersThis endpoint requires these parameters to return a response: storeId, serviceMode and channel.
GET Store Menu Diff Endpoint
For a given store, serviceMode and channel combination, this endpoint provides a history of versions starting from the provided version number. This history contains key/value pairs where the keys refer to a given version and the value contains one object with the created, updated and deleted information for the given version.
This endpoint is usually used in conjuction with the https://rbictg.atlassian.net/wiki/spaces/RDP/pages/5285970207/Menu+Management+-+API+Actions#Store-Menu-Version-Webhook .
...
This endpoint allows updating multiple PLU pricing & availability values for multiple stores for a given serviceModeservice mode. In the request body, the partner can specify plus, region, channel, serviceMode and storeIds. storeIds supports an array of strings, whereas plusis an array of objects supporting specifying mainly the values of availability, price and PLU. For details, refer to the partners API documentation.
Store Menu Version Webhook
...
This webhook is a more generic webhook similar to the https://rbictg.atlassian.net/wiki/spaces/RDP/pages/5285970207/Menu+Management+-+API+Actions#Store-Menu-Version-Webhook .
It is being published upon menu pricing & availability changes, however it doesn’t specify which data points have specifically changed. Therefore, upon receiving this webhook update, vendors usually do a full sync of the menu to fetch the most up-to-date version of the menu,
...