Update individual Menu Item unavailabilities

This endpoint allows the caller to change the status of items to either "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.

Examples

In contrast to the PUT endpoint, this endpoint will only update the status of items which are explicitly mentioned in the payload. For example, see this sequence of calls:

1. Set orange_juice unavailable.
2. Set granola unavailable.

After those two calls, both granola and orange_juice will be unavailable.

Unavailable Status

As mentioned above, an item marked with the unavailable status will be marked as "sold out" till the end of day. However, if an individual update is made prior to the site opening, it is assumed all items made unavailable in the previous day be carried over. For example:

1. Yesterday, set orange_juice unavailable.
2. This morning, before site opens, set granola unavailable.

When site opens, both granola and orange_juice will be unavailable.

Rate Limit

This endpoint is rate limited at 1 request per 100ms per site. There is no limit to the number of items that can be updated in a single request.

Not Found

All ids in the request must be valid ids on the requested menu, if any id is not found the entire request will fail (returns 404).

Note

This endpoint works for menus created by Upload Menu API as well as menus created using the Menu Manager.