Stock webhook

The stock webhook allows you to receive updates when the inventory status of a menu item or a modifier (via its item reference) changes.

Note

Modifiers are supported by an underlying menu item, called the modifier item reference. In this section, the term menu item refers to both menu items and modifier item references, as the stock webhook reports on their status in the same way. For detailed information on modifier item references, see Understanding a modifier option's item reference.

When a message is published to your webhook endpoint for the stock event category, the eventCategory value is set to stock and the eventType is set to one of the following:

A menu item's inventory can be changed in the stock API, in the Toast app, and in the Toast administration back-end, and set to one of the following:

  • In Stock: The menu item is in stock. There is no specific quantity associated with the menu item but it is assumed to be available.

  • Out of Stock: The menu item is not in stock and cannot be ordered.

  • Quantity: A specific quantity for the menu item is defined. As the menu item is ordered, the quantity is decremented. When the quantity dips below the low quantity threshold, the low quantity webhook will fire. When the quantity reaches 0, the menu item's status changes to out of stock. Currently, the low quantity threshold is set to 5 for all menu items and is not configurable.

Stock webhook events reflect changes to these settings or to a menu item's quantity. For example, an out_of_stock event is triggered when a menu item's quantity has reached 0 or it has been manually marked as out of stock.

To set a menu item's stock status in the Toast app, a restaurant uses Quick Edit mode (described in this Toast Central article). To set it in the Toast administration back-end, the restaurant uses the Inventory section of the menu item's details page.

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"
  }
}

out_of_stock

The menu item's quantity has reached 0 or it has been manually marked as out of stock.

Attributes in the out_of_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

status

OUT_OF_STOCK

data type: string

versionId

Reserved for future use.

Payload example for the out_of_stock event

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

low_quantity

The menu item's quantity has dipped below the low quantity threshold. The amount remaining is indicated by the quantity value in the event's payload. Currently, the low quantity threshold is set to 5 for all menu items and is not configurable.

Attributes in the low_quantity 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

quantity

Indicates the quantity of this menu item that is available.

data type: number

format: double

restaurantGuid

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

data type: string

format: uuid

status

QUANTITY

data type: string

versionId

Reserved for future use.

Payload example for the low_quantity event

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