{"data":{"siteConfig":{"withRbac":false},"site":{"pathPrefix":""},"apis":[{"id":"8a165032-e697-58cf-b740-f32ee6c7894foverview/__redocly content redirect/authentication/overview/","definitionId":"authentication","link":"/authentication/overview/","sourcePath":"/data/toasttab/redocly-portal-config-prerelease-ordermgmt/authentication.reference.page.yaml","info":{"version":"1.0.0","title":"Toast authentication API","description":"The authentication API returns an authentication token that you can present\nwhen your integration client software uses other Toast APIs. For more\ninformation about authentication, see [the Toast Developer\nGuide](https://doc.toasttab.com/doc/devguide/authentication.html).\n","termsOfService":"https://pos.toasttab.com/api-terms-of-use","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"authentication","label":"Authentication","settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":true,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true},"apiVersions":[{"definitionId":"authentication","isDefault":true,"title":"authentication","id":"authentication"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Toast authentication API\",\"description\":\"The authentication API returns an authentication token that you can present\\nwhen your integration client software uses other Toast APIs. For more\\ninformation about authentication, see [the Toast Developer\\nGuide](https://doc.toasttab.com/doc/devguide/authentication.html).\\n\",\"termsOfService\":\"https://pos.toasttab.com/api-terms-of-use\",\"contact\":{\"name\":\"Toast developer support\"}},\"tags\":[{\"name\":\"Authentication\"}],\"externalDocs\":{\"description\":\"Authentication developer guide\",\"url\":\"https://doc.toasttab.com/doc/devguide/authentication.html\"},\"paths\":{\"/authentication/login\":{\"post\":{\"tags\":[\"Authentication\"],\"summary\":\"Get an authentication token\",\"description\":\"Returns an authentication token that your Toast API client can present\\nwhen using other Toast platform APIs.\\n\",\"externalDocs\":{\"description\":\"Authentication developer guide\",\"url\":\"https://doc.toasttab.com/doc/devguide/authentication.html\"},\"operationId\":\"authenticationLoginPost\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AuthenticationRequest\"}}},\"description\":\"The authentication credentials for your Toast API client integration\\nsoftware.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"A JSON `AuthenticationResponse` object that includes an\\nauthentication token string.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AuthenticationResponse\"}}}},\"401\":{\"description\":\"The Toast API client credentials in your request are not valid.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}}}}}},\"servers\":[{\"url\":\"https://toast-api-server/authentication/v1\"}],\"components\":{\"schemas\":{\"AuthenticationRequest\":{\"type\":\"object\",\"description\":\"Authentication credentials for your Toast API integration client software.\\n\",\"properties\":{\"clientId\":{\"description\":\"The identifier string for your Toast API client. You receive the\\nidentifier string from the Toast integrations team.\\n\",\"type\":\"string\",\"example\":\"VKuhk4NaLedOcjZpJM8grvdrsFi3MlcM\"},\"clientSecret\":{\"description\":\"The secret string that corresponds to your Toast API client. You\\nreceive the secret string from the Toast integrations team.\\n\",\"type\":\"string\",\"example\":\"eS960aiKdvgbSDcLUCk68HR2CJKwwHNO2HKfgxjCWxoj27KIp6jFAi2XOOc_oCuv\"},\"userAccessType\":{\"description\":\"Always include the `userAccessType` value and set it to\\n`TOAST_MACHINE_CLIENT`.\\n\",\"type\":\"string\",\"example\":\"TOAST_MACHINE_CLIENT\"}}},\"AuthenticationResponse\":{\"type\":\"object\",\"description\":\"A wrapper object for the response to a successful Toast API authentication\\nrequest.\\n\",\"properties\":{\"token\":{\"$ref\":\"#/components/schemas/AuthenticationToken\"},\"status\":{\"description\":\"The value `SUCCESS` indicates that your authentication request was successful.\",\"type\":\"string\",\"example\":\"SUCCESS\"}}},\"AuthenticationToken\":{\"type\":\"object\",\"description\":\"Information about a Toast platform API session, including an\\nauthentication token string that your Toast API client software can\\npresent when using other Toast platform APIs.\\n\",\"properties\":{\"tokenType\":{\"description\":\"The OAuth 2 authentication scheme used for the authentication token.\\nToast API authentication uses the bearer authentication scheme.\\n\",\"type\":\"string\",\"example\":\"Bearer\"},\"scope\":{\"description\":\"The scope value in the authentication token request response is\\n`null`. The `accessToken` JSON Web Token (JWT) contains the list of\\n[scopes for your Toast API\\nclient](https://dev.toasttab.com/doc/devguide/apiScopes.html).\\n\",\"type\":\"string\"},\"expiresIn\":{\"description\":\"The number of seconds that the authentication token is valid. \\n\",\"type\":\"integer\",\"example\":86400},\"accessToken\":{\"description\":\"A JSON Web Token (JWT) string that contains an authentication token.\\nYou [present this string when you make\\nrequests](https://dev.toasttab.com/doc/devguide/authentication.html#using-authentication-token)\\nto other Toast API resources. The JWT includes information about your\\nToast API client.\\n\",\"type\":\"string\"},\"idToken\":{\"description\":\"For internal use only.\\n\",\"type\":\"string\"},\"refreshToken\":{\"description\":\"For internal use only.\\n\",\"type\":\"string\"}}},\"ErrorMessage\":{\"type\":\"object\",\"description\":\"An object that contains information about one or more errors that the\\nToast platform encountered when processing your API request.\\n\",\"properties\":{\"status\":{\"description\":\"The HTTP status code of the response.\\n\",\"type\":\"string\"},\"code\":{\"description\":\"A numeric identifier for the error condition.\\n\",\"type\":\"integer\"},\"message\":{\"description\":\"A description of the error condition.\\n\",\"type\":\"string\"},\"messageKey\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\"},\"fieldName\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\"},\"link\":{\"description\":\"The URL of a resource that provides more information about the error\\ncondition.\\n\",\"type\":\"string\"},\"requestId\":{\"description\":\"The unique identifier of the HTTP request that your client sent to the Toast API.\\n\",\"type\":\"string\"},\"developerMessage\":{\"description\":\"Additional detail about the error condition, if it is available.\\n\",\"type\":\"string\"},\"errors\":{\"description\":\"A JSON array of `ErrorMessage` objects.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}},\"canRetry\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\"}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":true,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"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\":{}}}}}","permission":"guest","lastModified":"2023-01-05T21:46:45.000Z","redocInfoPageId":"authentication.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-config-prerelease-ordermgmt/authentication.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"authentication","isDefault":true,"id":"authentication","title":"authentication","link":null}]},{"id":"2134492f-4510-56e0-91e5-da41921a57f1overview/__redocly content redirect/retail/overview/","definitionId":"retail","link":"/retail/overview/","sourcePath":"/data/toasttab/redocly-portal-config-prerelease-ordermgmt/retail.reference.page.yaml","info":{"version":"1.0.0","title":"Retail API","description":"This API exposes information to power retail applications.\n","contact":{"name":"Toast Retail Team"},"termsOfService":"https://pos.toasttab.com/api-terms-of-use"},"data":{"redirect":true,"type":"reference-docs","definitionId":"retail","label":"Retail","settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":true,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true},"apiVersions":[{"definitionId":"retail","isDefault":true,"title":"retail","id":"retail"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.3\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Retail API\",\"description\":\"This API exposes information to power retail applications.\\n\",\"contact\":{\"name\":\"Toast Retail Team\"},\"termsOfService\":\"https://pos.toasttab.com/api-terms-of-use\"},\"servers\":[{\"url\":\"https://ws-sandbox-api.eng.toasttab.com\"}],\"paths\":{\"/v1/purchaseOrders/search\":{\"post\":{\"summary\":\"Retrieve all purchase orders that meet the specified parameters\",\"tags\":[\"Purchase orders\"],\"operationId\":\"searchPurchaseOrders\",\"security\":[{\"OAuth2\":[\"retail.inventory:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast identifier of the location queried for retail information.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"The page token for the next page of results. If this value is unspecified, the endpoint returns the\\nfirst page of results.\\n\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"An request object containing criteria for searching for purchase orders\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PurchaseOrdersSearchRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Success\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PurchaseOrdersResponse\"}}}},\"500\":{\"description\":\"Internal server error\"}}}},\"/v1/purchaseOrders/{purchaseOrderId}\":{\"get\":{\"summary\":\"Retrieve all purchase orders that meet the specified parameters\",\"tags\":[\"Purchase orders\"],\"operationId\":\"getPurchaseOrderById\",\"security\":[{\"OAuth2\":[\"retail.inventory:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast identifier of the location queried for retail information.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"purchaseOrderId\",\"in\":\"path\",\"description\":\"The identifier of the purchase order.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Success\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PurchaseOrder\"}}}},\"500\":{\"description\":\"Internal server error\"}}}},\"/v1/inventoryHistory/search\":{\"post\":{\"summary\":\"Get all inventory history at a location\",\"tags\":[\"Inventory History\"],\"operationId\":\"searchInventoryHistory\",\"security\":[{\"OAuth2\":[\"retail.inventory:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast GUID of the location queried for retail information.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"The page token for the next page of results. If this value is unspecified, the endpoint returns the\\nfirst page of results.\\n\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"An request object containing criteria for searching for inventory history records\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/InventoryHistorySearchRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Success\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/InventoryHistoryResponse\"}}}},\"401\":{\"description\":\"The client is not authorized to query this endpoint.\"},\"403\":{\"description\":\"The client does not have the proper permissions to query this endpoint.\"},\"500\":{\"description\":\"Internal server error\"}}}},\"/v1/inventoryHistory/{inventoryHistoryEntryId}\":{\"get\":{\"summary\":\"Retrieve all inventory history records that meet the specified parameters\",\"tags\":[\"Inventory History\"],\"operationId\":\"getInventoryHistoryById\",\"security\":[{\"OAuth2\":[\"retail.inventory:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast identifier of the location queried for retail information.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"inventoryHistoryEntryId\",\"in\":\"path\",\"description\":\"The identifier of the inventory history.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Success\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/InventoryHistoryLogEntry\"}}}},\"500\":{\"description\":\"Internal server error\"}}}}},\"components\":{\"securitySchemes\":{\"BearerAuth\":{\"type\":\"http\",\"scheme\":\"bearer\"},\"OAuth2\":{\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"/authentication/v1/authentication/customer/oauth/token\",\"scopes\":{\"retail:read\":\"Grants integration partners access to read retail information.\\n\"}}}}},\"schemas\":{\"PurchaseOrdersSearchRequest\":{\"type\":\"object\",\"properties\":{\"updatedDateRange\":{\"$ref\":\"#/components/schemas/DateRange\"},\"includeArchived\":{\"type\":\"boolean\",\"description\":\"Determines whether or not to include archived purchase orders. If this value is unspecified,\\narchived purchase orders are not returned in API responses.\\n\"},\"purchaseOrderStatuses\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PurchaseOrderStatus\"}}}},\"DateRange\":{\"type\":\"object\",\"required\":[\"startDate\"],\"properties\":{\"startDate\":{\"type\":\"string\",\"format\":\"date\",\"description\":\"The start date of the range\"},\"endDate\":{\"type\":\"string\",\"format\":\"date\",\"description\":\"The end date of the range\"}}},\"PurchaseOrdersResponse\":{\"type\":\"object\",\"properties\":{\"currentPageToken\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The page token the client provided to get the current page of results\"},\"nextPageToken\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The page token the client can provide to get the next page of results\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PurchaseOrder\"}}}},\"PurchaseOrder\":{\"type\":\"object\",\"required\":[\"id\",\"createdDate\",\"modifiedDate\",\"archived\",\"status\",\"paid\",\"supplier\",\"supplierNotes\",\"toastGeneratedPurchaseOrderNumber\",\"items\",\"purchaseOrderTotals\",\"purchasingEntityInfo\"],\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":false,\"description\":\"The unique identifier of the purchase order.\"},\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":false,\"readOnly\":true,\"description\":\"The date and time the purchase order was created.\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":false,\"readOnly\":true,\"description\":\"The date and time the purchase order was last modified.\"},\"archived\":{\"type\":\"boolean\",\"nullable\":false,\"description\":\"Whether the purchase order has been archived.\"},\"status\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The status of the purchase order.\",\"enum\":[\"DRAFT\",\"ORDERED\",\"PARTIALLY_RECEIVED\",\"RECEIVED\",\"VOIDED\"]},\"paid\":{\"type\":\"boolean\",\"nullable\":false,\"description\":\"A flag indicating whether the purchase order has been paid.\"},\"supplier\":{\"$ref\":\"#/components/schemas/Supplier\"},\"toastGeneratedPurchaseOrderNumber\":{\"type\":\"number\",\"format\":\"int32\",\"nullable\":false,\"description\":\"Toast generated purchase order number.\"},\"externalPurchaseOrderNumber\":{\"type\":\"string\",\"nullable\":true,\"description\":\"An optional purchase order number supplied by a Toast user.\"},\"externalInvoiceNumber\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The invoice number for the invoice associated with this purchase order.\"},\"items\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PurchaseOrderItem\"}},\"distributionStrategies\":{\"$ref\":\"#/components/schemas/DistributionStrategies\"},\"purchaseOrderTotals\":{\"$ref\":\"#/components/schemas/PurchaseOrderTotals\"},\"expectedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":false,\"description\":\"The expected fulfillment date of the purchase order.\"},\"purchasingEntityInfo\":{\"$ref\":\"#/components/schemas/PurchasingEntityInfo\"},\"supplierNotes\":{\"type\":\"string\",\"nullable\":false,\"description\":\"Notes for the supplier that pertain to ordering.\"},\"receivingNotes\":{\"type\":\"string\",\"nullable\":false,\"description\":\"Notes that pertain to the receiving of the ordered items.\"}}},\"PurchaseOrderStatus\":{\"type\":\"string\",\"description\":\"The status of the purchase order\",\"enum\":[\"DRAFT\",\"ORDERED\",\"PARTIALLY_RECEIVED\",\"RECEIVED\",\"VOIDED\"]},\"PurchaseOrderItem\":{\"type\":\"object\",\"required\":[\"itemVersionId\",\"name\",\"orderedItemInfo\",\"taxes\",\"fees\",\"discounts\",\"receivedEvents\"],\"properties\":{\"itemVersionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":false,\"description\":\"The Toast ID of the ordered item.\"},\"name\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The name of the ordered item.\"},\"supplierItemId\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The supplier item ID of the ordered item.\"},\"orderedItemInfo\":{\"$ref\":\"#/components/schemas/OrderedItemInfo\"},\"taxes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Tax\"}},\"fees\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Fee\"}},\"discounts\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PurchasingItemDiscount\"}},\"receivedEvents\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ReceivedEvent\"}}}},\"OrderedItemInfo\":{\"type\":\"object\",\"required\":[\"orderedQuantity\",\"orderedUnit\"],\"properties\":{\"orderedQuantity\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":false,\"description\":\"The quantity ordered.\"},\"orderedUnit\":{\"$ref\":\"#/components/schemas/NamedItemReceivingUnit\"},\"orderedCost\":{\"$ref\":\"#/components/schemas/ItemCosts\"}}},\"NamedItemReceivingUnit\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The name of the item receiving unit.\"},\"quantityInUnit\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":false,\"description\":\"The quantity that the receiving unit comes in. For example, if a case of wine contains 12 bottles,\\nthe quantityInUnit would be 12.\\n\"}}},\"ItemCosts\":{\"type\":\"object\",\"properties\":{\"baseCost\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The unit cost of the ordered item.\"},\"subtotal\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The total cost of the line item (excluding item-level taxes, fees and discounts).\"},\"total\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The total cost of the line item (including item-level taxes, fees and discounts).\"},\"landedCost\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The unit cost of the purchasable item, used in calculating the cost of goods sold.\"}}},\"PurchasingEntityInfo\":{\"type\":\"object\",\"required\":[\"taxes\",\"fees\",\"discounts\"],\"properties\":{\"taxes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Tax\"}},\"fees\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Fee\"}},\"discounts\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PurchasingEntityDiscount\"}}}},\"Tax\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The name of the tax.\"},\"absoluteValue\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The absolute value of the tax.\"},\"percentageValue\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The percentage value of the tax.\"}}},\"Fee\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The name of the fee.\"},\"absoluteValue\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The absolute value of the fee.\"},\"percentageValue\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The percentage value of the fee.\"},\"isTaxable\":{\"type\":\"boolean\",\"nullable\":false,\"description\":\"Whether or not the fee is taxable.\"}}},\"PurchasingItemDiscount\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The name of the discount.\"},\"absoluteValue\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The absolute value of the discount.\"},\"percentageValue\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The percentage value of the discount.\"}}},\"PurchasingEntityDiscount\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The name of the discount.\"},\"absoluteValue\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The absolute value of the discount.\"},\"percentageValue\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The percentage value of the discount.\"},\"combineWithItemDiscounts\":{\"type\":\"boolean\",\"nullable\":false,\"description\":\"Describes whether or not to combine this purchasing entity discount with item discounts.\"}}},\"DistributionStrategies\":{\"type\":\"object\",\"properties\":{\"taxDistributionStrategy\":{\"$ref\":\"#/components/schemas/AdjustmentDistributionStrategy\"},\"feesDistributionStrategy\":{\"$ref\":\"#/components/schemas/AdjustmentDistributionStrategy\"},\"discountsDistributionStrategy\":{\"$ref\":\"#/components/schemas/AdjustmentDistributionStrategy\"}}},\"PurchaseOrderTotals\":{\"type\":\"object\",\"required\":[\"itemsSubtotal\",\"totalCost\"],\"properties\":{\"itemsSubtotal\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The sum of the items' costs without any taxes, fees or discounts.\"},\"subtotalCost\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":true,\"description\":\"The total cost of the invoice before invoice-level taxes, fees or discounts.\"},\"totalCost\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":false,\"description\":\"The total cost of the invoice after invoice-level taxes, fees or discounts.\"}}},\"AdjustmentDistributionStrategy\":{\"type\":\"string\",\"description\":\"The distribution details of how purchase order adjustments were applied to item level costs.\\n\",\"enum\":[\"ITEM_TOTAL_COST\",\"ITEM_QUANTITY\",\"EQUALLY_PER_ITEM\"]},\"ReceivedEvent\":{\"type\":\"object\",\"required\":[\"receivedQuantity\"],\"properties\":{\"receivedQuantity\":{\"type\":\"number\",\"format\":\"double\",\"nullable\":false,\"description\":\"The quantity of the item.\"},\"receivedUnit\":{\"$ref\":\"#/components/schemas/NamedItemReceivingUnit\"},\"receivedCosts\":{\"$ref\":\"#/components/schemas/ItemCosts\"},\"inventoryHistoryId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":false,\"description\":\"The ID of the inventory history event associated with this received event.\"}}},\"Supplier\":{\"type\":\"object\",\"required\":[\"id\",\"name\"],\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":false,\"readOnly\":true,\"description\":\"The unique identifier of the supplier.\"},\"name\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The name of the supplier.\"},\"accountNumber\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The account number of the supplier.\"},\"address\":{\"$ref\":\"#/components/schemas/Address\"},\"contactName\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The name of the supplier contact.\"},\"phoneDetails\":{\"$ref\":\"#/components/schemas/PhoneDetails\"},\"email\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The email of the supplier.\"}}},\"PhoneDetails\":{\"type\":\"object\",\"required\":[\"countryCode\",\"countryIsoCode\",\"nationalNumber\"],\"properties\":{\"countryCode\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The country code of the phone number.\"},\"countryIsoCode\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The ISO country code of the phone number.\"},\"nationalNumber\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The national number part of the phone number.\"}}},\"Address\":{\"type\":\"object\",\"required\":[\"regionCode\",\"addressLines\",\"revision\"],\"properties\":{\"regionCode\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The region code of the address.\"},\"addressLines\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"nullable\":false,\"description\":\"The address lines of the address.\"},\"revision\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":false,\"description\":\"The revision number of the address.\"},\"languageCode\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The language code of the address.\"},\"postalCode\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The postal code of the address.\"},\"sortingCode\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The sorting code of the address.\"},\"administrativeArea\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The administrative area of the address.\"},\"locality\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The locality of the address.\"},\"sublocality\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The sublocality of the address.\"}}},\"InventoryHistorySearchRequest\":{\"type\":\"object\",\"properties\":{\"updatedDateRange\":{\"$ref\":\"#/components/schemas/DateRange\"},\"adjustmentType\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/InventoryHistoryAdjustmentType\"}}}},\"InventoryHistoryAdjustmentType\":{\"type\":\"string\",\"description\":\"The type of the adjustment.\",\"enum\":[\"AUTO_LINK_TRANSFER_IN\",\"AUTO_LINK_TRANSFER_OUT\",\"COUNT\",\"CYCLE_COUNT\",\"DAMAGE\",\"EXPIRE\",\"EXTERNAL\",\"INITIAL\",\"LOSS\",\"MISSING_DURING_TRANSFER\",\"PRODUCED_MANUALLY\",\"RECEIVE\",\"RESTOCK\",\"SAMPLED\",\"THEFT\",\"TRANSFERRED_INTERNALLY\",\"TRANSFERRED_TO_OTHER_LOCATION\",\"WASTED\"]},\"InventoryHistoryResponse\":{\"type\":\"object\",\"required\":[\"data\"],\"properties\":{\"currentPageToken\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The page token the client provided to get the current page of results\"},\"nextPageToken\":{\"type\":\"string\",\"nullable\":false,\"description\":\"The page token the client can provide to get the next page of results\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/InventoryHistoryLogEntry\"}}}},\"InventoryHistoryLogEntry\":{\"type\":\"object\",\"required\":[\"inventoryHistoryLogId\",\"itemVersionId\",\"createdDate\",\"modifiedDate\",\"notes\",\"adjustmentType\",\"quantityInfo\",\"userDetails\"],\"properties\":{\"inventoryHistoryLogId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":false,\"readOnly\":true,\"description\":\"The unique identifier of the inventory history adjustment.\"},\"itemVersionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":false,\"description\":\"The Toast ID of the adjusted item.\"},\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":false,\"readOnly\":true,\"description\":\"The date and time the inventory history log entry was created.\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":false,\"readOnly\":true,\"description\":\"The date and time the inventory history log entry was last modified.\"},\"notes\":{\"type\":\"string\",\"nullable\":true,\"description\":\"Notes that accompany the adjustment.\"},\"adjustmentType\":{\"$ref\":\"#/components/schemas/InventoryHistoryAdjustmentType\"},\"supplier\":{\"$ref\":\"#/components/schemas/Supplier\"},\"purchaseOrderId\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier of the purchase order, for receiving adjustments.\",\"nullable\":true},\"quantityInfo\":{\"$ref\":\"#/components/schemas/InventoryHistoryQuantity\"},\"costInfo\":{\"$ref\":\"#/components/schemas/InventoryHistoryCost\"},\"userDetails\":{\"$ref\":\"#/components/schemas/UserDetails\"}}},\"InventoryHistoryQuantity\":{\"type\":\"object\",\"required\":[\"quantityOnHand\"],\"properties\":{\"quantityOnHand\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The quantity on hand after this inventory history log entry\",\"nullable\":false},\"quantityVariance\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The difference between the quantity on hand and the expected quantity\",\"nullable\":true}}},\"InventoryHistoryCost\":{\"type\":\"object\",\"properties\":{\"capturedCost\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The cost captured at the time of the adjustment\",\"nullable\":true},\"landedCost\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The landed cost captured at the time if the adjustment\",\"nullable\":true},\"receivingUnitCost\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The raw receiving unit cost before division by quantity\",\"nullable\":true}}},\"UserDetails\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true,\"description\":\"The id of the user performing the adjustment.\"},\"firstName\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The first name of the user.\"},\"lastName\":{\"type\":\"string\",\"nullable\":true,\"description\":\"The last name of the user.\"}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":true,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"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\":{}}}}}","permission":"guest","lastModified":"2025-12-10T04:27:51.000Z","redocInfoPageId":"retail.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-config-prerelease-ordermgmt/retail.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"retail","isDefault":true,"id":"retail","title":"retail","link":null}]}]}}