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 All Inventory Information from a Location

Send a GET request to the /inventory endpoint of the stock API to get inventory information for the menu items of a restaurant. The request returns a JSON array of MenuItemInventory objects containing information on the inventory status of the menu items.

Information is returned only for menu items that have an inventory status of QUANTITY or OUT_OF_STOCK. Menu items for which inventory information is not returned have an IN_STOCK status.

The following example curl command sends a GET request to the /inventory endpoint.

Get All Menu Item Inventory of a Restaurant

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

1

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


The following example shows the JSON response data for a GET request to the /inventory endpoint.

Get All Inventory Return Data

[1
    {
        "guid": "fac40015-343a-475a-855f-cf29cd715bf0",2
        "status": "OUT_OF_STOCK",3
        "quantity": null
    },
    {
        "guid": "f7ef668f-efe8-42e4-9050-c859ecf4bc6e",
        "status": "QUANTITY",
        "quantity": 25.04
    },
    {
        "guid": "3b942128-f26d-4661-bfc9-85056e1a3bd3",
        "status": "QUANTITY",
        "quantity": 10.75
    }
]

1

The GET request returns a JSON array of menu item inventory objects containing information on menu items with a status of QUANTITY or OUT_OF_STOCK.

2

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

3

The status value is QUANTITY or OUT_OF_STOCK. The /inventory endpoint only returns information for menu items that have an inventory status of QUANTITY or OUT_OF_STOCK. Menu items for which inventory information is not returned have an IN_STOCK status.

4

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