Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2478177179.1 KB
Menu API Order Platform Webhooks

Update Availability

The Update Availability endpoint allows restaurants to manage the availability status of individual items in their store's menu on the ordering platform. This API, utilized by gOnline, enables restaurants to mark an item as out of stock, indicating that it is currently unavailable for ordering, hide an item from the menu, making it invisible to customers or make an item available for ordering again, ensuring it can be selected by customers. By using this endpoint, restaurants can efficiently update their inventory in real-time, ensuring an accurate reflection of their offerings to customers.

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

Path parameters

menuIdstring required

The id of the menu that this item was uploaded to the ordering platform.

itemIdstring required

The id of the menu item. this could be a menu item or modifier

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