Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2478177179.1 KB
Menu API Grubtech Endpoints

Update Availability

The Update Availability endpoint is designed to modify the availability status of a specific menu item within a menu associated with a particular store. This functionality is useful for managing the real-time availability of menu items, allowing stores to mark items as available or unavailable based on stock levels, operational changes, or other conditions.

put/menus/{menuId}/items/{itemId}/availability

Path parameters

menuIdstring required

Menu id

itemIdstring required

Item id

Request body

idstring required

Unique id for the item.

skustring

Stock keeping unit ID for the menu item, provided by GrubTech.

quantityinteger required

Available quantity for selling for a specific item

availability'AVAILABLE' | 'UNAVAILABLE' | 'HIDDEN' required

Availability types for an item. The external system should make an item unavailable or available on the platform based on this attribute and not based on the available quantity defined in the payload.

Example request

{
  "id": "601e50ce9509110c35650e01",
  "sku": "FG-00923",
  "quantity": 100,
  "availability": "AVAILABLE"
}

Response

Successful response OK