This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

in_stock

The menu item has been manually marked as in stock or its quantity has been set to a value that exceeds the low quantity threshold.

Attributes in the in_stock event's payload include:

Value Description

itemGuid

A unique identifier for the menu item, assigned by the Toast platform.

data type: string

format: uuid

multiLocationId

A consistent identifier that applies to all versions of a menu item that is shared across locations.

Requests sent to Toast APIs can use a combination of the multiLocationId and restaurantGuid values, instead of the itemGuid value, to identify a menu item. Integration clients can extract the multiLocationId and restaurantGuid from stock webhook messages to use in subsequent requests to Toast APIs. This is the recommended method for identifying menu items in Toast API requests. See Toast identifiers for more information.

data type: string

restaurantGuid

A unique identifier for the restaurant, assigned by the Toast platform.

data type: string

format: uuid

quantity

Indicates the quantity of this menu item that is available. This value is included if the status attribute is set to QUANTITY and omitted if the status attribute is set to IN_STOCK.

data type: number

format: double

status

IN_STOCK or QUANTITY

data type: string

versionId

Reserved for future use.

Payload for an in_stock event when a menu item is manually marked as In Stock

{
  "timestamp": "<ISO formatted timestamp in UTC>",
  "eventCategory": "stock",
  "eventType": "in_stock",
  "guid": "e445f586-081c-4a2a-bcd6-30717a48e17a",
  "details": {
    "itemGuid": "1e199622-ccbf-4ba8-8c37-111519dca13b",
    "restaurantGuid": "3325cc58-dc6e-4e21-85f9-7de275ffe820",
    "status": "IN_STOCK",
    "multiLocationId": "100000000171238879",
    "versionId": "1e199622-ccbf-4ba8-8c37-111519dca13b"    
  }
}

Payload for an in_stock event when a menu item's quantity is manually set and that quantity exceeds the low quantity threshold

{
  "timestamp": "<ISO formatted timestamp in UTC>",
  "eventCategory": "stock",
  "eventType": "in_stock",
  "guid": "e445f586-081c-4a2a-bcd6-30717a48e17a",
  "details": {
    "itemGuid": "1e199622-ccbf-4ba8-8c37-111519dca13b",
    "restaurantGuid": "3325cc58-dc6e-4e21-85f9-7de275ffe820",
    "status": "QUANTITY",
    "quantity": 10.0,
    "multiLocationId": "100000000171239701",
    "versionId": "1e199622-ccbf-4ba8-8c37-111519dca13b"
  }
}