{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/stock/overview/","result":{"data":{"contentItem":{"type":"redoc-info","link":"/stock/overview/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"Stock API\",\"description\":\"\\nThe stock API lets you retrieve and update inventory information for a\\nrestaurant's menu items and modifiers.\\n\\n_*Note:*_ Modifiers are supported by an underlying menu item, called the\\nmodifier's item reference. In this reference, the term \\\"menu item\\\" is used\\nto generically refer to both standalone menu items and modifier item\\nreferences, because the same data is used for both. For more information,\\nsee <a\\nhref=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">Understanding\\na modifier option's item reference</a>.\\n\\nYou can use the stock API to:\\n\\n* Get all inventory information for a restaurant.\\n* Get inventory information for a list of menu items.\\n* Get inventory information for a specific status\\n  of the menu items (such as all menu items that are out\\n  of stock).\\n* Update inventory information for a list of menu items.\\n\",\"contact\":{\"name\":\"Toast developer support\"},\"version\":\"1.0.0\"},\"servers\":[{\"url\":\"https://toast-api-server/stock\"}],\"paths\":{\"/v1/inventory\":{\"get\":{\"tags\":[\"Stock\"],\"summary\":\"Get menu item inventory for a restaurant\",\"description\":\"Returns inventory information for all menu items that have an\\n`OUT_OF_STOCK` or `QUANTITY` status.\\n\\nInventory information is not returned for menu items with an `IN_STOCK`\\nstatus, because they are not considered at risk for going out of stock.\\n\\nTo restrict the menu items in the response to either `OUT_OF_STOCK` or\\n`QUANTITY` stock status, use the `status` query parameter.\\n\",\"operationId\":\"getInventory\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast GUID of the restaurant queried for inventory information.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"status\",\"in\":\"query\",\"description\":\"Limits the items in the response to those items with the specified\\nstock status. Values are:\\n\\n* `OUT_OF_STOCK`- Returns all menu items that have the\\n  `OUT_OF_STOCK` stock status.\\n\\n* `QUANTITY` - Returns all menu items that have the\\n  `QUANTITY` stock status.\\n\",\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successful operation\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/MenuItemInventory\"}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"items\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}}}},\"security\":[{\"oauth2\":[\"stock:read\"]}]}},\"/v1/inventory/search\":{\"post\":{\"tags\":[\"Stock\"],\"summary\":\"Get inventory information for specific menu items\",\"description\":\"Returns inventory information for a list of menu items.\\n\\nThe request must include a message body that contains an\\n`InventorySearchRequest` object with one or both of these values:\\n\\n* A`multiLocationIds` value that contains an array of menu item\\n  multi-location IDs to search for.\\n\\n* A `guids` value that contains an array of menu item GUIDs to search\\n  for.\\n\\nFor information on these two identifier types, see <a\\nhref=\\\"https://doc.toasttab.com/doc/devguide/portalToastIdentifiers.html\\\">Toast\\nidentifiers</a>.\\n\",\"operationId\":\"postInventorySearch\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast GUID of the restaurant queried for inventory information.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"An `InventorySearchRequest` object containing identifiers for the\\nmenu items to include in the search.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/InventorySearchRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful operation\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/MenuItemInventory\"}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"items\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}}}},\"security\":[{\"oauth2\":[\"stock:read\"]}]}},\"/v1/inventory/update\":{\"put\":{\"tags\":[\"Stock\"],\"summary\":\"Update inventory information for specific menu items\",\"description\":\"Updates inventory information for a list of menu items.\\n\",\"operationId\":\"updateInventory\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast GUID of the restaurant whose inventory information will be updated.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"An array of `MenuItemInventory` objects for the menu items to be\\nupdated, with the following values:\\n\\n* An identifier for the menu item to be updated. This may be either the\\n  menu item's `multiLocationId` or its `guid`. See <a\\n  href=\\\"https://doc.toasttab.com/doc/devguide/portalToastIdentifiers.html\\\">Toast\\n  identifiers</a> for more information on these two identifier types.\\n\\n* The `status` for the menu item. Must be one of the following:\\n  * `IN_STOCK`\\n  * `OUT_OF_STOCK`\\n  * `QUANTITY`\\n\\n* For menu items with a status of `QUANTITY`, you must also provide a\\n  `quantity` value that is a double greater than 0 (such as 0.5, 7.0, or\\n  10.75). Do not include a `quantity` value for menu items with a\\n  `status` of `IN_STOCK` or `OUT_OF_STOCK`.\\n\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/MenuItemInventory\"}}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful operation\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/MenuItemInventory\"}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"items\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}}}},\"security\":[{\"oauth2\":[\"stock:write\"]}]}}},\"components\":{\"schemas\":{\"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.\"},\"MenuItemInventory\":{\"type\":\"object\",\"properties\":{\"guid\":{\"type\":\"string\",\"description\":\"The unique GUID assigned to the menu item by the Toast platform.\\n\",\"format\":\"uuid\"},\"itemGuidValidity\":{\"type\":\"string\",\"description\":\"Indicates whether a menu item identifier that you included in your request is valid or not.\\n\\n`INVALID` indicates the stock API did not find a matching menu item for the  identifier you supplied in the search or update request. This means either the menu item does not exist at the location being queried or it has been archived.\\n            \\n`VALID` indicates that the item in the API response is a valid item at the restaurant location.\\n\\nFor more information, see <a\\nhref=\\\"https://doc.toasttab.com/doc/devguide/apiUsingTheStockApi.html\\\">Getting stock information using the stock API</a> and <a\\nhref=\\\"https://doc.toasttab.com/doc/devguide/apiUpdatingInventoryInformation.html\\\">Updating stock API</a>.          \\n\",\"readOnly\":true,\"enum\":[\"VALID\",\"INVALID\"]},\"status\":{\"type\":\"string\",\"description\":\"The inventory status of the menu item. The `status` value can be:\\n\\n* `IN_STOCK` - The menu item is in stock in the restaurant.\\n\\n* `QUANTITY` - The menu item is in limited supply. The amount\\nof remaining items is indicated by the `quantity` value.\\n\\n* `OUT_OF_STOCK` - The menu item is no longer in stock and cannot\\nbe selected for an order.\\n\",\"enum\":[\"IN_STOCK\",\"QUANTITY\",\"OUT_OF_STOCK\"]},\"quantity\":{\"type\":\"number\",\"nullable\":true,\"description\":\"Contains the amount of stock remaining when the menu item\\n`status` is `QUANTITY`.\\n\\nThis value is `null` for menu items\\nthat have a stock staus of `IN_STOCK` or `OUT_OF_STOCK`.\\n\",\"format\":\"double\"},\"multiLocationId\":{\"type\":\"string\",\"description\":\"A consistent identifier that applies to all versions of a menu item\\nthat is shared across locations.\\n\\nSee <a\\nhref=\\\"https://doc.toasttab.com/doc/devguide/portalToastIdentifiers.html\\\">Toast\\nidentifiers</a> for more information.\\n\"},\"versionId\":{\"type\":\"string\",\"description\":\"For future use.\\n\",\"format\":\"uuid\"}},\"description\":\"Contains the stock status and quantity information for a menu item.\"},\"ErrorMessage\":{\"type\":\"object\",\"description\":\"An object that contains information about one or more errors that the\\nToast platform encountered when processing your API request. For more\\ninformation, see [API responses and errors in the _Toast Developer\\nGuide_](https://doc.toasttab.com/doc/devguide/apiResponsesAndErrors.html).\\n\",\"properties\":{\"status\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The HTTP status code of the response.\\n\"},\"code\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"A numeric identifier for the error condition.\\n\"},\"message\":{\"type\":\"string\",\"description\":\"A description of the error condition.\\n\"},\"messageKey\":{\"type\":\"string\",\"description\":\"Reserved for future use.\\n\"},\"fieldName\":{\"type\":\"string\",\"description\":\"Reserved for future use.\\n\"},\"link\":{\"type\":\"string\",\"description\":\"The URL of a resource that provides more information about the error\\ncondition.\\n\"},\"requestId\":{\"type\":\"string\",\"description\":\"The unique identifier of the HTTP request that your client sent to\\nthe Toast API.\\n\"},\"developerMessage\":{\"type\":\"string\",\"description\":\"Additional detail about the error condition, if it is available.\\n\"},\"errors\":{\"type\":\"array\",\"description\":\"A JSON array of `ErrorMessage` objects.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}}},\"securitySchemes\":{\"oauth2\":{\"type\":\"oauth2\",\"description\":\"Access to Toast APIs, specific endpoints, \\nand specific API endpoint operations is \\ncontrolled by the scopes that are associated \\nwith your API account. \\n\\nA full reference for Toast API scopes and \\ntheir capabilities can be found in the\\n[_Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiScopes.html).\\n\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"stock:read\":\"Allows reading from the stock API.\\n\",\"stock:write\":\"Allows updating stock status for menu items (and modifier option item references) using the stock API.\\n\"}}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"Node.js\"},{\"lang\":\"C#\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":false,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"showAccessMode\":true,\"downloadDefinitionUrl\":\"https://doc.toasttab.com/toast-api-specifications/toast-stock-api.yaml\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"","redocItemId":"overview","redocHasInfoPage":true,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"C#"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":false,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true,"showAccessMode":true,"downloadDefinitionUrl":"https://doc.toasttab.com/toast-api-specifications/toast-stock-api.yaml"},"requestLogin":false,"lastModified":"2024-09-05T12:56:37.000Z"},"seo":{"title":"Stock"}}},"pageContext":{"id":"2160ab56-ea1a-55d1-9329-e20e2436fcffoverview__redocly content/stock/overview/","seo":{"title":"Stock","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"stock.reference.page.yaml#overview","pageBaseUrl":"/stock","type":"redoc-info","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/stock/overview/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"stock","id":"stock","title":"stock","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}