Get inventory information for specific menu items

Returns inventory information for a list of menu items.

The request must include a message body that contains an InventorySearchRequest object with one or both of these values:

  • AmultiLocationIds value that contains an array of menu item multi-location IDs to search for.

  • A guids value that contains an array of menu item GUIDs to search for.

For information on these two identifier types, see Toast identifiers.

Securityoauth2
Request
header Parameters
Toast-Restaurant-External-ID
required
string

The Toast GUID of the restaurant queried for inventory information.

Request Body schema: application/json

An InventorySearchRequest object containing identifiers for the menu items to include in the search.

guids
Array of strings <uuid>

An array of menu item GUIDs. The /inventory/search endpoint tries to find menu items with matching GUIDs.

multiLocationIds
Array of strings

An array of menu item multi-location IDs. The /inventory/search endpoint tries to find menu items with matching multi-location IDs.

See Toast identifiers for more information on multi-location IDs.

versionIds
Array of strings <uuid>

For future use.

Responses
200

Successful operation

404

One of the specified menu items does not have inventory information.

post/inventory/search
Request samples
application/json
{
  • "guids": [
    ],
  • "multiLocationIds": [
    ],
  • "versionIds": [
    ]
}
Response samples
application/json
[
  • {
    }
]