Toast · Schema

InventorySearchRequest

Contains search parameters for retrieving menu item inventory information.

Food ServicePoint of SaleRestaurantsHospitality

Properties

Name Type Description
guids array An array of menu item GUIDs. The `/inventory/search` endpoint tries to find menu items with matching GUIDs.
multiLocationIds array An array of menu item multi-location IDs. The `/inventory/search` endpoint tries to find menu items with matching multi-location IDs. See versionIds array For future use.
View JSON Schema on GitHub

JSON Schema

toast-inventorysearchrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InventorySearchRequest",
  "title": "InventorySearchRequest",
  "type": "object",
  "properties": {
    "guids": {
      "type": "array",
      "description": "An array of menu item GUIDs. The `/inventory/search` endpoint tries to\nfind menu items with matching GUIDs.\n",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "multiLocationIds": {
      "type": "array",
      "description": "An array of menu item multi-location IDs. The `/inventory/search` endpoint\ntries to find menu items with matching multi-location IDs.\n\nSee <a\nhref=\"https://doc.toasttab.com/doc/devguide/portalToastIdentifiers.html\">Toast\nidentifiers</a> for more information on multi-location IDs.\n",
      "items": {
        "type": "string"
      }
    },
    "versionIds": {
      "type": "array",
      "description": "For future use.",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    }
  },
  "description": "Contains search parameters for retrieving menu item inventory information."
}