Note: this endpoint works for menus created by Upload Menu endpoint as well as menus created using the Menu Manager in Restaurant Hub. If you don't need to support the latter, we recommend you using the v1 endpoint instead.
Once a menu is sent to our platform, all new items in the menu are theoretically "available", therefore a customer can order them. This endpoint allows the caller to set items as "unavailable" or "hidden":
Statuses
unavailable- the item is "greyed out", "striked-through" and marked as "sold out" on our platform. It will be made available during the next morning stock reset.hidden- the item is not visible in the menu for the customers. It will not be affected by the morning stock reset.
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.
Interference with other channels
Remember that unavailabilities can be changed through multiple channels (API, Deliveroo tablet, Restaurant Hub). This means that using Replace All Unavailabilities endpoint without knowing the current state of the stock can reset availability of items that were made unavailable/hidden by other channels. Thus we recommend to either:
- use the Update Individual Item Unavailability (POST) instead
- or GET the unavailabilities first, so that you're fully aware of state of the stock when preparing the PUT request.
Rate Limit
This endpoint is rate limited at 1 request per minute per site.
Item IDs not found
Any item IDs sent in the request that don't exist on the requested menu will be ignored in the update. This won't prevent the request from succeeding.
Changing unavailabilities after menu upload
If you want to set item unavailabilities right after calling Upload Menu request, first wait to receive the Menu Upload Result Webhook. Otherwise the change of unavailabilities may be ineffective for newly created items.