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.

Getting Inventory By Status

You can restrict menu items in the response data to those with either a QUANTITY or OUT_OF_STOCK status by using the status query parameter of the /inventory endpoint. The format of the status request parameter is one of the following:

  • Use a value of QUANTITY to get all menu items with an inventory status of QUANTITY:

    https://[toast-api-hostname]/stock/v1/inventory?status=QUANTITY
  • Use a value of OUT_OF_STOCK to get all menu items with an inventory status of OUT_OF_STOCK:

    https://[toast-api-hostname]/stock/v1/inventory?status=OUT_OF_STOCK

The resource returns a JSON array of MenuItemInventory objects containing inventory information for the menu items. Information is returned only for menu items that have the requested inventory status.

The following example curl command sends a GET request to the /inventory endpoint with a status query parameter of OUT_OF_STOCK.

Get Inventory By Status

curl -X GET \
-H "Authorization: Bearer eyJzI1NiJ9hbGciOiJSU.eyJhd9yaXR5Ij
oiQ1JVTkNIVElNRSIsInJzR3VpZCI6IjE4YzQ5YWJlLWFlODItNGFlYy04ND
M1LWJhYTRjMjVlYTY2MiIsInNjb3BlIjpbImxWQiOlsidG9hc3QiXSwibmFt
aW5nQXV0aGhYm9yIiwib3JkZXJzIiwidXNlcm1nbXQiXSwiZXhwIjoxNDg0M
zg5ODUwLCJqdGkiOiJlMDYzZjJkMy1jNGYyLTRiZjItODJmNi01MTg1NWMzZ
DAxM2YiLCJjbGllbnRfaWQiOiJjcnVuY2h0aW1lIn0.X1_0y9Hzj5F9gdOw2
o6VSYTyZwooAJiFMDmNakbZrtiUdYwLzuLwLpCMQzX5pKYtOqDUz_cetGJL3
txKL1L-K2j1Enoq8An8hEM6e8J0KdAiwrYFO3W3CmWedaoz95K9ghNZVCs28
Td2Sp3Ix3fObxbrvanocx9_OT8S9uM8hdSXmBI_ykTWvOVgK4hO24V3DJy4b
9bz1FtgOvrClhELxCe8dJy7jiwAR60xczlCF5rna98RMLN6zY4ffjmljKFZ6
QV0KkVppWjEiJn7oFHiIylCX1sSg7sddrGatj0xJzts3GJ8u8_lryUNHaEvJ
dWq4Yzwo007AMgxjH9d241Y-g" \
-H "Toast-Restaurant-External-ID: 4622e7a9-b4be-3fef-9220-b3dad273e0b4" \1
https://[toast-api-hostname]/stock/v1/inventory?status=OUT_OF_STOCK2

1

Use the Toast-Restaurant-External-ID request parameter to specify the GUID of the restaurant from which you want to retrieve menu item inventories by status. The GUID must be for an individual restaurant, not the GUID for a restaurant group or management group.

2

Specify status=OUT_OF_STOCK to retrieve menu items that are not in stock.


The following example shows the JSON response data for the GET request.

Get Inventory By Status Return Data

[1
    {
        "guid": "ed89fb2f-b9e8-4243-9ed7-b216f98b5ff8",2
        "status": "OUT_OF_STOCK",3
        "quantity": null
    },
    {
        "guid": "74be0331-9634-4fa8-b892-7b9c80a1de0b",
        "status": "OUT_OF_STOCK",
        "quantity": null4
    }
]

1

This GET request returns a JSON array of menu item inventory objects for menu items with a status of OUT_OF_STOCK.

2

The guid value contains the unique Toast POS identifier for the menu item.

3

The status value is OUT_OF_STOCK for the menu item. The status value would be QUANTITY if you had specified status=QUANTITY as the request parameter.

4

The quantity value indicates the amount of stock remaining for menu items with an inventory status of QUANTITY, and is null for menu items with an OUT_OF_STOCK inventory status.