After a menu is uploaded, all items are "available" by default and can be ordered by a customer. This endpoint allows the caller to set items as "unavailable", "hidden", or "available".
Statuses
unavailable: The item will be "greyed out", "striked-through" and marked as "sold out" on our platform until the end of the current day.
hidden: The item will not be visible on the menu. The item will remain hidden from the menu until a subsequent update removes its hidden status.
available: The item will be visible and available for customer selection. This is the default status. Available items will not be included in the Get Menu Item unavailabilities response.
The call acts as a complete override of all the item unavailabilities for the given menu/site; as a corollary, sending an empty array will make everything available again.
Examples
See the following sequence of calls:
- Set
orange_juiceandgranolaunavailable. - Set
orange_juiceunavailable.
After those calls, only orange_juice will remain unavailable. granola will be available.
Rate Limit
This endpoint is rate limited at 1 request per minute per site.
Not Found
Any ids sent in the request that don't exist on the requested menu will be ignored from the update.
Note
This endpoint works for menus created by Upload Menu API as well as menus created using the Menu Manager.