POST /{storeId}/menus/items/availability

Grubtech will push the availability and item quantities to the external system via webhook endpoint.

Request

Base URL
https://virtserver.swaggerhub.com/GrubTech/grubtech-grocery-integration-apis/1.0.0
URL
https://virtserver.swaggerhub.com/GrubTech/grubtech-grocery-integration-apis/1.0.0/{storeId}/menus/items/availability
Auth
API key in header X-API-KEY

Path parameters

storeIdstring required

Unique Identifier for location in which menu item availability got updated. This ID will be provided by either Grubtech or the aggregator.

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

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.