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.
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 |
---|---|
|
A unique identifier for the menu item, assigned by the Toast platform. data type: string format: uuid |
|
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 data type: string |
|
Indicates the quantity of this menu item that is available. data type: number format: double |
|
A unique identifier for the restaurant, assigned by the Toast platform. data type: string format: uuid |
|
data type: string |
|
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" } }