{"data":{"siteConfig":{"withRbac":false},"site":{"pathPrefix":""},"apis":[{"id":"5d85824e-8828-518e-a341-0eb0e6ecaeb3overview/__redocly content redirect/analytics/overview/","definitionId":"analytics","link":"/analytics/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/analytics.reference.page.yaml","info":{"title":"Analytics API","description":"The analytics API provides an enterprise reporting and analytics service, \nand includes operations that retrieve information for all restaurants, or a\nsubset of restaurants, in a management group, create requests for reporting data, \nand retrieve the reporting data.\n\nThe types of reporting data include:\n* Aggregated sales reporting data covering sales and labor information.\n* Check reporting data providing information for each check.\n* Labor reporting data providing information for employees and jobs that are paid hourly.\n* Menu reporting data providing information for menu entities as they relate to sales.\n* Payout reporting data providing information for payouts organized either by settled date, payments, or sales date.\n* Guest reporting data providing information for guest's payment cards organized by payments.\n","version":"1.0.0","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"analytics","label":"Analytics","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,"downloadFileName":"toast-analytics-api.yaml","downloadDefinitionUrl":"https://doc.toasttab.com/toast-api-specifications/toast-reporting-api.yaml"},"apiVersions":[{"definitionId":"analytics","isDefault":true,"title":"analytics","id":"analytics"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Analytics API\",\"description\":\"The analytics API provides an enterprise reporting and analytics service, \\nand includes operations that retrieve information for all restaurants, or a\\nsubset of restaurants, in a management group, create requests for reporting data, \\nand retrieve the reporting data.\\n\\nThe types of reporting data include:\\n* Aggregated sales reporting data covering sales and labor information.\\n* Check reporting data providing information for each check.\\n* Labor reporting data providing information for employees and jobs that are paid hourly.\\n* Menu reporting data providing information for menu entities as they relate to sales.\\n* Payout reporting data providing information for payouts organized either by settled date, payments, or sales date.\\n* Guest reporting data providing information for guest's payment cards organized by payments.\\n\",\"version\":\"1.0.0\",\"contact\":{\"name\":\"Toast developer support\"}},\"tags\":[{\"name\":\"Aggregated sales\",\"description\":\"The analytics API endpoints for aggregated sales reporting data covering sales and labor information.\"},{\"name\":\"Check\",\"description\":\"The analytics API endpoints for check reporting data.\"},{\"name\":\"Labor\",\"description\":\"The analytics API endpoints for labor reporting data. This only supports hourly job and employee data.\"},{\"name\":\"Menu\",\"description\":\"The analytics API endpoints for menu reporting data.\"},{\"name\":\"Payout by settled date\",\"description\":\"The analytics API endpoint for payout reporting data organized by settled date.\"},{\"name\":\"Payout by payments\",\"description\":\"The analytics API endpoint for payout reporting data organized by payments.\"},{\"name\":\"Payout by sales date\",\"description\":\"The analytics API endpoint for payout reporting data organized by sales date.\"},{\"name\":\"Guest\",\"description\":\"The analytics API endpoint for guest reporting data organized by payment.\"},{\"name\":\"Restaurants information\",\"description\":\"The analytics API endpoint for providing information about restaurants in a management group.\"}],\"paths\":{\"/metrics\":{\"post\":{\"summary\":\"Post an aggregated sales reporting data request for a custom time range\",\"description\":\"Creates an aggregated sales reporting data request for a customized time range. \\n\\nUse the `onlyInactiveRestaurants` query parameter set to `true` to get data for inactive restaurants only.\\n\\nSpecify the `startBusinessDate` and `endBusinessDate` for the data in the message body.\\n\\nIdentify restaurants to include or exclude with the `restaurantIds` and \\n`excludedRestaurantIds` properties. If left blank, all restaurants are included by default.\\n\\nInclude information about how to aggregate the data with the `groupBy` property.\\n\",\"operationId\":\"postMetricsReportingDataCustomTimeRangeRequest\",\"parameters\":[{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is returned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MetricsReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the aggregated sales reporting data \\nrequest, included or excluded restaurants, and aggregation options.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Aggregated sales\"]}},\"/metrics/{timeRange}\":{\"post\":{\"summary\":\"Post an aggregated sales reporting data request for a specific time range\",\"description\":\"Creates an aggregated sales reporting data request for a specific time range.\\n\\nSpecify the time range with the `timeRange` path parameter.\\n\\nInclude information on how to aggregate the data for the `day` time range using the\\n`aggregateBy` query parameter.\\n\\nUse the `onlyInactiveRestaurants` query parameter set to `true` to get data for inactive restaurants only.\\n\\nSpecify the `startBusinessDate` and `endBusinessDate` for the data in the message body.\\n\\nIdentify which restaurants to include or exclude with the \\n`restaurantIds` and `excludedRestaurantIds` properties. If left blank, all restaurants are included by default.\\n\\nInclude information about how to aggregate the data with the `groupBy` property.\\n\",\"operationId\":\"postMetricsReportingDataSpecificTimeRangeRequest\",\"parameters\":[{\"name\":\"timeRange\",\"description\":\"The specific time range that you are requesting the data for.\\n\\nValid values:\\n\\n* `day` - The request covers a one day time range. This value can optionally use the `aggregateBy` query parameter.\\n\\n* `week` - The request covers a time range of seven days or fewer.\\n\\n* `month` - The request covers a time range of 31 days or fewer.\\n\\n* `year` - The request covers a time range of 366 days or fewer.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"day\",\"week\",\"month\",\"year\"]}},{\"name\":\"aggregateBy\",\"description\":\"Aggregates the data by day or hour if using the `timeRange` value `day`. The data is aggregated by day by default.\\n\\nValid values:\\n\\n* `DAY` - The reporting data is aggregated by day.\\n\\n* `HOUR` - The reporting data is aggregated by hour.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"enum\":[\"DAY\",\"HOUR\"]}},{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is returned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MetricsReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the aggregated sales reporting data\\nrequest, included or excluded restaurants, and aggregation options.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Aggregated sales\"]}},\"/metrics/{reportRequestGuid}\":{\"get\":{\"summary\":\"Get the aggregated sales reporting data\",\"description\":\"Returns the aggregated sales reporting data for the specified report request GUID. \\n\\nSpecify the `reportRequestGuid` for the data.\\n\\nSpecify whether to include the guest-facing restaurant names.\\n\",\"operationId\":\"getMetricsReportingData\",\"parameters\":[{\"name\":\"reportRequestGuid\",\"description\":\"The Toast platform identifier for the data request.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"fetchRestaurantNames\",\"description\":\"Specifies whether the data includes the guest-facing restaurant name. The guest-facing \\nrestaurant name is not returned by default.\\n\\nValid values:\\n\\n* `true` - The guest-facing restaurant name is returned with the data.\\n\\n* `false` - The guest-facing restaurant name is not returned with the data.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"responses\":{\"200\":{\"description\":\"The aggregated sales reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MetricsReportingData\"}}}},\"202\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportingDataInProgress\"}}}},\"404\":{\"description\":\"An unexpected error occurred. Refer to the `message` attached to this error for more information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"409\":{\"description\":\"The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"},\"504\":{\"description\":\"The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Aggregated sales\"]}},\"/metrics/{timeRange}/{reportRequestGuid}\":{\"get\":{\"deprecated\":true,\"summary\":\"Get the aggregated sales reporting data for a specific time range\",\"description\":\"This endpoint is deprecated. Instead of `/metrics/{timeRange}/{reportRequestGuid}`, use\\n`/metrics/{reportRequestGuid}`.\\n\\nReturns the aggregated sales reporting data for cumulative metrics for the specified time range report request GUID. \\n\\nSpecify the time range with the `timeRange` path parameter.\\n\\nSpecify the `reportRequestGuid` for the data.\\n\\nSpecify whether to include the guest-facing restaurant names.\\n\",\"operationId\":\"getMetricsReportingDataSpecificTimeRange\",\"parameters\":[{\"name\":\"timeRange\",\"description\":\"The specific time range that you are requesting the data for.\\n\\nValid values:\\n\\n* `day` - The request covers a one day time range.\\n\\n* `week` - The request covers a time range of seven days or fewer.\\n\\n* `month` - The request covers a time range of 31 days or fewer.\\n\\n* `year` - The request covers a time range of 366 days or fewer.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"day\",\"week\",\"month\",\"year\"]}},{\"name\":\"reportRequestGuid\",\"description\":\"The Toast platform identifier for the data request.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"fetchRestaurantNames\",\"description\":\"Specifies whether the data includes the guest-facing restaurant name. The guest-facing restaurant name is not returned by default.\\n\\nValid values:\\n\\n* `true` - The guest-facing restaurant name is returned with the data.\\n\\n* `false` - The guest-facing restaurant name is not returned with the data.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"responses\":{\"200\":{\"description\":\"The aggregated sales reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MetricsReportingData\"}}}},\"202\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportingDataInProgress\"}}}},\"404\":{\"description\":\"An unexpected error occurred. Refer to the `message` attached to this error for more information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"409\":{\"description\":\"The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"},\"504\":{\"description\":\"The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Aggregated sales\"]}},\"/restaurants-information\":{\"get\":{\"summary\":\"Get management group restaurant information\",\"description\":\"Returns an array of `RestaurantInfo` objects containing the GUID and guest-facing name for each\\nrestaurant in the associated management group, and whether or not the restaurant is activated, in test mode, or archived.\\n\",\"operationId\":\"getManagementGroupRestaurantsInformation\",\"responses\":{\"200\":{\"description\":\"A JSON array of `RestaurantsGuidName` objects for each restaurant in the management group.\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RestaurantsGuidName\"}}}}}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Restaurants information\"]}},\"/check/{timeRange}\":{\"post\":{\"summary\":\"Post a check reporting data request for a specific time range\",\"description\":\"Creates a check reporting data request for a specific time range. Currently, `day` is the only \\nvalid value.\\n\\nUse the `onlyInactiveRestaurants` query parameter set to `true` to get data for inactive \\nrestaurants only.\\n\\nSpecify the `startBusinessDate` and `endBusinessDate` for the \\ndata in the message body.\\n\\nIdentify restaurants to include or exclude with the `restaurantIds` and `excludedRestaurantIds` \\nproperties. If left blank, all restaurants are included by default.\\n\",\"operationId\":\"postCheckReportingDataSpecificTimeRangeRequest\",\"parameters\":[{\"name\":\"timeRange\",\"description\":\"The specific time range that you are requesting the data for. Currently, `day` is the \\nonly valid value.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"day\"]}},{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is \\nreturned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CheckReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the check reporting data \\nrequest and included or excluded restaurants.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Check\"]}},\"/check/{reportRequestGuid}\":{\"get\":{\"summary\":\"Get the check reporting data\",\"description\":\"Returns the check reporting data for the specified report request GUID.\\n\\nSpecify the `reportRequestGuid` for the data.\\n\\nSpecify whether to include the guest-facing restaurant names.\\n\",\"operationId\":\"getCheckReportingData\",\"parameters\":[{\"name\":\"reportRequestGuid\",\"description\":\"The Toast platform identifier for the data request.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"fetchRestaurantNames\",\"description\":\"Specifies whether the data includes the guest-facing restaurant name. The guest-facing \\nrestaurant name is not returned by default.\\n\\nValid values:\\n\\n* `true` - The guest-facing restaurant name is returned with the data.\\n\\n* `false` - The guest-facing restaurant name is not returned with the data.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"responses\":{\"200\":{\"description\":\"The check reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CheckReportingData\"}}}},\"202\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportingDataInProgress\"}}}},\"404\":{\"description\":\"An unexpected error occurred. Refer to the `message` attached to this error for more information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"409\":{\"description\":\"The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"},\"504\":{\"description\":\"The Toast platform was unable to process the request because internal \\nservices took too long to process, resulting in a timeout.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Check\"]}},\"/labor/{timeRange}\":{\"post\":{\"summary\":\"Post a labor data request for a specific time range\",\"description\":\"Creates a labor reporting data request for a specific time range.\\n\\nSpecify the time range with the `timeRange` path parameter.\\n\\nSpecify whether to include data from inactive restaurants using the `onlyInactiveRestaurants` query parameter.\\n\\nSpecify the `startBusinessDate` and `endBusinessDate` for the labor data in the message body.\\n\\nInclude information about which restaurants to include or exclude with the \\n`restaurantIds` and `excludedRestaurantIds` properties.\\n\\nInclude information about how to aggregate the data with the `groupBy` property.\\n\",\"operationId\":\"postLaborReportingDataSpecificTimeRangeRequest\",\"parameters\":[{\"name\":\"timeRange\",\"description\":\"The specific time range that you are requesting reporting data for.\\n\\nValid values:\\n\\n* `day` - The request covers a one day time range.\\n\\n* `week` - The request covers a time range of seven days or fewer.\\n\\n* `month` - The request covers a time range of 31 days or fewer.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"day\",\"week\",\"month\"]}},{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is \\nreturned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LaborReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the reporting metrics \\nrequest, included or excluded restaurants, and aggregation options.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Labor\"]}},\"/labor/{reportRequestGuid}\":{\"get\":{\"summary\":\"Get the labor reporting data\",\"description\":\"Returns the labor data for the reporting data request.\\n\\nSpecify the `reportRequestGuid` for the reporting data.\\n\",\"operationId\":\"getLaborReportingData\",\"parameters\":[{\"name\":\"reportRequestGuid\",\"description\":\"The Toast platform identifier for the reporting data request.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"The reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LaborReportingData\"}}}},\"202\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportingDataInProgress\"}}}},\"404\":{\"description\":\"An unexpected error occurred. Refer to the `message` attached to this error for more information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"409\":{\"description\":\"The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"},\"504\":{\"description\":\"The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Labor\"]}},\"/menu\":{\"post\":{\"summary\":\"Post a menu data request for a custom time range\",\"description\":\"Creates a menu reporting data request for a custom time range.\\n\\nUse the `onlyInactiveRestaurants` query parameter set to `true` to get data for inactive restaurants only.\\n\\nSpecify the `startBusinessDate` and `endBusinessDate` for the data in the message body.\\n\\nIdentify restaurants to include or exclude with the `restaurantIds` and \\n`excludedRestaurantIds` properties. If left blank, all restaurants are included by default.\\n\",\"operationId\":\"postMenuReportCustomTimeRange\",\"parameters\":[{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is returned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MenuReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the menu reporting data \\nrequest, included or excluded restaurants, and aggregation options.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Menu\"]}},\"/menu/{timeRange}\":{\"post\":{\"summary\":\"Post a menu reporting data request for a specific time range\",\"description\":\"Creates a menu reporting data request for a specific time range.\\n\\nSpecify the time range with the `timeRange` path parameter.\\n\\nSpecify whether to include data from inactive restaurants using the `onlyInactiveRestaurants` query parameter.\\n\\nSpecify the `startBusinessDate` and `endBusinessDate` for the menu data in the message body.\\n\\nInclude information about which restaurants to include or exclude with the \\n`restaurantIds` and `excludedRestaurantIds` properties.\\n\\nInclude information about how to aggregate the data with the `groupBy` property. You can only use the `groupBy` property when requesting\\ndata for a `day` or `week` time range.\\n\",\"operationId\":\"postMenuReportSpecificTimeRange\",\"parameters\":[{\"name\":\"timeRange\",\"description\":\"The specific time range that you are requesting reporting data for.\\n\\nValid values:\\n\\n* `day` - The request covers a one day time range.\\n\\n* `week` - The request covers a time range of seven days or fewer.\\n\\n* `month` - The request covers a time range of 31 days or fewer.\\n\\n* `year` - The request covers a time range of 366 days or fewer.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"day\",\"week\",\"month\",\"year\"]}},{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is \\nreturned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MenuReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the reporting data \\nrequest, included or excluded restaurants, and aggregation options.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Menu\"]}},\"/menu/{reportRequestGuid}\":{\"get\":{\"summary\":\"Get the menu reporting data\",\"description\":\"Returns the menu data for the reporting data request.\\n\\nSpecify the `reportRequestGuid` for the reporting data.\\n\",\"operationId\":\"getMenuReportingData\",\"parameters\":[{\"name\":\"reportRequestGuid\",\"description\":\"The Toast platform identifier for the reporting data request.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"The reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MenuReportingData\"}}}},\"202\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportingDataInProgress\"}}}},\"404\":{\"description\":\"An unexpected error occurred. Refer to the `message` attached to this error for more information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"409\":{\"description\":\"The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"},\"504\":{\"description\":\"The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Menu\"]}},\"/payout/{timeRange}\":{\"post\":{\"summary\":\"Post a payout data request organized by settled date for a specific time range\",\"description\":\"Creates a payout reporting data organized by settled date request for a specific time range.\\n\\nSpecify the time range with the `timeRange` path parameter.\\n\\nSpecify whether to include data from inactive restaurants using the `onlyInactiveRestaurants` query parameter.\\n\\nSpecify the `startDate` and `endDate` for the payout data in the message body.\\n\\nInclude information about which restaurants to include or exclude with the \\n`restaurantIds` and `excludedRestaurantIds` properties.\\n\",\"operationId\":\"postPayoutReportSettledDateSpecificTimeRange\",\"parameters\":[{\"name\":\"timeRange\",\"description\":\"The specific time range that you are requesting reporting data for.\\n\\nValid values:\\n\\n* `day` - The request covers a one day time range.\\n\\n* `week` - The request covers a time range of seven days or fewer.\\n\\n* `month` - The request covers a time range of 31 days or fewer.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"day\",\"week\",\"month\"]}},{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is \\nreturned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PayoutSettledDateReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the reporting data request and included or excluded restaurants.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Payout by settled date\"]}},\"/payout/{reportRequestGuid}\":{\"get\":{\"summary\":\"Get the payout reporting data organized by settled date\",\"description\":\"Returns the payout data organized by settled date for the reporting data request.\\n\\nSpecify the `reportRequestGuid` for the reporting data.\\n\",\"operationId\":\"getPayoutSettledDateReportingData\",\"parameters\":[{\"name\":\"reportRequestGuid\",\"description\":\"The Toast platform identifier for the reporting data request.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"The reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PayoutSettledDateReportingData\"}}}},\"202\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportingDataInProgress\"}}}},\"404\":{\"description\":\"An unexpected error occurred. Refer to the `message` attached to this error for more information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"409\":{\"description\":\"The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"},\"504\":{\"description\":\"The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Payout by settled date\"]}},\"/payout/payments/{timeRange}\":{\"post\":{\"summary\":\"Post a payout data request organized by payment for a specific time range\",\"description\":\"Creates a payout reporting data organized by payment request for a specific time range. Currently, `day` is the only \\nvalid value.\\n\\nSpecify whether to include data from inactive restaurants using the `onlyInactiveRestaurants` query parameter.\\n\\nSpecify the `startDate` and `endDate` for the payout payments data in the message body.\\n\\nInclude information about which restaurants to include or exclude with the \\n`restaurantIds` and `excludedRestaurantIds` properties.\\n\",\"operationId\":\"postPayoutReportPaymentsSpecificTimeRange\",\"parameters\":[{\"name\":\"timeRange\",\"description\":\"The specific time range that you are requesting the data for. Currently, `day` is the \\nonly valid value.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"day\"]}},{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is \\nreturned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PayoutPaymentsReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the reporting data request and included or excluded restaurants.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Payout by payments\"]}},\"/payout/payments/{reportRequestGuid}\":{\"get\":{\"summary\":\"Get the payout reporting data organized by payment\",\"description\":\"Returns the payout data organized by payments for the reporting data request.\\n\\nSpecify the `reportRequestGuid` for the reporting data.\\n\",\"operationId\":\"getPayoutPaymentsReportingData\",\"parameters\":[{\"name\":\"reportRequestGuid\",\"description\":\"The Toast platform identifier for the reporting data request.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"The reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PayoutPaymentsReportingData\"}}}},\"202\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportingDataInProgress\"}}}},\"404\":{\"description\":\"An unexpected error occurred. Refer to the `message` attached to this error for more information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"409\":{\"description\":\"The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"},\"504\":{\"description\":\"The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Payout by payments\"]}},\"/payout/sales-date/{timeRange}\":{\"post\":{\"summary\":\"Post a payout data request organized by sales date for a specific time range\",\"description\":\"Creates a payout reporting data organized by sales date request for a specific time range.\\n\\nSpecify the time range with the `timeRange` path parameter.\\n\\nSpecify whether to include data from inactive restaurants using the `onlyInactiveRestaurants` query parameter.\\n\\nSpecify the `startDate` and `endDate` for the payout data in the message body.\\n\\nInclude information about which restaurants to include or exclude with the \\n`restaurantIds` and `excludedRestaurantIds` properties.\\n\",\"operationId\":\"postPayoutReportSalesDateSpecificTimeRange\",\"parameters\":[{\"name\":\"timeRange\",\"description\":\"The specific time range that you are requesting reporting data for.\\n\\nValid values:\\n\\n* `day` - The request covers a one day time range.\\n\\n* `week` - The request covers a time range of seven days or fewer.\\n\\n* `month` - The request covers a time range of 31 days or fewer.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"day\",\"week\",\"month\"]}},{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is \\nreturned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PayoutSalesDateReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the reporting data request and included or excluded restaurants.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Payout by sales date\"]}},\"/payout/sales-date/{reportRequestGuid}\":{\"get\":{\"summary\":\"Get the payout reporting data organized by sales date\",\"description\":\"Returns the payout data organized by sales date for the reporting data request.\\n\\nSpecify the `reportRequestGuid` for the reporting data.\\n\",\"operationId\":\"getPayoutSalesDateReportingData\",\"parameters\":[{\"name\":\"reportRequestGuid\",\"description\":\"The Toast platform identifier for the reporting data request.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"The reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PayoutSalesDateReportingData\"}}}},\"202\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportingDataInProgress\"}}}},\"404\":{\"description\":\"An unexpected error occurred. Refer to the `message` attached to this error for more information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"409\":{\"description\":\"The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"},\"504\":{\"description\":\"The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Payout by sales date\"]}},\"/guest/payments/{timeRange}\":{\"post\":{\"summary\":\"Post a guest reporting data request organized by payment for a specific time range\",\"description\":\"Creates a guest reporting data organized by payment request for a specific time range.\\n\\nSpecify the time range with the `timeRange` path parameter.\\n\\nSpecify whether to include data from inactive restaurants using the `onlyInactiveRestaurants` query parameter.\\n\\nSpecify the `startDate` and `endDate` for the guest data in the message body.\\n\\nInclude information about which restaurants to include or exclude with the \\n`restaurantIds` and `excludedRestaurantIds` properties.\\n\",\"operationId\":\"postGuestReportPaymentDateSpecificTimeRange\",\"parameters\":[{\"name\":\"timeRange\",\"description\":\"The specific time range that you are requesting reporting data for.\\n\\nValid values:\\n\\n* `day` - The request covers a one day time range.\\n\\n* `week` - The request covers a time range of seven days or fewer.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"day\",\"week\"]}},{\"name\":\"onlyInactiveRestaurants\",\"description\":\"Specifies whether the data is for inactive restaurants only. Active restaurant data is \\nreturned by default.\\n\\nValid values:\\n\\n* `true` - The data retrieved is for inactive restaurants only.\\n\\n* `false` - The data retrieved is for active restaurants only.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GuestPaymentsReportingDataRequest\"}}},\"description\":\"A JSON object containing the starting and ending dates for the reporting data request and included or excluded restaurants.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The `reportRequestGuid` used to retrieve the reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportRequestGuid\"}}}},\"400\":{\"description\":\"The request contains invalid information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Guest\"]}},\"/guest/payments/{reportRequestGuid}\":{\"get\":{\"summary\":\"Get the guest reporting data organized by payment\",\"description\":\"Returns the guest data organized by payment for the reporting data request.\\n\\nSpecify the `reportRequestGuid` for the reporting data.\\n\",\"operationId\":\"getGuestByPaymentDateReportingData\",\"parameters\":[{\"name\":\"reportRequestGuid\",\"description\":\"The Toast platform identifier for the reporting data request.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"The reporting data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GuestPaymentsReportingData\"}}}},\"202\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReportingDataInProgress\"}}}},\"404\":{\"description\":\"An unexpected error occurred. Refer to the `message` attached to this error for more information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}},\"409\":{\"description\":\"The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` attached to this error can be referenced by\\nthe Toast support team.\\n\"},\"504\":{\"description\":\"The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.\"}},\"security\":[{\"oauth2\":[\"enterprise-metrics:read\"]}],\"tags\":[\"Guest\"]}}},\"x-components\":{},\"servers\":[{\"url\":\"https://toast-api-server/era/v1\"}],\"components\":{\"securitySchemes\":{\"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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"enterprise-metrics:read\":\"Allows reading from the analytics API.\\n\"}}}}},\"schemas\":{\"MetricsReportingDataRequest\":{\"description\":\"Information about what the aggregated sales reporting data covers and how it is presented. This includes \\nthe starting and ending dates of the time range, the included or excluded restaurants, and \\naggregation options.\\n\",\"type\":\"object\",\"properties\":{\"startBusinessDate\":{\"description\":\"The starting date of the time range for the reporting data.\\n\\nSpecify the business day in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"endBusinessDate\":{\"description\":\"The ending date of the time range for the reporting data.\\n\\nSpecify the business day in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"restaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to include in the \\nreporting data. If used, only the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is included. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"},\"type\":\"array\"},\"excludedRestaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to exclude from the \\nreporting data. If used, the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is excluded. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"UUID\",\"type\":\"string\"},\"type\":\"array\"},\"groupBy\":{\"description\":\"The way the reporting data results are aggregated. You can use up to two values at a time.\\n\\nValid values:\\n\\n* `DINING_OPTION` - The reporting data is grouped by dining option.\\n* `ORDER_SOURCE` - The reporting data is grouped by order source.\\n* `REVENUE_CENTER` - The reporting data is grouped by revenue center.\\n\",\"items\":{\"enum\":[\"REVENUE_CENTER\",\"DINING_OPTION\",\"ORDER_SOURCE\"],\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"restaurantIds\",\"excludedRestaurantIds\",\"startBusinessDate\",\"endBusinessDate\"]},\"MetricsReportingData\":{\"description\":\"The aggregated sales reporting data.\",\"type\":\"object\",\"properties\":{\"restaurantGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a restaurant location.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"businessDate\":{\"description\":\"The date for the aggregated reporting data. The business \\nday uses the YYYYMMDD format. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"string\"},\"guestCount\":{\"description\":\"The total number of guests recorded across all orders.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"voidOrdersCount\":{\"description\":\"The total number of orders with at least one voided item.\",\"format\":\"integer\",\"type\":\"number\"},\"discountOrderCount\":{\"description\":\"The total number of orders that have at least one discount.\",\"format\":\"integer\",\"type\":\"number\"},\"ordersCount\":{\"description\":\"The total number of orders that were not voided.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"openOrderCount\":{\"description\":\"The total number of open orders.\",\"format\":\"integer\",\"type\":\"number\"},\"closedOrderCount\":{\"description\":\"The total number of closed orders.\",\"format\":\"integer\",\"type\":\"number\"},\"netSalesAmount\":{\"description\":\"The total sales, excluding tax, gratuity, tips, discounts, refunds, and \\ndeferred amounts.\\n\",\"format\":\"double\",\"type\":\"number\"},\"grossSalesAmount\":{\"description\":\"The total sales, including discounts and refunds.\",\"format\":\"double\",\"type\":\"number\"},\"discountAmount\":{\"description\":\"The total amount of discounts for orders.\",\"format\":\"double\",\"type\":\"number\"},\"voidOrdersAmount\":{\"description\":\"The total amount of voided items.\",\"format\":\"double\",\"type\":\"number\"},\"refundAmount\":{\"description\":\"The total amount of refunded sales.\",\"format\":\"double\",\"type\":\"number\"},\"avgOrderValue\":{\"description\":\"The average amount for an order.\",\"format\":\"double\",\"type\":\"number\"},\"revenueCenter\":{\"description\":\"The revenue center for the data. This property only appears when the \\nrequest for reporting data includes the `groupBy` property with\\nvalue `REVENUE_CENTER`.\\n\",\"type\":\"string\"},\"diningOption\":{\"description\":\"The dining option for the data. This property only appears when the \\nrequest for reporting data includes the `groupBy` property with\\nvalue `DINING_OPTION`.\\n\",\"type\":\"string\"},\"orderSource\":{\"description\":\"The method used to place an order, also known as the order source. This property\\nonly appears when the request for reporting data includes the `groupBy` property \\nwith value `ORDER_SOURCE`.\\n\\nValid values:\\n* `API`\\n* `BRANDED_ONLINE_ORDERING`\\n* `CALLER_ID`\\n* `CATERING`\\n* `CATERING_ONLINE_ORDERING`\\n* `GOOGLE`\\n* `GRUBHUB` (deprecated)\\n* `IN_STORE`\\n* `INVOICE`\\n* `KIOSK`\\n* `ONLINE`\\n* `ORDER_AND_PAY_AT_TABLE`\\n* `TOAST_LOCAL`\\n* `TOAST_PICKUP_APP`\\n* `TOAST_TABLES`\\n\"},\"businessHour\":{\"description\":\"The hour the data represents. This property only appears when the `aggregateBy` \\nquery parameter is set to `HOUR` in the `POST` request for creating the reporting\\nmetrics request. The hour number corresponds to the 24 hours of the day, starting \\nat 0 and ending at 23.\\n\",\"format\":\"integer\",\"type\":\"string\"},\"hourlyJobTotalHours\":{\"description\":\"The total hours worked by employees with hourly jobs. This does not include breaks.\\n\",\"format\":\"double\",\"type\":\"string\"},\"hourlyJobTotalPay\":{\"description\":\"The total wages earned by employees with hourly jobs, including overtime pay. This does not include tips.\\n\",\"format\":\"double\",\"type\":\"string\"},\"hourlyJobSalesPerLaborHour\":{\"description\":\"The average net sales for each hour worked by employees with hourly jobs.\\n\",\"format\":\"double\",\"type\":\"string\"},\"restaurantName\":{\"description\":\"The restaurant's name. This property is only included when\\nthe `fetchRestaurantNames` parameter is set to `true` in the `GET` request.\\n\",\"format\":\"string\",\"type\":\"string\"}}},\"RestaurantsGuidName\":{\"description\":\"Information about a restaurant in the management group.\",\"type\":\"object\",\"properties\":{\"restaurantGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a restaurant location.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"restaurantName\":{\"description\":\"The restaurant's name.\",\"format\":\"string\",\"type\":\"string\"},\"active\":{\"description\":\"Indicates whether the restaurant is activated or not.\\n\\nValid values:\\n\\n* `true` - The restaurant is activated.\\n\\n* `false` - The restaurant is deactivated.\\n\",\"format\":\"boolean\",\"type\":\"boolean\"},\"testMode\":{\"description\":\"Indicates whether the restaurant is in test mode or not.\\n\\nValid values:\\n\\n* `true` - The restaurant is in test mode.\\n\\n* `false` - The restaurant is not in test mode.\\n\",\"format\":\"boolean\",\"type\":\"boolean\"},\"archived\":{\"description\":\"Indicates whether the restaurant is archived or not.\\n\\nValid values:\\n\\n* `true` - The restaurant is archived.\\n\\n* `false` - The restaurant is not archived.\\n\",\"format\":\"boolean\",\"type\":\"boolean\"}}},\"CheckReportingDataRequest\":{\"description\":\"Information about what the check reporting data covers and how it is presented. This includes\\nthe starting and ending dates of the time range, and the included or excluded restaurants.\\n\",\"type\":\"object\",\"properties\":{\"startBusinessDate\":{\"description\":\"The starting date of the time range for the reporting data.\\n\\nSpecify the business day in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"endBusinessDate\":{\"description\":\"The ending date of the time range for the reporting data.\\n\\nSpecify the business day in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"restaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to include in the \\nreporting data. If used, only the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is included. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"},\"type\":\"array\"},\"excludedRestaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to exclude from the \\nreporting data. If used, the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is excluded. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"UUID\",\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"restaurantIds\",\"excludedRestaurantIds\",\"startBusinessDate\",\"endBusinessDate\"]},\"CheckReportingData\":{\"description\":\"The check reporting data.\",\"type\":\"object\",\"properties\":{\"restaurantGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a restaurant location.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"orderNumber\":{\"description\":\"The number of the order.\",\"format\":\"long\",\"type\":\"number\"},\"orderGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify an order.\",\"format\":\"UUID\",\"type\":\"string\"},\"checkNumber\":{\"description\":\"The number of the check.\",\"format\":\"long\",\"type\":\"number\"},\"checkGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a check.\",\"format\":\"UUID\",\"type\":\"string\"},\"orderOpenDate\":{\"description\":\"The business date for when the order is initially expected to be fulfilled. The business \\ndate uses the YYYYMMDD format. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"string\"},\"checkPaidDateTime\":{\"description\":\"The business date and time that the check was paid.\",\"format\":\"date-time\",\"type\":\"string\"},\"checkModifiedDateTime\":{\"description\":\"The business date and time that the check was modified.\",\"format\":\"date-time\",\"type\":\"string\"},\"checkStatus\":{\"description\":\"The state of the check. \\n\\nValid values:\\n\\n* `OPEN` - The check is open and unpaid.\\n\\n* `PAID` - The check is initially paid, but the payment is not finalized.\\n\\n* `CLOSED` - The check payment is finalized.\\n\",\"format\":\"text\",\"type\":\"string\"},\"checkVoidedStatus\":{\"description\":\"Indicates whether the check is void or not.\\n\\nValid values:\\n\\n* `true` - The check is void.\\n\\n* `false` - The check is not void.\\n\",\"format\":\"boolean\",\"type\":\"boolean\"},\"diningOption\":{\"description\":\"The dining option for the data.\\n\",\"type\":\"string\"},\"revenueCenter\":{\"description\":\"The revenue center for the data.\\n\",\"type\":\"string\"},\"serverName\":{\"description\":\"The first and last name of the employee who initially created the order associated with the check.\",\"type\":\"string\"},\"checkTotalAmount\":{\"description\":\"The sum of the cost of each item applied to a check, taking into account the item quantity.\\nThis includes taxes, services charges, tip, and refunds applied to the check.\\n\",\"format\":\"double\",\"type\":\"number\"},\"checkDiscountAmount\":{\"description\":\"The total discount amount applied to the check or to associated items on the check.\",\"format\":\"double\",\"type\":\"number\"},\"checkTaxAmount\":{\"description\":\"The calculated tax amount applied to the check. This includes any service charge and item-level taxes.\",\"format\":\"double\",\"type\":\"number\"},\"checkTipAmount\":{\"description\":\"The tip amount applied to the check.\",\"format\":\"double\",\"type\":\"number\"},\"checkGratuityAmount\":{\"description\":\"The gratuity amount applied to the check.\",\"format\":\"double\",\"type\":\"number\"},\"checkRefundAmount\":{\"description\":\"The refund amount applied to the check.\",\"format\":\"double\",\"type\":\"number\"},\"restaurantName\":{\"description\":\"The restaurant's name. This property is only included when\\nthe `fetchRestaurantNames` parameter is set to `true` in the `GET` request.\\n\",\"format\":\"string\",\"type\":\"string\"}}},\"LaborReportingDataRequest\":{\"description\":\"Information about what the labor data covers and how it is presented. This includes \\nthe starting and ending dates of the time range, the included or excluded restaurants, and \\naggregation options.\\n\",\"type\":\"object\",\"properties\":{\"startBusinessDate\":{\"description\":\"The starting date of the time range for the reporting data.\\n\\nSpecify the business day in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"endBusinessDate\":{\"description\":\"The ending date of the time range for the reporting data.\\n\\nSpecify the business day in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"restaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to include in the \\nreporting data. If used, only the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is included. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"},\"type\":\"array\"},\"excludedRestaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to exclude from the \\nreporting data. If used, the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is excluded. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"UUID\",\"type\":\"string\"},\"type\":\"array\"},\"groupBy\":{\"description\":\"The way the reporting data results are aggregated.\\n\\nValid values:\\n\\n* `JOB` - The reporting data is grouped by job.\\n\\n* `EMPLOYEE` - The reporting data is grouped by employee.\\n\",\"type\":\"array\",\"items\":{\"enum\":[\"JOB\",\"EMPLOYEE\"],\"type\":\"string\"}}},\"required\":[\"restaurantIds\",\"excludedRestaurantIds\",\"startBusinessDate\",\"endBusinessDate\"]},\"LaborReportingData\":{\"description\":\"The labor reporting data.\",\"type\":\"object\",\"properties\":{\"businessDate\":{\"description\":\"The date for the aggregated reporting data. The business \\nday uses the YYYYMMDD format. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"string\"},\"restaurantGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a restaurant location.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"restaurantName\":{\"description\":\"The restaurant's name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationName\":{\"description\":\"The restaurant's location name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationCode\":{\"description\":\"The restaurant's location code.\\n\",\"format\":\"string\",\"type\":\"string\"},\"regularHours\":{\"description\":\"The total regular hours logged between clock-in and clock-out for employees with hourly jobs. This does not include overtime hours.\\n\",\"format\":\"double\",\"type\":\"number\"},\"overtimeHours\":{\"description\":\"The total overtime hours logged between clock-in and clock-out for employees with hourly jobs. This only includes overtime hours.\\n\",\"format\":\"double\",\"type\":\"number\"},\"totalHours\":{\"description\":\"The total hours logged between clock-in and clock-out for employees with hourly jobs. This includes regular and overtime hours.\\n\",\"format\":\"double\",\"type\":\"number\"},\"regularCost\":{\"description\":\"The operation costs related to employees with hourly jobs from all regular hours, including all shifts.\",\"format\":\"double\",\"type\":\"number\"},\"overtimeCost\":{\"description\":\"The operation costs related to employees with hourly jobs from all overtime hours, including all shifts.\",\"format\":\"double\",\"type\":\"number\"},\"totalCost\":{\"description\":\"The operation costs related to employees with hourly jobs from all work hours, including all shifts.\",\"format\":\"double\",\"type\":\"number\"},\"netSalesAmount\":{\"description\":\"The total sales, excluding tax, gratuity, tips, discounts, refunds, and \\ndeferred amounts. This property is only included when no `groupBy` value is specified.\\n\",\"format\":\"double\",\"type\":\"number\"},\"grossSalesAmount\":{\"description\":\"The total sales, including discounts and refunds. This property is only included when no `groupBy` value is specified.\\n\",\"format\":\"double\",\"type\":\"number\"},\"netSalesPerEmployeeHour\":{\"description\":\"The average of the location's total net sales for each hour clocked by an employee. This property is only included when no `groupBy` value is specified.\\n\",\"format\":\"double\",\"type\":\"number\"},\"grossSalesPerEmployeeHour\":{\"description\":\"The average of the location's total gross sales for each hour clocked by an employee. This property is only included when no `groupBy` value is specified.\\n\",\"format\":\"double\",\"type\":\"number\"},\"totalCostPerNetSales\":{\"description\":\"The ratio of employee operational costs compared to total net sales, expressed as a percentage.\\n\",\"format\":\"double\",\"type\":\"number\"},\"totalCostPerGrossSales\":{\"description\":\"The ratio of employee operational costs compared to gross sales, expressed as a percentage.\\n\",\"format\":\"double\",\"type\":\"number\"},\"jobGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a job. This property only appears when the request for labor data includes the `groupBy` property with value `JOB`.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"jobTitle\":{\"description\":\"The guest-facing job name. This property only appears when the request for labor data includes the `groupBy` property with value `JOB`.\\n\",\"type\":\"string\"},\"jobCode\":{\"description\":\"The guest-facing job code. This property only appears when the request for labor data includes the `groupBy` property with value `JOB`.\\n\",\"type\":\"string\"},\"employeeGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify an employee. This property only appears when the request for labor data includes the `groupBy` property with value `EMPLOYEE`.\\n\",\"type\":\"string\"},\"employeeFirstName\":{\"description\":\"The employee's first name. This property only appears when the request for labor data includes the `groupBy` property with value `EMPLOYEE`.\\n\",\"type\":\"string\"},\"employeeLastName\":{\"description\":\"The employee's last name. This property only appears when the request for labor data includes the `groupBy` property with value `EMPLOYEE`.\\n\",\"type\":\"string\"},\"employeeChosenName\":{\"description\":\"The employee's chosen name. This property only appears when the request for labor data includes the `groupBy` property with value `EMPLOYEE`.\\n\",\"type\":\"string\"}}},\"MenuReportingDataRequest\":{\"description\":\"Information about what the menu data covers and how it is presented. This includes \\nthe starting and ending dates of the time range, the included or excluded restaurants, and \\naggregation options.\\n\",\"type\":\"object\",\"properties\":{\"startBusinessDate\":{\"description\":\"The starting date of the time range for the reporting data.\\n\\nSpecify the business day in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"endBusinessDate\":{\"description\":\"The ending date of the time range for the reporting data.\\n\\nSpecify the business day in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"restaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to include in the \\nreporting data. If used, only the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is included. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"},\"type\":\"array\"},\"excludedRestaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to exclude from the \\nreporting data. If used, the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is excluded. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"UUID\",\"type\":\"string\"},\"type\":\"array\"},\"groupBy\":{\"description\":\"The way the reporting data results are aggregated.\\nYou can only use the `groupBy` property when requesting data for a `day` or `week` time range.\\n\\nValid values:\\n\\n* `MENU` - The reporting data is grouped by menu.\\n\\n* `MENU_GROUP` - The reporting data is grouped by menu group.\\n\\n* `MENU_ITEM` - The reporting data is grouped by menu item.\\n\\n* `MODIFIER` - The reporting data is grouped by modifier.\\n\",\"type\":\"array\",\"items\":{\"enum\":[\"MENU\",\"MENU_GROUP\",\"MENU_ITEM\",\"MODIFIER\"],\"type\":\"string\"}}},\"required\":[\"restaurantIds\",\"excludedRestaurantIds\",\"startBusinessDate\",\"endBusinessDate\"]},\"MenuReportingData\":{\"description\":\"The menu reporting data.\",\"type\":\"object\",\"properties\":{\"businessDate\":{\"description\":\"The date for the menu reporting data. The business day uses the YYYYMMDD format. For example, 20220824.\\n\",\"format\":\"integer\",\"type\":\"string\"},\"restaurantGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a restaurant location.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"restaurantName\":{\"description\":\"The restaurant’s name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationName\":{\"description\":\"The restaurant’s location name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationCode\":{\"description\":\"The restaurant’s location code.\\n\",\"format\":\"string\",\"type\":\"string\"},\"netSalesAmount\":{\"description\":\"The total sales, excluding tax, gratuity, tips, discounts, refunds, and deferred amounts.\\n\",\"format\":\"double\",\"type\":\"number\"},\"grossSalesAmount\":{\"description\":\"The total sales, including discounts and refunds.\\n\",\"format\":\"double\",\"type\":\"number\"},\"discountAmount\":{\"description\":\"The total amount of discounts.\",\"format\":\"double\",\"type\":\"number\"},\"refundAmount\":{\"description\":\"The total amount of refunded sales.\",\"format\":\"double\",\"type\":\"number\"},\"voidAmount\":{\"description\":\"The total amount of voided sales.\",\"format\":\"double\",\"type\":\"number\"},\"quantitySold\":{\"description\":\"The number of line items sold. This number includes items that were made but later refunded.\\nWhen grouping by `MENU`, `MENU_GROUP`, or `MENU_ITEM`, this is the count of the associated menu items and includes any modifiers.\\nWhen grouping by `MODIFIER`, this is the count of the modifier.\\n\",\"format\":\"double\",\"type\":\"number\"},\"averagePrice\":{\"description\":\"The average price of the associated line items.\\nWhen grouping by `MENU`, `MENU_GROUP`, or `MENU_ITEM`, this is the average price for the menu item and any associated modifiers.\\nWhen grouping by `MODIFIER`, this is the average price for the modifier.\\n\",\"format\":\"double\",\"type\":\"number\"},\"wasteCount\":{\"description\":\"The number of line items tracked as food waste.\\nWhen grouping by `MENU`, `MENU_GROUP`, or `MENU_ITEM`, this is the count of the associated menu items and does not include modifiers.\\nWhen grouping by `MODIFIER`, this is the count of the modifier.\\n\",\"format\":\"double\",\"type\":\"number\"},\"wasteAmount\":{\"description\":\"The total amount of menu items tracked as food waste.\\nWhen grouping by `MENU`, `MENU_GROUP`, or `MENU_ITEM`, this is the total price for the menu items and any associated modifiers.\\nWhen grouping by `MODIFIER`, this is the total price for the modifiers.\\n\",\"format\":\"double\",\"type\":\"number\"},\"menuGuid\":{\"description\":\"The identifier for the menu, assigned by the Toast platform.\\nThis property appears when the request for menu data includes the groupBy property with value MENU.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"menuName\":{\"description\":\"The name of the menu. This property appears when the request for menu data includes the groupBy property with value MENU.\",\"format\":\"string\",\"type\":\"string\"},\"menuGroupGuid\":{\"description\":\"The identifier for the menu group, assigned by the Toast platform.\\nThis property appears when the request for menu data includes the groupBy property with value MENU_GROUP.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"menuGroupName\":{\"description\":\"The name of the menu group. This property appears when the request for menu data includes the groupBy property with value MENU_GROUP.\",\"format\":\"string\",\"type\":\"string\"},\"menuItemGuid\":{\"description\":\"The identifier for the menu item, assigned by the Toast platform.\\nThis property appears when the request for menu data includes the groupBy property with value MENU_ITEM.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"menuItemName\":{\"description\":\"The name of the menu item. This property appears when the request for menu data includes the groupBy property with value MENU_ITEM.\",\"format\":\"string\",\"type\":\"string\"},\"modifierGuid\":{\"description\":\"The identifier for the modifier, assigned by the Toast platform.\\nThis property appears when the request for menu data includes the groupBy property with value MODIFIER.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"modifierName\":{\"description\":\"The name of the modifier. This property appears when the request for menu data includes the groupBy property with value MODIFIER.\",\"format\":\"string\",\"type\":\"string\"}}},\"PayoutSettledDateReportingDataRequest\":{\"description\":\"Information about what the payout data organized by settled date covers and how it is presented. This includes \\nthe starting and ending dates of the time range and the included or excluded restaurants.\\n\",\"type\":\"object\",\"properties\":{\"startDate\":{\"description\":\"The starting date of the time range for the reporting data.\\n\\nSpecify the date in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"endDate\":{\"description\":\"The ending date of the time range for the reporting data.\\n\\nSpecify the date in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"restaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to include in the \\nreporting data. If used, only the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is included. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"},\"type\":\"array\"},\"excludedRestaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to exclude from the \\nreporting data. If used, the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is excluded. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"UUID\",\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"restaurantIds\",\"excludedRestaurantIds\",\"startDate\",\"endDate\"]},\"PayoutSettledDateReportingData\":{\"description\":\"The payout reporting data organized by settled date.\",\"type\":\"object\",\"properties\":{\"restaurantGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a restaurant location.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"restaurantName\":{\"description\":\"The restaurant’s name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationName\":{\"description\":\"The restaurant’s location name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationCode\":{\"description\":\"The restaurant’s location code.\\n\",\"format\":\"string\",\"type\":\"string\"},\"settledDate\":{\"description\":\"The date when the payout was either processed or settled.\\n\",\"format\":\"integer\",\"type\":\"string\"},\"salesPeriodStartDateTime\":{\"description\":\"The date and time of the first payment included in the payout amount.\\n\",\"format\":\"string\",\"type\":\"string\"},\"salesPeriodEndDateTime\":{\"description\":\"The date and time of the last payment included in the payout amount.\\n\",\"format\":\"string\",\"type\":\"string\"},\"transactionCount\":{\"description\":\"The number of transactions included in the payout.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"paymentAmount\":{\"description\":\"The amount paid to the restaurant by guests using cards that contributes towards the payout amount.\\n\",\"format\":\"double\",\"type\":\"number\"},\"refundAmount\":{\"description\":\"The amount refunded to guests by the restaurant that contributes towards the payout amount.\\n\",\"format\":\"double\",\"type\":\"number\"},\"totalFeeAmount\":{\"description\":\"The amount paid or owed by the restaurant in fees that contributes towards the payout amount. An example is the processing fees charged by card providers on payments.\\n\",\"format\":\"double\",\"type\":\"number\"},\"withholdingAmount\":{\"description\":\"The amount owed to Toast by the restaurant for products and services. For example, this includes Toast Capital, Fundraising, and Instant Deposit.\\n\",\"format\":\"double\",\"type\":\"number\"},\"payoutAmount\":{\"description\":\"The amount to be deposited into the restaurant’s account. This amount is calculated by subtracting the refund, fee, and withholding amounts from the payment amount.\\n\",\"format\":\"double\",\"type\":\"number\"},\"payoutStatus\":{\"description\":\"The status of the payout.\\n\\nValid values:\\n\\n* `CAPTURED` - Toast collected the guest card payments included in the payout successfully.\\n* `SENT` - Toast sent the payout to the bank. It may take some time to appear in the account.\\n* `NONE` - The payout was made prior to January 10, 2024 and is unavailable.\\n\",\"format\":\"string\",\"type\":\"string\"}}},\"PayoutPaymentsReportingDataRequest\":{\"description\":\"Information about what the payout data organized by payments covers and how it is presented. This includes the \\nstarting and ending dates of the time range, and the included or excluded restaurants.\\n\",\"type\":\"object\",\"properties\":{\"startDate\":{\"description\":\"The starting date of the time range for the reporting data.\\n\\nSpecify the date in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"endDate\":{\"description\":\"The ending date of the time range for the reporting data.\\n\\nSpecify the date in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"restaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to include in the \\nreporting data. If used, only the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is included. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"},\"type\":\"array\"},\"excludedRestaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to exclude from the \\nreporting data. If used, the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is excluded. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"UUID\",\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"restaurantIds\",\"excludedRestaurantIds\",\"startDate\",\"endDate\"]},\"PayoutPaymentsReportingData\":{\"description\":\"The payout reporting data organized by payments.\",\"type\":\"object\",\"properties\":{\"restaurantGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a restaurant location.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"restaurantName\":{\"description\":\"The restaurant’s name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationName\":{\"description\":\"The restaurant’s location name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationCode\":{\"description\":\"The restaurant’s location code.\\n\",\"format\":\"string\",\"type\":\"string\"},\"orderGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify an order. This is the order associated with the payment.\",\"format\":\"UUID\",\"type\":\"string\"},\"checkGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a check. This is the check associated with the payment.\",\"format\":\"UUID\",\"type\":\"string\"},\"paymentGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify the payment.\",\"format\":\"UUID\",\"type\":\"string\"},\"settledDate\":{\"description\":\"The date when the payouts associated with the payment were either processed or settled.\\n\",\"format\":\"integer\",\"type\":\"string\"},\"orderOpenDateTime\":{\"description\":\"The date and time when the order associated with the payment was opened.\\n\",\"format\":\"string\",\"type\":\"string\"},\"paidDateTime\":{\"description\":\"The date and time when the order associated with the payment was paid.\\n\",\"format\":\"string\",\"type\":\"string\"},\"paymentCardBrand\":{\"description\":\"The brand or card provider of the card used to complete the payment.\\n\",\"format\":\"string\",\"type\":\"string\"},\"paymentCardType\":{\"description\":\"The payment type used by the card completing the payment.\\n\",\"format\":\"string\",\"type\":\"string\"},\"tipAmount\":{\"description\":\"The tip amount added to the payment.\\n\",\"format\":\"double\",\"type\":\"number\"},\"gratuityAmount\":{\"description\":\"The gratuity amount added to the payment.\\n\",\"format\":\"double\",\"type\":\"number\"},\"paymentSubtotal\":{\"description\":\"The total amount after excluding tip and gratuity.\\n\",\"format\":\"double\",\"type\":\"number\"},\"paymentTotal\":{\"description\":\"Total payment that was made on the order.This value includes tip and gratuity.\\n\",\"format\":\"double\",\"type\":\"number\"}}},\"PayoutSalesDateReportingDataRequest\":{\"description\":\"Information about what the payout data organized by sales date covers and how it is presented.\\nThis includes the starting and ending dates of the time range, and the included or excluded restaurants.\\n\",\"type\":\"object\",\"properties\":{\"startDate\":{\"description\":\"The starting date of the time range for the reporting data.\\nSpecify the date in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"endDate\":{\"description\":\"The ending date of the time range for the reporting data.\\nSpecify the date in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"restaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to include in the \\nreporting data. If used, only the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is included. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"},\"type\":\"array\"},\"excludedRestaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to exclude from the \\nreporting data. If used, the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is excluded. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"UUID\",\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"restaurantIds\",\"excludedRestaurantIds\",\"startDate\",\"endDate\"]},\"PayoutSalesDateReportingData\":{\"description\":\"The payout reporting data organized by sales date.\",\"type\":\"object\",\"properties\":{\"restaurantGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a restaurant location.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"restaurantName\":{\"description\":\"The restaurant’s name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationName\":{\"description\":\"The restaurant’s location name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationCode\":{\"description\":\"The restaurant’s location code.\\n\",\"format\":\"string\",\"type\":\"string\"},\"salesDate\":{\"description\":\"The date when the payment was completed. The sales date is considered the same as the order payment date.\\n\",\"format\":\"integer\",\"type\":\"string\"},\"settledDates\":{\"description\":\"The date when the payouts associated with the payment were either processed or settled.\\n\",\"items\":{\"format\":\"integer\",\"type\":\"string\"},\"type\":\"array\"},\"transactionCount\":{\"description\":\"The number of transactions made on the sales date.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"paymentAmount\":{\"description\":\"The amount paid to the restaurant by guests using cards on the sales date.\\n\",\"format\":\"double\",\"type\":\"number\"},\"refundAmount\":{\"description\":\"The amount refunded to guests by the restaurant for payments made on the sales date.\\n\",\"format\":\"double\",\"type\":\"number\"},\"totalFeeAmount\":{\"description\":\"The amount paid or owed by the restaurant in fees associated with payments made on the sales date.\\nAn example is the processing fees charged by card providers on payments.\\n\",\"format\":\"double\",\"type\":\"number\"},\"withholdingAmount\":{\"description\":\"The amount owed to Toast by the restaurant for products and services. For example, this includes Toast Capital, Fundraising, and Instant Deposit.\\n\",\"format\":\"double\",\"type\":\"number\"},\"payoutAmount\":{\"description\":\"The amount to be deposited into the restaurant’s account. This amount is calculated by subtracting the refund, fee, and withholding amounts from the payment amount.\\n\",\"format\":\"double\",\"type\":\"number\"}}},\"GuestPaymentsReportingDataRequest\":{\"description\":\"Information about what the guest data organized by payment covers and how it is presented. This includes \\nthe starting and ending dates of the time range and the included or excluded restaurants.\\n\",\"type\":\"object\",\"properties\":{\"startDate\":{\"description\":\"The starting date of the time range for the reporting data.\\n\\nSpecify the date in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"endDate\":{\"description\":\"The ending date of the time range for the reporting data.\\n\\nSpecify the date in the format YYYYMMDD. For example, `20220824`.\\n\",\"format\":\"integer\",\"type\":\"number\"},\"restaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to include in the \\nreporting data. If used, only the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is included. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"},\"type\":\"array\"},\"excludedRestaurantIds\":{\"description\":\"The `restaurantGuid` values of specific restaurants in the management group to exclude from the \\nreporting data. If used, the data for listed restaurants in the management group \\nthat are identified by `restaurantGuid` is excluded. If left blank, all restaurants are included \\nby default.\\n\",\"items\":{\"format\":\"UUID\",\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"restaurantIds\",\"excludedRestaurantIds\",\"startDate\",\"endDate\"]},\"GuestPaymentsReportingData\":{\"description\":\"The guest reporting data organized by payment.\",\"type\":\"object\",\"properties\":{\"restaurantGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify a restaurant location.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"restaurantName\":{\"description\":\"The restaurant’s name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationName\":{\"description\":\"The restaurant’s location name.\\n\",\"format\":\"string\",\"type\":\"string\"},\"restaurantLocationCode\":{\"description\":\"The restaurant’s location code.\\n\",\"format\":\"string\",\"type\":\"string\"},\"paymentDate\":{\"description\":\"The date when the payment was processed.\\n\",\"format\":\"integer\",\"type\":\"string\"},\"orderGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify an order.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"paymentGuid\":{\"description\":\"The identifier assigned by the Toast platform used to identify the payment.\\n\",\"format\":\"UUID\",\"type\":\"string\"},\"cardFingerprint\":{\"description\":\"The identifier assigned by the Toast platform used to identify a guest's payment card.\\n\",\"format\":\"UUID\",\"type\":\"string\"}}},\"ReportingDataInProgress\":{\"description\":\"The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.\",\"type\":\"object\",\"properties\":{\"message\":{\"description\":\"A brief message describing that the reporting data is still in progress and to try again at a later time.\",\"format\":\"string\",\"type\":\"string\"},\"reportStatus\":{\"description\":\"Reflects the in progress status of the reporting data using the IN_PROGRESS value.\",\"format\":\"text\",\"type\":\"string\"},\"reportRequestGuid\":{\"description\":\"The Toast platform assigned identifier used to identify a specific analytics reporting data request.\",\"format\":\"UUID\",\"type\":\"string\"}}},\"ReportRequestGuid\":{\"description\":\"The Toast platform assigned identifier used to identify a specific analytics reporting data request.\",\"format\":\"UUID\",\"type\":\"string\"},\"ErrorMessage\":{\"type\":\"object\",\"description\":\"Information about an unsuccessful REST request.\",\"properties\":{\"status\":{\"description\":\"The HTTP status code.\",\"format\":\"integer\",\"type\":\"number\"},\"code\":{\"description\":\"The service-specific result code.\",\"format\":\"integer\",\"type\":\"number\"},\"message\":{\"description\":\"A brief message describing the error.\",\"type\":\"string\"},\"messageKey\":{\"description\":\"Reserved for future use.\",\"type\":\"string\"},\"fieldName\":{\"description\":\"Reserved for future use.\",\"type\":\"string\"},\"link\":{\"description\":\"The URL of a Toast page that provides more information about the error.\",\"format\":\"URL\",\"type\":\"string\"},\"requestId\":{\"description\":\"The identifier of the HTTP request that generated the error.\",\"format\":\"UUID\",\"type\":\"string\"},\"developerMessage\":{\"description\":\"Optional, technical information to help a developer investigate the cause of the error.\",\"type\":\"string\"},\"errors\":{\"description\":\"A list of JSON `ErrorMessage` objects.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"canRetry\":{\"description\":\"Reserved for future use.\",\"type\":\"string\"}}}}}}},\"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,\"downloadFileName\":\"toast-analytics-api.yaml\",\"downloadDefinitionUrl\":\"https://doc.toasttab.com/toast-api-specifications/toast-reporting-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\":{}}}}}","permission":"guest","lastModified":"2025-07-21T15:04:17.000Z","redocInfoPageId":"analytics.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/analytics.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"analytics","isDefault":true,"id":"analytics","title":"analytics","link":null}]},{"id":"7e49d9d6-61ce-50d1-a0e5-916b4f87a97boverview/__redocly content redirect/authentication/overview/","definitionId":"authentication","link":"/authentication/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/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"},{"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-authentication-api.yaml"},"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\"},{\"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-authentication-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"authentication.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/authentication.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"authentication","isDefault":true,"id":"authentication","title":"authentication","link":null}]},{"id":"2cf056c4-dca2-579b-9478-fde3045a7c84overview/__redocly content redirect/toast-integrations-giftcard-api/overview/","definitionId":"autogenerated_toast-integrations-giftcard-api.yaml","link":"/toast-integrations-giftcard-api/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/toast-integrations-giftcard-api.yaml","info":{"version":"1.0.0","title":"Gift Card Integration API","description":"A REST API that allows the Toast platform to process \ngift card transactions using a gift card provider that it does not \ncurrently support.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_toast-integrations-giftcard-api.yaml","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_toast-integrations-giftcard-api.yaml","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Gift Card Integration API\",\"description\":\"A REST API that allows the Toast platform to process \\ngift card transactions using a gift card provider that it does not \\ncurrently support.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/yourendpointname\":{\"post\":{\"operationId\":\"yourendpointnamePost\",\"summary\":\"Returns gift card transaction information\\n\",\"description\":\"Provides information about a gift card transaction processed by \\nthe Toast platform. The transaction information in the \\nmessage body is intended to allow a gift card provider to \\nperform corresponding operations on the gift card account, \\nmaintained by that provider.\\n\\nYou define the endpoint name for this implementation. The Toast \\nplatform makes requests to the REST path that you supply \\nduring integration setup.\\n\\nEach `POST` request to the endpoint includes a \\n`Toast-Transaction-Type` header parameter value to indicate the \\ntype of gift card transaction it represents. The possible \\ntransaction types are:\\n\\n* Activate a new gift card.\\n* Add value to an active gift card.\\n* Get the current balance of a gift card.\\n* Redeem value from a gift card, for example for a purchase.\\n* Reverse a previous transaction, for example to void a purchase \\n  made with the gift card.\\n\\nThe `GiftCardTransaction` \\nobject in the message body includes a set of information that \\nis specific for each transaction type.\\n\\nThe response time for a gift card transaction request must be \\nless than 500ms.\\n\\nAll gift card transactions must be considered idempotent. The \\nimplementation must handle multiple requests with the same \\n`Toast-Transaction-GUID` *and* the same `giftCardIdentifier`.\\n\",\"parameters\":[{\"name\":\"Toast-Transaction-GUID\",\"description\":\"A unique identifier of the gift card transaction, defined \\nby the Toast platform.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The unique identifier of the restaurant, defined by the \\nToast platform.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Transaction-Type\",\"description\":\"The type of gift card transaction that occurred. Values are:\\n<ul>\\n  <li>GIFTCARD_ACTIVATE</li>\\n  <li>GIFTCARD_ADD_VALUE</li>\\n  <li>GIFTCARD_GET_BALANCE</li>\\n  <li>GIFTCARD_REDEEM</li>\\n  <li>GIFTCARD_REVERSE</li>\\n</ul>\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\",\"enum\":[\"GIFTCARD_ACTIVATE\",\"GIFTCARD_ADD_VALUE\",\"GIFTCARD_GET_BALANCE\",\"GIFTCARD_REDEEM\",\"GIFTCARD_REVERSE\"]}},{\"name\":\"Authorization\",\"description\":\"a JSON Web Token (JWT) that you can use to authenticate the request. Verify the token using the public key that you get from the Toast user management service.\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GiftCardTransaction\"}}},\"description\":\"A `GiftCardTransaction` \\nobject containing information about the gift card \\ntransaction that the Toast platform processed.\\n\"},\"responses\":{\"200\":{\"description\":\"OK. The `transactionStatus` value of the \\n`GiftCardTransactionResponse` object is `ACCEPT`.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GiftCardTransactionResponse\"}}}},\"400\":{\"description\":\"Bad request. The `transactionStatus` value of the \\n`GiftCardTransactionResponse` object is one of: \\n\\n* `ERROR_INVALID_TOAST_TRANSACTION_TYPE`\\n* `ERROR_CARD_ALREADY_ACTIVATED`\\n* `ERROR_CARD_NOT_ACTIVATED`\\n* `ERROR_CARD_INVALID`\\n* `ERROR_INVALID_INPUT_PROPERTIES`\\n* `ERROR_TRANSACTION_DOES_NOT_EXIST`\\n* `ERROR_INVALID_TOKEN`\\n* `ERROR_TRANSACTION_CANNOT_BE_REVERSED`\\n* `ERROR_INVALID_RESTAURANT`\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GiftCardTransactionResponse\"}}}},\"500\":{\"description\":\"Internal server error.\"}}}}},\"servers\":[{\"url\":\"https://toast-api-server/yourapiname/v1\"}],\"components\":{\"schemas\":{\"GiftCardTransaction\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform. Gift card providers are expected to handle that \\ntransaction.\\n\\nThe set of information in this object depends on the gift card \\ntransaction type. The transaction type is specified in the \\n`Toast-Transaction-Type` header parameter for the request.\\n\\nThe `GiftCardTransaction` object includes the following values \\nfor specific transaction types:\\n\\n* `GIFTCARD_ACTIVATE` - includes an `activateTransactionInformation` value.\\n* `GIFTCARD_ADD_VALUE` - includes an `addValueTransactionInformation` value.\\n* `GIFTCARD_GET_BALANCE` - includes a `getBalanceTransactionInformation` value.\\n* `GIFTCARD_REDEEM` - includes a `redeemTransactionInformation` value.\\n* `GIFTCARD_REVERSE` - includes a `reverseTransactionInformation` value.\\n\",\"properties\":{\"activateTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationActivate\"},\"addValueTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationAddValue\"},\"getBalanceTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationGetBalance\"},\"redeemTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationRedeem\"},\"reverseTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationReverse\"}}},\"TransactionInformationActivate\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform that activates a new card. Gift card providers are \\nexpected to handle the transaction.\\n\",\"properties\":{\"giftCardIdentifier\":{\"description\":\"The unique identifier of the gift card.\\n\",\"type\":\"string\"},\"identifierSource\":{\"description\":\"Indicates how the Toast platform received the gift card \\nidentifier string. Values are:\\n\\n* `KEYED` - A restaurant employee or guest manually entered \\nthe identifier string.\\n\\n* `SCANNED` - A restaurant employee or guest used a barcode \\nscanner or other scanning device to enter the identifier \\nstring.\\n\\n* `SWIPED` - A restaurant employee or guest used a magnetic \\ncard strip reader to enter the identifier string.\\n\\n* `UNKNOWN` - The Toast platform received the identifier \\nstring using a method other than `KEYED`, `SCANNED`, or \\n`SWIPED`, or the method is not known.\\n\",\"type\":\"string\",\"enum\":[\"KEYED\",\"SCANNED\",\"SWIPED\",\"UNKNOWN\"]},\"initialBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"},\"checkIdentifier\":{\"description\":\"The unique identifier of the check that this gift card transaction\\nis part of. No action needs to be taken based on this identifier,\\nit is just provided for tracking purposes.\\n\",\"type\":\"string\"}}},\"TransactionInformationAddValue\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast POS \\nsystem that adds to the funds that are available on the card. \\nGift card providers are expected to handle the transaction.\\n\",\"properties\":{\"giftCardIdentifier\":{\"description\":\"The unique identifier of the gift card.\\n\",\"type\":\"string\"},\"identifierSource\":{\"description\":\"Indicates how the Toast platform received the gift card \\nidentifier string. Values are:\\n\\n* `KEYED` - A restaurant employee or guest manually entered \\nthe identifier string.\\n\\n* `SCANNED` - A restaurant employee or guest used a barcode \\nscanner or other scanning device to enter the identifier \\nstring.\\n\\n* `SWIPED` - A restaurant employee or guest used a magnetic \\ncard strip reader to enter the identifier string.\\n\\n* `UNKNOWN` - The Toast platform received the identifier \\nstring using a method other than `KEYED`, `SCANNED`, or \\n`SWIPED`, or the method is not known.\\n\",\"type\":\"string\",\"enum\":[\"KEYED\",\"SCANNED\",\"SWIPED\",\"UNKNOWN\"]},\"additionalValue\":{\"description\":\"The currency amount of the funds being added to the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"},\"checkIdentifier\":{\"description\":\"The unique identifier of the check that this gift card transaction\\nis part of. No action needs to be taken based on this identifier,\\nit is just provided for tracking purposes.\\n\",\"type\":\"string\"}}},\"TransactionInformationGetBalance\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform that requests the currency value of the funds available \\nfrom the gift card. Gift card providers are expected to handle \\nthe transaction.\\n\",\"properties\":{\"giftCardIdentifier\":{\"description\":\"The unique identifier of the gift card.\\n\",\"type\":\"string\"},\"identifierSource\":{\"description\":\"Indicates how the Toast platform received the gift card \\nidentifier string. Values are:\\n\\n* `KEYED` - A restaurant employee or guest manually entered \\nthe identifier string.\\n\\n* `SCANNED` - A restaurant employee or guest used a barcode \\nscanner or other scanning device to enter the identifier \\nstring.\\n\\n* `SWIPED` - A restaurant employee or guest used a magnetic \\ncard strip reader to enter the identifier string.\\n\\n* `UNKNOWN` - The Toast platform received the identifier \\nstring using a method other than `KEYED`, `SCANNED`, or \\n`SWIPED`, or the method is not known.\\n\",\"type\":\"string\",\"enum\":[\"KEYED\",\"SCANNED\",\"SWIPED\",\"UNKNOWN\"]}}},\"TransactionInformationRedeem\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform that reduces the balance of funds available from the card. \\nFor example, when the gift card is used for a purchase. Gift card \\nproviders are expected to handle the transaction.\\n\",\"properties\":{\"giftCardIdentifier\":{\"description\":\"The unique identifier of the gift card.\\n\",\"type\":\"string\"},\"identifierSource\":{\"description\":\"Indicates how the Toast platform received the gift card \\nidentifier string. Values are:\\n\\n* `KEYED` - A restaurant employee or guest manually entered \\nthe identifier string.\\n\\n* `SCANNED` - A restaurant employee or guest used a barcode \\nscanner or other scanning device to enter the identifier \\nstring.\\n\\n* `SWIPED` - A restaurant employee or guest used a magnetic \\ncard strip reader to enter the identifier string.\\n\\n* `UNKNOWN` - The Toast platform received the identifier \\nstring using a method other than `KEYED`, `SCANNED`, or \\n`SWIPED`, or the method is not known.\\n\",\"type\":\"string\",\"enum\":[\"KEYED\",\"SCANNED\",\"SWIPED\",\"UNKNOWN\"]},\"redeemedValue\":{\"description\":\"The currency amount of the funds being redeemed from the gift \\ncard. \\n\",\"type\":\"number\",\"format\":\"double\"},\"checkIdentifier\":{\"description\":\"The unique identifier of the check that this gift card transaction\\nis part of. No action needs to be taken based on this identifier,\\nit is just provided for tracking purposes.\\n\",\"type\":\"string\"},\"isCashOut\":{\"description\":\"True if this redeem transaction is a cash out transaction,\\nfalse otherwise\\n\",\"type\":\"boolean\"}}},\"TransactionInformationReverse\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform that undoes a previous transaction. Gift card providers \\nare expected to handle the transaction. The only types of\\ntransactions that can be reversed are `GIFTCARD_ADD_VALUE`,\\n`GIFTCARD_REDEEM`, and `GIFTCARD_ACTIVATE`.\\nIf a `GIFTCARD_ADD_VALUE` is reversed then the amount of the\\noriginal transaction should be deducted from the card's balance.\\nIf a `GIFTCARD_REDEEM` is reversed then the amount of the\\noriginal transaction should be added to the card's balance.\\nIf a `GIFTCARD_ACTIVATE` is reversed then the card should be\\nset to inactive and its balance set to `0.00`.\\n`GIFTCARD_GET_BALANCE` and `GIFTCARD_REVERSE` cannot be reversed.\\n\",\"properties\":{\"giftCardIdentifier\":{\"description\":\"The unique identifier of the gift card.\\n\",\"type\":\"string\"},\"identifierSource\":{\"description\":\"Indicates how the Toast platform received the gift card \\nidentifier string. Values are:\\n\\n* `KEYED` - A restaurant employee or guest manually entered \\nthe identifier string.\\n\\n* `SCANNED` - A restaurant employee or guest used a barcode \\nscanner or other scanning device to enter the identifier \\nstring.\\n\\n* `SWIPED` - A restaurant employee or guest used a magnetic \\ncard strip reader to enter the identifier string.\\n\\n* `UNKNOWN` - The Toast platform received the identifier \\nstring using a method other than `KEYED`, `SCANNED`, or \\n`SWIPED`, or the method is not known.\\n\",\"type\":\"string\",\"enum\":[\"KEYED\",\"SCANNED\",\"SWIPED\",\"UNKNOWN\"]},\"previousTransaction\":{\"description\":\"The identifier of an earlier gift card transaction. This \\nidentifier is provided in the `Toast-Transaction-GUID` header \\nparameter.\\n\",\"type\":\"string\",\"format\":\"guid\"},\"checkIdentifier\":{\"description\":\"The unique identifier of the check that this gift card transaction\\nis part of. No action needs to be taken based on this identifier,\\nit is just provided for tracking purposes.\\n\",\"type\":\"string\"}}},\"GiftCardTransactionResponse\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift \\ncard provider. The Toast platform uses this information to \\ncomplete guests' gift card transactions.\\n\\nThe set of information in this object depends on the gift card \\ntransaction type. The transaction type is specified in the \\n`Toast-Transaction-Type` header parameter for the request.\\n\\nAll `GiftCardTransactionResponse` objects must include a \\n`transactionStatus` value.\\n\\nThe `GiftCardTransactionResponse` object includes the following \\nadditional values for specific transaction types:\\n\\n* `GIFTCARD_ACTIVATE` - includes an `activateResponse` value.\\n* `GIFTCARD_ADD_VALUE` - includes an `addValueResponse` value.\\n* `GIFTCARD_GET_BALANCE` - includes a `getBalanceResponse` value.\\n* `GIFTCARD_REDEEM` - includes a `redeemResponse` value.\\n* `GIFTCARD_REVERSE` - includes a `reverseResponse` value.\\n\\nFor \\nexample, the response object for a `GIFTCARD_ACTIVATE` transaction \\nincludes an `activateResponse` value.\\n\",\"properties\":{\"transactionStatus\":{\"description\":\"Indicates the result of a gift card transaction, reported by the\\ngift card service provider. Possible values are:\\n\\n<ul>\\n  <li>`ACCEPT` - The gift card service provider processed the transaction successfully.</li>\\n  <li>`ERROR_INVALID_TOAST_TRANSACTION_TYPE` - The requested Toast-Transaction-Type is not valid.</li>\\n  <li>`ERROR_CARD_ALREADY_ACTIVATED` - The gift card has already been activated.</li>\\n  <li>`ERROR_CARD_NOT_ACTIVATED` - The gift card has not been activated.</li>\\n  <li>`ERROR_CARD_INVALID` - The gift card is not valid at the current restaurant.</li>\\n  <li>`ERROR_INVALID_INPUT_PROPERTIES` - The specified JSON properties in the request body are not valid.</li>\\n  <li>`ERROR_TRANSACTION_DOES_NOT_EXIST` - The transaction that is being requested to be reversed does not exist.\\n    Only occurs on a `GIFTCARD_REVERSE`</li>\\n  <li>`ERROR_INVALID_TOKEN` - The token supplied in the `Authorization` header field is invalid or cannot be validated.</li>\\n  <li>`ERROR_TRANSACTION_CANNOT_BE_REVERSED` - The specified transaction cannot be reversed. `GIFTCARD_GET_BALANCE`\\n    and `GIFTCARD_REVERSE` transactions cannot be reversed.</li>\\n  <li>`ERROR_INVALID_RESTAURANT` - The restaurant specified by the `Toast-Restaurant-External-ID` is invalid.</li>\\n</ul>\\n\",\"type\":\"string\",\"enum\":[\"ACCEPT\",\"ERROR_INVALID_TOAST_TRANSACTION_TYPE\",\"ERROR_CARD_ALREADY_ACTIVATED\",\"ERROR_CARD_NOT_ACTIVATED\",\"ERROR_CARD_INVALID\",\"ERROR_INVALID_INPUT_PROPERTIES\",\"ERROR_TRANSACTION_DOES_NOT_EXIST\",\"ERROR_INVALID_TOKEN\",\"ERROR_TRANSACTION_CANNOT_BE_REVERSED\",\"ERROR_INVALID_RESTAURANT\"]},\"activateResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseActivate\"},\"addValueResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseAddValue\"},\"getBalanceResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseGetBalance\"},\"redeemResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseRedeem\"},\"reverseResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseReverse\"}}},\"TransactionResponseActivate\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider for activating a new gift card. The Toast POS \\nsystem uses this information to complete guests' gift card \\ntransactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"}}},\"TransactionResponseAddValue\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider for add value transactions. The Toast platform \\nuses this information to complete guests' gift card transactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"}}},\"TransactionResponseGetBalance\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider for get balance transactions. The Toast POS \\nsystem uses this information to complete guests' gift card \\ntransactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"}}},\"TransactionResponseRedeem\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider that reduces the balance of funds available from \\nthe card. For example, when the gift card is used for a purchase. \\nThe Toast platform uses this information to complete guests' \\ngift card transactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"},\"redeemedValue\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of the funds that were redeemed from the \\ngift card. This value may be different than the \\n`redeemedValue` in a gift card transaction request. For \\nexample, if the card balance is less than the redeem value \\nrequested by the Toast platform, the `redeemedValue` in the \\nresponse will be less than the `redeemedValue in the request.\\n\"}}},\"TransactionResponseReverse\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider that undoes a previous gift card transaction. \\nThe Toast platform uses this information to complete guests' \\ngift card transactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"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\":{}}}}}","lastModified":"2022-12-22T13:56:16.000Z","redocInfoPageId":"toast-integrations-giftcard-api.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/toast-integrations-giftcard-api.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_toast-integrations-giftcard-api.yaml","isDefault":true,"id":null,"title":null,"link":"/toast-integrations-giftcard-api/overview/"}]},{"id":"5631f50a-9335-5bd6-8b60-ddcfe1de3480overview/__redocly content redirect/toast-partners-api/overview/","definitionId":"autogenerated_toast-partners-api.yaml","link":"/toast-partners-api/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/toast-partners-api.yaml","info":{"version":"1.0.0","title":"Partners API","description":"Returns information about the Toast restaurants that a partner \nAPI client can access.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_toast-partners-api.yaml","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_toast-partners-api.yaml","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Partners API\",\"description\":\"Returns information about the Toast restaurants that a partner \\nAPI client can access.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/restaurants\":{\"get\":{\"operationId\":\"restaurantsGet\",\"summary\":\"Get accessible restaurants\",\"description\":\"Returns an array of `PartnerAccessExternalRep` \\nobjects that contain information about the Toast restaurants that a partner \\nAPI client can access. If a `lastModified` date is specified, the API returns \\nall objects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"lastModified\",\"description\":\"Limits the return data to restaurants that changed their \\naccess configuration for a partner API client after a \\nspecific date and time.\\n\\nRestaurants returned either:\\n\\n* Gave access to a partner API client for a partner \\n  integration service after a specific date and time.\\n\\n* Modified the configuration for a partner integration \\n  after a specific date and time. \\n\\nYou must specify the date and time as a UTC timestamp in \\nISO 8601 format, for example: \\n`2020-03-01T00:00:00.000-0000`. URL encode the timestamp. \\nFor example, `2020-03-01T00%3A00%3A00.000-0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\"}}],\"responses\":{\"200\":{\"description\":\"Returns the list of external parner accesses\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PartnerAccessExternalRep\"}}}}},\"403\":{\"description\":\"Your Toast API client does not have permission to use the \\n`/restaurants` endpoint.\\n\"}}}}},\"servers\":[{\"url\":\"https://toast-api-server/partners/v1\"}],\"components\":{\"schemas\":{\"PartnerAccessExternalRep\":{\"type\":\"object\",\"description\":\"Information about a Toast POS system restaurant.\\n\",\"properties\":{\"restaurantGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique Toast POS identifier for the restaurant.\\n\"},\"managementGroupGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The guid of the management group containing the restaurant.\\n\"},\"restaurantName\":{\"type\":\"string\",\"description\":\"The human-readable name of the restaurant location.\\n\"},\"locationName\":{\"type\":\"string\",\"description\":\"The identifier of a specific restaurant location, set on the \\n*Restaurant Info* page of the Toast administration back-end. \\nFor example, a restaurant group might assign a location code \\nsuch as #1234 to a specific location.\\n\"},\"createdByEmailAddress\":{\"type\":\"string\",\"description\":\"The email address of the restaurant employee who connected \\nthe restaurant to the partner that made the request to the \\n`/restaurants` endpoint, or who edited the connection \\ndetails.\\n\"},\"externalGroupRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant group that is recognized by \\nthe the partner that made the request to the `/restaurants` \\nendpoint. This information is entered by the restaurant \\nadministrator. If you need information about the restaurant \\ngroup in this data string, you instruct the restaurant \\nadministrator to enter it in the Toast POS system \\nconfiguration for the integration partner connection.\\n\"},\"externalRestaurantRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant location that is recognized \\nby the partner that made the request to the `/restaurants` \\nendpoint. This information is entered by the restaurant \\nadministrator. If you need information about the restaurant \\nlocation in this data string, you instruct the restaurant \\nadministrator to enter it in the Toast POS system \\nconfiguration for the integration partner connection.\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\"},\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the partner connection was created in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\"},\"isoModifiedDate\":{\"type\":\"string\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in ISO8601 format.\\n\"},\"isoCreatedDate\":{\"type\":\"string\",\"description\":\"The date and time that the partner connection was created in ISO8601 format.\\n\"}}},\"PartnerAccessExternalWebhookRep\":{\"type\":\"object\",\"description\":\"Information about a Toast POS system restaurant.\\n\",\"properties\":{\"restaurantGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique Toast POS identifier for the restaurant.\\n\"},\"managementGroupGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The guid of the management group containing the restaurant.\\n\"},\"restaurantName\":{\"type\":\"string\",\"description\":\"The human-readable name of the restaurant location.\\n\"},\"locationName\":{\"type\":\"string\",\"description\":\"The identifier of a specific restaurant location, set on the\\n*Restaurant Info* page of the Toast administration back-end.\\nFor example, a restaurant group might assign a location code\\nsuch as #1234 to a specific location.\\n\"},\"externalGroupRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant group that is recognized by\\nthe the partner that made the request to the `/restaurants`\\nendpoint. This information is entered by the restaurant\\nadministrator. If you need information about the restaurant\\ngroup in this data string, you instruct the restaurant\\nadministrator to enter it in the Toast POS system\\nconfiguration for the integration partner connection.\\n\"},\"externalRestaurantRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant location that is recognized\\nby the partner that made the request to the `/restaurants`\\nendpoint. This information is entered by the restaurant\\nadministrator. If you need information about the restaurant\\nlocation in this data string, you instruct the restaurant\\nadministrator to enter it in the Toast POS system\\nconfiguration for the integration partner connection.\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\"},\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the partner connection was created in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\"},\"isoModifiedDate\":{\"type\":\"string\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in ISO8601 format.\\n\"},\"isoCreatedDate\":{\"type\":\"string\",\"description\":\"The date and time that the partner connection was created in ISO8601 format.\\n\"},\"createdByFirstName\":{\"type\":\"string\",\"description\":\"The first name of the user who initiated the event.\\n\"},\"createdByLastName\":{\"type\":\"string\",\"description\":\"The last name of the user who initiated the event.\\n\"},\"createdByEmailAddress\":{\"type\":\"string\",\"description\":\"The email address of the restaurant employee who connected\\nthe restaurant to the partner that made the request to the\\n`/restaurants` endpoint, or who edited the connection\\ndetails.\\n\"},\"createdByPhoneNumber\":{\"type\":\"string\",\"description\":\"The phone number of the user who initiated the event.\\n\"},\"restaurantPhoneNumber\":{\"type\":\"string\",\"description\":\"The phone number of the restaurant.\\n\"},\"restaurantAddressLine1\":{\"type\":\"string\",\"description\":\"The physical address of the restaurant location.\\n\"},\"restaurantAddressLine2\":{\"type\":\"string\",\"description\":\"Optional additional physical address of the restaurant location.\\n\"},\"restaurantCity\":{\"type\":\"string\",\"description\":\"The city in which the restaurant is located.\\n\"},\"restaurantState\":{\"type\":\"string\",\"description\":\"The state in which the restaurant is located.\\n\"},\"restaurantZipCode\":{\"type\":\"string\",\"description\":\"The zip code of the restaurant location.\\n\"}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"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\":{}}}}}","lastModified":"2022-12-22T13:56:16.000Z","redocInfoPageId":"toast-partners-api.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/toast-partners-api.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_toast-partners-api.yaml","isDefault":true,"id":null,"title":null,"link":"/toast-partners-api/overview/"}]},{"id":"00c98516-7014-53ca-9900-b6b874acd9caoverview/__redocly content redirect/cashmanagement/overview/","definitionId":"cashManagement","link":"/cashmanagement/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/cashmanagement.reference.page.yaml","info":{"version":"1.1.0","title":"Cash Management API","description":"Provides information about cash operations that add cash to or \nremove cash from a restaurant cash drawer, separately from cash\ntransaction payments (customer payments for individual checks). \nCash entries are different than cash transactions, and affect \nthe overall amount of cash that the Toast POS accounts for in \na restaurant.\n","termsOfService":"https://pos.toasttab.com/api-terms-of-use"},"data":{"redirect":true,"type":"reference-docs","definitionId":"cashManagement","label":"Cash Management","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-cashmgmt-api.yaml"},"apiVersions":[{"definitionId":"cashManagement","isDefault":true,"title":"cashManagement","id":"cashManagement"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.1.0\",\"title\":\"Cash Management API\",\"description\":\"Provides information about cash operations that add cash to or \\nremove cash from a restaurant cash drawer, separately from cash\\ntransaction payments (customer payments for individual checks). \\nCash entries are different than cash transactions, and affect \\nthe overall amount of cash that the Toast POS accounts for in \\na restaurant.\\n\",\"termsOfService\":\"https://pos.toasttab.com/api-terms-of-use\"},\"externalDocs\":{\"description\":\"Cash management API documentation\",\"url\":\"https://doc.toasttab.com/doc/devguide/apiWorkingWithCashEntriesAndDeposits.html\"},\"paths\":{\"/entries\":{\"get\":{\"summary\":\"Get cash entries\\n\",\"description\":\"Returns information about cash added to or removed from a cash\\ndrawer or other cash storage device. Returns an array of \\n`CashEntry` objects.\\n\",\"operationId\":\"entriesGet\",\"externalDocs\":{\"description\":\"Getting cash entries\",\"url\":\"https://dev.toasttab.com/doc/devguide/apiUsingCashManagementApi.html\"},\"security\":[{\"cashMgmtRead\":[\"cashmgmt:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The GUID of the restaurant that is the context of the\\nrequest.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"yyyymmdd\",\"description\":\"Deprecated. Use the `businessDate` parameter. The business\\ndate the cash entries were created, in the format\\n`yyyymmdd`. For example, `20180228`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"calendar-date\"}},{\"name\":\"businessDate\",\"description\":\"The business date the cash entries were created, in the\\nformat `yyyymmdd`. For example, `20180228`.\\n\",\"in\":\"query\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"calendar-date\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `CashEntry` objects.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/CashEntry\"}}}}},\"default\":{\"description\":\"Unexpected error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/deposits\":{\"get\":{\"summary\":\"Get deposits\\n\",\"description\":\"Returns an array of `Deposit` objects containing information about\\ncash removed from a restaurant to be deposited in a bank or \\nother financial institution during one business day.\\n\",\"operationId\":\"depositsGet\",\"externalDocs\":{\"description\":\"Getting cash deposit entries\",\"url\":\"https://dev.toasttab.com/doc/devguide/apiGetCashDeposits.html\"},\"security\":[{\"cashMgmtRead\":[\"cashmgmt:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The GUID of the restaurant that is the context of the\\nrequest.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"businessDate\",\"description\":\"The business date the deposits were created, in the\\nformat `yyyymmdd`. For example, `20180228`.\\n\",\"in\":\"query\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"calendar-date\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Deposit` objects.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/Deposit\"}}}}},\"default\":{\"description\":\"An unexpected error.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}}},\"servers\":[{\"url\":\"https://toast-api-server/cashmgmt/v1\"}],\"components\":{\"securitySchemes\":{\"cashMgmtRead\":{\"type\":\"oauth2\",\"flows\":{\"implicit\":{\"authorizationUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"cashmgmt:read\":\"Read cash transactions\"}}}}},\"schemas\":{\"ToastReference\":{\"type\":\"object\",\"description\":\"Identifying information about a Toast POS entity.\\n\",\"required\":[\"guid\",\"entityType\"],\"properties\":{\"guid\":{\"description\":\"The GUID assigned to the entity by the Toast POS.\",\"type\":\"string\"},\"entityType\":{\"description\":\"The category of the Toast POS object.\",\"type\":\"string\"}}},\"ExternalReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"externalId\":{\"description\":\"External identifier string that is prefixed by the naming authority.\",\"type\":\"string\"}}}]},\"CashEntry\":{\"type\":\"object\",\"description\":\"Information about an event in which a restaurant employee puts\\ncash into a cash drawer or removes cash from a cash drawer.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"required\":[\"amount\",\"reason\",\"date\",\"type\"],\"properties\":{\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of the cash that an employee adds to\\nor removes from a cash drawer. This value is positive\\nwhen an employee adds cash and negative when an employee\\nremoves cash.\\n\"},\"reason\":{\"type\":\"string\",\"description\":\"A short description of why this cash entry was created,\\nwritten by the restaurant employee.\\n\"},\"date\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the cash entry occurred.\\n\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the cash entry.\\n<ul>\\n  <li><code>CASH_IN</code> - cash added to a cash\\n  drawer.</li>\\n\\n  <li><code>CASH_COLLECTED</code> - cash added to a cash\\n  drawer at the end of an employee shift.</li>\\n\\n  <li><code>CASH_OUT</code> - cash removed from a cash\\n  drawer and stored in a different restaurant location.\\n  The Toast POS does track cash after it is removed by a\\n  <code>CASH_OUT</code> entry.</li>\\n\\n  <li><code>NO_SALE</code> - cash drawer opened with no\\n  change to the cash balance. For example, a restaurant\\n  employee might perform a no sale transaction to make\\n  change for a customer.</li>\\n\\n  <li><code>PAY_OUT</code> - cash removed from a cash\\n  drawer to pay for a pre-configured restaurant\\n  expense.</li>\\n\\n  <li><code>TIP_OUT</code> - cash removed from a cash\\n  drawer to distribute tips or gratuities to restaurant\\n  employees.</li>\\n\\n  <li><code>UNDO_PAY_OUT</code> - cash added to a cash\\n  drawer to undo a previous <code>PAY_OUT</code> cash\\n  entry.</li>\\n\\n  <li><code>DRIVER_REIMBURSEMENT</code> - cash removed\\n  from a cash drawer to repay delivery drivers for\\n  delivery driving expenses.</li>\\n\\n  <li><code>CLOSE_OUT_EXACT</code> - an employee closes\\n  a cash drawer and the closing balance is equal to the\\n  expected balance.</li>\\n\\n  <li><code>CLOSE_OUT_OVERAGE</code> - an employee\\n  closes a cash drawer and the closing balance is greater\\n  than the expected balance.</li>\\n\\n  <li><code>CLOSE_OUT_SHORTAGE</code> - an employee\\n  closes a cash drawer and the closing balance is less\\n  than the expected balance.</li>\\n</ul>\\n\",\"enum\":[\"CASH_IN\",\"CASH_COLLECTED\",\"CASH_OUT\",\"PAY_OUT\",\"UNDO_PAY_OUT\",\"TIP_OUT\",\"NO_SALE\",\"DRIVER_REIMBURSEMENT\",\"CLOSE_OUT_EXACT\",\"CLOSE_OUT_OVERAGE\",\"CLOSE_OUT_SHORTAGE\"]},\"cashDrawer\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"payoutReason\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"noSaleReason\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"undoes\":{\"description\":\"The Toast GUID of the cash entry that is being undone.\\nThis value is null if the cash entry does not undo a\\nprevious entry.\\n\",\"type\":\"string\"},\"employee1\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"employee2\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"creatorOrShiftReviewSubject\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"approverOrShiftReviewSubject\":{\"$ref\":\"#/components/schemas/ToastReference\"}}}]},\"Deposit\":{\"type\":\"object\",\"description\":\"Information about an event in which a restaurant employee removes\\ncash from a restaurant and deposits it in a bank or other\\nfinancial institution.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"required\":[\"amount\",\"date\"],\"properties\":{\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the deposit. The `amount` value must be greater than zero. \\n\"},\"date\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date that the deposit was registered in the POS and\\nthe deposit slip was printed.\\n\"},\"undoes\":{\"type\":\"string\",\"format\":\"string\",\"description\":\"The Toast GUID of the deposit entry that is being undone. This value is null if the deposit entry does not undo a previous entry.\\n\"},\"employee\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"creator\":{\"$ref\":\"#/components/schemas/ToastReference\"}}}]},\"Error\":{\"required\":[\"status\",\"message\"],\"properties\":{\"status\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"An HTTP status code.\"},\"message\":{\"type\":\"string\",\"description\":\"A message that describes the error.\"}}}}}}},\"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-cashmgmt-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"cashmanagement.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/cashmanagement.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"cashManagement","isDefault":true,"id":"cashManagement","title":"cashManagement","link":null}]},{"id":"be1a07ef-2b5a-5d3c-88eb-47a17351f8a3overview/__redocly content redirect/configuration/overview/","definitionId":"configuration","link":"/configuration/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/configuration.reference.page.yaml","info":{"version":"2.5.0","title":"Configuration API","description":"Returns information about the configuration of a restaurant and \nits menus, such as menu items and alternate payment types, as \nwell as physical configuration such as cash drawers and \nrestaurant tables.\n\nThe configuration API does not return information about entities that you have \nremoved from your restaurant configuration or archived.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"configuration","label":"Configuration","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-config-api.yaml"},"apiVersions":[{"definitionId":"configuration","isDefault":true,"title":"configuration","id":"configuration"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"2.5.0\",\"title\":\"Configuration API\",\"description\":\"Returns information about the configuration of a restaurant and \\nits menus, such as menu items and alternate payment types, as \\nwell as physical configuration such as cash drawers and \\nrestaurant tables.\\n\\nThe configuration API does not return information about entities that you have \\nremoved from your restaurant configuration or archived.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"tags\":[{\"name\":\"Alternate Payment Types\"},{\"name\":\"Break Types\"},{\"name\":\"Cash Drawers\"},{\"name\":\"Dining Options\"},{\"name\":\"Discounts\"},{\"name\":\"Menu Groups\"},{\"name\":\"Menu Items\"},{\"name\":\"Modifier Groups\"},{\"name\":\"Menus\"},{\"name\":\"No Sale Reasons\"},{\"name\":\"Payout Reasons\"},{\"name\":\"Pre Modifier Groups\"},{\"name\":\"Pre Modifiers\"},{\"name\":\"Price Groups\"},{\"name\":\"Printers\"},{\"name\":\"Restaurant Services\"},{\"name\":\"Revenue Centers\"},{\"name\":\"Sales Categories\"},{\"name\":\"Service Areas\"},{\"name\":\"Service Charges\"},{\"name\":\"Tables\"},{\"name\":\"Tax Rates\"},{\"name\":\"Tip Withholding\"},{\"name\":\"Void Reasons\"}],\"paths\":{\"/alternatePaymentTypes/{guid}\":{\"get\":{\"tags\":[\"Alternate Payment Types\"],\"operationId\":\"alternatePaymentTypesGuidGet\",\"summary\":\"Get an alternative payment type\\n\",\"description\":\"Returns an `AlternatePaymentType`\\nobject containing information about an alternative form of payment\\nconfigured for a restaurant. Alternate payment types are forms\\nof payment that are not standard in the Toast POS and that are\\nconfigured for a particular restaurant. For example, a\\nthird-party service that processes payments might be configured\\nas an alternate payment type.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the alternate payment\\ntype is configured for.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the alternative form of payment.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns an `AlternatePaymentType` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AlternatePaymentType\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/alternatePaymentTypes\":{\"get\":{\"tags\":[\"Alternate Payment Types\"],\"operationId\":\"alternatePaymentTypesGet\",\"summary\":\"Get alternative payment types\\n\",\"description\":\"Returns an array of `AlternatePaymentType`\\nobjects containing information about alternative forms of\\npayment that are configured for a restaurant. Alternate\\npayment types are forms of payment that are not standard in the\\nToast POS and that are configured for a particular restaurant.\\nFor example, a third-party service that processes payments\\nmight be configured as an alternate payment type. If a\\n`lastModified` date is specified, returns all objects that were\\ncreated or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `AlternatePaymentType` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/AlternatePaymentType\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/breakTypes/{guid}\":{\"get\":{\"tags\":[\"Break Types\"],\"operationId\":\"breakTypesGuidGet\",\"summary\":\"Get a break type\\n\",\"description\":\"Returns a `BreakType`\\nobject containing information about a break type configured for \\na restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the break is configured for.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the break config.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `BreakType` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BreakType\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/breakTypes\":{\"get\":{\"tags\":[\"Break Types\"],\"operationId\":\"breakTypesGet\",\"summary\":\"Get break types\\n\",\"description\":\"Returns an array of `BreakType`\\nobjects containing information about breaks configured for a\\nrestaurant. If a `lastModified` date is specified, returns\\nall objects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `BreakType` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/BreakType\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/cashDrawers/{guid}\":{\"get\":{\"tags\":[\"Cash Drawers\"],\"operationId\":\"cashDrawersGuidGet\",\"summary\":\"Get a cash drawer\\n\",\"description\":\"Returns a `CashDrawer`\\nobject containing information about a specific cash drawer\\ndevice.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the cash drawer.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `CashDrawer` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CashDrawer\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/cashDrawers\":{\"get\":{\"tags\":[\"Cash Drawers\"],\"operationId\":\"cashDrawersGet\",\"summary\":\"Get cash drawers\\n\",\"description\":\"Returns an array of `CashDrawer` objects\\ncontaining information about the cash drawer devices for the\\nrestaurant. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `CashDrawer` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/CashDrawer\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/diningOptions/{guid}\":{\"get\":{\"tags\":[\"Dining Options\"],\"operationId\":\"diningOptionsGuidGet\",\"summary\":\"Get a dining option\\n\",\"description\":\"Returns a `DiningOption` object\\ncontaining information about a type of service offered by a\\nrestaurant. For example, dine in, take out, and delivery might\\nbe dining options for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the dining option.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `DiningOption` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DiningOption\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/diningOptions\":{\"get\":{\"tags\":[\"Dining Options\"],\"operationId\":\"diningOptionsGet\",\"summary\":\"Get dining options\\n\",\"description\":\"Returns an array of `DiningOption` objects\\ncontaining information about types of service offered by a\\nrestaurant. For example, dine in, take out, and delivery might\\nbe dining options for a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `DiningOption` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/DiningOption\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/discounts/{guid}\":{\"get\":{\"tags\":[\"Discounts\"],\"operationId\":\"discountsGuidGet\",\"summary\":\"Get a discount\\n\",\"description\":\"Returns a `Discount`\\nobject containing information about a price deduction\\nconfigured for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the discount.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `Discount` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Discount\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/discounts\":{\"get\":{\"tags\":[\"Discounts\"],\"operationId\":\"discountsGet\",\"summary\":\"Get discounts\\n\",\"description\":\"Returns an array of `Discount` objects containing\\ninformation about the price deductions configured for a\\nrestaurant. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Discount` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/Discount\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuGroups/{guid}\":{\"get\":{\"tags\":[\"Menu Groups\"],\"operationId\":\"menuGroupsGuidGet\",\"summary\":\"Get a menu group\\n\",\"description\":\"Returns a `MenuGroup`\\nobject containing information about a section within a menu.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the menu group.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `MenuGroup` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MenuGroup\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuGroups\":{\"get\":{\"tags\":[\"Menu Groups\"],\"operationId\":\"menuGroupsGet\",\"summary\":\"Get menu groups\\n\",\"description\":\"Returns an array of `MenuGroup` objects\\ncontaining information about the subsections of the menus\\nconfigured for a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `MenuGroup` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/MenuGroup\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuItems/{guid}\":{\"get\":{\"tags\":[\"Menu Items\"],\"operationId\":\"menuItemsGuidGet\",\"summary\":\"Get a menu item or modifier\\n\",\"description\":\"Returns a `MenuItem`\\nobject containing information about an item or modifier available from a\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID for the menu item.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `MenuItem` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MenuItem\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuItems\":{\"get\":{\"tags\":[\"Menu Items\"],\"operationId\":\"menuItemsGet\",\"summary\":\"Get menu items and modifiers\\n\",\"description\":\"Returns an array of `MenuItem` objects containing\\ninformation about the items and modifiers available from a\\nrestaurant. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `MenuItem` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/MenuItem\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuOptionGroups/{guid}\":{\"get\":{\"tags\":[\"Modifier Groups\"],\"operationId\":\"menuOptionGroupsGuidGet\",\"summary\":\"Get a modifier group\\n\",\"description\":\"Returns a `MenuOptionGroup`\\nobject containing information about a modifier group. For\\nexample, salad dressings might be a modifier group for a\\nsalad menu item.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the modifier group.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `MenuOptionGroup` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MenuOptionGroup\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuOptionGroups\":{\"get\":{\"tags\":[\"Modifier Groups\"],\"operationId\":\"menuOptionGroupsGet\",\"summary\":\"Get modifier groups\\n\",\"description\":\"Returns an array of `MenuOptionGroup`\\nobjects containing information about modifier groups. \\nFor example, salad dressings might be a modifier group\\nfor a salad menu item. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `MenuOptionGroup` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/MenuOptionGroup\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menus/{guid}\":{\"get\":{\"tags\":[\"Menus\"],\"operationId\":\"menusGuidGet\",\"summary\":\"Get a menu\\n\",\"description\":\"Returns a `Menu` object\\ncontaining information about a menu configured for a\\nrestaurant. For example, a restaurant might have drinks,\\ndinner, and dessert menus.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the menu.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `Menu` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Menu\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menus\":{\"get\":{\"tags\":[\"Menus\"],\"operationId\":\"menusGet\",\"summary\":\"Get menus\\n\",\"description\":\"Returns an array of `Menu`\\nobjects containing information about menus configured for a\\nrestaurant. For example, a restaurant might have drinks,\\ndinner, and dessert menus. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Menu` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/Menu\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/preModifiers/{guid}\":{\"get\":{\"tags\":[\"Pre Modifiers\"],\"operationId\":\"preModifiersGuidGet\",\"summary\":\"Get a pre modifier\\n\",\"description\":\"Returns a `PreModifier` object\\ncontaining information about a pre modifier.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the pre modifier.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PreModifier` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PreModifier\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/preModifiers\":{\"get\":{\"tags\":[\"Pre Modifiers\"],\"operationId\":\"preModifiersGet\",\"summary\":\"Get pre-modifiers\\n\",\"description\":\"Returns an array of `PreModifier` objects\\ncontaining information about PreModifiers configured\\nfor a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PreModifier` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/PreModifier\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/preModifierGroups/{guid}\":{\"get\":{\"tags\":[\"Pre Modifier Groups\"],\"operationId\":\"preModifierGroupsGuidGet\",\"summary\":\"Get a pre-modifier group\\n\",\"description\":\"Returns a `PreModifierGroup` object\\ncontaining information about a pre modifier group.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the pre-modifier.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PreModifierGroup` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PreModifierGroup\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/preModifierGroups\":{\"get\":{\"tags\":[\"Pre Modifier Groups\"],\"operationId\":\"preModifierGroupsGet\",\"summary\":\"Get pre modifier groups\\n\",\"description\":\"Returns an array of `PreModifierGroup` objects\\ncontaining information about PreModifierGroup configured\\nfor a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PreModifierGroup` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/PreModifierGroup\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/noSaleReasons/{guid}\":{\"get\":{\"tags\":[\"No Sale Reasons\"],\"operationId\":\"noSaleReasonsGuidGet\",\"summary\":\"Get a no sale reason\\n\",\"description\":\"Returns a `NoSaleReason` object\\ncontaining information about a no sale reason.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the no sale reason.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `NoSaleReason` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NoSaleReason\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/noSaleReasons\":{\"get\":{\"tags\":[\"No Sale Reasons\"],\"operationId\":\"noSaleReasonsGet\",\"summary\":\"Get no sale reasons\\n\",\"description\":\"Returns an array of `NoSaleReason` objects\\ncontaining information about no sale reasons configured\\nfor a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `NoSaleReason` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/NoSaleReason\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/payoutReasons/{guid}\":{\"get\":{\"tags\":[\"Payout Reasons\"],\"operationId\":\"payoutReasonsGuidGet\",\"summary\":\"Get a payout reason\\n\",\"description\":\"Returns a `PayoutReason` object\\ncontaining information about a recurring restaurant expense\\nthat is paid in cash. Payout reasons are pre-configured for a\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the payout reason.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PayoutReason` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PayoutReason\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/payoutReasons\":{\"get\":{\"tags\":[\"Payout Reasons\"],\"operationId\":\"payoutReasonsGet\",\"summary\":\"Get payout reasons\\n\",\"description\":\"Returns an array of `PayoutReason` objects\\ncontaining information about recurring cash expenses configured\\nfor a restaurant. For example, payment for services such as\\nwindow washing might be payout reasons. If a `lastModified`\\ndate is specified, returns all objects that were created or\\nmodified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PayoutReason` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/PayoutReason\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/priceGroups/{guid}\":{\"get\":{\"tags\":[\"Price Groups\"],\"operationId\":\"priceGroupsGuidGet\",\"summary\":\"Get a price level for menu items\\n\",\"description\":\"Returns a `PriceGroup` object\\ncontaining information about a variable price level configured for\\nitems at a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the price level.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PriceGroup` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PriceGroup\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/priceGroups\":{\"get\":{\"tags\":[\"Price Groups\"],\"operationId\":\"priceGroupsGet\",\"summary\":\"Get price levels for menu items\\n\",\"description\":\"Returns an array of `PriceGroup` objects\\ncontaining information about the variable price levels\\nconfigured for items at a restaurant. If a `lastModified` date\\nis specified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PriceGroup` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/PriceGroup\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/printers/{guid}\":{\"get\":{\"tags\":[\"Printers\"],\"operationId\":\"printersGuidGet\",\"summary\":\"Get a printer\\n\",\"description\":\"Returns a `Printer` object\\ncontaining information about a printer device configured for a\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the printer.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `Printer` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Printer\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/printers\":{\"get\":{\"tags\":[\"Printers\"],\"operationId\":\"printersGet\",\"summary\":\"Get printers\\n\",\"description\":\"Returns an array of `Printer` objects containing\\ninformation about the printer devices configured for a\\nrestaurant. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Printer` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/Printer\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/salesCategories/{guid}\":{\"get\":{\"tags\":[\"Sales Categories\"],\"operationId\":\"salesCategoriesGuidGet\",\"summary\":\"Get a menu item sales category\\n\",\"description\":\"Returns a `SalesCategory` object\\ncontaining information about a type of menu item used to\\nanalyze purchases at a restaurant. For example, food and\\nalcohol might be sales categories for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the sales category.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `SalesCategory` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SalesCategory\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/salesCategories\":{\"get\":{\"tags\":[\"Sales Categories\"],\"operationId\":\"salesCategoriesGet\",\"summary\":\"Get menu item sales categories\\n\",\"description\":\"Returns an array of `SalesCategory` objects\\ncontaining information about the types of menu item used to\\nanalyze purchases at a restaurant. For example, food and\\nalcohol might be sales categories for a restaurant. If a\\n`lastModified` date is specified, returns all objects that were\\ncreated or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `SalesCategory` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/SalesCategory\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/serviceAreas/{guid}\":{\"get\":{\"tags\":[\"Service Areas\"],\"operationId\":\"serviceAreasGuidGet\",\"summary\":\"Get a service area\\n\",\"description\":\"Returns a `ServiceArea`\\nobject containing information about a physical setting that a\\nrestaurant serves customers in. For example, a restaurant might\\nserve customers in dining room and patio service areas.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the service area.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `ServiceArea` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ServiceArea\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/serviceAreas\":{\"get\":{\"tags\":[\"Service Areas\"],\"operationId\":\"serviceAreasGet\",\"summary\":\"Get service areas\\n\",\"description\":\"Returns an array of `ServiceArea` objects\\ncontaining information about the physical settings that a\\nrestaurant serves customers in. For example, a restaurant might\\nserve customers in dining room and patio service areas. If a\\n`lastModified` date is specified, returns all objects that were\\ncreated or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `ServiceArea` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/ServiceArea\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/serviceCharges/{guid}\":{\"get\":{\"tags\":[\"Service Charges\"],\"operationId\":\"serviceChargesGuidGet\",\"summary\":\"Get a service charge type\\n\",\"description\":\"Returns a `ServiceCharge` object\\ncontaining information about a type of fee applied to\\nrestaurant sales. For example, an automatic gratuity applied to\\nthe check for a large dining party might be a type of service\\ncharge for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the service charge.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `ServiceCharge` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ServiceCharge\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/serviceCharges\":{\"get\":{\"tags\":[\"Service Charges\"],\"operationId\":\"serviceChargesGet\",\"summary\":\"Get service charges\\n\",\"description\":\"Returns an array of `ServiceCharge` objects\\ncontaining information about the types of fee applied to\\nrestaurant sales. For example, an automatic gratuity applied to\\nthe check for a large dining party might be a type of service\\ncharge for a restaurant. If a `lastModified` date is specified,\\nreturns all objects that were created or modified after that\\ndate.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `ServiceCharge` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/ServiceCharge\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/revenueCenters/{guid}\":{\"get\":{\"tags\":[\"Revenue Centers\"],\"operationId\":\"revenueCentersGuidGet\",\"summary\":\"Get a revenue center\\n\",\"description\":\"Returns a `RevenueCenter` object\\ncontaining information about a segment of restaurant income,\\nfor reporting.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the revenue center.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `RevenueCenter` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RevenueCenter\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/revenueCenters\":{\"get\":{\"tags\":[\"Revenue Centers\"],\"operationId\":\"revenueCentersGet\",\"summary\":\"Get revenue centers\\n\",\"description\":\"Returns an array of `RevenueCenter` objects\\ncontaining information about segments of restaurant income, for\\nreporting. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `RevenueCenter` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/RevenueCenter\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/restaurantServices/{guid}\":{\"get\":{\"tags\":[\"Restaurant Services\"],\"operationId\":\"restaurantServicesGuidGet\",\"summary\":\"Get a restaurant service period\\n\",\"description\":\"Returns a `RestaurantService`\\nobject containing information about a type of menu and dining\\noffered by a restaurant. For example, a restaurant might offer\\na lunch service at some hours of the day and a dinner service\\nat other hours of the day.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the service.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `RestaurantService` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RestaurantService\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/restaurantServices\":{\"get\":{\"tags\":[\"Restaurant Services\"],\"operationId\":\"restaurantServicesGet\",\"summary\":\"Get restaurant service periods\\n\",\"description\":\"Returns an array of `RestaurantService`\\nobjects containing information about the types of menu and dining\\noffered by a restaurant. For example, a restaurant might offer\\na lunch service at some hours of the day and a dinner service\\nat other hours of the day. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `RestaurantService` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/RestaurantService\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/tables/{guid}\":{\"get\":{\"tags\":[\"Tables\"],\"operationId\":\"tablesGuidGet\",\"summary\":\"Get a table\\n\",\"description\":\"Returns a `Table`\\nobject containing information about a dining table configured for a\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the table.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `Table` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Table\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/tables\":{\"get\":{\"tags\":[\"Tables\"],\"operationId\":\"tablesGet\",\"summary\":\"Get tables\\n\",\"description\":\"Returns an array of `Table`\\nobjects containing information about the dining tables\\nconfigured for a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Table` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/Table\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/taxRates/{guid}\":{\"get\":{\"tags\":[\"Tax Rates\"],\"operationId\":\"taxRatesGuidGet\",\"summary\":\"Get a tax rate\\n\",\"description\":\"Returns a `TaxRate` object\\ncontaining information about a form of taxation applied to\\nsales at a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the tax rate.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `TaxRate` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TaxRate\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/taxRates\":{\"get\":{\"tags\":[\"Tax Rates\"],\"operationId\":\"taxRatesGet\",\"summary\":\"Get tax rates\\n\",\"description\":\"Returns an array of `TaxRate` objects\\ncontaining information about the forms of taxation applied to\\nsales at a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `TaxRate` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/TaxRate\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/tipWithholding\":{\"get\":{\"tags\":[\"Tip Withholding\"],\"operationId\":\"tipWithholdingGet\",\"summary\":\"Get the percentage withheld for credit card tips\\n\",\"description\":\"Returns a `TipWithholding`\\nobject containing information about the way tip withholding\\nis configured for a restaurant. Tip withholding is a percentage\\nof employees' credit card tips that is kept by a restaurant to\\ncover credit card processing fees.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration applies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `TipWithholding` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TipWithholding\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/voidReasons/{guid}\":{\"get\":{\"tags\":[\"Void Reasons\"],\"operationId\":\"voidReasonsGuidGet\",\"summary\":\"Get a void sale reason\\n\",\"description\":\"Returns a `VoidReason` object\\ncontaining information about a cause for making a sale invalid\\nconfigured for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the void reason.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `VoidReason` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/VoidReason\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/voidReasons\":{\"get\":{\"tags\":[\"Void Reasons\"],\"operationId\":\"voidReasonsGet\",\"summary\":\"Get void sale reasons\\n\",\"description\":\"Returns an array of `VoidReason` objects\\ncontaining information about causes for making a sale invalid\\nconfigured for a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `VoidReason` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/VoidReason\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/config/v2\"}],\"components\":{\"securitySchemes\":{\"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. \\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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"config:read\":\"Allows reading from the configuration API.\\n\"}}}}},\"schemas\":{\"AlternatePaymentType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the alternate payment type.\"}}}]},\"BreakType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the work break type, as recognized by\\nrestaurant employees.\\n\"},\"active\":{\"type\":\"boolean\",\"description\":\"Indicates whether the break is available and can be taken\\nby restaurant employees.\\n\"},\"paid\":{\"type\":\"boolean\",\"description\":\"Indicates whether the break is paid.\"},\"duration\":{\"type\":\"integer\",\"description\":\"The duration of the break in minutes.\"},\"enforceMinimumTime\":{\"type\":\"boolean\",\"description\":\"Indicates whether the duration is enforced as the minimum\\ntime for the break.\\n\"},\"trackMissedBreaks\":{\"type\":\"boolean\",\"description\":\"True if breaks that are not taken within the specified break\\ninterval should be generated in Toast.\\n\"},\"breakIntervalHrs\":{\"type\":\"integer\",\"description\":\"The number of hours between break intervals. Break intervals\\nare specified in hours and minutes. If missed breaks are not\\ntracked, this value may be null.\\n\"},\"breakIntervalMins\":{\"type\":\"integer\",\"description\":\"The number of minutes between break intervals. Break intervals\\nare specified in hours and minutes. If missed breaks are not\\ntracked, this value may be null.\\n\"},\"trackBreakAcknowledgement\":{\"type\":\"boolean\",\"description\":\"Indicates whether break acknowledgements are collected for\\nthis type of break. Break acknowledgements will not be\\ncollected if `trackMissedBreaks` is false.\\n\"}}}]},\"CashDrawer\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"printer\":{\"$ref\":\"#/components/schemas/ToastReference\"}}}]},\"DiningOption\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the dining option.\"},\"behavior\":{\"type\":\"string\",\"description\":\"The behavior of the dining option. `TAKE_OUT` and\\n`DELIVERY` require a `customer` to be specified on the\\norder, and `DELIVERY` requires a `deliveryInfo` value.\\n\",\"enum\":[\"DINE_IN\",\"TAKE_OUT\",\"DELIVERY\"]},\"curbside\":{\"type\":\"boolean\",\"description\":\"Indicates whether the dining option has curbside behavior, and allows the guest to\\nprovide identifying information such as a description of their vehicle.\\n\"}}}]},\"Discount\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"A discount configured in Toast Web.\\nDiscounts are always applied before taxes, but after\\nservice charges are calculated.\\n\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The human-readable name of the discount.\"},\"active\":{\"type\":\"boolean\",\"description\":\"Indicates whether the discount is available and can be\\napplied by restaurant employees.\\n\"},\"type\":{\"type\":\"string\",\"description\":\"* `PERCENT` - the discount reduces the price by a\\npreconfigured percent.\\n* `FIXED` - the discount reduces the price by a\\npreconfigured currency amount.\\n* `OPEN_PERCENT` - the discount reduces the price by a\\npercent entered by a restaurant employee.\\n* `OPEN_FIXED` - the discount reduces the price by a\\ncurrency amount entered by a restaurant employee.\\n* `BOGO` - a buy one get one (BOGO) discount.\\n* `FIXED_TOTAL` - a combo discount that reduces the\\nprice of all eligible items to a preconfigured currency\\namount.\\n\",\"enum\":[\"PERCENT\",\"FIXED\",\"OPEN_PERCENT\",\"OPEN_FIXED\",\"BOGO\",\"FIXED_TOTAL\"]},\"percentage\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Percent discount applied when the `amountType` is\\n`PERCENT`. This value will be greater than 0 and at\\nmost 100.\\n\"},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of the discount when the\\n`amountType` is `FIXED`. This value will be greater\\nthan 0.\\n\"},\"selectionType\":{\"type\":\"string\",\"description\":\"* `CHECK` - the discount can be applied to a check.\\n* `BOGO` - a buy one get one (BOGO) discount.\\n* `ITEM` - the discount can be applied to an item\\nselection in a check.\\n\",\"enum\":[\"CHECK\",\"ITEM\",\"BOGO\"]},\"nonExclusive\":{\"type\":\"boolean\",\"description\":\"Indicates whether you can apply the discount with other\\ndiscounts. This value is always `false` for item and\\ncombo discounts. Set this value for check and BOGO\\ndiscounts by selecting **Allow with other discounts** in\\nthe **Discounts Rules** section of the discounts\\nconfiguration page of Toast Web.\\n\"},\"itemPickingPriority\":{\"type\":\"string\",\"description\":\"Indicates which menu item selections are discounted\\nwhen you apply a BOGO discount. An item that is\\ndiscounted by a BOGO discount is a \\\"get\\\" item.\\n\\n* `FIRST` - the BOGO discount applies to the first\\nmatching item selection in the check or the discount is\\nnot a BOGO discount.\\n\\n* `LEAST_EXPENSIVE` - the BOGO discount applies\\nto the least expensive matching item selection in the check.\\n`LEAST_EXPENSIVE` is the default `itemPickingPriority` value\\nfor discounts that are not BOGO discounts.\\n\\n* `MOST_EXPENSIVE` - the BOGO discount applies to the most\\nexpensive matching item selection in the check.\\n\",\"enum\":[\"FIRST\",\"LEAST_EXPENSIVE\",\"MOST_EXPENSIVE\"]},\"fixedTotal\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The total price of items discounted by a combo\\ndiscount. This value is `null` for discounts that are\\nnot combo discounts.\\n\"},\"promoCodes\":{\"type\":\"array\",\"description\":\"A list of promotion identifiers associated with this discount.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PromoCode\"}}}}]},\"PromoCode\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"Information about a promotion, associated with a discount.\\n\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"The identifier of the promotion. Guests enter the code to apply the discount.\"},\"name\":{\"type\":\"string\",\"description\":\"The human-readable name of the promotion.\"},\"usageType\":{\"type\":\"string\",\"description\":\"Indicates how the promo code can be used.\\n* `SINGLE_USE_PHONE` - the promo code can only be used once per phone number. Some promotional discounts require a guest's phone number when applying the promo code.\\n* `SINGLE_USE_UNIQUE_CODE` - the promo code is a unique code that can only be used once.\\n* `MULTI_USE` - the promo code can be used multiple times.\\n\",\"enum\":[\"SINGLE_USE_PHONE\",\"SINGLE_USE_UNIQUE_CODE\",\"MULTI_USE\"]}}}]},\"Menu\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the menu as it appears in the Toast POS.\\n\"},\"orderableOnline\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates whether restaurant guests can order from the menu online.\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu entity, instead of this\\n`orderableOnline` value, to determine if the entity should be\\navailable for online ordering.\\n\",\"enum\":[\"YES\",\"NO\"]},\"visibility\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates where the menu is displayed and who can see it.\\n* ALL: Visible to everyone (servers and customers)\\n* POS_ONLY: Only visible to servers\\n* NONE: Hidden from everyone\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu\\nentity, instead of this `visibility` value, to determine where the\\nentity should be visible.\\n\",\"enum\":[\"ALL\",\"POS_ONLY\",\"NONE\"]},\"groups\":{\"type\":\"array\",\"description\":\"An array of the `MenuGroup` objects\\nthat are part of this menu.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"images\":{\"type\":\"array\",\"description\":\"A collection of images associated with the menu.\",\"items\":{\"$ref\":\"#/components/schemas/Image\"}},\"unitOfMeasure\":{\"type\":\"string\",\"description\":\"The unit of measure used to determine the price of items in this menu. For example, $10.00 per gram.\\n\\nThe default is `NONE`, which means that the item is not meant to\\nbe measured during a sale.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"]}}}]},\"MenuItem\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the menu item as it appears in the Toast POS.\\n\"},\"calories\":{\"type\":\"integer\",\"description\":\"The amount of food energy in the item, expressed in\\nCalorie units. Values can be positive, negative, or zero.\\n\"},\"sku\":{\"type\":\"string\",\"description\":\"The stock keeping unit (SKU) code for the item.\"},\"plu\":{\"type\":\"string\",\"description\":\"The price look up (PLU) code for the item.\"},\"orderableOnline\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates whether restaurant guests can order from the menu online.\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu entity, instead of this\\n`orderableOnline` value, to determine if the entity should be\\navailable for online ordering.\\n\",\"enum\":[\"YES\",\"NO\"]},\"visibility\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates where the menu is displayed and who can see it.\\n* ALL: Visible to everyone (servers and customers)\\n* POS_ONLY: Only visible to servers\\n* NONE: Hidden from everyone\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu\\nentity, instead of this `visibility` value, to determine where the\\nentity should be visible.\\n\",\"enum\":[\"ALL\",\"POS_ONLY\",\"NONE\"]},\"type\":{\"type\":\"string\",\"description\":\"Specifies whether this item is a special request or other\\noff-menu transaction.\\n* `NONE` - a normal menu item or modifier.\\n* `OPEN_ITEM` - an item that is not on a menu.\\n* `SPECIAL_REQUEST` - a selection that is not an item.\\n* `PORTION` - a division of a menu item used to apply modifiers separately to separate parts of an item. For example, one half of a pizza.\\n\",\"enum\":[\"NONE\",\"OPEN_ITEM\",\"SPECIAL_REQUEST\",\"PORTION\"]},\"optionGroups\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the `MenuOptionGroup`s\\nthat contain modifiers applicable to this item. Does not\\ninclude those inherited from the parent `MenuGroup`.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"inheritOptionGroups\":{\"type\":\"boolean\",\"description\":\"True if this menu item inherits `MenuOptionGroup`s\\nfrom its parent `MenuGroup`.\\n\"},\"images\":{\"type\":\"array\",\"description\":\"An array of `Image`\\nobjects that are associated with the `MenuItem`.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Image\"}},\"unitOfMeasure\":{\"type\":\"string\",\"description\":\"The unit of measure used to determine the price of the item.\\nThe default is NONE, which means that the item is not meant to\\nbe measured during a sale.\\nThis value is not relevant if `inheritUnitOfMeasure` is true.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"]},\"inheritUnitOfMeasure\":{\"type\":\"boolean\",\"description\":\"True if this menu item inherits its unit of measure\\nfrom its parent `MenuGroup`.\\n\"}}}]},\"MenuGroup\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the menu group as it appears in the Toast POS.\"},\"menu\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"orderableOnline\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates whether restaurant guests can order from the menu online.\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu entity, instead of this\\n`orderableOnline` value, to determine if the entity should be\\navailable for online ordering.\\n\",\"enum\":[\"YES\",\"NO\"]},\"visibility\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates where the menu is displayed and who can see it.\\n* ALL: Visible to everyone (servers and customers)\\n* POS_ONLY: Only visible to servers\\n* NONE: Hidden from everyone\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu\\nentity, instead of this `visibility` value, to determine where the\\nentity should be visible.\\n\",\"enum\":[\"ALL\",\"POS_ONLY\",\"NONE\"]},\"parent\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"items\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the `MenuItem`s in the menu\\ngroup.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"subgroups\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the child `MenuGroup`s in\\nthe menu group. Empty if the menu group does not include any child\\nmenu groups.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"optionGroups\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the child `MenuOptionGroup`s\\nthat contain modifiers applicable to the group, its\\nsubgroups and its items. Does not include\\n`MenuOptionGroup`s inherited from its parent `MenuGroup`.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"inheritOptionGroups\":{\"type\":\"boolean\",\"description\":\"True if this `MenuGroup` inherits `MenuOptionGroup`s\\nfrom its parent `MenuGroup`.\\n\"},\"images\":{\"type\":\"array\",\"description\":\"An array of `Image`\\nobjects associated with with the `MenuGroup`.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Image\"}},\"unitOfMeasure\":{\"type\":\"string\",\"description\":\"The unit of measure used to determine the price of items in this group.\\n\\nThe default is `NONE`, which means that the item is not meant to\\nbe measured during a sale.\\nThis value is not relevant if `inheritUnitOfMeasure` is true.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"]},\"inheritUnitOfMeasure\":{\"type\":\"boolean\",\"description\":\"True if this `MenuGroup` inherits its unit of measure\\nfrom its parent `MenuGroup` or (if its parent is null)\\nits parent `Menu`.\\n\"}}}]},\"MenuOptionGroup\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the `MenuOptionGroup` as it appears in the Toast POS.\"},\"options\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the `MenuItem`s in\\nthe menu group.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"minSelections\":{\"type\":\"number\",\"format\":\"integer\",\"description\":\"The minimum number of selections that must be made from this option group.\"},\"maxSelections\":{\"type\":\"number\",\"format\":\"integer\",\"description\":\"The maximum number of selections that can be made from this option group.\"}}}]},\"PreModifier\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the pre modifier that appears in the Toast POS.\"},\"scalePrice\":{\"type\":\"boolean\",\"description\":\"True if this multiplies the modifier price, false if it adds to the modifier price.\"},\"basePrice\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Amount to add to the modifier price, if scalePrice is false. Otherwise not used.\"},\"scaleFactor\":{\"type\":\"number\",\"format\":\"float\",\"description\":\"Amount to multiply the modifier price, if scalePrice is true. Otherwise not used.\"},\"displayMode\":{\"type\":\"string\",\"description\":\"Where this premodifier should be displayed relative to the modifier name.\\nPREFIX - before the modifier name\\nSUFFIX - after the modifier name\\n\",\"enum\":[\"PREFIX\",\"SUFFIX\"]},\"parent\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"chargeAsExtra\":{\"type\":\"boolean\",\"description\":\"When true, selecting this pre-modifier adds an additional portion of the modifier to the menu item and adds the price of the additional portion to the menu item according to the rules listed below.\\n\\nIf the modifier group that the modifier belongs to:\\n* Uses the **No charge** option, the Toast platform uses the modifier's <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminBasingModifierOptionsOnExistingMenuItems\\\">override price</a> or, if no override price exists, the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> price as the price of the additional portion.\\n* Uses the **Individual** option where each modifier has its own price, the Toast platform uses the modifier's override price or, if no override price exists, the item reference price as the price of the additional portion.\\n* Uses the **Group** option where all modifiers in the group share a price, the Toast platform uses the group price as the price of the additional portion.\\n\\nAdditionally, if the modifier group that the modifier belongs to uses:\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSizePrice.html#adminSizePricingForModifierGroups\\\">Size</a> pricing, the Toast platform uses the size price that matches the size of the menu item when determining the price of the additional portion.\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSequencePrice.html\\\">Sequence</a> pricing, the Toast platform treats the additional portion as the next modifier in the sequence and prices it using the sequence pricing rules that have been specified.\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSizeSequencePrice.html\\\">Size/sequence</a> pricing, the Toast platform matches the size of the additional portion to the size of the menu item and then treats it as the next modifier in the sequence when determining the price of the additional portion.\\n\\nThe `chargeAsExtra` value is `null` if the value is not set.\\n\",\"nullable\":true}}}]},\"PreModifierGroup\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the pre modifier that appears in the Toast POS.\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"True if this PreModifierGroup is set as the default Group.\\nOnly a single PreModifierGroup can be set as default at one time.\\n\"}}}]},\"NoSaleReason\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the no sale reason that appears in the Toast POS.\"}}}]},\"PayoutReason\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The short name of this payout reason.\"}}}]},\"PriceGroup\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this price group.\"}}}]},\"Printer\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this printer.\"}}}]},\"RestaurantService\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this meal service (for example, `Lunch` or\\n`Dinner`).\\n\"}}}]},\"RevenueCenter\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"A set of ServiceAreas and POS devices for which separate revenue reports can be generated. For instance, a restaurant with a bar might choose to define two RevenueCenters, one for the bar and one for the dining area.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this revenue center.\"},\"description\":{\"type\":\"string\",\"description\":\"The description of this revenue center.\"}}}]},\"SalesCategory\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"A set of items that will be grouped together in sales reports. SalesCategories can be applied at any level, from entire menus to individual menu items.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this sales category.\"}}}]},\"ServiceArea\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"A representation of a physical service area, a group of tables, in a restaurant.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this service area.\"},\"revenueCenter\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}}]},\"ServiceCharge\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"description\":\"Any charge applied to a check for something other than menu item. Typical examples include gratuity and delivery fees.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this service charge.\"},\"amountType\":{\"type\":\"string\",\"description\":\"The type of service charge.\",\"enum\":[\"FIXED\",\"PERCENT\",\"OPEN\"]},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Amount in USD to be applied for `FIXED` type service charges.\"},\"percent\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Percent fee to be applied for `PERCENT` type service\\ncharges, based on pre-discount check amount. Must be a\\nnumber between 0 and 100.\\n\"},\"criteria\":{\"$ref\":\"#/components/schemas/ServiceChargeCriteria\"},\"gratuity\":{\"type\":\"boolean\",\"description\":\"True if the service charge is a gratuity and is assigned to the owner of the check.\"},\"taxable\":{\"type\":\"boolean\",\"description\":\"True if tax should be applied to the service charge.\"},\"applicableTaxes\":{\"type\":\"array\",\"description\":\"A reference to the taxes applied to the service charge, if the service charge is taxable.\",\"items\":{\"$ref\":\"#/components/schemas/TaxRate\"}},\"serviceChargeCalculation\":{\"type\":\"string\",\"description\":\"Defines whether or not the service charge is applied before (PRE) or after (POST) discounts. This field is null for non-percent service charges.\",\"enum\":[\"PRE_DISCOUNT\",\"POST_DISCOUNT\"]},\"destination\":{\"type\":\"string\",\"description\":\"Final recipient of the funds from this service charge.\\n\\n* `RESTAURANT` - The business owner of the restaurant receives the service charge funds.\\n* `SERVER` - Restaurant employees receive the service charge funds e.g. gratuity.\\n* `TOAST` - Toast receives the service charge funds.\\n* `THIRD_PARTY` - A third party receives the service charge funds e.g. fundraising funds go to charity.\\n\",\"enum\":[\"RESTAURANT\",\"SERVER\",\"TOAST\",\"THIRD_PARTY\"]},\"taxInclusive\":{\"type\":\"boolean\",\"description\":\"Supports future functionality.\"},\"taxProrated\":{\"type\":\"boolean\",\"description\":\"Supports future functionality.\"}}}]},\"ServiceChargeCriteria\":{\"description\":\"Describes thresholds for when a service charge should be applied to a check.\",\"properties\":{\"minCheckAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The service charge is only applicable if the pre-discount check is at least this amount.\"},\"delivery\":{\"type\":\"boolean\",\"description\":\"True if the service charge is only applicable for deliveries.\"},\"maxCheckAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The service charge is waived if the pre-discount check amount is more than this amount. A `null` value means this criteria is inapplicable.\"},\"minDeliveryDistance\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The service charge is only applicable to deliveries that are at least this distance. A `null` value means this criteria is inapplicable.\"},\"takeout\":{\"type\":\"boolean\",\"description\":\"Indicates whether the service charge is automatically applied to orders that have the takeout dining option behavior.\"},\"dineIn\":{\"type\":\"boolean\",\"description\":\"Indicates whether the service charge is applied to orders that have the dine-in dining option behavior.\"}}},\"Table\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"Represents a dining table in a restaurant.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The human-readable name of this table as it appears in the POS.\"},\"serviceArea\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"revenueCenter\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}}]},\"TaxRate\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this tax rate.\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"True if this tax rate is the default tax rate.\"},\"rate\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The tax rate value.\\n\\nFor a fixed amount tax rate, is the fixed amount of the tax.\\n\\nFor a percent tax rate, the percentage is expressed as a decimal value. For example, if the tax rate is 6.25%, then `rate` is 0.0625.\\n\\nIf `type` is `NONE`, then `rate` is `null`.\\n\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the tax rate.\",\"enum\":[\"PERCENT\",\"FIXED\",\"TABLE\",\"NONE\",\"EXTERNAL\"]},\"roundingType\":{\"type\":\"string\",\"description\":\"The method used to round fractional currency amounts to non-fractional currency amounts.\\n\\nOnly applies to `PERCENT` tax rates. For other tax rate types, `roundingType` is `null`.\\n\\nValid values:\\n\\n* `HALF_UP` - Round values up or down to the nearest number. If the last digit is 5, which is halfway, then always round up to the nearest number.\\n\\n* `HALF_EVEN` - Round values up or down to the nearest number. If the last digit is 5, which is halfway, then round up or down to the nearest even number.\\n\\n* `ALWAYS_UP` - Always round up to the next number.\\n\\n* `ALWAYS_DOWN` - Always round down to the next number.\\n\\nFor more details and examples, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPercentTaxRates.html#roundingOptions\\\">Rounding options</a>.\\n\",\"enum\":[\"HALF_UP\",\"HALF_EVEN\",\"ALWAYS_UP\",\"ALWAYS_DOWN\"]},\"taxTable\":{\"type\":\"array\",\"description\":\"An array of `TaxTableRow` objects that define a set of tax amounts that apply to specific sale amount ranges.\",\"items\":{\"$ref\":\"#/components/schemas/TaxTableRow\"}},\"conditionalTaxRates\":{\"type\":\"array\",\"description\":\"An array of `ConditionalTaxRate`\\nobjects that indicate the conditional rates that override\\nthe default `rate` for this `TaxRate` in specific\\nsituations. For example, a conditional rate might\\noverride the default rate when a `TaxRate` is applied for\\na specific dining option, such as takeout.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ConditionalTaxRate\"}}}}]},\"ConditionalTaxRate\":{\"type\":\"object\",\"description\":\"A conditional tax rate that overrides the default `rate`\\nfor a `TaxRate` in\\nspecific situations. For example, a conditional rate\\nmight override the default rate when a `TaxRate` is\\napplied for a specific dining option, such as takeout.\\n\",\"properties\":{\"condition\":{\"description\":\"A string describing the condition for the tax rate\",\"type\":\"string\"},\"rate\":{\"description\":\"The percentage rate of the conditional tax rate\",\"type\":\"number\",\"format\":\"double\"}}},\"TaxTableRow\":{\"type\":\"object\",\"description\":\"A closed sale amount range that corresponds to a specific tax amount in a tax table.\",\"properties\":{\"start\":{\"description\":\"The start of a sale amount range that corresponds to a specific tax amount in a tax table.\",\"type\":\"number\",\"format\":\"currency\"},\"end\":{\"description\":\"The end of a sale amount range that corresponds to a specific tax amount in a tax table.\",\"type\":\"number\",\"format\":\"currency\"},\"tax\":{\"description\":\"The tax amount for the tax table row.\",\"type\":\"number\",\"format\":\"currency\"},\"pattern\":{\"description\":\"Specifies whether the price range is part of an incomplete set of ranges that establish an algorithm that you can use to calculate tax amounts.\",\"type\":\"boolean\"}}},\"TipWithholding\":{\"type\":\"object\",\"description\":\"Information about the way tip withholding is configured for\\na restaurant. Tip withholding is a percentage of employees'\\ncredit card tips and service charges that are paid to\\nemployees as a gratuity that is kept by a restaurant to\\ncover credit card processing fees.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Indicates whether a restaurant location withholds a percent of\\nemployees' credit card tips.\\n\\n* `true` - the location keeps a percent of employees' credit card\\ntips.\\n\\n* `false` - the location does not keep a percent of employees'\\ncredit card tips.\\n\"},\"percentage\":{\"type\":\"number\",\"description\":\"The decimal percentage of credit card tips withheld. If tip\\nwithholding is not `enabled`, tips will not be withheld in the\\nToast platform regardless of this value.\\n\"}}}]},\"VoidReason\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"When voiding something through the POS, the user must choose a preconfigured void reason.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this void reason.\"}}}]},\"Image\":{\"type\":\"object\",\"description\":\"Information about an image associated with a menu or menu item.\",\"properties\":{\"url\":{\"description\":\"The web address of the image.\",\"type\":\"string\"}}},\"ExternalReference\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"externalId\":{\"description\":\"External identifier string, prefixed by the naming authority.\",\"type\":\"string\"}},\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.\"}]},\"ToastReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID.\",\"required\":[\"guid\",\"entityType\"],\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast POS.\",\"type\":\"string\"},\"entityType\":{\"description\":\"The type of object this is.\",\"type\":\"string\"}}}}}}},\"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-config-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"configuration.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/configuration.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"configuration","isDefault":true,"id":"configuration","title":"configuration","link":null}]},{"id":"509e1611-d1cf-5ec9-9c46-6bb752352549overview/__redocly content redirect/creditcards/overview/","definitionId":"creditCards","link":"/creditcards/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/creditcards.reference.page.yaml","info":{"title":"Credit Cards API","description":"A simple, single request, synchronous API to authorize credit card \ntransactions associated with an orders API order.\n","version":"1.0.0","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"creditCards","label":"Credit cards","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-ccpartner-api.yaml"},"apiVersions":[{"definitionId":"creditCards","isDefault":true,"title":"creditCards","id":"creditCards"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Credit Cards API\",\"description\":\"A simple, single request, synchronous API to authorize credit card \\ntransactions associated with an orders API order.\\n\",\"version\":\"1.0.0\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/merchants/{merchantUuid}/payments/{paymentUuid}\":{\"put\":{\"operationId\":\"merchantsMerchantUuidPaymentsPaymentUuidPut\",\"summary\":\"Authorize a credit card\",\"description\":\"Authorize a credit card payment. Funds will be held until the\\npayment is voided or captured.\\n\\nYou must submit an orders API request to apply the payment to a\\ncheck within five minutes of authorization, otherwise the\\npayment is automatically voided.\\n\\nPayment must be captured within seven days of authorization,\\notherwise the payment is automatically voided. Capture\\noccurs the evening after the order is fulfilled by the\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"merchantUuid\",\"in\":\"path\",\"description\":\"The Toast GUID of the merchant (restaurant) that will\\nreceive the payment. This is the same value as the\\nToast-Restaurant-External-ID.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"paymentUuid\",\"in\":\"path\",\"description\":\"The unique identifier (UID) of this authorization,\\ngenerated by the restaurant organization or integration\\npartner.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The GUID of the restaurant used as the context of the request.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PaymentAuthorization\"}}},\"description\":\"The authorization request, including encrypted credit card information and payment details.\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The authorization request was processed. See the response for details.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PaymentStatus\"}}}},\"400\":{\"description\":\"The request was not valid. A required field may be missing.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ToastError\"}}}},\"404\":{\"description\":\"The merchant (restaurant) does not exist.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ToastError\"}}}},\"409\":{\"description\":\"An authorization request was already made for this payment\\nUUID. Verify that you are generating unique payment UUIDs\\nfor each request.  This can also occur if the same request\\nis resubmitted, but the state has since been changed by\\nanother system (for example, voided on the POS).\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ToastError\"}}}},\"422\":{\"description\":\"The request failed validation. The structure is not\\ncorrect. A message with more information is returned if\\nusing the certification environment.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ToastError\"}}}},\"500\":{\"description\":\"Unexpected error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ToastError\"}}}}},\"security\":[{\"oauth2\":[\"credit_cards.authorization:write\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/ccpartner/v1\"}],\"components\":{\"securitySchemes\":{\"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. \\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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"credit_cards.authorization:write\":\"Allows authorization of payments through the credit cards API.\\n\"}}}}},\"schemas\":{\"ToastError\":{\"description\":\"Contains error details.\",\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the problem.\"},\"detail\":{\"type\":\"string\",\"description\":\"Error details, such as an exception and stack trace.\"}},\"required\":[\"description\"]},\"PaymentStatus\":{\"description\":\"Status of a payment.\",\"type\":\"object\",\"required\":[\"paymentState\"],\"properties\":{\"paymentState\":{\"type\":\"string\",\"enum\":[\"AUTHORIZED\",\"ACKNOWLEDGED\",\"DENIED\"],\"description\":\"The state of the payment. Toast may add values to this field.\\nMake sure that your implementation can handle additional\\nvalues.\\n\"},\"authorizationMetadata\":{\"$ref\":\"#/components/schemas/AuthorizationMetadata\"},\"amount\":{\"description\":\"The amount of this payment, not including tip.\",\"type\":\"object\"},\"tipAmount\":{\"description\":\"The tip amount of this payment.\",\"type\":\"object\"},\"denialReason\":{\"description\":\"The reason a payment was denied. This must be displayed to the consumer.\",\"type\":\"string\"},\"error\":{\"type\":\"string\",\"description\":\"If the payment is in an error state, this will contain the error.\"}}},\"AuthorizationMetadata\":{\"description\":\"Additional details about a payment, typically displayed on a receipt\\nand logged by the partner.\\n\",\"type\":\"object\",\"required\":[\"localTransactionDate\",\"cardBrand\",\"authorizationCode\",\"last4\"],\"properties\":{\"localTransactionDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"A copy of the `localTransactionDate` provided by the partner, in ISO 8601 format.\\n\"},\"cardBrand\":{\"type\":\"string\",\"description\":\"The brand of the credit card. For example, AMEX, Discover, Visa, or Mastercard.\"},\"authorizationCode\":{\"type\":\"string\",\"description\":\"A code generated by card processing networks upon accepting an\\nauthorization request.\\n\"},\"last4\":{\"type\":\"string\",\"description\":\"The final four digits of the credit card number.\\n\"}}},\"PartnerServiceInfo\":{\"required\":[\"instanceId\"],\"description\":\"Information about the client that made the payment request. This\\ninformation can be used for troubleshooting problems.\\n\",\"type\":\"object\",\"properties\":{\"instanceId\":{\"type\":\"string\",\"description\":\"An identifier for the client that made the authorization\\nrequest. For example, this might be a partner service\\ninstance ID that is visible in log messages.\\n\"},\"additionalInfo\":{\"type\":\"string\",\"description\":\"Additional information about the service. For example, this\\nmight be a JSON structure containing the IP address and\\nservice version.\\n\"}}},\"PaymentRequestMetadata\":{\"description\":\"Metadata about the request being made.\",\"type\":\"object\",\"required\":[\"partnerServiceInfo\",\"localTransactionDate\",\"originIPAddr\",\"cardFirst6\",\"cardLast4\",\"billingAddress\",\"guestIdentifier\"],\"properties\":{\"partnerServiceInfo\":{\"$ref\":\"#/components/schemas/PartnerServiceInfo\"},\"localTransactionDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time, in ISO 8601 format, when the guest presents their credit card. \\n\"},\"originIPAddr\":{\"type\":\"string\",\"description\":\"The public ipv4 or ipv6 address of the cardholder making the payment. The origin IP address is essential for detecting and preventing fraud attempts in credit card authorization requests. To prevent disruption to your transaction workflow, ensure the correct origin IP address is used.\"},\"cardFirst6\":{\"type\":\"string\",\"description\":\"The first six digits of the credit card number. The first six\\ndigits are the bank identification number (BIN) for the card.\\nMust exactly match that provided in the encrypted card data.\\n\"},\"cardLast4\":{\"type\":\"string\",\"description\":\"The last four digits of the credit card number. Must exactly\\nmatch that provided in the encrypted card data.\\n\"},\"billingAddress\":{\"$ref\":\"#/components/schemas/BillingAddress\"},\"deliveryAddress\":{\"$ref\":\"#/components/schemas/DeliveryAddress\"},\"userAgent\":{\"type\":\"string\",\"description\":\"For payments taken through a browser, the browser's user agent string.\\n\"},\"guestIdentifier\":{\"type\":\"string\",\"description\":\"An identifier for the guest making the payment such as\\nan email address or phone number. Must consist of the following characters:\\n`a-z, A-Z, 0-9, =, ., -, _, +, @, :, &, ^, %, !, $`\\n\"},\"guestEmail\":{\"type\":\"string\",\"description\":\"The email address of the guest placing the payment.\\n\"},\"appName\":{\"type\":\"string\",\"description\":\"A company-specific name for the mobile app (if any) the payment is made through.\\nFor instance, use 'MyCompany Android App' instead of 'Android App'\\n\"},\"appVersion\":{\"type\":\"string\",\"description\":\"The version of the mobile app (if any) the payment is made through.\\nYou can use any string to represent the app version. There are no\\nformat or content requirements.\\n\"}}},\"PaymentAuthorization\":{\"description\":\"A request to authorize a credit card payment.\",\"type\":\"object\",\"required\":[\"cardNumberOrigin\",\"willSaveCard\",\"encryptedCardData\",\"amount\",\"tipAmount\",\"requestMetadata\",\"keyId\"],\"properties\":{\"cardNumberOrigin\":{\"type\":\"string\",\"enum\":[\"END_USER\",\"PARTNER_VAULT\"],\"description\":\"The way that the credit card was provided for the payment\\nrequest. The value is `END_USER` if the cardholder entered\\nthe card number (PAN) as part of a web order. The value is\\n`PARTNER_VAULT` if the PAN was retrieved from a vault\\ncontrolled by the integration partner.\\n\\nThis value is used with `willSaveCard` to report information \\nabout stored credit card numbers to credit card provider \\nnetworks. If your organization is using stored credit card \\ninformation for a credit card authorization, this value must \\nbe `PARTNER_VAULT`. The default value is `END_USER`.\\n\"},\"willSaveCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether your organization will save the restaurant \\nguests' credit card information for future use.\\n\\nToast reports information about stored credit card information \\nto some credit card providers. This \\\"card on file\\\" or \\\"stored \\ncredentials\\\" reporting is required by some credit card provider \\nnetworks. These networks may impose fees for non-compliance \\nwith \\\"card on file\\\" reporting requirements.\\n\\nNote that integration partners are responsible for any and \\nall fees incurred, and must comply with all applicable law \\nand rules relevant to, \\\"card on file\\\" consent, storage, use \\nand reporting requirements in accordance with card brand \\nregulations and the integration partner agreement.\\n\"},\"encryptedCardData\":{\"type\":\"object\",\"description\":\"A base64-encoded version of the encrypted card data payload.\\nFor information about encrypting and encoding credit card\\ninformation, see the <cite>Toast API Developer's\\nGuide</cite>.\\n\"},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The check price that should be charged to the credit card,\\nnot including the tip. For example, the value `10.00`\\nrepresents ten USD and zero cents. The `amount` must not be\\nnegative. The total of the `amount` value and the `tipAmount`\\nvalue must be greater than zero.\\n\"},\"keyId\":{\"type\":\"string\",\"description\":\"The identifier of the encryption key and algorithm used \\nto encrypt the credit card data. Toast integration support \\nprovides this identifier along with the encryption key \\nitself. If you received an encryption key before June 2018,\\nyou may omit this field. For all API users, supplying a\\nkeyId value prevents downtime during key rotations.\\n\"},\"tipAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The tip that should be charged to the credit card. For\\nexample, the value `1.00` represents one USD and zero cents.\\nThe tip amount must not be negative. The total of the `amount`\\nvalue and the `tipAmount` value must be greater than zero.\\n\"},\"requestMetadata\":{\"$ref\":\"#/components/schemas/PaymentRequestMetadata\"}}},\"BillingAddress\":{\"description\":\"An international billing address including name and phone number.\\nA `BillingAddress` object for a `PaymentRequestMetadata` `billingAddress`\\nvalue must exactly match address information you provide in encrypted\\ncredit card data.\\n\",\"type\":\"object\",\"required\":[\"postalCode\",\"country\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name attached to the billing address. This is not necessarily\\nthe same as the name on the card.\\n\"},\"phone\":{\"type\":\"string\",\"description\":\"The phone number associated with the account in [E.164 format](https://www.itu.int/rec/T-REC-E.164).\\n\"},\"address1\":{\"type\":\"string\",\"description\":\"Line 1 of the address\"},\"address2\":{\"type\":\"string\",\"description\":\"Line 2 of the address\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address\"},\"region\":{\"type\":\"string\",\"description\":\"Region or state of the address\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal or ZIP code. If using a code with an extra four digits,\\nfor example a US ZIP+4 code, do not separate the extra digits.\\nFor example, `123451234`.\\n\"},\"country\":{\"type\":\"string\",\"description\":\"Country code using the ISO 3166-1 alpha-3 standard\"}}},\"DeliveryAddress\":{\"description\":\"A generic international delivery address including name and phone number.\\n\",\"type\":\"object\",\"required\":[\"address1\",\"city\",\"region\",\"postalCode\",\"country\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name associated with the address.\\n\"},\"phone\":{\"type\":\"string\",\"description\":\"The phone number associated with the account in [E.164 format](https://www.itu.int/rec/T-REC-E.164).\\n\"},\"address1\":{\"type\":\"string\",\"description\":\"Line 1 of the address\"},\"address2\":{\"type\":\"string\",\"description\":\"Line 2 of the address\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address\"},\"region\":{\"type\":\"string\",\"description\":\"Region or state of the address\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal or ZIP code. If using a code with an extra four digits,\\nfor example a US ZIP+4 code, do not separate the extra digits.\\nFor example, `123451234`.\\n\"},\"country\":{\"type\":\"string\",\"description\":\"Country code using the ISO 3166-1 alpha-3 standard\"}}}}}}},\"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-ccpartner-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"creditcards.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/creditcards.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"creditCards","isDefault":true,"id":"creditCards","title":"creditCards","link":null}]},{"id":"1293e37c-89da-509d-a538-e7b3f4c56ae8overview/__redocly content redirect/giftcards/overview/","definitionId":"giftCards","link":"/giftcards/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/giftcards.reference.page.yaml","info":{"version":"1.0.0","title":"Gift Card Integration API","description":"A REST API that allows the Toast platform to process \ngift card transactions using a gift card provider that it does not \ncurrently support.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"giftCards","label":"Gift cards integration specification","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-integrations-giftcard-api.yaml"},"apiVersions":[{"definitionId":"giftCards","isDefault":true,"title":"giftCards","id":"giftCards"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Gift Card Integration API\",\"description\":\"A REST API that allows the Toast platform to process \\ngift card transactions using a gift card provider that it does not \\ncurrently support.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/yourendpointname\":{\"post\":{\"operationId\":\"yourendpointnamePost\",\"summary\":\"Returns gift card transaction information\\n\",\"description\":\"Provides information about a gift card transaction processed by \\nthe Toast platform. The transaction information in the \\nmessage body is intended to allow a gift card provider to \\nperform corresponding operations on the gift card account, \\nmaintained by that provider.\\n\\nYou define the endpoint name for this implementation. The Toast \\nplatform makes requests to the REST path that you supply \\nduring integration setup.\\n\\nEach `POST` request to the endpoint includes a \\n`Toast-Transaction-Type` header parameter value to indicate the \\ntype of gift card transaction it represents. The possible \\ntransaction types are:\\n\\n* Activate a new gift card.\\n* Add value to an active gift card.\\n* Get the current balance of a gift card.\\n* Redeem value from a gift card, for example for a purchase.\\n* Reverse a previous transaction, for example to void a purchase \\n  made with the gift card.\\n\\nThe `GiftCardTransaction` \\nobject in the message body includes a set of information that \\nis specific for each transaction type.\\n\\nThe response time for a gift card transaction request must be \\nless than 500ms.\\n\\nAll gift card transactions must be considered idempotent. The \\nimplementation must handle multiple requests with the same \\n`Toast-Transaction-GUID` *and* the same `giftCardIdentifier`.\\n\",\"parameters\":[{\"name\":\"Toast-Transaction-GUID\",\"description\":\"A unique identifier of the gift card transaction, defined \\nby the Toast platform.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The unique identifier of the restaurant, defined by the \\nToast platform.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Transaction-Type\",\"description\":\"The type of gift card transaction that occurred. Values are:\\n<ul>\\n  <li>GIFTCARD_ACTIVATE</li>\\n  <li>GIFTCARD_ADD_VALUE</li>\\n  <li>GIFTCARD_GET_BALANCE</li>\\n  <li>GIFTCARD_REDEEM</li>\\n  <li>GIFTCARD_REVERSE</li>\\n</ul>\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\",\"enum\":[\"GIFTCARD_ACTIVATE\",\"GIFTCARD_ADD_VALUE\",\"GIFTCARD_GET_BALANCE\",\"GIFTCARD_REDEEM\",\"GIFTCARD_REVERSE\"]}},{\"name\":\"Authorization\",\"description\":\"a JSON Web Token (JWT) that you can use to authenticate the request. Verify the token using the public key that you get from the Toast user management service.\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GiftCardTransaction\"}}},\"description\":\"A `GiftCardTransaction` \\nobject containing information about the gift card \\ntransaction that the Toast platform processed.\\n\"},\"responses\":{\"200\":{\"description\":\"OK. The `transactionStatus` value of the \\n`GiftCardTransactionResponse` object is `ACCEPT`.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GiftCardTransactionResponse\"}}}},\"400\":{\"description\":\"Bad request. The `transactionStatus` value of the \\n`GiftCardTransactionResponse` object is one of: \\n\\n* `ERROR_INVALID_TOAST_TRANSACTION_TYPE`\\n* `ERROR_CARD_ALREADY_ACTIVATED`\\n* `ERROR_CARD_NOT_ACTIVATED`\\n* `ERROR_CARD_INVALID`\\n* `ERROR_INVALID_INPUT_PROPERTIES`\\n* `ERROR_TRANSACTION_DOES_NOT_EXIST`\\n* `ERROR_INVALID_TOKEN`\\n* `ERROR_TRANSACTION_CANNOT_BE_REVERSED`\\n* `ERROR_INVALID_RESTAURANT`\\n* `ERROR_VERIFICATION_FAILED`\\n* `ERROR_VERIFICATION_REQUIRED`\\n* `ERROR_VERIFICATION_NOT_SUPPORTED`\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GiftCardTransactionResponse\"}}}},\"500\":{\"description\":\"Internal server error.\"}}}}},\"servers\":[{\"url\":\"https://toast-api-server/yourapiname/v1\"}],\"components\":{\"schemas\":{\"GiftCardTransaction\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform. Gift card providers are expected to handle that \\ntransaction.\\n\\nThe set of information in this object depends on the gift card \\ntransaction type. The transaction type is specified in the \\n`Toast-Transaction-Type` header parameter for the request.\\n\\nThe `GiftCardTransaction` object includes the following values \\nfor specific transaction types:\\n\\n* `GIFTCARD_ACTIVATE` - includes an `activateTransactionInformation` value.\\n* `GIFTCARD_ADD_VALUE` - includes an `addValueTransactionInformation` value.\\n* `GIFTCARD_GET_BALANCE` - includes a `getBalanceTransactionInformation` value.\\n* `GIFTCARD_REDEEM` - includes a `redeemTransactionInformation` value.\\n* `GIFTCARD_REVERSE` - includes a `reverseTransactionInformation` value.\\n\",\"properties\":{\"activateTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationActivate\"},\"addValueTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationAddValue\"},\"getBalanceTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationGetBalance\"},\"redeemTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationRedeem\"},\"reverseTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationReverse\"}}},\"TransactionInformation\":{\"type\":\"object\",\"properties\":{\"giftCardIdentifier\":{\"description\":\"The unique identifier of the gift card.\\n\",\"type\":\"string\"},\"identifierSource\":{\"description\":\"Indicates how the Toast platform received the gift card identifier string. Values are:\\n\\n* `KEYED` - A restaurant employee or guest manually entered the identifier string.\\n\\n* `SCANNED` - A restaurant employee or guest used a barcode scanner or other scanning device to enter the identifier string.\\n\\n* `SWIPED` - A restaurant employee or guest used a magnetic card strip reader to enter the identifier string.\\n\\n* `KEYED_ONLINE` - The source of this transaction is Toast Online Ordering, The provider can reject the transaction regardless of the restaurant's verification code settings.\\n\\n* `UNKNOWN` - The Toast platform received the identifier string using a method other than `KEYED`, `SCANNED`, or `SWIPED`, or the method is not known.\\n\",\"type\":\"string\",\"enum\":[\"KEYED\",\"SCANNED\",\"SWIPED\",\"KEYED_ONLINE\",\"UNKNOWN\"]},\"verificationCode\":{\"type\":\"object\",\"description\":\"The verification code, also often referred to as a PIN code, for the gift card account. A verification code is an additional layer of security that some gift card providers include.\\n\",\"properties\":{\"value\":{\"description\":\"The verification code value of the gift card.\\n\",\"type\":\"string\"},\"source\":{\"description\":\"Indicates how the Toast platform received the verification code value. This can differ from an `identifierSource` if the verification code is keyed in by a restaurant employee or guest after a swipe.\\n\\nValues are:\\n\\n* `KEYED` - A restaurant employee or guest manually entered the verification code string.\\n\\n* `SCANNED` - A restaurant employee or guest used a barcode scanner or other scanning device to enter the verification code string.\\n\\n* `SWIPED` - A restaurant employee or guest used a magnetic card strip reader to enter the verification code string. \\n\\n* `VERIFIED` - The Toast platform has previously verified the verification code for this transaction. This is commonly used in the subsequent transactions on the same order. The provider should ignore the validation.\\n\\n* `UNKNOWN` - The Toast platform received the verification code string using a method other than `KEYED`, `SCANNED`, or `SWIPED`, or the method is not known.\\n\",\"type\":\"string\",\"enum\":[\"KEYED\",\"SCANNED\",\"SWIPED\",\"VERIFIED\",\"UNKNOWN\"]}}}}},\"TransactionInformationActivate\":{\"allOf\":[{\"$ref\":\"#/components/schemas/TransactionInformation\"},{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform that activates a new card. Gift card providers are \\nexpected to handle the transaction.\\n\",\"properties\":{\"initialBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"},\"checkIdentifier\":{\"description\":\"The unique identifier of the check that this gift card transaction\\nis part of. No action needs to be taken based on this identifier,\\nit is just provided for tracking purposes.\\n\",\"type\":\"string\"}}}]},\"TransactionInformationAddValue\":{\"allOf\":[{\"$ref\":\"#/components/schemas/TransactionInformation\"},{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast POS \\nsystem that adds to the funds that are available on the card. \\nGift card providers are expected to handle the transaction.\\n\",\"properties\":{\"additionalValue\":{\"description\":\"The currency amount of the funds being added to the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"},\"checkIdentifier\":{\"description\":\"The unique identifier of the check that this gift card transaction\\nis part of. No action needs to be taken based on this identifier,\\nit is just provided for tracking purposes.\\n\",\"type\":\"string\"}}}]},\"TransactionInformationGetBalance\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform that requests the currency value of the funds available \\nfrom the gift card. Gift card providers are expected to handle \\nthe transaction.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/TransactionInformation\"}]},\"TransactionInformationRedeem\":{\"allOf\":[{\"$ref\":\"#/components/schemas/TransactionInformation\"},{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform that reduces the balance of funds available from the card. \\nFor example, when the gift card is used for a purchase. Gift card \\nproviders are expected to handle the transaction.\\n\",\"properties\":{\"redeemedValue\":{\"description\":\"The currency amount of the funds being redeemed from the gift \\ncard.\\n\",\"type\":\"number\",\"format\":\"double\"},\"checkIdentifier\":{\"description\":\"The unique identifier of the check that this gift card transaction\\nis part of. No action needs to be taken based on this identifier,\\nit is just provided for tracking purposes.\\n\",\"type\":\"string\"},\"isCashOut\":{\"description\":\"True if this redeem transaction is a cash out transaction,\\nfalse otherwise\\n\",\"type\":\"boolean\"},\"relatedTransaction\":{\"description\":\"The Toast platform unique identifier for a previous gift card transaction.\\nYour integration can use this identifier to confirm information about a\\nprevious, related transaction such as PIN verification. For example, if a\\nrestaurant employee adds a tip or gratuity to a transaction, the Toast POS\\nreverses the initial redemption and sends another redemption with the new\\namount. This value provides the identifier of the initial transaction. If the\\ncurrent transaction is not part of an adjustment (for example, reversing a\\ntransaction) this value is `null`.\\n\",\"type\":\"string\"}}}]},\"TransactionInformationReverse\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction in the Toast  \\nplatform that undoes a previous transaction. Gift card providers \\nare expected to handle the transaction. The only types of\\ntransactions that can be reversed are `GIFTCARD_ADD_VALUE`,\\n`GIFTCARD_REDEEM`, and `GIFTCARD_ACTIVATE`.\\nIf a `GIFTCARD_ADD_VALUE` is reversed then the amount of the\\noriginal transaction should be deducted from the card's balance.\\nIf a `GIFTCARD_REDEEM` is reversed then the amount of the\\noriginal transaction should be added to the card's balance.\\nIf a `GIFTCARD_ACTIVATE` is reversed then the card should be\\nset to inactive and its balance set to `0.00`.\\n`GIFTCARD_GET_BALANCE` and `GIFTCARD_REVERSE` cannot be reversed.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/TransactionInformation\"}],\"properties\":{\"previousTransaction\":{\"description\":\"The identifier of an earlier gift card transaction. This \\nidentifier is provided in the `Toast-Transaction-GUID` header \\nparameter.\\n\",\"type\":\"string\",\"format\":\"guid\"}}},\"GiftCardTransactionResponse\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift \\ncard provider. The Toast platform uses this information to \\ncomplete guests' gift card transactions.\\n\\nThe set of information in this object depends on the gift card \\ntransaction type. The transaction type is specified in the \\n`Toast-Transaction-Type` header parameter for the request.\\n\\nAll `GiftCardTransactionResponse` objects must include a \\n`transactionStatus` value.\\n\\nThe `GiftCardTransactionResponse` object includes the following \\nadditional values for specific transaction types:\\n\\n* `GIFTCARD_ACTIVATE` - includes an `activateResponse` value.\\n* `GIFTCARD_ADD_VALUE` - includes an `addValueResponse` value.\\n* `GIFTCARD_GET_BALANCE` - includes a `getBalanceResponse` value.\\n* `GIFTCARD_REDEEM` - includes a `redeemResponse` value.\\n* `GIFTCARD_REVERSE` - includes a `reverseResponse` value.\\n\\nFor \\nexample, the response object for a `GIFTCARD_ACTIVATE` transaction \\nincludes an `activateResponse` value.\\n\",\"properties\":{\"transactionStatus\":{\"description\":\"Indicates the result of a gift card transaction, reported by the\\ngift card service provider. Possible values are:\\n\\n<ul>\\n  <li>`ACCEPT` - The gift card service provider processed the transaction successfully.</li>\\n  <li>`ERROR_INVALID_TOAST_TRANSACTION_TYPE` - The requested Toast-Transaction-Type is not valid.</li>\\n  <li>`ERROR_CARD_ALREADY_ACTIVATED` - The gift card has already been activated.</li>\\n  <li>`ERROR_CARD_NOT_ACTIVATED` - The gift card has not been activated.</li>\\n  <li>`ERROR_CARD_INVALID` - The gift card is not valid at the current restaurant.</li>\\n  <li>`ERROR_INVALID_INPUT_PROPERTIES` - The specified JSON properties in the request body are not valid.</li>\\n  <li>`ERROR_TRANSACTION_DOES_NOT_EXIST` - The transaction that is being requested to be reversed does not exist.\\n    Only occurs on a `GIFTCARD_REVERSE`</li>\\n  <li>`ERROR_INVALID_TOKEN` - The token supplied in the `Authorization` header field is invalid or cannot be validated.</li>\\n  <li>`ERROR_TRANSACTION_CANNOT_BE_REVERSED` - The specified transaction cannot be reversed. `GIFTCARD_GET_BALANCE`\\n    and `GIFTCARD_REVERSE` transactions cannot be reversed.</li>\\n  <li>`ERROR_INVALID_RESTAURANT` - The restaurant specified by the `Toast-Restaurant-External-ID` is invalid.</li>\\n  <li>`ERROR_VERIFICATION_FAILED` - Verification data specified by the JSON body is invalid.</li>\\n  <li>`ERROR_VERIFICATION_REQUIRED` - Verification data necessary to complete the transaction but the data is missing or `null` in the JSON body.</li>\\n  <li>`ERROR_VERIFICATION_NOT_SUPPORTED` - Verification data is provided by the JSON body but the provider doesn't support verification.</li>\\n</ul>\\n\",\"type\":\"string\",\"enum\":[\"ACCEPT\",\"ERROR_INVALID_TOAST_TRANSACTION_TYPE\",\"ERROR_CARD_ALREADY_ACTIVATED\",\"ERROR_CARD_NOT_ACTIVATED\",\"ERROR_CARD_INVALID\",\"ERROR_INVALID_INPUT_PROPERTIES\",\"ERROR_TRANSACTION_DOES_NOT_EXIST\",\"ERROR_INVALID_TOKEN\",\"ERROR_TRANSACTION_CANNOT_BE_REVERSED\",\"ERROR_INVALID_RESTAURANT\",\"ERROR_VERIFICATION_FAILED\",\"ERROR_VERIFICATION_REQUIRED\",\"ERROR_VERIFICATION_NOT_SUPPORTED\"]},\"activateResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseActivate\"},\"addValueResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseAddValue\"},\"getBalanceResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseGetBalance\"},\"redeemResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseRedeem\"},\"reverseResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseReverse\"}}},\"TransactionResponseActivate\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider for activating a new gift card. The Toast POS \\nsystem uses this information to complete guests' gift card \\ntransactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"}}},\"TransactionResponseAddValue\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider for add value transactions. The Toast platform \\nuses this information to complete guests' gift card transactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"}}},\"TransactionResponseGetBalance\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider for get balance transactions. The Toast POS \\nsystem uses this information to complete guests' gift card \\ntransactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"}}},\"TransactionResponseRedeem\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider that reduces the balance of funds available from \\nthe card. For example, when the gift card is used for a purchase. \\nThe Toast platform uses this information to complete guests' \\ngift card transactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"},\"redeemedValue\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of the funds that were redeemed from the \\ngift card. This value may be different than the \\n`redeemedValue` in a gift card transaction request. For \\nexample, if the card balance is less than the redeem value \\nrequested by the Toast platform, the `redeemedValue` in the \\nresponse will be less than the `redeemedValue in the request.\\n\"}}},\"TransactionResponseReverse\":{\"type\":\"object\",\"description\":\"Information about a gift card transaction from the gift card \\nservice provider that undoes a previous gift card transaction. \\nThe Toast platform uses this information to complete guests' \\ngift card transactions.\\n\",\"properties\":{\"currentBalance\":{\"description\":\"The currency amount of the funds available from the gift card.\\n\",\"type\":\"number\",\"format\":\"double\"}}}}}}},\"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-integrations-giftcard-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"giftcards.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/giftcards.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"giftCards","isDefault":true,"id":"giftCards","title":"giftCards","link":null}]},{"id":"016853b3-3abd-546d-8a72-a6f44e2da661overview/__redocly content redirect/kitchen/overview/","definitionId":"kitchen","link":"/kitchen/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/kitchen.reference.page.yaml","info":{"title":"Kitchen API","version":"1.0.2","description":"Returns information about kitchen operations.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"kitchen","label":"Kitchen","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-kitchen-api-docs.yaml"},"apiVersions":[{"definitionId":"kitchen","isDefault":true,"title":"kitchen","id":"kitchen"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Kitchen API\",\"version\":\"1.0.2\",\"description\":\"Returns information about kitchen operations.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/prepStations\":{\"get\":{\"operationId\":\"prepStationsGet\",\"summary\":\"Get all prep stations\",\"description\":\"Returns the configuration for every prep station that has been created for the specified restaurant. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment. You can use optional query parameters to paginate the results. If a `lastModified` date is specified, returns all objects that were created or modified after that date.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html#adminRoutingToPrepStations\\\">Routing to prep stations</a>\\n\",\"parameters\":[{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to control the pagination of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"in\":\"query\",\"description\":\"Limits the return data to objects created or modified after a specific date and time. For example: `2021-12-01T00:00:00.000+0000`.\\n\",\"schema\":{\"type\":\"string\",\"format\":\"date\"}},{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast platform identifier for the restaurant.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PrepStation` objects. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment.<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html#adminRoutingToPrepStations\\\">Routing to prep stations</a>\\n\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto control the pagination of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response \\ndata</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"minItems\":0,\"maxItems\":1000,\"items\":{\"$ref\":\"#/components/schemas/PrepStation\"}}}}}},\"security\":[{\"oauth2\":[\"kitchen:read\"]}]}},\"/prepStations/{guid}\":{\"parameters\":[{\"name\":\"guid\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"get\":{\"operationId\":\"prepStationsGuidGet\",\"summary\":\"Get a prep station\",\"description\":\"Returns the configuration for a single prep station that has been defined for the specified restaurant. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html#adminRoutingToPrepStations\\\">Routing to prep stations</a>\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast platform identifier for the restaurant.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PrepStation` object.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PrepStation\"}}}}},\"security\":[{\"oauth2\":[\"kitchen:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/kitchen/v1/published\"}],\"components\":{\"securitySchemes\":{\"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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"kitchen:read\":\"Allows reading from the kitchen API.\\n\"}}}}},\"schemas\":{\"PrepStation\":{\"title\":\"PrepStation\",\"type\":\"object\",\"description\":\"The configuration for a single prep station. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminAddPrepStation.html\\\">Add a prep station</a>\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"connectedPrepStations\":{\"type\":\"array\",\"description\":\"An array of `ToastReference` objects containing the identifiers of the other prep stations that this prep station monitors.<br>\\n<br>\\nAllowing a prep station to monitor other prep stations makes it easier for restaurant employees to coordinate when an order includes items that are fulfilled at more than one prep station.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminMonitoringTicketsOtherPrepStations.html\\\">Monitoring items at other prep stations</a><br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminMonitoringTicketsOtherPrepStations.html#adminConfigurePrintOtherStationsItems\\\">Configure printing of other stations' items</a>\\n\",\"items\":{\"$ref\":\"#/components/schemas/ToastReference\"}},\"printingMode\":{\"type\":\"string\",\"description\":\"Determines whether tickets sent to this prep station are printed at the prep station's assigned printer. Values include:\\n* ON: Every ticket sent to this prep station prints at the prep station's assigned printer.\\n* OFFLINE_ONLY: Tickets sent to this prep station only print at the assigned printer if the prep station normally uses a KDS device for ticket display but that device is offline.          \\n\",\"enum\":[\"ON\",\"OFFLINE_ONLY\"]},\"includeWithExpediter\":{\"type\":\"boolean\",\"description\":\"True if tickets sent to this prep station should also be sent to the printer or KDS device that has been set up for the restaurant's expediter.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminUsingExpo.html\\\">Using an expediter KDS</a><br>\\n\"},\"expoRouting\":{\"type\":\"string\",\"description\":\"Determines how tickets are routed to the expediter. This field works in conjunction with `includeWithExpediter` to provide more granular control over expo routing. Values include:\\n* SEND_TO_EXPO: Tickets are sent to both the prep station and the expediter (equivalent to `includeWithExpediter: true`)\\n* EXPO_ONLY: Tickets are sent only to the expediter, not to the prep station\\n* SKIP_EXPO: Tickets are sent only to the prep station, not to the expediter (equivalent to `includeWithExpediter: false`)\\n<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminUsingExpo.html\\\">Using an expediter KDS</a><br>\\n\",\"enum\":[\"SEND_TO_EXPO\",\"EXPO_ONLY\",\"SKIP_EXPO\"]},\"name\":{\"type\":\"string\",\"description\":\"The name of this prep station.\"},\"kitchenPrinter\":{\"$ref\":\"#/components/schemas/ToastReference\"}}}]},\"ToastReference\":{\"type\":\"object\",\"title\":\"ToastReference\",\"description\":\"A wrapper object containing a Toast platform GUID.\\n\",\"properties\":{\"guid\":{\"type\":\"string\",\"description\":\"A Toast platform identifier for an entity.\\n\"},\"entityType\":{\"type\":\"string\",\"description\":\"The type of object this is. For prep stations, `entityType` is set to `PrepStation`.\\n\"}},\"required\":[\"guid\",\"entityType\"]}}}}},\"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-kitchen-api-docs.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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"kitchen.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/kitchen.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"kitchen","isDefault":true,"id":"kitchen","title":"kitchen","link":null}]},{"id":"2b9d6692-d42d-5a91-be13-a2dd7189ad8boverview/__redocly content redirect/labor/overview/","definitionId":"labor","link":"/labor/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/labor.reference.page.yaml","info":{"version":"1.9.0","title":"Toast Labor API","description":"Toast labor API is a set of REST web services that you can use to \nmanage the employees, jobs, and shifts for your restaurant. The \nlabor API is intended for software engineers, managers, and \ntechnical staff who are responsible for integrating third-party \nsystems with the Toast platform.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"labor","label":"Labor","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-labor-api.yaml"},"apiVersions":[{"definitionId":"labor","isDefault":true,"title":"labor","id":"labor"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.9.0\",\"title\":\"Toast Labor API\",\"description\":\"Toast labor API is a set of REST web services that you can use to \\nmanage the employees, jobs, and shifts for your restaurant. The \\nlabor API is intended for software engineers, managers, and \\ntechnical staff who are responsible for integrating third-party \\nsystems with the Toast platform.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"tags\":[{\"name\":\"Employees\"},{\"name\":\"Jobs\"},{\"name\":\"Shifts\"},{\"name\":\"Time entries\"}],\"paths\":{\"/employees\":{\"get\":{\"tags\":[\"Employees\"],\"summary\":\"Get employees\",\"description\":\"Returns an array of `Employee` objects containing information \\nabout restaurant employees.\\n\",\"operationId\":\"employeesGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"employeeIds\",\"description\":\"An optional identifier that filters return values for a \\nspecific employee. The identifier can be a Toast platform \\nGUID or an external identifier. If present, the `employees` \\nresource will only return the employees you specify. You \\ncan include multiple `employeeIds` query parameters \\n(maximum 100). If not present, the resource returns each \\nemployee for the restaurant.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"JSON objects for all employees in the restaurant\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:read\"]}]},\"post\":{\"tags\":[\"Employees\"],\"summary\":\"Add an employee\",\"description\":\"Creates a restaurant employee record.\\n\",\"operationId\":\"employeesPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":{\"entityType\":\"RestaurantUser\",\"email\":\"email\",\"firstName\":\"first name\",\"chosenName\":\"optional chosen name\",\"lastName\":\"last name\",\"externalId\":\"optional external ID\",\"externalEmployeeId\":\"optional external employee ID\",\"jobReferences\\\"\":[{\"guid\":\"f290a951-2042-4f3d-b861-d89e9e583876\",\"entityType\":\"RestaurantJob\"}],\"wageOverrides\":[{\"jobReference\":{\"guid\":\"f290a951-2042-4f3d-b861-d89e9e583876\",\"entityType\":\"RestaurantJob\"},\"wage\":10}]}}}},\"description\":\"An `Employee` object containing information about the \\nemployee, including the employee's name and email address.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Returns the created employee.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"The request contains data that is not supported by the \\ncurrent version of the API as described.\\n\"},\"415\":{\"description\":\"The request did not have \\\"application/json\\\" in the \\nContent-Type header.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a requestId \\nattached to this error that can be referenced by Toast \\nsupport.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}\":{\"get\":{\"tags\":[\"Employees\"],\"summary\":\"Get information about one employee\",\"description\":\"Returns an `Employee` object containing information about one \\nrestaurant employee.\\n\",\"operationId\":\"employeesEmployeeIdGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID or external identifier for the\\nemployee to be returned.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the employee information.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"The GUID or external identifier was malformed.\\n\"},\"401\":{\"description\":\"Unauthorized - Missing or invalid authentication.\\n\\n**Cause:** No valid OAuth token provided in Authorization header.\\n\"},\"403\":{\"description\":\"Forbidden - Insufficient permissions.\\n\"},\"404\":{\"description\":\"The GUID or external identifier does not match any \\nemployees at the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:read\"]}]},\"delete\":{\"tags\":[\"Employees\"],\"summary\":\"Delete an employee\",\"description\":\"Deletes a restaurant employee record by marking the record as \\ndeleted. A deleted employee cannot log in at the restaurant or \\nopen new time entries.\\n\\nIf you `GET` an employee record that has been deleted, its \\n`deleted` value is `true` and its `deletedDate` value contains \\nthe date and time the record was deleted. \\n\\nIf you delete an employee that has already been deleted then \\nthe result is successful (200) and no change is made.\\n\\nThe deleted record appears in the list of deleted employees for \\nthe restaurant in Toast Web. From the \\nlist of deleted employees, you can enable a deleted record so \\nthat the employee can use it again. Information about deleted \\nemployees remains available in reports.\\n\\nYou cannot delete employees who have open time entries (time \\nentries that do not have an out date value).\\n\",\"operationId\":\"employeesEmployeeIdDelete\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID or external identifier for the \\nemployee to be deleted.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"The employee has been deleted. Returns an `Employee` object \\ncontaining information about the deleted restaurant \\nemployee.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"The GUID or external identifier was malformed.\\n\"},\"404\":{\"description\":\"The GUID or external identifier does not match any\\nemployees at the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]},\"patch\":{\"tags\":[\"Employees\"],\"summary\":\"Update employee information\",\"description\":\"Updates the first name, chosen name, last name, external employee ID, and/or \\npasscode of a restaurant employee. The `PATCH` operation cannot \\nupdate any other employee information.\\n\",\"operationId\":\"employeesEmployeeIdPatch\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID or external identifier for the \\nemployee to be returned.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":{\"firstName\":\"Mynewfirstname\",\"chosenName\":\"Mynewchosenname\",\"lastName\":\"Mynewlastname\",\"externalEmployeeId\":\"1234567890\",\"passcode\":\"1234\",\"currentPasscode\":\"1111\"}}}},\"description\":\"A JSON object containing the employee information that you \\nare updating. You can update an employee's:\\n\\n* `firstName` - First name.\\n\\n* `chosenName` - Chosen name.\\n\\n* `lastName` - Last name.\\n\\n* `externalEmployeeId` - External employee identifier.\\n\\n* `passcode` - The passcode for access to Toast POS devices.\\n\\nAll values are optional. You must include at least one \\nvalue. Each value that you include must contain information \\n(not null). If you include the `passcode` value to update \\nan employee's passcode you must include the employee's \\ncurrent passcode in the `currentPasscode` value.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Returns the updated Toast platform employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"The Toast platform GUID or external identifier was \\nmalformed, or the body of the request was malformed.\\n\"},\"404\":{\"description\":\"The Toast platform GUID or external identifier does not \\nmatch any employees at the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}/externalId\":{\"parameters\":[{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID of the employee record.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"post\":{\"tags\":[\"Employees\"],\"summary\":\"Add an external identifier\",\"description\":\"Adds an external identifier for an existing employee. Include \\nthe string value of the new external identifier in the message \\nbody.\\n\\nYou cannot change an existing external identifier with another \\n`POST` request; use `PUT` instead. The Toast platform uses this \\nexternal identifier as one of the unique, persistent \\nidentifiers for an employee record.\\n\",\"operationId\":\"employeesEmployeeIdExternalIdPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/employeesEmployeeIdExternalIdPostBody\"},\"responses\":{\"200\":{\"description\":\"Returns the updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]},\"put\":{\"tags\":[\"Employees\"],\"summary\":\"Add or replace an external identifier\",\"description\":\"Adds or replaces the external identifier for an\\nexisting employee. Include the string value of the new external\\nidentifier in the message body.\\n\\nThe Toast platform uses this external identifier as one of the \\nunique, persistent identifiers for an employee record. \\n_Changing the external identifier for an existing employee \\nmight affect reporting and other Toast platform functions that \\nselect employees using the `externalId` value._\\n\",\"operationId\":\"employeesEmployeeIdExternalIdPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/employeesEmployeeIdExternalIdPostBody\"},\"responses\":{\"200\":{\"description\":\"Returns the updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}/unarchive\":{\"parameters\":[{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID of the employee record.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"put\":{\"tags\":[\"Employees\"],\"summary\":\"Unarchive an employee\",\"description\":\"Unarchives an employee record that was previously archived.\\n\\n* Unarchived employees can sign into the Toast POS.\\n* Unarchived employees can sign in to Toast Web. \\n* When you unarchive an employee, the employee has all \\n  jobs that were previously assigned to them.\\n* If an employee had a swipe card for signing into the \\n  Toast POS, the swipe card _is not_ re-associated with \\n  the employee when you unarchive them.\\n\\nIf you unarchive an employee who will take a different \\nrole than the one they had when they were archived, you \\nmust update the employee's jobs list and verify that the \\nemployee should continue to sign into Toast Web.\\n\",\"operationId\":\"employeesEmployeeIdUnarchivePut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"Employee being unarchived is not currently archived.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}/jobs\":{\"parameters\":[{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID of the employee record.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"put\":{\"tags\":[\"Employees\"],\"summary\":\"Replace a jobs list\",\"description\":\"Replaces the list of jobs for an employee. Include a JSON  \\narray of job identifiers in the message body.\\n\\nIf a job is defined at the restaurant group or subgroup level, \\nthis operation adds or removes that job for the the employee at \\n_all restaurant locations_ in the group or subgroup.\\n\",\"operationId\":\"employeesEmployeeIdJobsPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":[{\"guid\":\"dd8cea7a-add5-4508-b8fe-ffd0b584e4da\"},{\"externalId\":\"MyToastNamingAuthority:9876543210\"}]}}},\"description\":\"An array of JSON objects containing identifiers for jobs. \\nThe identifiers can be either Toast platform GUIDs or \\nexternal identifiers.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Returns the updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}/wageOverrides\":{\"parameters\":[{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID of the employee record.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"put\":{\"tags\":[\"Employees\"],\"summary\":\"Replace wage overrides\",\"description\":\"Replaces the list of wage overrides for the jobs that are \\nassigned to an employee. Include a JSON  array of \\n`JobWageOverride` objects in the message body. Include the new \\nwage for the employee in the `wage` value. Specify the wage in \\nU.S. dollars.\\n\\nYou must include all existing wage overrides in the message \\nbody. Any wage overrides that are not present in the array are \\nremoved from the employee record.\\n\",\"operationId\":\"employeesEmployeeIdWageOverridesPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":[{\"jobReference\":{\"guid\":\"8d3bba92-10e4-4345-9ae6-ed94c09dc332\"},\"wage\":15.75}]}}},\"description\":\"An array of JSON `JobWageOverride` objects.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The wage overrides for the employee are replaced. Returns \\nthe updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/shifts\":{\"get\":{\"tags\":[\"Shifts\"],\"summary\":\"Get shifts\",\"description\":\"Returns an array of `Shift` objects that contain information \\nabout schedule shifts for restaurant employees.\\n\",\"operationId\":\"shiftsGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"shiftIds\",\"description\":\"An optional identifier that filters return values for a\\nspecific shift. The identifier can be a Toast platform GUID\\nor an external identifier. If present, the shifts\\nresource will only return the shifts you specify. You\\ncan include multiple `shiftIds` query parameters (maximum\\n100).\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"startDate\",\"description\":\"Optional start date and time of time period to match \\nshifts. A shift matches the time period if the shift \\n`inDate` is after (inclusive) the specified `startDate` and \\nthe shift `outDate` is before the `endDate` (exclusive). \\nThese parameters are required if the `shiftIds` parameter \\nis not defined. The specified period cannot be longer than \\none month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"endDate\",\"description\":\"Optional end date and time of time period to match shifts. \\nA shift matches the time period if the shift `inDate` is \\nafter (inclusive) the specified `startDate` and the shift \\n`outDate` is before the `endDate` (exclusive). These \\nparameters are required if the `shiftIds` parameter is not \\ndefined. The specified period cannot be longer than one \\nmonth.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified shifts in an unordered list.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Shift\"}}}}},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]},\"post\":{\"tags\":[\"Shifts\"],\"summary\":\"Create a shift\",\"description\":\"Creates a schedule shift for a restaurant employee.\\n\",\"operationId\":\"shiftsPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":{\"externalId\":\"MyToastNamingAuthority:1234\",\"entityType\":\"Shift\",\"jobReference\":{\"guid\":\"678758d1-6aa8-494c-be55-0614f761d160\",\"externalId\":\"\",\"entityType\":\"RestaurantJob\"},\"employeeReference\":{\"guid\":\"7030407f-761c-4d92-86d9-4e84bc700d0f\",\"externalId\":\"\",\"entityType\":\"RestaurantUser\"},\"inDate\":\"2015-10-10T06:00:00.000+0000\",\"outDate\":\"2015-10-10T12:00:00.000+0000\"}}}},\"description\":\"A `Shift` object containing information about the shift, \\nincluding the job identifier, the employee identifier, and \\nthe start and end times.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Creates a shift record and returns information about it.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Shift\"}}}},\"400\":{\"description\":\"The request contains data that is not supported by the \\ncurrent version of the API as described.\\n\"},\"415\":{\"description\":\"The request did not have \\\"application/json\\\" in the \\n`Content-Type` header.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.shifts:write\"]}]}},\"/shifts/{shiftId}\":{\"get\":{\"tags\":[\"Shifts\"],\"summary\":\"Get a shift\",\"description\":\"Returns a `Shift` object containing of information about one \\nschedule shift for a restaurant employee.\\n\",\"operationId\":\"shiftsShiftIdGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"shiftId\",\"description\":\"The Toast platform GUID or an external identifier for the \\nshift.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified shifts in an unordered list.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Shift\"}}}},\"400\":{\"description\":\"The GUID or external identifier was malformed.\\n\"},\"404\":{\"description\":\"The GUID or external identifier does not match any shifts\\nat the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]},\"put\":{\"tags\":[\"Shifts\"],\"summary\":\"Update a shift\",\"description\":\"Updates an existing schedule shift record for a restaurant \\nemployee. A `PUT` request completely replaces the information \\nin the existing record.\\n\",\"operationId\":\"shiftsShiftIdPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"shiftId\",\"description\":\"The shift identifier, either the Toast platform GUID or an \\nexternal identifier.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":{\"entityType\":\"Shift\",\"jobReference\":{\"guid\":\"678758d1-6aa8-494c-be55-0614f761d160\",\"externalId\":\"\",\"entityType\":\"RestaurantJob\"},\"employeeReference\":{\"guid\":\"7030407f-761c-4d92-86d9-4e84bc700d0f\",\"externalId\":\"\",\"entityType\":\"RestaurantUser\"},\"inDate\":\"2015-10-10T06:00:00.000+0000\",\"outDate\":\"2015-10-10T12:00:00.000+0000\"}}}},\"description\":\"The shift information. The `externalId` identifier is not \\nallowed for`PUT` requests.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Returns the updated `Shift`.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Shift\"}}}},\"400\":{\"description\":\"The request contains data that is not supported by the \\ncurrent version of the API as described.\\n\"},\"404\":{\"description\":\"The GUID or external identifier does not match any shifts\\nat the current restaurant.\\n\"},\"415\":{\"description\":\"The request did not have `application/json` in the \\n`Content-Type` header.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.shifts:write\"]}]},\"delete\":{\"tags\":[\"Shifts\"],\"summary\":\"Delete a shift\",\"description\":\"Marks an existing schedule shift record for a restaurant \\nemployee as deleted. If the shift record was already deleted, \\nthen the operation will succeed (HTTP 200 response code) and no \\nchange will be made.\\n\",\"operationId\":\"shiftsShiftIdDelete\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"shiftId\",\"description\":\"The shift identifier, either the Toast platform GUID or an \\nexternal identifier.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified shift, with the deleted flag set to \\n`true`.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Shift\"}}}},\"400\":{\"description\":\"The Toast platform GUID or external identifier was \\nmalformed.\\n\"},\"404\":{\"description\":\"The Toast platform GUID or external identifier does not \\nmatch any shifts at the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.shifts:write\"]}]}},\"/jobs\":{\"get\":{\"tags\":[\"Jobs\"],\"summary\":\"Get jobs\",\"description\":\"Returns an array of `Job` objects containing information about \\nthe employee jobs configured at a restaurant. By default, if no\\njob IDs are provided in the request, deleted jobs will be excluded\\nfrom the array.\\n\",\"operationId\":\"jobsGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"jobIds\",\"description\":\"An optional array of one or more job identifiers, either \\nthe Toast platform GUID or an external identifier assigned \\nby the client. 100 max. If not provided, all jobs known to \\nthe Toast platform for this restaurant will be returned.\\n\",\"in\":\"query\",\"style\":\"form\",\"explode\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}],\"responses\":{\"200\":{\"description\":\"Returns the specified jobs.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Job\"}}}}},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]}},\"/jobs/{jobId}\":{\"get\":{\"tags\":[\"Jobs\"],\"summary\":\"Get one job\",\"description\":\"Returns a `Job` object containing information about one \\nemployee job at a restaurant.\\n\",\"operationId\":\"jobsJobIdGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"jobId\",\"description\":\"The Toast platform GUID or an external identifier for the \\njob.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified job.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Job\"}}}},\"400\":{\"description\":\"The Toast platform GUID or external identifier was \\nmalformed.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]}},\"/jobs/{jobId}/externalId\":{\"parameters\":[{\"name\":\"jobId\",\"description\":\"The Toast platform GUID or external identifier of the job \\nrecord.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"post\":{\"tags\":[\"Jobs\"],\"summary\":\"Add an external identifier\",\"description\":\"Adds an external identifier for an existing job. Include the \\nstring value of the new external identifier in the message \\nbody.\\n\\nYou cannot change an existing external identifier with another \\n`POST` request. The Toast platform uses this external \\nidentifier as one of the unique, persistent identifiers for a \\njob record.\\n\",\"operationId\":\"jobsJobIdExternalIdPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/jobsJobIdExternalIdPostBody\"},\"responses\":{\"200\":{\"description\":\"Returns the updated job record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Job\"}}}}},\"security\":[{\"oauth2\":[\"labor.jobs:write\"]}]},\"put\":{\"tags\":[\"Jobs\"],\"summary\":\"Add or replace an external identifier\",\"description\":\"Adds or replaces the external identifier for an existing job. \\nInclude the string value of the new external identifier in the \\nmessage body.\\n\\nThe Toast platform uses this external identifier as one of the \\nunique, persistent identifiers for a job record. _Changing the \\nexternal identifier for an existing job might affect reporting \\nand other Toast platform functions that select jobs using the \\n`externalId` value._\\n\",\"operationId\":\"jobsJobIdExternalIdPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/jobsJobIdExternalIdPostBody\"},\"responses\":{\"200\":{\"description\":\"Returns the updated job record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Job\"}}}}},\"security\":[{\"oauth2\":[\"labor.jobs:write\"]}]}},\"/timeEntries\":{\"get\":{\"tags\":[\"Time entries\"],\"summary\":\"Get time entries\",\"description\":\"Returns an array of `TimeEntry` objects that contain \\ninformation about employee shift events. The information \\nincludes shift start times, end times, and the start and end \\ntimes of break periods.\\n\\n*  Include one or more `timeEntryId` query parameters set to \\n   the GUIDs for specific time entries.\\n\\n*  Include both a `startDate` and an `endDate` query parameter \\n   to get time entries for a specific time period.\\n\\n*  Include both a `modifiedStartDate` and a `modifiedEndDate` \\n   query parameter to get the time entries that were modified \\n   during a specific time period.\\n\\n*  Includes a `businessDate` query parameter to get the time \\n   entries with an `inDate` during a specific business date.\\n\\nValid requests include one or more `timeEntryId` parameters, \\nboth a `startDate` and an `endDate`, both a `modifiedStartDate` \\nand a `modifiedEndDate`, or a `businessDate`.\\n\",\"operationId\":\"timeEntriesGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"timeEntryIds\",\"description\":\"Optional array of one or more time entry identifiers, \\neither the Toast platform GUID or an external identifier. \\n100 max.\\n\",\"in\":\"query\",\"explode\":true,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},{\"name\":\"startDate\",\"description\":\"Optional start date and time of time period to match time \\nentries. A time entry matches the time period if its \\nclock-in `inDate` is after (inclusive) the specified \\n`startDate` and before (exclusive) the `endDate`. The \\nspecified period cannot be longer than one month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"endDate\",\"description\":\"Optional end date and time of time period to match time \\nentries. A time entry matches the time period if its \\nclock-in `inDate` is after (inclusive) the specified \\n`startDate` and before (exclusive) the `endDate`. The \\nspecified period cannot be longer than one month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"modifiedStartDate\",\"description\":\"Start date and time of the time period to match modified \\ntime entries. A time entry matches the time period if that \\nentry was modified after (inclusive) the \\n`modifiedStartDate`. If you include this parameter, you \\nmust also include the `modifiedEndDate` parameter.  The \\nspecified period cannot be longer than one month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"modifiedEndDate\",\"description\":\"End date and time of the time period to match modified time \\nentries. A time entry matches the time period if that entry \\nwas modified before (exclusive) the `modifiedEndDate`. If \\nyou include this parameter, you must also include the \\n`modifiedStartDate` parameter.  The specified period cannot \\nbe longer than one month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"businessDate\",\"description\":\"Optional date to match time entries. A time entry matches \\nthe business date if its clock-in `inDate` is during the \\nbusiness date. The cutoff from one `businessDate` to the \\nnext is the `closeoutHour` for the restaurant.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"yyyymmdd\"}},{\"name\":\"includeMissedBreaks\",\"description\":\"Optional flag to indicate whether missed breaks should be \\nreturned in the breaks array for the time entries.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}},{\"name\":\"includeArchived\",\"description\":\"Controls whether the response includes archived time entries, when\\nusing the `startDate` and `endDate` parameters.\\n\\n**Important**: this parameter _has no effect_ if you use the\\n`modifiedStartDate` and `modifiedEndDate` parameters or the\\n`businessDate` parameter to select time entries.\\n\\n* Querying by modified date range _always_ returns archived time entries.\\n* Querying by businessDate _never_ returns archived time entries.\\n\\nThis parameter is optional and the default value is `false`.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified time entries.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TimeEntry\"}}}}},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]}},\"/timeEntries/{timeEntryId}\":{\"get\":{\"tags\":[\"Time entries\"],\"summary\":\"Get one time entry\",\"description\":\"Returns a `TimeEntry` object containing information about one \\nemployee shift. The information includes the shift start time, \\nend time, and the start and end times of break periods.\\n\",\"operationId\":\"timeEntriesTimeEntryIdGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"timeEntryId\",\"description\":\"The Toast platform GUID or an external identifier for the \\ntime entry.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"includeMissedBreaks\",\"description\":\"Optional flag to indicate whether missed breaks should be \\nreturned in the breaks array for the time entries.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}},{\"name\":\"includeArchived\",\"description\":\"Controls whether the response includes an archived time entry.\\nOptional.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified time entry.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TimeEntry\"}}}},\"400\":{\"description\":\"The GUID or external identifier was malformed.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/labor/v1\"}],\"components\":{\"requestBodies\":{\"jobsJobIdExternalIdPostBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":\"MyToastNamingAuthority:9876543210\"}}},\"description\":\"The JSON string value of the `externalId` for the job \\nrecord. Wrap the value in double quotation marks to make it \\nvalid JSON syntax.\\n\",\"required\":true},\"employeesEmployeeIdExternalIdPostBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":\"MyToastNamingAuthority:9876543210\"}}},\"description\":\"The JSON string value of the `externalId` for the employee \\nrecord. Wrap the value in double quotation marks to make it \\nvalid JSON syntax.\\n\",\"required\":true}},\"securitySchemes\":{\"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. \\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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"labor.employees:read\":\"Allows reading employee information from the labor API.\\n\",\"labor.employees:write\":\"Allows updating employee information in the labor API.\\n\",\"employees.tax-identifier-unmasked:read\":\"Allows reading full unmasked tax identifier (SSN) information for employees\\nvia expand parameter.\\n\",\"employees.tax-identifier-masked:read\":\"Allows reading masked tax identifier (SSN) information for employees via\\nexpand parameter.\\n\",\"labor:read\":\"Allows reading all data except employees from the labor API.\\n\",\"labor.shifts:write\":\"Allows updating shift information in the labor API.\\n\",\"labor.jobs:write\":\"Allows updating job information in the labor API.\\n\"}}}}},\"schemas\":{\"Employee\":{\"type\":\"object\",\"description\":\"A restaurant employee\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date created, in UTC format (read-only).\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date modified, in UTC format (read-only).\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date deleted, in UTC format (read-only).\\n\"},\"firstName\":{\"type\":\"string\",\"description\":\"Optional, first name of the employee.\\n\"},\"chosenName\":{\"type\":\"string\",\"description\":\"Optional, chosen name of the employee. To be used, when appropriate, in place of first name.\\n\"},\"lastName\":{\"type\":\"string\",\"description\":\"Optional, last name of the employee.\\n\"},\"email\":{\"type\":\"string\",\"description\":\"Employee's email address.\\n\"},\"phoneNumber\":{\"type\":\"string\",\"description\":\"Employee's phone number\\n\"},\"phoneNumberCountryCode\":{\"type\":\"string\",\"description\":\"A numeric code corresponding to one or more countries, \\nused as a telephone number prefix when making international telephone calls.\\n\"},\"passcode\":{\"type\":\"string\",\"description\":\"An optional numeric security code that a new employee can \\nuse to begin a session in a Toast POS device. The \\npasscode value can only occur in `POST` requests. The \\nvalue must be numeric and it must contain at least one \\nand no more than eight digits. The employee can only use \\nthe passcode at the restaurant specified in the `POST` \\nrequest.   The response to a successful `POST` request \\nwill include the passcode value in clear text. A `GET` \\nrequest for the employee will not return the passcode.\\n\"},\"externalEmployeeId\":{\"type\":\"string\",\"description\":\"Optional, employee’s external ID in the Toast platform.\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"If the employee is deleted in the Toast platform.\\n\"},\"jobReferences\":{\"type\":\"array\",\"description\":\"An array of external references to jobs assigned to this \\nemployee. If the job is deleted, it will be excluded from this array.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"wageOverrides\":{\"type\":\"array\",\"description\":\"An optional array of per job wage overrides, where each \\nelement defines a job reference and the wage override for \\nthis employee when performing that job. If the underlying job\\nis deleted, it will be excluded from the array.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/JobWageOverride\"}},\"v2EmployeeGuid\":{\"type\":\"string\",\"description\":\"This value is included for future use. An alternate Toast \\nplatform GUID for the employee that will be used in \\nupcoming labor API functionality.\\n\"}}}]},\"Job\":{\"type\":\"object\",\"description\":\"A restaurant job.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date created, in UTC format (read-only).\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date modified, in UTC format (read-only).\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date deleted, in UTC format (read-only).\\n\"},\"title\":{\"type\":\"string\",\"description\":\"Title of the job.\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"If the job is deleted in the Toast platform.\\n\"},\"wageFrequency\":{\"type\":\"string\",\"description\":\"An enumerated type specifying how to interpret the \\ndefault wage for this job.\\n\",\"enum\":[\"HOURLY\",\"SALARY\"]},\"defaultWage\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The default wage of the job.\\n\"},\"tipped\":{\"type\":\"boolean\",\"description\":\"Indicates whether the job receives gratuities (tips).\\n\"},\"code\":{\"type\":\"string\",\"description\":\"A reference identifier for the job. This is an optional \\nfield entered when the job is created. For example, it \\ncan be used to match Toast platform jobs to jobs \\nconfigured in external labor management systems.\\n\"},\"excludeFromReporting\":{\"type\":\"boolean\",\"description\":\"Indicates whether labor summary reports should include hours and pay \\nfor this job. Restaurant employees set this configuration option for a job \\non the **Jobs** page of Toast Web.\\n\"}}}]},\"JobWageOverride\":{\"type\":\"object\",\"description\":\"The overriding job wage, for an employee that has a wage that \\ndiffers from the job's default wage.\\n\",\"required\":[\"wage\",\"jobReference\"],\"properties\":{\"wage\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Required currency value of the employee's overriding job wage.\\n\"},\"jobReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}},\"Shift\":{\"type\":\"object\",\"description\":\"A scheduled shift in the Toast platform used to enforce employee \\nclock-in and clock outs. Shifts might be created in an external \\nscheduling system and pushed to the Toast platform.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date created, in UTC format (read-only).\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date modified, in UTC format (read-only).\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date deleted, in UTC format (read-only).\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"If the shift is deleted in the Toast platform.\\n\"},\"jobReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"employeeReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"inDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Timestamp of the beginning of the shift. This is when the \\nemployee can clock in. Expressed in the UTC time zone.\\n\"},\"outDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Timestamp of the end of the shift. This is when the \\nemployee can clock out. Expressed in the UTC time zone.\\n\"},\"scheduleConfig\":{\"$ref\":\"#/components/schemas/ScheduleConfig\"}}}]},\"ScheduleConfig\":{\"type\":\"object\",\"description\":\"Schedule configuration containing info about the clock in/clock out\\ngrace period.\\n\",\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast platform.\\n\",\"type\":\"string\"},\"minBeforeClockIn\":{\"description\":\"Grace period minutes before clock in\\n\",\"type\":\"number\",\"format\":\"double\"},\"minAfterClockIn\":{\"description\":\"Grace period minutes after clock in\\n\",\"type\":\"number\",\"format\":\"double\"},\"minBeforeClockOut\":{\"description\":\"Grace period minutes before clock out\\n\",\"type\":\"number\",\"format\":\"double\"},\"minAfterClockOut\":{\"description\":\"Grace period minutes after clock out\\n\",\"type\":\"number\",\"format\":\"double\"}}},\"TimeEntry\":{\"type\":\"object\",\"description\":\"A `TimeEntry` captures the actual time an employee worked or took \\na break. Typically, a time entry is one-to-one with a scheduled \\nshift, but it is possible in the Toast platform for an employee \\nto clock-in and clock-out without a shift.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date created, in UTC format (read-only).\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date modified, in UTC format (read-only).\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date deleted, in UTC format (read-only).\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"If the time entry is deleted in the Toast platform.\\n\"},\"jobReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"employeeReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"shiftReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"inDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that an employee clocked in to a work\\nshift.\\n\"},\"outDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that an employee closed a work shift.\\nIf the employee has not closed the shift this field is\\nnull.\\n\"},\"autoClockedOut\":{\"type\":\"boolean\",\"description\":\"Indicates whether the Toast platform automatically clocked the\\nemployee out of their shift at the end of the restaurant business\\nday. For more information, see [the Toast platform guide section\\nabout automatic clock-out and time\\nentries](https://doc.toasttab.com/doc/platformguide/adminEffectOfAutoclockOutOnBreakEntries.html).\\n\"},\"businessDate\":{\"type\":\"string\",\"description\":\"The business date of `inDate`, in the format of \\n\\\"yyyymmdd\\\".\\n\"},\"regularHours\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Regular hours worked by the employee for this time entry, \\nexcluding breaks.\\n\"},\"overtimeHours\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Any overtime hours taken by this employee during this \\ntime entry.\\n\"},\"hourlyWage\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Optional, historical `hourlyWage`; that is, the wage in \\neffect when the time entry was made. The current \\n`hourlyWage` for the employee (or job) may be different. \\nThis will be null if the job is `SALARY`.\\n\"},\"breaks\":{\"type\":\"array\",\"description\":\"An optional array of time entry breaks, each break \\ndefining a clock-in date, clock-out date, and whether or \\nnot the break was paid.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/TimeEntryBreak\"}},\"declaredCashTips\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of tips paid in cash during the time\\nentry. This does not include service charges applied as\\nautomatic gratuities. If the employee has not closed the\\nshift, this value is not final and may change. If the\\n`outDate` value is set, the `declaredCashTips` value is\\nfinal.\\n\"},\"nonCashTips\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of tips paid using non-cash tender\\nduring the time entry. For example, this includes credit\\ncard tips. This does not include service charges applied\\nas automatic gratuities. If the employee has not closed\\nthe shift, this value is not final and may change. If the\\n`outDate` value is set, the `nonCashTips` value is final.\\n\"},\"nonCashTipsRoundingLoss\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of cash added to the payout of total\\ntips paid using non-cash tender and service charges\\napplied as automatic gratuities to round up the total to\\nthe nearest $.05. This only applies if tip rounding is\\nconfigured for shift review. If the employee has not\\nclosed the shift, the value should be null.\\n\",\"nullable\":true},\"cashGratuityServiceCharges\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of service charges applied as\\nautomatic gratuities that were paid in cash during the\\ntime entry. If the employee has not closed the shift,\\nthis value is not final and may change. If the `outDate`\\nvalue is set, the `cashGratuityServiceCharges` value is\\nfinal.\\n\"},\"nonCashGratuityServiceCharges\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of service charges applied as\\nautomatic gratuities that were paid using non-cash tender\\nduring the time entry. If the employee has not closed the\\nshift, this value is not final and may change. If the\\n`outDate` value is set, the\\n`nonCashGratuityServiceCharges` value is final.\\n\"},\"tipsWithheld\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount withheld from the employee's credit \\ncard tips during the time entry. The amount withheld is \\ncalculated as a percentage of tips added to credit card \\npayments. If the employee has not closed the shift (the \\n`outDate` value is null), the `tipsWithheld` value is not \\nfinal and may change. If the employee has closed the \\nshift (the `outDate` value is set), the `tipsWithheld` \\nvalue is final.\\n\"},\"nonCashSales\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of non-cash sales during the time \\nentry. The value includes the order amounts and tax.\\nIt does not include tips.\\n\\nIf the employee has not closed the shift, this \\nvalue is `0`. If the `outDate` value is set, then the \\n`nonCashSales` value is final.\\n\"},\"cashSales\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of sales paid for in cash during the \\ntime entry. The value includes the order amounts and tax.\\nIt does not include tips.\\n\\nIf the employee has not closed the shift, \\nthis value is `0`. If the `outDate` value is set, \\nthen the `cashSales` value is final.\\n\"}}}]},\"TimeEntryBreak\":{\"type\":\"object\",\"description\":\"Information about a period of time that an employee is not\\nworking during a shift. For example, an employee might take a\\nbreak to eat at some time during a shift. An employee can be paid\\nor unpaid for the break period.\\n\",\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast platform.\\n\",\"type\":\"string\"},\"breakType\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"paid\":{\"type\":\"boolean\",\"description\":\"Indicates whether the employee was paid for the break.\\n* `true` - The break was a paid break.\\n* `false` - The break was an unpaid break.\\n\"},\"inDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the employee started the break period,\\nin UTC.\\n\"},\"outDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the employee ended the break period\\nand returned to work, in UTC.\\n\"},\"missed\":{\"type\":\"boolean\",\"description\":\"Indicates whether the break was a missed break.\\n* `true` - The break was missed.\\n* `false` - The break was taken.\\n\"},\"waived\":{\"type\":\"boolean\",\"description\":\"Indicates whether the break was waived by the employee.\\n* `true` - The break was waived.\\n* `false` - The break was not waived.\\n\"},\"auditResponse\":{\"type\":\"boolean\",\"description\":\"Indicates whether the employee was asked to take the break.\\n\\n* `true` - The employee was asked to take the break.\\n* `false` - The employee was not asked to take the break.\\n\\nNull for break types that do not use break acknowledgement \\ntracking or when the employee did not complete the audit \\nresponse prompt.\\n\"}}},\"ExternalReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast \\nplatform entity by Toast GUID or an external identifier.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"externalId\":{\"description\":\"External identifier string that is prefixed by the naming \\nauthority. You can, for example, use the labor API to \\n`POST` an `externalId` for an employee and then `GET` the \\nemployee with that `externalId`.\\n\",\"type\":\"string\"}}}]},\"ToastReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast \\nplatform entity by Toast GUID.\\n\",\"required\":[\"guid\",\"entityType\"],\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast platform.\\n\",\"type\":\"string\"},\"entityType\":{\"description\":\"The type of object this is.\\n\",\"type\":\"string\"}}}}}}},\"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-labor-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"labor.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/labor.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"labor","isDefault":true,"id":"labor","title":"labor","link":null}]},{"id":"cd10614c-6b0e-51bb-a352-00b67aaca5ffoverview/__redocly content redirect/loyalty/overview/","definitionId":"loyalty","link":"/loyalty/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/loyalty.reference.page.yaml","info":{"version":"1.1.0","title":"Toast Loyalty Integration API","description":"This API specification describes the interface that the Toast POS \nsystem will call when it processes loyalty transactions.\n\nImplement this REST API to allow the Toast POS system to process \nloyalty transactions using a loyalty provider that it does not \ncurrently support.\n","contact":{"name":"Toast API Support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"loyalty","label":"Loyalty integration specification","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-integrations-loyalty-api.yaml"},"apiVersions":[{"definitionId":"loyalty","isDefault":true,"title":"loyalty","id":"loyalty"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.1.0\",\"title\":\"Toast Loyalty Integration API\",\"description\":\"This API specification describes the interface that the Toast POS \\nsystem will call when it processes loyalty transactions.\\n\\nImplement this REST API to allow the Toast POS system to process \\nloyalty transactions using a loyalty provider that it does not \\ncurrently support.\\n\",\"contact\":{\"name\":\"Toast API Support\"}},\"paths\":{\"/yourendpointname\":{\"post\":{\"summary\":\"Provide information on a loyalty transaction\\n\",\"description\":\"Provides information about a loyalty transaction processed by \\nthe Toast platform. The transaction information in the \\nmessage body is intended to allow a loyalty provider to \\nperform corresponding operations on the loyalty account, \\nmaintained by that provider.\\n\\nYou define the endpoint name for this implementation. The Toast \\nPOS system makes requests to the REST path that you supply \\nduring integration setup.\\n\\nEach `POST` request to the endpoint includes a \\n`Toast-Transaction-Type` header parameter value to indicate the \\ntype of loyalty transaction it represents. The possible \\ntransaction types are:\\n\\n* Inquire to get information about a given loyalty account\\n  given the items currently on the check.\\n* Search for a loyalty account.\\n* Signup to create a new loyalty account.\\n* Redeem offers.\\n* Accrue rewards based on a given check.\\n* Reverse a previous redeem or accrue transaction.\\n\\nThe `LoyaltyTransaction` \\nobject in the message body includes a set of information that \\nis specific for each transaction type.\\n\\nThe response time for a loyalty transaction request must be \\nless than 500ms on average. A response time of greater than\\n5000ms will be considered a timeout and will be retried. There\\nis a limit on the number of retries which depends on the context\\nof the call.\\n\\nAll loyalty transactions must be considered idempotent. The \\nimplementation must handle multiple requests with the same \\n`Toast-Transaction-GUID` *and* the same `loyaltyIdentifier`.\\n\",\"operationId\":\"yourEndpointNamePost\",\"parameters\":[{\"name\":\"Toast-Transaction-GUID\",\"description\":\"A unique identifier of the loyalty transaction, defined \\nby the Toast POS system.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The unique identifier of the restaurant, defined by the \\nToast POS system.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Transaction-Type\",\"description\":\"The type of loyalty transaction that occurred. Values are:\\n<ul>\\n  <li>LOYALTY_INQUIRE</li>\\n  <li>LOYALTY_SEARCH</li>\\n  <li>LOYALTY_SIGNUP</li>\\n  <li>LOYALTY_REDEEM</li>\\n  <li>LOYALTY_ACCRUE</li>\\n  <li>LOYALTY_REVERSE</li>\\n  <li>LOYALTY_TRANSFER</li>\\n</ul>\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\",\"enum\":[\"LOYALTY_INQUIRE\",\"LOYALTY_SEARCH\",\"LOYALTY_SIGNUP\",\"LOYALTY_REDEEM\",\"LOYALTY_ACCRUE\",\"LOYALTY_REVERSE\",\"LOYALTY_TRANSFER\"]}},{\"name\":\"Authorization\",\"description\":\"A JSON Web Token (JWT) that you can use to authenticate the request. \\nVerify the token using the public key that you get from the Toast user management service.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LoyaltyTransaction\"}}},\"description\":\"A `LoyaltyTransaction` \\nobject containing information about the loyalty \\ntransaction that the Toast POS system processed.\\n\"},\"responses\":{\"200\":{\"description\":\"OK. The `transactionStatus` value of the \\n`LoyaltyTransactionResponse` object is `ACCEPT`.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LoyaltyTransactionResponse\"}}}},\"400\":{\"description\":\"Bad request. The `transactionStatus` value of the\\n`LoyaltyTransactionResponse` object is one of:\\n\\n* `ERROR_INVALID_TOAST_TRANSACTION_TYPE`\\n* `ERROR_ACCOUNT_INVALID`\\n* `ERROR_INVALID_INPUT_PROPERTIES`\\n* `ERROR_TRANSACTION_DOES_NOT_EXIST`\\n* `ERROR_INVALID_TOKEN`\\n* `ERROR_TRANSACTION_CANNOT_BE_REVERSED`\\n* `ERROR_INVALID_RESTAURANT`\\n* `ERROR_ALREADY_REGISTERED`\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LoyaltyTransactionResponse\"}}}},\"500\":{\"description\":\"Internal server error.\"}}}}},\"servers\":[{\"url\":\"https://toast-api-server/yourapiname/v1\"}],\"components\":{\"schemas\":{\"LoyaltyTransaction\":{\"type\":\"object\",\"description\":\"Information about a loyalty transaction in the Toast POS \\nsystem. Loyalty providers are expected to handle that \\ntransaction.\\n\\nThe set of information in this object depends on the loyalty \\ntransaction type. The transaction type is specified in the \\n`Toast-Transaction-Type` header parameter for the request, \\nand within the body of the request.\\n\\nThe `LoyaltyTransaction` object includes the `toastTransactionType`\\nvalue, which will be the same as the value in the header. It will also\\ninclude one of the following values depending on the transaction type:\\n\\n* `LOYALTY_INQUIRE` - checkTransactionInformation\\n* `LOYALTY_SEARCH` - searchTransactionInformation\\n* `LOYALTY_SIGNUP` - signupTransactionInformation\\n* `LOYALTY_REDEEM` - checkTransactionInformation\\n* `LOYALTY_ACCRUE` - checkTransactionInformation\\n* `LOYALTY_REVERSE` - reverseTransactionInformation\\n* `LOYALTY_TRANSFER` - transferTransactionInformation\\n\",\"properties\":{\"toastTransactionType\":{\"description\":\"The transaction type that is included in the header is duplicated here in the body of the request.\\n\",\"type\":\"string\",\"enum\":[\"LOYALTY_INQUIRE\",\"LOYALTY_SEARCH\",\"LOYALTY_SIGNUP\",\"LOYALTY_REDEEM\",\"LOYALTY_ACCRUE\",\"LOYALTY_REVERSE\",\"LOYALTY_TRANSFER\"]},\"searchTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationSearch\"},\"signupTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationSignup\"},\"checkTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationCheck\"},\"reverseTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationReverse\"},\"transferTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationTransfer\"}}},\"TransactionInformationSearch\":{\"type\":\"object\",\"description\":\"Information needed to complete a search transaction. Included if the toastTransactionType is\\nLOYALTY_SEARCH, absent otherwise.\\n\",\"properties\":{\"searchCriteria\":{\"$ref\":\"#/components/schemas/AccountSearchCriteria\"}}},\"TransactionInformationSignup\":{\"type\":\"object\",\"description\":\"Information needed to complete a signup transaction. Included if the toastTransactionType is\\nLOYALTY_SIGNUP, absent otherwise. Requires exactly one of email or phone to be provided (not both,\\nnot neither).\\n\",\"properties\":{\"phone\":{\"description\":\"A telephone number for the customer to create the loyalty account. This number\\nwill be ten digits with no other characters. Either phone or email must be provided, but not both.\\n\",\"type\":\"string\"},\"email\":{\"description\":\"An email address for the customer to create the loyalty account. Either phone or email must be\\nprovided, but not both.\\n\",\"type\":\"string\"}}},\"TransactionInformationCheck\":{\"type\":\"object\",\"description\":\"Information needed to complete an inquire, redeem, or accrue transaction. Included if the \\ntoastTransactionType is one of LOYALTY_INQUIRE, LOYALTY_REDEEM, or LOYALTY_ACCRUE,\\nabsent otherwise.\\n\",\"properties\":{\"loyaltyIdentifier\":{\"description\":\"Unique identifier of the loyalty account. Format will vary by provider.\",\"type\":\"string\"},\"orderGuid\":{\"description\":\"The Toast POS system identifier for the order that contains the check.\",\"type\":\"string\"},\"check\":{\"$ref\":\"#/components/schemas/Check\"},\"redemptions\":{\"description\":\"List of offers to be redeemed, or already redeemed on a check. If this is the\\nfirst time this particular Redemption has been present in a request (as part of\\nthis customer interaction), it will be present in this list but not on the Check.\\nIf a Redemption has been previously validated, it will be present both in this list\\nand on the Check as an `AppliedDiscount`.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Redemption\"}}}},\"TransactionInformationReverse\":{\"type\":\"object\",\"description\":\"Information needed to complete a reverse transaction. Included if the toastTransactionType is\\nLOYALTY_REVERSE, absent otherwise.\\n\",\"properties\":{\"loyaltyIdentifier\":{\"description\":\"Unique identifier of the loyalty account. Format will vary by provider.\",\"type\":\"string\"},\"transactionId\":{\"description\":\"Id of a previous transaction to reverse.\",\"type\":\"string\"},\"redemptions\":{\"description\":\"If the transaction to be reversed was a LOYALTY_REDEEM transaction, this array optional includes the list of redemptions from that transaction to reverse. If this field is absent, all redemptions from the transaction should be reversed.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Redemption\"}}}},\"TransactionInformationTransfer\":{\"type\":\"object\",\"description\":\"Information needed to complete a transfer transaction. Included if the toastTransactionType is\\nLOYALTY_TRANSFER, absent otherwise.\\n\",\"properties\":{\"fromLoyaltyIdentifier\":{\"description\":\"Unique identifier of the current loyalty account. Format will vary by provider.\",\"type\":\"string\"},\"toLoyaltyIdentifier\":{\"description\":\"Unique identifier of the loyalty account that the user wants to transfer to. Format will vary by provider.\",\"type\":\"string\"}}},\"AccountSearchCriteria\":{\"type\":\"object\",\"description\":\"A set of possible criteria to be used to search for a given loyalty account. The provider\\nmust return a list of loyalty accounts that match the criteria given so the customer can\\nselect the correct one. All of the fields are optional, though at least one will be \\npopulated.\\n\",\"properties\":{\"firstName\":{\"description\":\"The first or given name of the customer attached to the loyalty account.\",\"type\":\"string\"},\"lastName\":{\"description\":\"The last or family name of the customer attached to the loyalty account.\",\"type\":\"string\"},\"email\":{\"description\":\"An email address for the customer attached to the loyalty account.\",\"type\":\"string\"},\"phone\":{\"description\":\"A telephone number for the customer attached to the loyalty account. This number\\nwill be ten digits with no other characters.\\n\",\"type\":\"string\"}}},\"Redemption\":{\"type\":\"object\",\"description\":\"Information about an offer to be redeemed (or that was redeemed) to a check.\\n\",\"properties\":{\"identifier\":{\"description\":\"Identifier of the `Offer` to be redeemed. The \\nOffer must be one that was returned by the provider in response to an inquiry\\nrequest.\\n\",\"type\":\"string\"},\"selectionGuid\":{\"description\":\"If this is an item level discount, the guid of the selection that this redemption is\\nattached to. If this redemption has not been added to a specific selection yet, this\\nfield will be absent.\\n\",\"type\":\"string\"},\"appliedDiscountGuid\":{\"description\":\"The GUID of the `AppliedDiscount` on the `Check` or `Selection` object corresponding to the discount.\\nThis is required if the `Redemption` object is contained within the `RejectionRedemption` \\nobject and identifies the rejected redemption.\\nThis is included to differentiate if multiple redemptions of the same type are applied to the\\nsame check or item.\\n\",\"type\":\"string\"},\"multiItemDiscountGuid\":{\"description\":\"The GUID of a Multi Item Redemption. A Multi Item Redemption is a single loyalty redemption that applied to\\nmultiple items on the check. For instance, a \\\"$3 off burgers, $2 off fries, and $1 off a drink\\\" would be a\\nsingle loyalty redemption that applies to 3 separate items. This field is an identifier for a Multi Item\\nredemption, but does not correspond to any one object on the `Check`. To see what items were discounted,\\nrefer to the `itemApplication` field.\\n\",\"type\":\"string\"},\"amount\":{\"description\":\"The dollar (or other currency) amount that this offer actually discounts.\\n\",\"type\":\"number\"},\"itemApplication\":{\"type\":\"array\",\"description\":\"If this offer this object is redeeming is of type MULTI_ITEM, this array includes the selections\\nto which the offer has been applied, along with the amounts applied to each selection and the identifier\\nof the discounts applied to each selection. If this field is present, the `selectionGuid`,\\n`appliedDiscountGuid`, and `amount` fields will be null, as the values in this array convey that\\ninformation.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ItemRedemptionInfo\"}},\"quantity\":{\"description\":\"The number of times the offer has been applied to the item or check. For example, if an offer is\\na stackable \\\"$5 off check\\\" discount, this field could indicate that multiple copies of that offer\\nhave been applied.\\n\",\"type\":\"number\"},\"name\":{\"description\":\"Human-readable name of the offer being redeemed. Used to identify the\\nspecific offer on POS, Kiosk, and Guest Display. Maximum 200 characters.\\n\",\"type\":\"string\",\"maxLength\":200}}},\"RejectedRedemption\":{\"type\":\"object\",\"required\":[\"redemption\"],\"description\":\"A redemption that was included in a list of redemptions to redeem, but is not valid\\nbased on the partner's validation logic.\\n\",\"properties\":{\"redemption\":{\"$ref\":\"#/components/schemas/Redemption\"},\"message\":{\"description\":\"An explanation of why the discount was rejected.\",\"type\":\"string\"}}},\"AccountInfo\":{\"type\":\"object\",\"description\":\"Identifying information about a specific loyalty account.\\n\",\"properties\":{\"identifier\":{\"description\":\"A unique identifer for this account.\",\"type\":\"string\"},\"firstName\":{\"description\":\"First or given name of the account holder\",\"type\":\"string\"},\"lastName\":{\"description\":\"Last or family name of the account holder\",\"type\":\"string\"},\"phone\":{\"description\":\"Phone number of the account holder\",\"type\":\"string\"},\"email\":{\"description\":\"Email address of the account holder\",\"type\":\"string\"},\"pointsBalance\":{\"description\":\"If the loyalty program tracks points, use this field to report the \\ncurrent points available to the account owner. This field only displays on \\nthe POS in `LOYALTY_INQUIRE` workflows. If absent, no value is displayed. Optional.\\n\",\"type\":\"string\"}}},\"Offer\":{\"type\":\"object\",\"description\":\"Information about a potential discount or other benefit available to the holder of \\na loyalty account. Contrast with a `Redemption`,\\nwhich is an Offer that is applied to a `Check`.\\n\",\"properties\":{\"identifier\":{\"description\":\"A unique identifier for this offer. Each offer must have a unique\\nidentifier. The Toast platform will not apply discounts correctly if\\nyour integration uses an identifier for more than one offer on a\\ncheck.\\n\",\"type\":\"string\"},\"name\":{\"description\":\"The name of this discount. This should be a human readable description of the order.\\nExamples include \\\"5% off your entire order\\\" or \\\"Free small cheese pizza\\\".\\n\",\"type\":\"string\"},\"applicable\":{\"description\":\"true if this offer can be applied to the check submitted with the request,\\nfalse otherwise\\n\",\"type\":\"boolean\"},\"selectionType\":{\"description\":\"Describes what this offer covers. A `CHECK` level discount applies to the entire\\ncheck, without requirements on the items contained within the check. An `ITEM` \\nlevel discount applies to a specific item on the check. \\n\",\"type\":\"string\",\"enum\":[\"CHECK\",\"ITEM\",\"MULTI_ITEM\"]},\"itemApplication\":{\"type\":\"array\",\"description\":\"If this offer is of type ITEM or MULTI_ITEM, this array includes the selection or selections\\nto which the offer can be applied. Required if applicable is true, optional otherwise.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ItemRedemptionInfo\"}},\"amount\":{\"description\":\"The currency amount of the discount when applied based on the current check information.\\nThis value can be updated in future calls based on updated check information (for example,\\na 10% off offer will change based on the check total). This field is optional in response to\\nLOYALTY_INQUIRE requests and required in response to LOYALTY_REDEEM requests. If the selection type\\nis ITEM or MULTI_ITEM, this amount should be the sum of the amounts on each ItemRedemptionInfo in\\nthe itemApplication array.\\n\",\"type\":\"number\"},\"quantity\":{\"description\":\"The quantity of this reward available to the account owner. This is informational to display to the\\nuser. It does not necessarily mean the offer is redeemable multiple times (for example, a guest may\\nhave two \\\"10% off your entire check\\\" offers, but only one can be redeemed per visit).\\n\",\"type\":\"number\"},\"expiration\":{\"type\":\"array\",\"description\":\"If this offer will expire, expiration dates can be included in this element to indicate on which date(s) this offer will expire. The next upcoming expiration date will be displayed for the offer on the POS. Optional.\",\"items\":{\"$ref\":\"#/components/schemas/ExpirationData\"}},\"description\":{\"type\":\"string\",\"description\":\"Optional description providing additional context about the offer, such as requirements\\nor restrictions. This text will be displayed on the Customer's Reward Screen to help guests\\nunderstand offer eligibility before attempting redemption. Examples include \\\"Requires additional\\npurchase of $0.50\\\" or \\\"Valid on dine-in orders only\\\". Maximum 200 characters. Optional.\\n\"},\"autoApply\":{\"description\":\"Indicates whether the offer should be automatically applied to the check without requiring explicit\\naction from a guest or employee. When `true`, the Toast platform will automatically apply the offer.\\nIf you do not provide an `autoApply` value, the Toast platform uses the default value `false`. This\\nToast platform feature is in limited release. Not all Toast POS locations will automatically apply\\noffers in response to this value.\\n\",\"type\":\"boolean\",\"default\":false}}},\"ItemRedemptionInfo\":{\"type\":\"object\",\"description\":\"Information about the application of a `Redemption` to a specific item.\",\"properties\":{\"selectionIdentifier\":{\"description\":\"The identifier of the selection that discount is applied to. This will correspond to the `guid`\\nfield on the `Selection` object that is included with the `Check`. Toast uses these values to determine\\nwhich item(s) will have the offer applied.\\n\",\"type\":\"string\"},\"amount\":{\"description\":\"The currency amount of the discount applied to this item. This value can be updated in future calls.\\nThis field is optional in response to LOYALTY_INQUIRE requests and required in response to LOYALTY_REDEEM requests.\\n\",\"type\":\"number\"},\"appliedDiscountIdentifier\":{\"description\":\"If this redemption has been applied, this is the identifier of the applied discount created for this offer\\non this selection. It will correspond to the `guid` field of the `AppliedDiscount` object on the Selection.\\nResponse only.\\n\"}}},\"ExpirationData\":{\"type\":\"object\",\"description\":\"If an offer will expire, this can detail information of when that offer is set to expire.\",\"properties\":{\"date\":{\"description\":\"The date at which the offer will expire. Optional. <a\\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"quantity\":{\"description\":\"The quantity of the offer that will expire at the expiration date. If not present assumes the entire offer will expire at the expiration date. Optional.\",\"format\":\"number\"}}},\"Check\":{\"type\":\"object\",\"description\":\"Represents a single check within an order.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"selections\"],\"properties\":{\"openedDate\":{\"description\":\"The date at which this check was opened. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"closedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date at which this check's payment status \\nwas set to CLOSED. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date at which this check was modified. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date at which this check was deleted. `deletedDate` \\nis only applicable when deleted is true (by default the \\nvalue will be set to 1970-01-01T00:00:00.000+0000). <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"True if this check has been deleted.\"},\"selections\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Selection\"}},\"appliedLoyaltyInfo\":{\"$ref\":\"#/components/schemas/AppliedLoyaltyInfo\"},\"taxExempt\":{\"type\":\"boolean\",\"default\":false,\"description\":\"True if this check is tax exempt. Tax exempt number is not yet supported.\"},\"displayNumber\":{\"type\":\"string\",\"description\":\"Generally starts at one each day and counts up. Not guaranteed to be unique.\"},\"appliedServiceCharges\":{\"type\":\"array\",\"description\":\"Any restaurant-configured service charges that applied to this check.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedServiceCharge\"}},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The dollar amount due on this check in USD, after discounts but before tax.\"},\"taxAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The computed tax amount in USD. Includes service charge and item level taxes.\"},\"totalAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The total amount due on this check in USD, including discounts and taxes.\"},\"payments\":{\"type\":\"array\",\"description\":\"Payments made on this check\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/Payment\"}},\"tabName\":{\"type\":\"string\",\"description\":\"The name of the tab on this check. This will show up on the KDS (Kitchen Display System) for pending orders. The tabName's length can be up to 255 characters.\"},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The payment status of this check. OPEN means there is outstanding balance. PAID means a credit card payment has been applied but the tip has not been adjusted. CLOSED means there is no remaining amount due on this check. Toast does not prevent a CLOSED check from transitioning back to OPEN or PAID.\",\"enum\":[\"OPEN\",\"PAID\",\"CLOSED\"]},\"appliedDiscounts\":{\"type\":\"array\",\"description\":\"The discounts applied to this check.\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscount\"}},\"voided\":{\"type\":\"boolean\",\"description\":\"True if this check has been voided.\"},\"voidDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date at which this check was voided. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"voidBusinessDate\":{\"type\":\"integer\",\"description\":\"The business date (yyyyMMdd) on which this check was \\nvoided.\\n\"},\"paidDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date at which this check received \\npayment. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"createdDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"lastModifiedDevice\":{\"$ref\":\"#/components/schemas/Device\"}}}]},\"ConfigReference\":{\"type\":\"object\",\"description\":\"A wrapper object containing identifier values for Toast platform entities.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"multiLocationId\":{\"description\":\"A consistent identifier for Toast platform entities, such\\nas menu items, that applies to all versions of a shared\\nentity at all locations in a restaurant group. For\\nexample, you can use the `multiLocationId` value to\\nidentify menu entities that are versions of a shared menu\\nentity. The `multiLocationId` value in the orders API\\ncorresponds to the `masterId` value for menu\\nconfiguration entities in the menus API. For more\\ninformation about the menus API `masterId` value, see\\n[the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiUnderstandingGuidsEntityIdentifiersAndMultilocationIds_V2.html#apiMultilocationIdValues_V2).\\ntype: string\\n\"},\"externalId\":{\"description\":\"An external identifier that is prefixed by a naming\\nauthority. Deprecated for use in `ConfigReference`.\\n\",\"type\":\"string\"}}}]},\"AppliedLoyaltyInfo\":{\"type\":\"object\",\"description\":\"Information about the customer loyalty program account associated with a check.\",\"required\":[\"loyaltyIdentifier\",\"vendor\"],\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"loyaltyIdentifier\":{\"type\":\"string\",\"description\":\"An identifier for the loyalty program account.\"},\"vendor\":{\"type\":\"string\",\"description\":\"The specific loyalty program service provider that supports the loyalty account. For all interactions with the Loyalty Integration API, this value will be INTEGRATION.\",\"enum\":[\"INTEGRATION\"]},\"accrualFamilyGuid\":{\"type\":\"string\",\"description\":\"An internal Toast POS identifier for loyalty program transactions.\"},\"accrualText\":{\"type\":\"string\",\"description\":\"A description of the loyalty program transaction that will be printed on the customer's reciept. For example, \\\"Earned 27 points.\\\" The maximum length of the description string is 255 characters.\"}}}]},\"Selection\":{\"type\":\"object\",\"description\":\"A Selection object can represent either a primary item (i.e. Check.selections) or a modifier (Selection.modifiers) selection. Quantity defaults to 1. <br><br> Specify a modifier selection by adding it to the `modifiers` list of another selection. For each modifier selection, its optionGroup field must be set correctly, because a MenuItem can be included in multiple MenuOptionGroups, potentially with different prices or sizing. \",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"item\",\"quantity\"],\"properties\":{\"item\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"itemGroup\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"optionGroup\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"preModifier\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"quantity\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Quantity ordered. A decimal number for items sold by weight; a counting number for discrete items.\"},\"unitOfMeasure\":{\"type\":\"string\",\"description\":\"The unit of measure required for weighing the item. Default is NONE, which means the item is not meant to be weighed.\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\"]},\"selectionType\":{\"type\":\"string\",\"description\":\"Specifies whether this selection is a special request or other off-menu sale. If left null or NONE, describes a normal modifier or item selection.\",\"enum\":[\"NONE\",\"OPEN_ITEM\",\"SPECIAL_REQUEST\",\"PORTION\",\"HOUSE_ACCOUNT_PAY_BALANCE\"]},\"salesCategory\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"appliedDiscounts\":{\"type\":\"array\",\"description\":\"The itemized discounts applied to this item.\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscount\"}},\"deferred\":{\"type\":\"boolean\",\"description\":\"Whether this selection is a deferred revenue transaction, e.g. gift card sales.\"},\"preDiscountPrice\":{\"type\":\"number\",\"description\":\"Gross sale price for this selection. Excludes tax.\",\"format\":\"double\"},\"price\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Net price for this selection. The final price of the item after considering discounts (including discounts at the check level), quantity adjustments, and modifier prices at the time the item was selected for purchase.\"},\"tax\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The total tax amount for this selection.\"},\"voided\":{\"type\":\"boolean\",\"description\":\"True if this selection has been voided.\"},\"voidDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date at which this selection was voided. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"voidBusinessDate\":{\"type\":\"integer\",\"description\":\"The business date (yyyyMMdd) on which this selection was \\nvoided.\\n\"},\"voidReason\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"displayName\":{\"type\":\"string\",\"description\":\"The display name of the selection. This field can be used to set a special request value, otherwise it will be generated from this Selection's item property.\"},\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date at which this selection was created. Defaults to \\ncurrent time if not specified. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date at which this selection was last modified. \\nDefaults to current time if not specified. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"modifiers\":{\"type\":\"array\",\"description\":\"A list of modifiers applying to this selection.\",\"items\":{\"$ref\":\"#/components/schemas/Selection\"}},\"fulfillmentStatus\":{\"type\":\"string\",\"default\":\"NEW\",\"description\":\"Indicates the stage of the preparation workflow that the \\nmenu item selection is in. The `fulfillmentStatus` of a \\nmenu item selection changes as restaurant employees move \\nthe item through the functions of the Toast POS, for \\nexample order entry and the kitchen display system (KDS).\\nResponse only. \\n<ul>\\n  <li>`NEW` - the menu item selection has been added to a \\n    check but has not been sent to the KDS for \\n    preparation.</li>\\n  <li>`HOLD` - a restaurant employee has paused the menu \\n    item selection so that it does not appear in the \\n    KDS for preparation.</li>\\n  <li>`SENT` - the menu item selection has been fired and \\n    appears in the KDS for preparation.</li>\\n  <li>`READY` - preparation is complete, the menu item \\n    selection has been fulfilled and no longer appears in \\n    the KDS. If your restaurant does not use the Toast POS \\n    KDS, items in an order will not reach the `READY` \\n    status.</li>\\n</ul>\\n\",\"enum\":[\"NEW\",\"HOLD\",\"SENT\",\"READY\"]},\"taxInclusion\":{\"type\":\"string\",\"description\":\"Indicates whether the menu item price includes one or more tax\\namounts. If the menu item is a modifier for another menu item\\nselection, it always inherits the tax inclusion behavior of the menu\\nitem it applies to. Values are:\\n* `INCLUDED` - the menu item price includes one or more tax amounts.\\n* `NOT_INCLUDED` - the menu item price does not include any tax\\n  amounts.\\n* `INHERITED` - the menu item is a modifier for another menu item\\n  selection in the check. The `taxInclusion` value of the parent menu\\n  item selection applies to the modifier. If a menu item selection\\n  *that is not a modifier* inherits tax inclusion behavior from a\\n  menu or menu group, the `taxInclusion` value will be either\\n  `INCLUDED` or `NOT_INCLUDED`.\\n\",\"enum\":[\"INCLUDED\",\"NOT_INCLUDED\",\"INHERITED\"]},\"appliedTaxes\":{\"type\":\"array\",\"description\":\"An array of AppliedTaxRate objects that contain information about tax payments made for the selection.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedTaxRate\"}},\"plu\":{\"type\":\"string\",\"description\":\"The price look-up (PLU) code for the menu item selection used for\\npricing and inventory management. This value is null if the menu\\nitem does not have a PLU code configured. For information about\\nconfiguring PLUs for menu items, see [Toast product\\ndocumentation](https://doc.toasttab.com/doc/platformguide/platformMenuManagerWorkingWithMenuItems.html#platformMenuManagerSpecifyingAPluOrSkuForAMenuItem).\\n\"}}}]},\"Payment\":{\"type\":\"object\",\"description\":\"Defines a payment.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"type\",\"amount\",\"tipAmount\"],\"properties\":{\"paidDate\":{\"description\":\"The date at which the payment was made. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"paidBusinessDate\":{\"description\":\"The business date (yyyyMMdd) on which this payment was \\nfirst applied.\\n\",\"type\":\"integer\"},\"type\":{\"type\":\"string\",\"description\":\"The payment method.\",\"enum\":[\"CASH\",\"CREDIT\",\"GIFTCARD\",\"HOUSE_ACCOUNT\",\"REWARDCARD\",\"LEVELUP\",\"OTHER\",\"UNDETERMINED\"]},\"cardEntryMode\":{\"type\":\"string\",\"description\":\"Indicates how credit card data was obtained. Response only.\",\"enum\":[\"SWIPED\",\"KEYED\",\"ONLINE\",\"EMV_CHIP_SIGN\",\"TOKENIZED\",\"PRE_AUTHED\",\"SAVED_CARD\",\"FUTURE_ORDER\",\"CONTACTLESS\",\"APPLE_PAY_CNP\",\"GOOGLE_PAY_CNP\",\"CLICK_TO_PAY_CNP\",\"INCREMENTAL_PRE_AUTHED\",\"PARTNER_ECOM_COF\"]},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of this payment, excluding tips.\"},\"tipAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount tipped on this payment.\"},\"amountTendered\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount tendered for this payment.\"},\"cardType\":{\"type\":\"string\",\"description\":\"The type of card used.\",\"enum\":[\"VISA\",\"MASTERCARD\",\"AMEX\",\"DISCOVER\",\"JCB\",\"DINERS\",\"CIT\",\"MAESTRO\",\"LASER\",\"SOLO\",\"INTERAC\",\"UNKNOWN\"]},\"last4Digits\":{\"type\":\"string\",\"description\":\"The last 4 digits of the card used.\"},\"originalProcessingFee\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The original processing fee for this payment. The original processing fee value is populated after the payment has been captured.\"},\"server\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"cashDrawer\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"refundStatus\":{\"type\":\"string\",\"enum\":[\"NONE\",\"PARTIAL\",\"FULL\"]},\"refund\":{\"$ref\":\"#/components/schemas/Refund\"},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The status of this payment when the type is CREDIT.\",\"enum\":[\"OPEN\",\"PROCESSING\",\"AUTHORIZED_AT_RISK\",\"AUTHORIZED\",\"ERROR\",\"DENIED\",\"VOIDED_AT_RISK\",\"CANCELLED\",\"CAPTURE_IN_PROGRESS\",\"CAPTURED\",\"VOIDED\",\"PROCESSING_VOID\"]},\"voidInfo\":{\"$ref\":\"#/components/schemas/VoidInformation\"},\"houseAccount\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"otherPayment\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"createdDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"lastModifiedDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"mcaRepaymentAmount\":{\"description\":\"The total currency amount withheld as repayment for a merchant\\ncash advance (MCA). The MCA repayment amount is set at the time\\nthe payment is captured, and then updated when settlement occurs.\\n\",\"type\":\"number\",\"format\":\"double\"}}}]},\"DeliveryInfo\":{\"type\":\"object\",\"description\":\"Required if the dining option behavior is DELIVERY\",\"required\":[\"address1\",\"city\",\"state\",\"zipCode\"],\"properties\":{\"address1\":{\"type\":\"string\",\"description\":\"The first line of the street address of the delivery destination.\\n\"},\"address2\":{\"type\":\"string\",\"description\":\"The second line of the street address of the delivery destination.\\n\"},\"city\":{\"type\":\"string\",\"description\":\"The name of the city or town of the delivery destination.\\n\"},\"state\":{\"type\":\"string\",\"format\":\"ISO 3166-2\",\"description\":\"The postal abbreviation of the state or province of the \\ndelivery destination. The abbreviation must be in ISO 3166-2 \\nformat (two capital letters).\\n\"},\"zipCode\":{\"type\":\"string\",\"description\":\"The postal or zip code of the delivery destination.\\n\"},\"latitude\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The north/south geographic coordinate of the delivery \\ndestination, in decimal format.\\n\"},\"longitude\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The east/west geographic coordinate of the delivery \\ndestination, in decimal format.\\n\"},\"notes\":{\"description\":\"Additional instructions or information about the delivery.\\n\",\"type\":\"string\"},\"deliveredDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the delivery employee indicated that \\nthe order was delivered in the Toast POS. Response only. This \\nvalue is only set when the dining option for the order is \\n`DELIVERY`. For other dining options, the value is `null`. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"dispatchedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the restaurant indicated that the \\norder was available for delivery and assigned to a delivery \\nemployee in the Toast POS. This value is only set when the \\ndining option for the order is `DELIVERY`. For other dining \\noptions, the value is `null`. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"deliveryEmployee\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}},\"AppliedServiceCharge\":{\"type\":\"object\",\"description\":\"A percentage/open/fixed service charge added to a check which could represent in general an upcharge like a gratuity or delivery fee. Whether the upcharge is taxable is defined in the restaurant-configured serviceCharge. The fields on the AppliedServiceCharge are computed based on the referenced ServiceCharge configuration.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"serviceCharge\"],\"properties\":{\"chargeAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The final applied amount excluding tax. This is required if the amountType is OPEN.\"},\"serviceCharge\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"chargeType\":{\"description\":\"Derived from serviceCharge. An OPEN service charge can either be a dollar amount or a percentage.\",\"type\":\"string\",\"enum\":[\"FIXED\",\"PERCENT\",\"OPEN\"]},\"name\":{\"description\":\"Derived from serviceCharge - the configured human readable label for the service charge.\",\"type\":\"string\"},\"delivery\":{\"description\":\"Derived from serviceCharge - whether this service charge is a delivery charge.\",\"type\":\"boolean\"},\"gratuity\":{\"description\":\"Derived from serviceCharge - whether this service charge is a gratuity. Can be used to derive required tip amount on the check.\",\"type\":\"boolean\"},\"taxable\":{\"description\":\"Derived from serviceCharge - whether this service charge is taxable.\",\"type\":\"boolean\"},\"appliedTaxes\":{\"type\":\"array\",\"description\":\"Derived from serviceCharge - the taxes applied to the service\",\"items\":{\"$ref\":\"#/components/schemas/AppliedTaxRate\"}}}}]},\"AppliedTaxRate\":{\"type\":\"object\",\"description\":\"A tax rate applied to an Item or ServiceCharge.\",\"required\":[\"taxRate\"],\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"entityType\":{\"description\":\"The type of object this is.\",\"type\":\"string\"},\"taxRate\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the tax rate.\"},\"rate\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The tax rate, which can be a fixed amount, a percentage, or null.\"},\"taxAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The tax amount that was actually applied.\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the tax rate. Default is percent if no tax rate config\",\"enum\":[\"PERCENT\",\"FIXED\",\"NONE\",\"TABLE\",\"EXTERNAL\"]}}}]},\"AppliedDiscountTrigger\":{\"type\":\"object\",\"description\":\"The Selection which triggered the application of this discount\",\"properties\":{\"selection\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"quantity\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the selection used to trigger the applied discount.\"}}},\"AppliedDiscount\":{\"type\":\"object\",\"description\":\"A discount applied to a check or item. The Toast POS system calculates service\\ncharges before applying discounts. The system calculates tax after applying\\ndiscounts. In a `POST` request, the type of the discount must be fixed amount\\nor fixed percentage, and the discount must be applied to a check. See\\n[Applying Discounts to a Check in an Order](https://doc.toasttab.com/Ie5QH/apiApplyingDiscountsToACheck.html).\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the applied discount.\"},\"discountAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The discount amount in USD. This amount will be subtracted from the check or item.\"},\"nonTaxDiscountAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount that a discount reduces a menu item price,\\nexcluding any discount amount applied to taxes. In most\\ncases, a discount only applies to the menu item price and\\nthe `nonTaxDiscountAmount` is the same as the `discountAmount`. \\nIf you apply a discount to a menu item that includes tax in \\nits price, the `nonTaxDiscountAmount` is less than the full \\ndiscount amount.\\n\"},\"discount\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"triggers\":{\"type\":\"array\",\"description\":\"Optional items which triggered this discount.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscountTrigger\"}},\"approver\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"processingState\":{\"type\":\"string\",\"description\":\"Applies to loyalty program discounts only. Loyalty\\nprogram reward discounts are validated and then applied,\\nor redeemed, by the third-party loyalty program service\\nprovider depending on the state of the Toast POS order.\\nThis value indicates the state of the discount in that\\nvalidation and application process. Response only. The\\n`processingState` may be one of the following enumerated\\nvalues.\\n<ul>\\n  <li><code>PENDING_APPLIED</code> - The loyalty program\\n  service provider has confirmed that the reward discount\\n  is valid for the order and customer. The reward has not\\n  been redeemed, or applied to the customer's loyalty\\n  account.</li>\\n  <li><code>APPLIED</code> - The reward discount has been\\n  redeemed. The reward is no longer available from the\\n  customer's loyalty program account.</li>\\n  <li><code>PENDING_VOID</code> - The reward discount has been\\n  removed from the Toast POS order. The reward is not\\n  available from the customer's loyalty program account\\n  until the loyalty program service provider processes\\n  the void operation.</li>\\n  <li><code>VOID</code> - The reward discount has been removed\\n  from the Toast POS order and the reward is available from\\n  the customer's loyalty program account again.</li>\\n</ul>\\n\",\"enum\":[\"PENDING_APPLIED\",\"APPLIED\",\"PENDING_VOID\",\"VOID\"]},\"loyaltyDetails\":{\"$ref\":\"#/components/schemas/LoyaltyDetails\"},\"comboItems\":{\"type\":\"array\",\"description\":\"A List of Menu Item Selections that this discount is applied to (empty for NonCombo Discounts).\",\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"appliedPromoCode\":{\"type\":\"string\",\"description\":\"The promo code that was applied for this discount.\"}}}]},\"LoyaltyDetails\":{\"type\":\"object\",\"description\":\"Information about the loyalty program discount applied to a check. The loyalty program account is identified in the AppliedLoyaltyInfo value for the check.\",\"required\":[\"vendor\",\"referenceId\"],\"properties\":{\"vendor\":{\"type\":\"string\",\"description\":\"The specific loyalty program service provider that supports the loyalty account.\",\"enum\":[\"INTEGRATION\"]},\"referenceId\":{\"type\":\"string\",\"description\":\"The identifier of the loyalty program discount that is recognized by the loyalty program service provider. The Toast POS transmits the discount identifier to the service provider to determine the validity and amount of the discount.\"}}},\"Refund\":{\"type\":\"object\",\"description\":\"A discount applied to a check or item.\",\"properties\":{\"refundAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the refund excluding the tip.\"},\"tipRefundAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the tip refund.\"},\"refundDate\":{\"description\":\"The date and time the refund was made. <a \\n    href=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\n    ISO 8601 date and time format for all Toast APIs.</a>\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"refundBusinessDate\":{\"description\":\"The business date (yyyyMMdd) on which this refund was \\ncreated.\\n\",\"type\":\"integer\"}}},\"Device\":{\"type\":\"object\",\"description\":\"The *Device ID* value that the Toast POS system assigns to a specific Toast POS device. The `id` value is a unique identifier for a device. To find the ID for a Toast POS device, do the following. From the overflow  menu (⋮) select *Device Status* and then select the *Device* tab.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"The physical id of the device\"}}},\"VoidInformation\":{\"type\":\"object\",\"description\":\"Information about a void applied to a check or item.\",\"properties\":{\"voidUser\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"voidApprover\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"voidDate\":{\"description\":\"The date at which the refund was made. <a \\nhref=\\\"https://dev.toasttab.com/Ie5QH/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"voidBusinessDate\":{\"description\":\"The business date (yyyyMMdd) on which this void was made.\\n\",\"type\":\"integer\"},\"voidReason\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}},\"ExternalReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"externalId\":{\"description\":\"External identifier string that is prefixed by the naming authority.\",\"type\":\"string\"}}}]},\"ToastReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID.\",\"required\":[\"guid\",\"entityType\"],\"properties\":{\"guid\":{\"description\":\"The GUID maintained by Toast.\",\"type\":\"string\"},\"entityType\":{\"description\":\"The type of object this is.\",\"type\":\"string\"}}},\"LoyaltyTransactionResponse\":{\"type\":\"object\",\"description\":\"Information about a loyalty transaction from the loyalty provider. The Toast POS system\\nuses this information to complete guests' loyalty transactions.\\n\\nThe set of information in this object depends on the loyalty \\ntransaction type. The transaction type is specified in the \\n`Toast-Transaction-Type` header parameter for the request.\\n\\nAll `LoyaltyTransactionResponse` objects must include a\\n`transactionStatus` value. The object must include one of\\nthe following additional values depending on the transaction type:\\n\\n* `LOYALTY_INQUIRE` - checkResponse\\n* `LOYALTY_SEARCH` - searchResponse\\n* `LOYALTY_SIGNUP` - signupResponse\\n* `LOYALTY_REDEEM` - checkResponse\\n* `LOYALTY_ACCRUE` - checkResponse\\n* `LOYALTY_REVERSE` - none\\n* `LOYALTY_TRANSFER` - transferResponse\\n\",\"properties\":{\"transactionStatus\":{\"description\":\"Indicates the result of a loyalty transaction, reported by the\\nloyalty service provider. Possible values are:\\n\\n<ul>\\n  <li>`ACCEPT` - The loyalty service provider processed the transaction successfully.</li>\\n  <li>`ERROR_INVALID_TOAST_TRANSACTION_TYPE` - The requested Toast-Transaction-Type is not valid.</li>\\n  <li>`ERROR_ACCOUNT_INVALID` - The loyalty account is not recognized or is not valid at the current restaurant.</li>\\n  <li>`ERROR_INVALID_INPUT_PROPERTIES` - The specified JSON properties in the request body are not valid.</li>\\n  <li>`ERROR_TRANSACTION_DOES_NOT_EXIST` - The transaction that is being requested to be reversed does not exist.\\n    Only occurs on a `LOYALTY_REVERSE` transaction.</li>\\n  <li>`ERROR_INVALID_TOKEN` - The token supplied in the `Authorization` header field is invalid or cannot be validated.</li>\\n  <li>`ERROR_TRANSACTION_CANNOT_BE_REVERSED` - The specified transaction cannot be reversed. Only `LOYALTY_REDEEM`\\n    and `LOYALTY_ACCRUE` transactions can be reversed.</li>\\n  <li>`ERROR_INVALID_RESTAURANT` - The restaurant specified by the `Toast-Restaurant-External-ID` is invalid.</li>\\n  <li>`ERROR_INVALID_TRANSFER` - The cards that is being requested to be Transfer could not be completed.</li>\\n  <li>`ERROR_ALREADY_REGISTERED` - The phone number or email address used is already registered to a different account.\\n    Only occurs on a `LOYALTY_SIGNUP` transaction.</li>\\n</ul>\\n\",\"type\":\"string\",\"enum\":[\"ACCEPT\",\"ERROR_INVALID_TOAST_TRANSACTION_TYPE\",\"ERROR_ACCOUNT_INVALID\",\"ERROR_INVALID_INPUT_PROPERTIES\",\"ERROR_TRANSACTION_DOES_NOT_EXIST\",\"ERROR_INVALID_TOKEN\",\"ERROR_TRANSACTION_CANNOT_BE_REVERSED\",\"ERROR_INVALID_RESTAURANT\",\"ERROR_INVALID_TRANSFER\",\"ERROR_ALREADY_REGISTERED\"]},\"searchResponse\":{\"$ref\":\"#/components/schemas/ResponseSearch\"},\"signupResponse\":{\"$ref\":\"#/components/schemas/ResponseSignup\"},\"checkResponse\":{\"$ref\":\"#/components/schemas/ResponseCheck\"},\"transferResponse\":{\"$ref\":\"#/components/schemas/ResponseTransfer\"}}},\"ResponseSearch\":{\"description\":\"Response to a search request. Contains the array of account information matching the search\\ncriteria. If no matching accounts were found, the service should return a 404 response.\\n\",\"properties\":{\"accounts\":{\"description\":\"A list of loyalty accounts that match the criteria from the search request.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AccountInfo\"}}}},\"ResponseCheck\":{\"description\":\"Response to an inquire, redeem, or accure request. For an inquire response this field is requried.\\nFor all other responses it is optional unless any of the redemptions were rejected. If the \\naccount corresponding to the identifier was not found, the service should return a 404 response.\\n\",\"properties\":{\"accountInfo\":{\"$ref\":\"#/components/schemas/AccountInfo\"},\"offers\":{\"description\":\"An array of offers that are currently available to the holder of this account.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Offer\"}},\"rejectedRedemptions\":{\"description\":\"A list of redemptions that were submitted as part of a LOYALTY_INQUIRE or LOYALTY_REDEEM\\nrequest that are not valid for the given loyalty account and the contents of the check. \\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RejectedRedemption\"}},\"appliedRedemptions\":{\"description\":\"A list of redemptions that were submitted as part of a LOYALTY_INQUIRE or LOYALTY_REDEEM\\nrequest that are valid for the given loyalty account and the contents of the check. For item level redemptions the\\n`selectionGuid` will be set to indicate which item it applies to.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Redemption\"}},\"userMessage\":{\"description\":\"An optional message to be relayed to the guest at the restaurant. \\nExamples could include \\\"Visit http://www.website.com to check your points balance\\\" or \\n\\\"You will accrue 15 points with this transaction!\\\"\\n\",\"type\":\"string\"}}},\"ResponseTransfer\":{\"description\":\"Response to a transfer request. For a transfer response this field is required. Contains the loyalty identifier that the old account transferred to.\",\"properties\":{\"loyaltyIdentifier\":{\"description\":\"A unique identifier for the new account.\\n\",\"type\":\"string\"}}},\"ResponseSignup\":{\"description\":\"Response to a signup request. For a signup response this field is required.\\nContains the loyalty identifier of the newly created account.\\n\",\"required\":[\"loyaltyIdentifier\"],\"properties\":{\"loyaltyIdentifier\":{\"description\":\"The identifier of the loyalty account that was created. This identifier will be used\\nin subsequent loyalty transactions to identify this account.\\n\",\"type\":\"string\"}}}}}}},\"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-integrations-loyalty-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"loyalty.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/loyalty.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"loyalty","isDefault":true,"id":"loyalty","title":"loyalty","link":null}]},{"id":"c7399dc7-f5b6-50f4-bcf4-8d5264626edeoverview/__redocly content redirect/menus/overview/","definitionId":"menus","link":"/menus/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/menus.reference.page.yaml","info":{"version":"2.4.1","title":"Menus API","description":"Returns information about a restaurant's menus.\n\n_Important:_ Ordering integrations should use menus API V3. Other integration types should continue to use menus API V2 until further notice. See <a href=\"https://doc.toasttab.com/doc/devguide/apiComparingMenusAPIV2AndV3.html\">Comparing menus API V2 and V3</a> for more information.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"menus","label":"Menus V2","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-menus-api.yaml"},"apiVersions":[{"definitionId":"menus","isDefault":true,"title":"menus","id":"menus"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"2.4.1\",\"title\":\"Menus API\",\"description\":\"Returns information about a restaurant's menus.\\n\\n_Important:_ Ordering integrations should use menus API V3. Other integration types should continue to use menus API V2 until further notice. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiComparingMenusAPIV2AndV3.html\\\">Comparing menus API V2 and V3</a> for more information.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/menus\":{\"get\":{\"operationId\":\"menusGet\",\"summary\":\"Get menus\",\"description\":\"Get menus\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier for the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}}],\"responses\":{\"200\":{\"description\":\"Successful operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Restaurant\"}}}},\"404\":{\"description\":\"No published data was found for the restaurant. Ensure that the restaurant GUID is correct and that its data has been published.\"},\"503\":{\"description\":\"Unable to retrieve menus for the restaurant due to a service outage.\"}},\"security\":[{\"oauth2\":[\"menus:read\"]}]}},\"/metadata\":{\"get\":{\"operationId\":\"metadataGet\",\"summary\":\"Get menu last modified timestamp\\n\",\"description\":\"A lightweight endpoint that allows you to determine if a restaurant's menu data has been updated. Toast support strongly recommends that you do not make a call to the `/menus` endpoint unless the date and time returned by the `/metadata` endpoint is more recent than the `lastUpdated` date and time. While this recommendation applies to all clients of the menus API, it is particularly important for clients that have limited bandwidth.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier for the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}}],\"responses\":{\"200\":{\"description\":\"successful operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Metadata\"}}}}},\"security\":[{\"oauth2\":[\"menus:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/menus/v2\"}],\"components\":{\"securitySchemes\":{\"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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"menus:read\":\"Allows reading from menus API V2.\\n\"}}}}},\"schemas\":{\"Metadata\":{\"type\":\"object\",\"description\":\"Information about the last date and time that this restaurant's menu data was updated.\\n\",\"properties\":{\"restaurantGuid\":{\"description\":\"A unique identifier for this restaurant, assigned by the Toast POS system.\\n\",\"type\":\"string\",\"format\":\"uuid\"},\"lastUpdated\":{\"description\":\"The most recent date and time that this menu's data was published. Use this value to determine if you need to refresh your menu data. The `lastUpdated` value uses the absolute timestamp format describe in the <a href=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Dates and timestamps</a> section of the Toast Developer Guide.\\n\",\"type\":\"string\"}}},\"Restaurant\":{\"type\":\"object\",\"description\":\"Information about the restaurant whose menu data has been retrieved.\\n\",\"properties\":{\"restaurantGuid\":{\"description\":\"A unique identifier for this restaurant, assigned by the Toast POS system.\\n\",\"type\":\"string\",\"format\":\"uuid\"},\"lastUpdated\":{\"description\":\"The most recent date and time that this menu's data was published. Use this value to determine if you need to refresh your menu data. The `lastUpdated` value uses the absolute timestamp format describe in the <a href=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Dates and timestamps</a> section of the Toast Developer Guide.\\n\",\"type\":\"string\"},\"restaurantTimeZone\":{\"description\":\"The name of the restaurant's time zone in the IANA time zone database https://www.iana.org/time-zones. For example, \\\"America/New_York\\\".\\n\",\"type\":\"string\"},\"menus\":{\"type\":\"array\",\"description\":\"An array of `Menu` objects that represent the published menus used by this restaurant.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Menu\"}},\"modifierGroupReferences\":{\"description\":\"A map of `ModifierGroup` objects that define the modifier groups used by this restaurant. Each `ModifierGroup` object is presented as a key/value pair. A pair's key matches the `referenceId` of the object contained in the pair's value, as shown below:\\n```\\n  \\\"modifierGroupReferences\\\": {\\n    ...\\n    \\\"3\\\": {\\n      \\\"referenceId\\\": 3,\\n      \\\"name\\\": \\\"Toppings\\\",\\n      \\\"guid\\\": \\\"58b79986-f88f-411d-ba18-14b1e2441e9d\\\",\\n        ...\\n      },\\n      ...\\n      \\\"modifierOptionReferences\\\": [\\n        10,\\n        11\\n      ],\\n      ...\\n    },\\n    ...\\n  },\\n```\\n\\nOther menu entities refer to modifier groups using their `referenceId`. Having a key that matches the `referenceId` allows you to locate the correct modifier group in the `modifierGroupReferences` map. For more information on the `referenceId` value, see the <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUnderstandingGuidsEntityIdentifiersAndMultilocationIds_V2.html\\\">Understanding GUIDs, referenceIds, and multilocationIds</a> section of the Toast Developer Guide.\\n\",\"properties\":{\"identifier\":{\"type\":\"integer\"}},\"additionalProperties\":{\"$ref\":\"#/components/schemas/ModifierGroup\"}},\"modifierOptionReferences\":{\"description\":\"A map of `ModifierOption` objects that define the modifier options used by this restaurant. Each `ModifierOption` object is presented as a key/value pair. A pair's key matches the `referenceId` of the object contained in the pair's value, as shown below:\\n```\\n\\\"modifierOptionReferences\\\": {\\n  ...\\n  \\\"10\\\": {\\n    \\\"referenceId\\\": 10,\\n    \\\"name\\\": \\\"Mushrooms\\\",\\n    \\\"guid\\\": \\\"fa24fee9-76c4-40ba-ae3c-7dfccafdd8d3\\\",\\n    ...\\n  },\\n  \\\"11\\\": {\\n    \\\"referenceId\\\": 11,\\n    \\\"name\\\": \\\"Onions\\\",\\n    \\\"guid\\\": \\\"afee6be7-8280-4c69-a170-9fdf4c76bf7b\\\",\\n    ...\\n  },\\n  ...\\n}\\n```\\n\\nOther menu entities refer to modifier options using their `referenceId`. Having a key that matches the `referenceId` allows you to locate the correct modifier option in the `modifierOptionReferences` map. For more information on the `referenceId` value, see the <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUnderstandingGuidsEntityIdentifiersAndMultilocationIds_V2.html\\\">Understanding GUIDs, referenceIds, and multilocationIds</a> section of the Toast Developer Guide.\\n\",\"properties\":{\"identifier\":{\"type\":\"integer\"}},\"additionalProperties\":{\"$ref\":\"#/components/schemas/ModifierOption\"}},\"preModifierGroupReferences\":{\"description\":\"A map of `PreModifierGroup` objects that define the premodifier groups used by this restaurant. Each `PreModifierGroup` object is presented as a key/value pair. A pair's key matches the `referenceId` of the object contained in the pair's value, as shown below:\\n```\\n\\\"preModifierGroupReferences\\\": {\\n  \\\"22\\\": {\\n    \\\"referenceId\\\": 22,\\n    \\\"guid\\\": \\\"07a1a94d-6f7b-46d5-a916-a07fa16bb8e8\\\",\\n    \\\"name\\\": \\\"PreModGroup\\\",\\n    \\\"preModifiers\\\": [\\n      {\\n        \\\"guid\\\": \\\"ad45e697-9356-468e-b7b4-1b23f4d4b8a5\\\",\\n        \\\"name\\\": \\\"EXTRA\\\",\\n        \\\"fixedPrice\\\": 1.0,\\n        \\\"multiplicationFactor\\\": null,\\n        \\\"displayMode\\\": \\\"PREFIX\\\"\\n      },\\n      {\\n        \\\"guid\\\": \\\"483dd4cf-acea-4373-ae76-5f7efd0d529d\\\",\\n        \\\"name\\\": \\\"NO\\\",\\n        \\\"fixedPrice\\\": 0.0,\\n        \\\"multiplicationFactor\\\": null,\\n        \\\"displayMode\\\": \\\"PREFIX\\\"\\n      }\\n    ]\\n  },\\n},            \\n```\\n\\nOther menu entities refer to premodifier groups using their `referenceId`. Having a key that matches the `referenceId` allows you to locate the correct premodifier group in the `preModifierGroupReferences` map. For more information on the `referenceId` value, see the <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUnderstandingGuidsEntityIdentifiersAndMultilocationIds_V2.html\\\">Understanding GUIDs, referenceIds, and multilocationIds</a> section of the Toast Developer Guide.          \\n\",\"properties\":{\"identifier\":{\"type\":\"integer\"}},\"additionalProperties\":{\"$ref\":\"#/components/schemas/PreModifierGroup\"}}}},\"Menu\":{\"type\":\"object\",\"description\":\"Information about a menu configured for this restaurant.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this menu, for example, \\\"Food\\\" or \\\"Drinks\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this menu, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"description\":{\"description\":\"An optional short description for this menu.\\n\",\"type\":\"string\"},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"highResImage\":{\"type\":\"string\",\"description\":\"The URL to a high resolution image that has been uploaded for this menu. The image file must be in JPG, PNG, or SVG format. The `highResImage` value is only available if the Toast Kiosk module has been enabled for this restaurant. This value is null if no high resolution image has been specified.\\n\",\"nullable\":true},\"image\":{\"$ref\":\"#/components/schemas/Image\"},\"visibility\":{\"$ref\":\"#/components/schemas/Visibility\"},\"availability\":{\"type\":\"object\",\"description\":\"An `Availability` object with information about the days and times this menu is available. If the menu is available 24 hours per day, 7 days per week, this `Availability` object contains a single value, `alwaysAvailable`, that is set to TRUE. If the menu is not available 24 hours per day, 7 days per week, the `alwaysAvailable` value is set to FALSE and the object will also contain a `schedule` value that provides detailed information about the specific days and times this menu is available.\\n\\n**_Important_**\\nThe orders API does not validate against the availability settings of a menu, meaning it is possible to submit an order for an item on a menu when it is not currently available. For this reason, it is particularly important that you check a menu’s `availability` value before placing an order from it.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Availability\"}},\"menuGroups\":{\"type\":\"array\",\"description\":\"An array of the `MenuGroup` objects contained in this menu.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/MenuGroup\"}}}},\"MenuGroup\":{\"type\":\"object\",\"description\":\"Information about a menu group configured for this restaurant, including an array of menu items contained in the group.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this menu group, for example, \\\"Appetizers\\\" or \\\"Sandwiches\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this menu group, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"description\":{\"description\":\"An optional short description of this menu group.\\n\",\"type\":\"string\"},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"image\":{\"$ref\":\"#/components/schemas/Image\"},\"visibility\":{\"$ref\":\"#/components/schemas/Visibility\"},\"itemTags\":{\"type\":\"array\",\"description\":\"An array of `ItemTag` objects that are assigned to this menu group. Item tags are used to assign identifying characteristics, for example, vegetarian, gluten-free, or alcohol.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ItemTag\"}},\"menuGroups\":{\"type\":\"array\",\"description\":\"An array of the `MenuGroup` objects that are children of this menu group. The array is empty if the menu group has no child menu groups.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/MenuGroup\"}},\"menuItems\":{\"type\":\"array\",\"description\":\"An array of the `MenuItem` objects contained in this menu group.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/MenuItem\"}}}},\"MenuItem\":{\"type\":\"object\",\"description\":\"Information about a menu item configured for this restaurant.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this menu item, for example, \\\"Caesar Salad\\\" or \\\"Turkey Sandwich\\\".\\n\\nTo avoid menu ingestion failures, if the `name` value is an empty string or `null`, the menus API updates it to the string `Missing name` in the returned menus data.\\n\\nNote that, while this solution allows menu ingestion to proceed without failure, it does allow a menu item with the name `Missing name` to appear in a restaurant’s menu, creating potential confusion for guests and employees. Also, the menus API only updates the returned data. It does not update the menu item in the Toast database, meaning the name will still be blank when looking at the menu item in Toast Web.\\n\\nTo fix the issue in Toast Web, the restaurant must identify the parent menu entity for the menu item or modifier, view its details page in Toast Web, and then locate and fix the item with the blank name.\\n\",\"type\":\"string\"},\"kitchenName\":{\"type\":\"string\",\"description\":\"The name of the menu item as it appears on kitchen tickets. The `kitchenName` can include both numbers and letters. This value contains an empty string if a kitchen name has not been configured for the menu item.\\n\"},\"guid\":{\"description\":\"A unique identifier for this menu item, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"description\":{\"description\":\"An optional short description of this menu item.\\n\",\"type\":\"string\"},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"image\":{\"$ref\":\"#/components/schemas/Image\"},\"visibility\":{\"$ref\":\"#/components/schemas/Visibility\"},\"price\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The price of this menu item.\\n\\nIn Toast Web, menu items may have prices assigned to them individually, or they may inherit them from a parent menu group. The `price` value reflects the menu item's fully resolved pricing configuration in the following ways:\\n\\n  * For base prices, the `price` value is populated with the specified base price.\\n  \\n  * For menu-specific prices, the `price` value is resolved based on the current menu. For example, consider a menu item that is included in both Lunch and Dinner menus and is priced at $10 for the Lunch menu and $12 for the Dinner menu. In the fully resolved JSON returned by the menus API, this menu item would appear twice, once as a child of the Lunch menu with a `price` value of $10, and again as a child of the Dinner menu with a `price` value of $12.\\n  \\n  If this same menu item is added to a Breakfast menu but a menu-specific price is not defined for the Breakfast menu, then the `price` value for the instance of the menu item that appears in the Breakfast menu JSON is populated with the base price from the menu-specific price configuration. Menu-specific price configurations include a base price that functions as a default price when a menu-specific price cannot be resolved.\\n\\n  * For location-specific prices, the `price` value is resolved based on the current location. For example, consider a menu item that costs $15 in the Boston location and $20 in the New York location. When you retrieve menu data for the Boston location, this menu item's `price` value is $15. When you retrieve menu data for the New York location, the menu item's `price` value is $20.\\n  \\n  * For time-specific prices, the `price` value is populated with the base price that is specified as part of the time-specific price configuration. This base price functions as a default price for the menu item during times of the day when a time-specific price has not been defined. For example, consider a menu item that costs $8 from noon to 2pm and $10 during the rest of the day. The `price` value for this item would be $10. You must use the `pricingStrategy` and `pricingRules` values for this menu item to calculate the price of the item during time periods for which a time-specific price has been defined.\\n  \\n  * For size prices, the `price` value is null. You must use this menu item's `pricingStrategy` and `pricingRules` values to calculate the price of the item for different sizes.\\n  \\n  * For open prices, the `price` value is null.\\n\\n  \\n  If the menu item is priced using a price level, the `price` value reflects the pricing strategy used for that price level, using the same logic described above. For example, consider a price level that applies a size price to the menu items it is assigned to. In this scenario, the `price` value is null and you must use the menu item's `pricingStrategy` and `pricingRules` values to calculate the price of the item for different sizes.\\n\\n  For more information on menu item pricing and pricing strategies, see the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminToastPosPricingFeatures.html\\\">Menu Pricing</a> section in the Toast Platform Guide.\\n\",\"nullable\":true},\"pricingStrategy\":{\"type\":\"string\",\"enum\":[\"BASE_PRICE\",\"MENU_SPECIFIC_PRICE\",\"TIME_SPECIFIC_PRICE\",\"SIZE_PRICE\",\"OPEN_PRICE\"],\"description\":\"A string that represents the pricing strategy used for this menu item.\\n\\nYou use the `pricingStrategy` value, in conjunction with the `pricingRules` value, to calculate the price for a menu item that uses the Time Specific Price or Size Price pricing strategy.\\n\\nIn Toast Web, menu items may have pricing strategies assigned to them individually, or they may inherit them from a parent menu group. The `pricingStrategy` value indicates the menu item's fully resolved pricing strategy. If the menu item is priced using the:\\n  * Base Price pricing strategy, then the `pricingStrategy` value is BASE_PRICE.\\n  * Menu Specific Price pricing strategy, then the `pricingStrategy` value is MENU_SPECIFIC_PRICE.\\n  * Time Specific Price pricing strategy, then the `pricingStrategy` value is TIME_SPECIFIC_PRICE.\\n  * Size Price pricing strategy, then the `pricingStrategy` value is SIZE_PRICE.\\n  * Open Price pricing strategy, then the `pricingStrategy` value is OPEN_PRICE.\\n\\nIf the menu item is priced using the Location Specific Price pricing strategy, then the `pricingStrategy` value indicates which pricing strategy is used at the current location. For example, consider a menu item that uses a menu-specific price at the Boston location and a base price at the New York location. When you retrieve the menu data for the Boston location, the `pricingStrategy` for the menu item is MENU_SPECIFIC_PRICE. When you retrieve menu data for the New York location, the `pricingStrategy` for the menu item is BASE_PRICE.\\n\\nIf the menu item is priced using a price level, then the `pricingStrategy` value indicates which pricing strategy is used for that price level. For example, if the \\\"Draft Beer\\\" pricing level uses a time-specific price, then the `pricingStrategy` value for a menu item that is assigned the \\\"Draft Beer\\\" pricing level is TIME_SPECIFIC_PRICE.\\n\\nIf the `pricingStrategy` value is BASE_PRICE or MENU_SPECIFIC_PRICE, you can retrieve the menu item's price from its `price` value.\\n\\nIf the `pricingStrategy` value is TIME_SPECIFIC_PRICE or SIZE_PRICE, you must use the rules provided in _this menu item's_ `pricingRules` value to calculate the price for it.\\n\"},\"pricingRules\":{\"type\":\"object\",\"description\":\"A `PricingRules` object with information about how to calculate the price for this menu item. You use a menu item's `pricingRules` value, in conjunction with its `pricingStrategy` value, to calculate a price for a menu item that uses a size-specific or time-specific price.\\n\\nThe `pricingRules` object takes different forms depending on the pricing strategy configured for the menu item. Use the `pricingStrategy` value to determine which pricing strategy has been used so that you can properly interpret the data in the `pricingRules` object. For the BASE_PRICE, and MENU_SPECIFIC_PRICE pricing strategies, the `pricingRules` object is null because you can retrieve the price from the `price` value without additional calculation. For the OPEN_PRICE pricing strategy, the `pricingRules` object is also null (the price of an open menu item is specified when it is ordered). For the TIME_SPECIFIC_PRICE and SIZE_PRICE pricing strategies, the `PricingRules` object contains additional values that you use to calculate the menu item's price.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PricingRules\"},\"nullable\":true},\"isDeferred\":{\"type\":\"boolean\",\"description\":\"Indicates whether this menu item should be considered deferred revenue.\\n\"},\"isDiscountable\":{\"type\":\"boolean\",\"description\":\"Indicates whether this menu item can be discounted.\\n\\n**_Important_** The orders API _does not validate_ against the `isDiscountable` value. If you submit an order that applies a discount to a menu item whose `isDiscountable` value is FALSE, the orders API will not fail the order but it will set the discount amount on the menu item to $0.00. If you are using the menus API to build an ordering application, be sure to inspect the `isDiscountable` value of the menu items to ensure that your ordering application does not allow an item to be discounted if its `isDiscountable` value is FALSE.\\n\"},\"salesCategory\":{\"$ref\":\"#/components/schemas/SalesCategory\"},\"taxInfo\":{\"type\":\"array\",\"description\":\"An array of GUIDs for the tax rates that apply to this menu item.\\n\\nNote that a menu item's tax rates may get overridden if a modifier option is applied to it and that modifier option is configured so that it overrides its parent menu item's tax rates. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUsingTaxInfoAndModifierOptionTaxInfoToCalculateTaxesForMenuItemsAndModOptions.html\\\">Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options</a> in the Toast Developer Guide for more information.   \\n          \\nTo retrieve full configuration data for a tax rate, use the `/taxRates/{guid}` endpoint in the configuration API.\\n\\n_Important:_ The `taxInfo` value is intended to help you display prices but the `/prices` endpoint of the orders API is the only supported way to determine the prices of orders that you submit to the orders API. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiOrderPrices.html\\\">Order prices</a> in the Toast Developer Guide for more information.\\n\",\"items\":{\"type\":\"string\"}},\"taxInclusion\":{\"type\":\"string\",\"enum\":[\"TAX_INCLUDED\",\"TAX_NOT_INCLUDED\",\"SMART_TAX\"],\"description\":\"A string that represents the tax inclusion setting for this menu item. Possible values include:\\n\\n* `TAX_INCLUDED`: The menu item's price includes taxes. You should not display additional tax on top of the menu item price in your ordering UI.\\n* `TAX_NOT_INCLUDED`: The menu item's price does not include taxes. You should display tax values alongside the menu item price in your ordering UI.\\n* `SMART_TAX`: The menu item is using smart tax, a feature that allows a restaurant to configure menu item prices to include or not include taxes, depending on the section of the restaurant that the item is ordered in (for example, the bar or the dining room). For example, a guest can order an item at either the bar or in the main dining room. To prevent bartenders from having to handle coins, which can slow down service, and to make tipping easier, the restaurant wants the price of the item to be a whole number that includes tax when it is ordered at the bar. In the main dining room, where speed of service is less of a concern, the restaurant doesn't want the item's price to include tax, so that it doesn't lose out on the extra revenue.\\n\\nTypically, the smart tax setting is used for in-store workflows where the efficiency of money handling is a priority. As such, it doesn't apply to online ordering integrations. If a menu item's `taxInclusion` value is set to `SMART_TAX`, your ordering integration should treat the menu item as if tax is not included. For more information on the smart tax feature, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSmartTax.html\\\">Smart tax</a> in the Toast Platform Guide.\\n\\n_Note:_ A menu item's tax inclusion setting is inherited by any modifiers that are applied to that menu item. For more information, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminTaxesOnModifiers.html#adminModifierTaxInteraction\\\">Tax functionality interaction</a> in the Toast Platform Guide.\\n\"},\"itemTags\":{\"type\":\"array\",\"description\":\"An array of `ItemTag` objects that are assigned to this menu item. Item tags are used to assign identifying characteristics to a menu item, for example, vegetarian, gluten-free, or alcohol.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ItemTag\"}},\"plu\":{\"type\":\"string\",\"description\":\"The price lookup (PLU) code for this menu item. The PLU code can include both numbers and letters. This value contains an empty string if a PLU code has not been defined.\\n\"},\"sku\":{\"type\":\"string\",\"description\":\"The stock keeping unit (SKU) identifier for this menu item. The SKU identifier can include both numbers and letters. This value contains an empty string if a SKU has not been defined.\\n\"},\"calories\":{\"type\":\"integer\",\"description\":\"The number of calories in this menu item. The calories value can be any positive or negative integer, or zero. This value is null if a calories amount has not been configured for the menu item.\\n\",\"nullable\":true},\"contentAdvisories\":{\"$ref\":\"#/components/schemas/ContentAdvisories\"},\"unitOfMeasure\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"],\"description\":\"The unit of measure used to determine the price of the item. For example, $10.00 per gram.\\n\\nThe default is `NONE`, which means that the item is not meant to be measured during a sale.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\"},\"portions\":{\"type\":\"array\",\"description\":\"An array of `Portion` objects that define the portions that can be used with this menu item. For example, for a pizza menu item, you could define 1st Half and 2nd Half portions. See <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPortionsOverview.html\\\">Portions overview</a> in the Toast Platform Guide for more information on portions.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/Portion\"}},\"prepTime\":{\"type\":\"integer\",\"description\":\"The amount of time, in seconds, that it takes to prepare this menu item. This value is null if a prep time has not been specified for the menu item.<br>\\n<br>\\n*Related topics*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminFireByPrepTime.html\\\">Using prep times to automate item firing</a><br>\\n\",\"format\":\"int32\",\"nullable\":true},\"prepStations\":{\"type\":\"array\",\"description\":\"An array of GUIDs for the prep stations that have been assigned to this menu item. This array is empty if no prep stations have been assigned.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html\\\">Routing to prep stations</a>\\n\",\"items\":{\"type\":\"string\"}},\"modifierGroupReferences\":{\"type\":\"array\",\"description\":\"An array of `referenceId`s for `ModifierGroup` objects. These objects define the modifier groups that apply to this menu item.\\n\",\"minItems\":0,\"items\":{\"type\":\"integer\"}},\"eligiblePaymentAssistancePrograms\":{\"type\":\"array\",\"description\":\"An array of strings that indicate which payment assistance programs may be used to pay for this menu item. Possible values include:\\n\\n* `SNAP`: Supplemental Nutrition Assistance Program\\n* `EBT_CASH`: Electronic Benefit Transfer Cash\\n\\nThe array is empty if no payment assistance programs have been assigned to the menu item.\\n\",\"items\":{\"type\":\"string\"}},\"allergens\":{\"type\":\"array\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AllergenItem\"},\"nullable\":true},\"length\":{\"$ref\":\"#/components/schemas/Length\"},\"height\":{\"$ref\":\"#/components/schemas/Height\"},\"width\":{\"$ref\":\"#/components/schemas/Width\"},\"dimensionUnitOfMeasure\":{\"$ref\":\"#/components/schemas/DimensionUnitOfMeasure\"},\"weight\":{\"$ref\":\"#/components/schemas/Weight\"},\"weightUnitOfMeasure\":{\"$ref\":\"#/components/schemas/WeightUnitOfMeasure\"},\"images\":{\"$ref\":\"#/components/schemas/Images\"},\"guestCount\":{\"$ref\":\"#/components/schemas/GuestCount\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"A number determining the order in which this item should appear on kitchen tickets. The sort order value can be any positive or negative integer, or zero. This value is null if a sort order has not been configured for the menu item.\\n\",\"nullable\":true},\"catalogProductInfo\":{\"$ref\":\"#/components/schemas/CatalogProductInfo\"},\"isComboParent\":{\"type\":\"boolean\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\",\"nullable\":true}}},\"ModifierGroup\":{\"type\":\"object\",\"description\":\"Information about a modifier group configured for this restaurant, including an array of modifier options contained in the group.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this modifier group, for example, \\\"Pizza Toppings\\\" or \\\"Salad Dressings\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this modifier group, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"referenceId\":{\"description\":\"An integer identifier that is used to refer to this modifier group by items and portions that use it.\\n\",\"type\":\"integer\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"visibility\":{\"$ref\":\"#/components/schemas/Visibility\"},\"pricingStrategy\":{\"type\":\"string\",\"description\":\"A string that represents the pricing strategy used for this modifier group.\\n\\nIf there is no additional charge for the modifier options in this group, or if the modifier options in the group are priced individually, then the `pricingStrategy` value is NONE.\\n\\nIf the modifier group is priced at the group level and is using the:\\n  * Fixed Price pricing strategy, then the `pricingStrategy` value is NONE.\\n  * Sequence Price pricing strategy, then the `pricingStrategy` value is SEQUENCE_PRICE.\\n  * Size Price pricing strategy, then the `pricingStrategy` value is SIZE_PRICE.\\n  * Size/Sequence Price pricing strategy, then the `pricingStrategy` value is SIZE_SEQUENCE_PRICE.\\n\\n  \\nIf the `pricingStrategy` value is NONE,  then the prices for the modifier options in this group are resolved down to the modifier option level and you can retrieve them from the `price` value of the individual `ModifierOption` objects.\\n\\nIf the `pricingStrategy` value is SIZE_PRICE, SEQUENCE_PRICE, or SIZE_SEQUENCE_PRICE, then you must use the rules provided in _this modifier group's_ `pricingRules` value to calculate the prices for the modifier options in the group.\\n\"},\"pricingRules\":{\"type\":\"object\",\"description\":\"A `PricingRules` object with information for calculating the prices for the modifier options contained in this modifier group. You use a modifier group's `pricingRules` object, in conjunction with its `pricingStrategy` value, to calculate prices for the group's modifier options when the group uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy.\\n\\nThe `pricingRules` object takes different forms depending on the pricing strategy configured for the modifier group. Use the `pricingStrategy` value to determine which pricing strategy has been used so that you can properly interpret the data in the `pricingRules` object. If the `pricingStrategy` value is NONE, the `pricingRules` object is null because you can retrieve the price from a `ModifierOption` object's `price` value without additional calculation. For the SIZE_PRICE, SEQUENCE_PRICE, and SIZE_SEQUENCE_PRICE pricing strategies, the `pricingRules` object contains additional values that you use to calculate the modifier option prices.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PricingRules\"},\"nullable\":true},\"defaultOptionsChargePrice\":{\"description\":\"Indicates whether the prices associated with any default modifiers in this group are added to the cost of the menu items they modify.\\n\\nValues are:\\n  * NO: The default modifier price is ignored. No change is made to the cost of the menu item.\\n  * YES: The default modifier price is added to the menu item price. YES is the default setting for `defaultOptionsChargePrice`.\\n\\nFor example, consider a scenario where Cheese is a default modifier for a Burger menu item (this means that Cheese is always included as a modifier option when you order a Burger unless it is explicitly removed). The price of the Cheese modifier option is $1 while the price of the Burger is $8. When `defaultOptionsChargePrice` is set to NO, a Burger costs $8 (the Cheese default modifier price is not added to the Burger price). When `defaultOptionsChargePrice` is set to YES, a Burger costs $9 (the Cheese default modifier price is added to the Burger price). If the Cheese default modifier is removed from the Burger menu item, the price of the Burger remains $8. Removing a default modifier from a menu item does not change the menu item’s price, regardless of the `defaultOptionsChargePrice` setting.\\n\\nThe `defaultOptionsChargePrice` value must be set to NO in order to use substitution pricing. See `defaultOptionsSubstitutionPricing` for more information.\\n\",\"type\":\"string\",\"enum\":[\"NO\",\"YES\"]},\"defaultOptionsSubstitutionPricing\":{\"description\":\"Indicates whether substitution pricing is enabled for the modifier group.\\n\\nIn Toast Web, you must set the `defaultOptionsChargePrice` configuration for a modifier group to NO before you can enable substitution pricing for the group. This means that the costs of default modifiers in the group do not increase the price of the menu items they apply to. These default modifiers continue to have a monetary value, however. By enabling substitution pricing, you are configuring the modifier group so that if any of its default modifiers are removed from a menu item, the monetary value of those default modifiers can be applied to the purchase of other modifier options within the same modifier group (even though the cost of those default modifiers was not explicitly added to the cost of the menu item).\\n\\nFor example, a guest orders a salad that comes with chicken by default but asks to substitute salmon for the chicken. The price of the chicken option is $7. The price of the salmon option is $9. In this case, the Toast POS system calculates the difference and charges the substitution price of $2 for the salmon (not the regular price of $9).\\n\\nValues for `defaultOptionsSubstitutionPricing` include:\\n  * YES: Substitution pricing is enabled. Substitution pricing allows a guest to remove one or more default modifiers from a menu item and apply the value of those modifiers toward the purchase of one or more other modifier options in the same modifier group.\\n  * NO: Substitution pricing is not enabled. Removing a default modifier from a menu item has no impact on the price of the menu item or on any other modifier options that get added. For example, a guest orders a burger that comes with cheese by default but asks to substitute bacon instead of cheese. The price of the burger is $8. The price of the default cheese modifier is $1 but it is not added to the cost of the burger because `defaultOptionsChargePrice` is set to NO. The price of the bacon modifier option is $3. In this scenario, the customer would pay $11, $8 for the burger and $3 for the bacon. No credit is given for removing the cheese modifier option. `NO` is the default setting for `defaultOptionsSubstitutionPricing`.\\n\\nRemoving default modifiers from a menu item never reduces the price of the menu item. If you remove the chicken from a $10 salad that includes chicken by default, the price of the salad remains $10. If you remove the chicken and substitute other modifier options that cost less than the chicken, the price of the salad remains $10. If you remove the chicken and replace it with modifier options that cost more than the chicken, the price increases by the difference in modifier option cost if you have substitution pricing enabled.\\n\",\"type\":\"string\",\"enum\":[\"NO\",\"YES\"]},\"minSelections\":{\"type\":\"integer\",\"description\":\"The minimum number of modifier options that a customer can choose from this modifier group.\\n\\nIf a server is not required to select a modifier option from this modifier group, `minSelections` is set to 0.\\n\\nIf a server must select a modifier option from this modifier group, `minSelections` must be set to 1 or higher. For example, a Temperature modifier group could be set to 1 to require a server to choose a temperature (Rare, Medium Rare, Medium, or Well Done) when placing a steak order. The orders API rejects an order if it does not follow the `minSelections` requirement for a modifier group.\\n\\nThe `minSelections` and `maxSelections` values can be used in conjunction with one another. For example, consider the following modifier group configuration:\\n\\n* Modifier Group: Cheese\\n* Modifier Options: ( Cheddar, American, Swiss )\\n* maxSelections: 2\\n* minSelections: 1\\n\\nWith this configuration:\\n  * You can select AT MOST two different cheeses from this group to apply to the menu item (the `maxSelections` value).\\n  * You must select AT LEAST one cheese from this group to apply to the menu item (the `minSelections` value).\\n\"},\"maxSelections\":{\"type\":\"integer\",\"description\":\"The maximum number of modifier options that a customer can choose from this modifier group. `maxSelections` is null if a customer can choose an unlimited number of modifier options from this modifier group. It is 1 if the modifier group is not enabled for multiple selections. The orders API rejects an order if it does not follow the `maxSelections` requirement for a modifier group.\\n\\nThe `minSelections` and `maxSelections` values can be used in conjunction with one another. For example, consider the following modifier group configuration:\\n\\n* Modifier Group: Cheese\\n* Modifier Options: ( Cheddar, American, Swiss )\\n* maxSelections: 2\\n* minSelections: 1\\n\\nWith this configuration:\\n  * You can select AT MOST two different cheeses from this group to apply to the menu item (the `maxSelections` value).\\n  * You must select AT LEAST one cheese from this group to apply to the menu item (the `minSelections` value).\\n\",\"nullable\":true},\"requiredMode\":{\"description\":\"Specifies how the modifier group appears and behaves in the Toast POS app. Values include:\\n  * REQUIRED: Forces a server to make a selection from the modifier group before continuing to the next screen in the Toast POS app. Note that the orders API rejects an order if a modifier option is not included for a modifier group whose `requiredMode` value is set to REQUIRED.\\n  * OPTIONAL FORCE SHOW: Prompts the server to view the modifier group but does not force them to choose a modifier option from it before continuing to the next screen in the Toast POS app. This setting is typically used for upselling.\\n  * OPTIONAL: The modifier group does not appear when an associated menu item is selected but the server can access it on the Toast POS app if necessary.\\n\",\"type\":\"string\",\"enum\":[\"REQUIRED\",\"OPTIONAL_FORCE_SHOW\",\"OPTIONAL\"]},\"isMultiSelect\":{\"type\":\"boolean\",\"description\":\"Indicates whether you can select more than one modifier option from this modifier group.\\n\\nThe `isMultiSelect` value provides similar information to the `maxSelections` value in a different format. If `isMultiSelect` is TRUE, then by definition more than one modifier option can be selected from the modifier group, so `maxSelections` must be greater than 1 or null (a null value indicates that an unlimited number of selections can be made from the modifier group). If `isMultiSelect` is FALSE, then only one modifier option may be selected from the modifier group and the Toast POS system enforces a setting of 1 for `maxSelections`.\\n\\nAlso, if `isMultiSelect` is FALSE for a modifier group, the Toast POS system enforces a setting of FALSE for the `allowsDuplicates`  value of the group’s modifier options. This prevents more than one instance of a modifier option being selected for the group. Similarly, the orders API rejects any orders that specify more than one modifier option for a modifier group whose `isMultiSelect` value is FALSE.\\n\"},\"preModifierGroupReference\":{\"type\":\"integer\",\"description\":\"The `referenceId` of a `PreModifierGroup` object. This object defines the premodifiers that can be applied to the modifier options contained in this modifier group. Premodifiers alter the display of modifier options on receipts and tickets to satisfy guest requests such as EXTRA or ON THE SIDE. Premodifiers can also be configured to modify the cost of the modifier options they are applied to, for example, by charging more for an EXTRA serving of a modifier option.\\n\"},\"modifierOptionReferences\":{\"type\":\"array\",\"description\":\"An array of `referenceId`s for `ModifierOption` objects. These objects define the modifier options contained in this modifier group.\\n\",\"minItems\":0,\"items\":{\"type\":\"integer\"}}}},\"ModifierOption\":{\"type\":\"object\",\"description\":\"Information about a modifier option configured for this restaurant.\\n\",\"properties\":{\"referenceId\":{\"description\":\"An integer identifier that is used to refer to this modifier option by modifier option groups that contain it.\\n\",\"type\":\"integer\"},\"name\":{\"description\":\"A descriptive name for this modifier option, for example, \\\"Cheese\\\" or \\\"Pepperoni\\\".\\n          \\nTo avoid menu ingestion failures, if the `name` value for a modifier option is an empty string or `null`, the menus API updates it to the string `Missing name` in the returned menus data. A modifier option has a blank name if both its item reference name and its modifier override name are missing.\\n\\nNote that, while this solution allows menu ingestion to proceed without failure, it does allow a modifier option with the name `Missing name` to appear in a restaurant’s menu, creating potential confusion for guests and employees. Also, the menus API only updates the returned data. It does not update the modifier option in the Toast database, meaning the name will still be blank when looking at the modifier option in Toast Web.\\n\\nTo fix the issue in Toast Web, the restaurant must identify the parent menu entity for the modifier option, view its details page in Toast Web, and then locate and fix the modifier option with the blank name.\\n\\nFor a detailed description of a modifier option's item reference, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">Understanding a modifier option’s item reference</a> in the Toast Platform Guide.\\n\",\"type\":\"string\"},\"kitchenName\":{\"description\":\"The name of the modifier option as it appears on kitchen tickets. The `kitchenName` can include both numbers and letters. This value contains an empty string if a kitchen name has not been configured for the modifier option.\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this modifier option's item reference, assigned by the Toast POS system. For a detailed description of a modifier option's item reference, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">Understanding a modifier option’s item reference</a> in the Toast Platform Guide.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"description\":{\"description\":\"An optional short description of this modifier option.\\n\",\"type\":\"string\"},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"prepStations\":{\"type\":\"array\",\"description\":\"An array of GUIDs for the prep stations that have been assigned to this modifier option.\\n\\nIf a modifier option's item reference has prep stations assigned to it, then the modifier option uses those prep stations. If the modifier option's item reference *does not* have prep stations assigned to it, then the modifier option inherits the prep stations of the menu group, menu item, or modifier (in the case of nested modifiers) it is modifying.\\n\\nThe array is empty if no prep stations have been assigned to the modifier option.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html\\\">Routing to prep stations</a>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">Understanding a modifier option’s item reference</a>\\n\",\"items\":{\"type\":\"string\"}},\"image\":{\"$ref\":\"#/components/schemas/Image\"},\"visibility\":{\"$ref\":\"#/components/schemas/Visibility\"},\"price\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The price of this modifier option.\\n\\nIn Toast Web, a modifier option may:\\n  * Inherit its price from a parent modifier group.\\n  * Use the price specified for its modifier option <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a>.\\n  * Specify a price that overrides the price defined for its item reference.\\n\\nThe `price` value is populated differently depending on which of these pricing scenarios is used for the modifier option. The sections below describe how the `price` value is populated in these different scenarios.\\n\\n_Note:_ To determine how a modifier option has been priced, you can inspect the modifier option's `pricingStrategy` value. If it is GROUP_PRICE, then the modifier option is inheriting its price from a parent modifier group. If it is any value other than GROUP_PRICE (for example, MENU_SPECIFIC_PRICE or TIME_SPECIFIC PRICE), then the modifier option is using either the price specified for its item reference or an override price (override prices always use the BASE_PRICE strategy).\\n\\n_Modifier Option Inherits Its Price from a Parent Modifier Group_\\n\\nIf the modifier option inherits its price from a parent modifier group and that group uses the:\\n  * Fixed Price pricing strategy, then the modifier option's `price` value is populated with the fixed price specified for the parent modifier group. No additional calculations are required.\\n  * Size Price, Sequence Price, or Size/Sequence pricing strategy, then the modifier option's `price` value is null. You must use the _parent modifier group's_ `pricingStrategy` and `pricingRules` values to calculate the modifier option's price.\\n\\n_Modifier Option Specifies an Override Price_\\n\\nIf the modifier option specifies an override price, the `price` value is set to that override price. No additional calculations are required.\\n\\n_Modifier Option Uses the Price from Its Item Reference_\\n\\nIf a modifier option uses the price from its underlying item reference, then the `price` value is populated using the same logic as the `price` value for a `MenuItem` object:\\n  * For base prices, the `price` value is populated with the specified base price.\\n  * For menu-specific prices, the `price` value is resolved based on the current menu. For example, consider a modifier option that is included in both Lunch and Dinner menus and is priced at $1 for the Lunch menu and $2 for the Dinner menu. In the fully resolved JSON returned by the menus API, this modifier option would appear twice, once as a child of the Lunch menu with a `price` value of $1, and again as a child of the Dinner menu with a `price` value of $2.\\n\\n  If this same modifier option is added to a Breakfast menu but a menu-specific price is not defined for the Breakfast menu, then the `price` value for the instance of the modifier option that appears in the Breakfast menu JSON is populated with the base price from the menu-specific price configuration. Menu-specific price configurations include a base price that functions as a default price when a menu-specific price cannot be resolved.\\n  \\n  * For location-specific prices, the `price` value is resolved based on the current location. For example, consider a modifier option that costs $2 in the Boston location and $3 in the New York location. When you retrieve menu data for the Boston location, this modifier option's `price` value is $2. When you retrieve menu data for the New York location, the modifier option's `price` value is $3.\\n  * For time-specific prices, the `price` value is populated with the base price that is specified as part of the time-specific price configuration. This base price functions as a default price for the modifier option during times of the day when a time-specific price has not been defined. For example, consider a modifier option that costs $1 from noon to 2pm and $2 during the rest of the day. The `price` value for this item would be $2. You must use _this modifier option's_ `pricingStrategy` and `pricingRules` values to calculate the price of the modifier option during time periods for which a time-specific price has been defined.\\n  * For size prices, the `price` value is null. You must use _this modifier option's_ `pricingStrategy` and `pricingRules` values to calculate the price of the modifier option for different sizes.\\n  * For open prices, the `price` value is null.\\n\\nIf the modifier option is priced using a price level, the `price` value reflects the pricing strategy used for the price level, using the same logic described above. For example, consider a price level that applies a size price to the modifier option it is assigned to. In this case, the `price` value for the modifier option is null and you must use this modifier option's `pricingStrategy` and `pricingRules` values to calculate the price of the modifier option for different sizes.\\n_Note:_ For detailed information on modifier option pricing and pricing strategies, see the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminToastPosPricingFeatures.html\\\">Menu pricing</a> section in the Toast Platform Guide.\\n\",\"nullable\":true},\"pricingStrategy\":{\"type\":\"string\",\"description\":\"A string that indicates how this modifier option has been priced. If `pricingStrategy` is:\\n  * GROUP_PRICE, then the modifier option inherits its price from a parent modifier group.\\n  * Any value other than GROUP_PRICE (for example, MENU_SPECIFIC_PRICE or TIME_SPECIFIC PRICE), then the modifier option is using either the price specified for its <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> or an override price (override prices always use the BASE_PRICE strategy).\\n\\nIf the modifier option is using the price of its underlying item reference, and that item reference is priced using the Location Specific Price pricing strategy, then the `pricingStrategy` value indicates which pricing strategy is used at the current location. For example, consider a modifier option that uses a menu-specific price at the Boston location and a base price at the New York location. When you retrieve the menu data for the Boston location, the `pricingStrategy` for the modifier option is MENU_SPECIFIC_PRICE. When you retrieve menu data for the New York location, the `pricingStrategy` for the modifier option is BASE_PRICE.\\n\\nIf the modifier option is using the price of its underlying item reference, and that item reference is priced using a price level, then the `pricingStrategy` value indicates which pricing strategy is used for that price level. For example, if the \\\"Special Toppings\\\" price level uses a time-specific price, then the `pricingStrategy` value for a modifier option that is assigned the \\\"Special Toppings\\\" price level is TIME_SPECIFIC_PRICE.\\n\\nIt is important to understand which `pricingRules` object to use when modifier option prices must be calculated. If the `pricingStrategy` value is:\\n  * BASE_PRICE or MENU_SPECIFIC_PRICE,  then you can retrieve the modifier option's price from its `price` value. No additional calculations are required.\\n  * GROUP_PRICE, then you must use the `pricingStrategy` and `pricingRules` values from _the modifier option's parent modifier group_ to calculate the modifier option's price.\\n  * TIME_SPECIFIC_PRICE or SIZE_PRICE, then you must use the rules provided in _this modifier option's_ `pricingRules` value to calculate the price for the modifier option.\\n\"},\"pricingRules\":{\"type\":\"object\",\"description\":\"A `PricingRules` object with information about how to calculate the price for this modifier option. You use a modifier option's `pricingRules` object, in conjunction with its `pricingStrategy` value, to calculate a price for the modifier option when the modifier option is _individually priced_ and its `price` value is null.\\n\\n_Note:_ If the modifier option is priced at the group level, you must use the `pricingRules` object of its parent modifier group to calculate its price. A modifier option is priced at the group level if its `pricingStrategy` value is GROUP_PRICE.\\n\\nThe `pricingRules` object takes different forms depending on the pricing strategy configured for the modifier option. Use the `pricingStrategy` value to determine which pricing strategy has been used so that you can properly interpret the data in the `pricingRules` object. For the BASE_PRICE, and MENU_SPECIFIC_PRICE pricing strategies, the `pricingRules` object is null because you can retrieve the price from the `price` value without additional calculation. For the OPEN_PRICE pricing strategy, the `pricingRules` object is also null (the price of a modifier option whose item reference uses the Open Price pricing strategy is specified at the time that the modifier option is ordered). For the TIME_SPECIFIC_PRICE and SIZE_PRICE pricing strategies, the `pricingRules` object contains additional values that you use to calculate the modifier option's price.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PricingRules\"},\"nullable\":true},\"salesCategory\":{\"$ref\":\"#/components/schemas/SalesCategory\"},\"taxInfo\":{\"type\":\"array\",\"description\":\"The `taxInfo` value on the `ModifierOption` object has been deprecated. An upcoming release will introduce new configuration settings for the taxes on a modifier option. The `taxInfo` value will not accurately represent these additional configurations. Your integration should switch to using the `modifierOptionTaxInfo` value instead. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUsingTaxInfoAndModifierOptionTaxInfoToCalculateTaxesForMenuItemsAndModOptions.html\\\">Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options</a> in the Toast Developer Guide for more information. \\n\",\"items\":{\"type\":\"string\"}},\"modifierOptionTaxInfo\":{\"$ref\":\"#/components/schemas/ModifierOptionTaxInfo\"},\"itemTags\":{\"type\":\"array\",\"description\":\"An array of `ItemTag` objects that are assigned to this modifier option. Item tags are used to assign identifying characteristics to a modifier option, for example, vegetarian, gluten-free, alcohol.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ItemTag\"}},\"plu\":{\"type\":\"string\",\"description\":\"The price lookup (PLU) code for this modifier option. The PLU code can contain both numbers and letters. This value contains an empty string if a PLU code has not been defined.\\n\"},\"sku\":{\"type\":\"string\",\"description\":\"The stock keeping unit (SKU) identifier for this modifier option. The SKU identifier can contain both numbers and letters. This value contains an empty string if a SKU has not been defined.\\n\"},\"calories\":{\"type\":\"integer\",\"description\":\"The number of calories in this modifier option. The calories value can be any positive or negative integer, or zero. This value is null if a calories amount has not been configured for the modifier option.\\n\",\"nullable\":true},\"contentAdvisories\":{\"$ref\":\"#/components/schemas/ContentAdvisories\"},\"unitOfMeasure\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"],\"description\":\"The unit of measure used to determine the price of the modifier option. For example, $10.00 per gram.\\n\\nThe default is `NONE`, which means that the item is not meant to be measured during a sale.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"Indicates whether this modifier option is included on the menu item by default.\\n\\n_Important:_ If a menu item is configured to use default modifiers and you submit an order to the orders API for that menu item but you omit those default modifiers, then the Toast POS system assumes you want to omit the default modifiers and they will not be included in the order. For example, consider a Burger menu item that has Lettuce and Tomato as default modifiers. If you submit an order to the orders API for the Burger menu item but omit the Lettuce and Tomato default modifiers in the request, the order ticket will include the Burger but not the Lettuce and Tomato modifier options.\\n\"},\"allowsDuplicates\":{\"type\":\"boolean\",\"description\":\"Indicates whether the modifier option may be added to a menu item multiple times.\\n\\nIf a modifier option belongs to a modifier group whose `isMultiSelect` value is FALSE, then the Toast POS system sets the modifier option’s `allowsDuplicates` value to FALSE to prevent more than one modifier option being selected for the group.\\n\"},\"portions\":{\"type\":\"array\",\"description\":\"An array of `Portion` objects that define the portions that this modifier option can be added to. For example, for a pizza menu item, you could define 1st Half and 2nd Half portions and this modifier option could be added to either portion. See <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPortionsOverview.html\\\">Portions overview</a> in the Toast Platform Guide for more information.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/Portion\"}},\"prepTime\":{\"type\":\"integer\",\"description\":\"The amount of time, in seconds, that it takes to prepare this modifier option. This value is null if a prep time has not been specified for the modifier option.<br>\\n<br>\\n*Related topics*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminFireByPrepTime.html\\\">Using prep times to automate item firing</a><br>\\n\",\"format\":\"int32\",\"nullable\":true},\"modifierGroupReferences\":{\"type\":\"array\",\"description\":\"An array of `referenceId`s for `ModifierGroup` objects. These objects define nested modifier groups contained in this modifier option. For example, you can have an entree that has a Sides modifier group that contains a Salad modifier option. The Salad modifier option has its own modifier group, Salad Dressing, that includes Ranch, Vinaigrette, and Blue Cheese modifier options. Salad Dressing is a nested modifier group and the individual salad dressings are nested modifier options.\\n\",\"minItems\":0,\"items\":{\"type\":\"integer\"}},\"length\":{\"$ref\":\"#/components/schemas/Length\"},\"height\":{\"$ref\":\"#/components/schemas/Height\"},\"width\":{\"$ref\":\"#/components/schemas/Width\"},\"dimensionUnitOfMeasure\":{\"$ref\":\"#/components/schemas/DimensionUnitOfMeasure\"},\"weight\":{\"$ref\":\"#/components/schemas/Weight\"},\"weightUnitOfMeasure\":{\"$ref\":\"#/components/schemas/WeightUnitOfMeasure\"},\"images\":{\"$ref\":\"#/components/schemas/Images\"},\"guestCount\":{\"$ref\":\"#/components/schemas/GuestCount\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"A number determining the order in which this modifier option should appear on kitchen tickets. The sort order value can be any positive or negative integer, or zero. This value is null if a sort order has not been configured for the modifier option.\\n\",\"nullable\":true},\"allergens\":{\"type\":\"array\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AllergenItem\"},\"nullable\":true}}},\"ModifierOptionTaxInfo\":{\"type\":\"object\",\"description\":\"Information about the tax rates and tax behavior of this modifier option.\\n\\n_Note:_ The `modifierOptionTaxInfo` value always reflects the parent menu item tax rate, unless Toast grants the restaurant the ability to override modifier tax rates. If this permission is not granted, then even if the restaurant configured the modifier with a different tax rate, `modifierOptionTaxInfo` reflects the parent menu item tax rate.\\n\\nNote that there are other tax-related features that can impact the tax of a modifier option, such as tax inclusion and smart tax, that are not returned in this `ModifierOptionTaxInfo` object. For more information, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminTaxesOnModifiers.html\\\">Tax on modifiers</a> and <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminTaxesOnModifiers.html#adminModifierTaxInteraction\\\">Tax functionality interaction</a>.\\n\\n_Important:_ The `ModifierOptionTaxInfo` object is intended to help you display prices but the `/prices` endpoint of the orders API is the only supported way to determine the prices of orders that you submit to the orders API. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiOrderPrices.html\\\">Order prices</a> in the Toast Developer Guide for more information.\\n\",\"properties\":{\"taxRateGuids\":{\"type\":\"array\",\"description\":\"An array of GUIDs for the tax rates that apply to this modifier option.\\n\\nThe `taxRateGuids` value includes different tax rate GUIDs, depending on whether the modifier option is configured in Toast Web to use its own tax rates or to inherit tax rates from a menu item it has been applied to. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUsingTaxInfoAndModifierOptionTaxInfoToCalculateTaxesForMenuItemsAndModOptions.html\\\">Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options</a> in the Toast Developer Guide for more information.\\n                   \\nTo retrieve full configuration data for a tax rate, use the `/taxRates/{guid}` endpoint in the configuration API.\\n\",\"items\":{\"type\":\"string\"}},\"overrideItemTaxRates\":{\"description\":\"Indicates whether the tax rates configured for this modifier option override the tax rates configured for a menu item that this modifier option has been applied to. For example, if the menu item is configured for a 6.25% tax rate and the modifier option is configured for a 2.75% tax rate, when that modifier option is applied to the menu item, both are taxed at the 2.75% tax rate.\\n\\nNote that the menu item's tax rate is overridden only if the modifier option is added to the menu item on a Toast POS device. The modifier option may be available to apply to the menu item, but if it is not actually added to the menu item on a Toast POS device, then the menu item's tax rate is not overridden. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUsingTaxInfoAndModifierOptionTaxInfoToCalculateTaxesForMenuItemsAndModOptions.html\\\">Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options</a> in the Toast Developer Guide for more information.\\n\",\"type\":\"boolean\"}}},\"PreModifierGroup\":{\"type\":\"object\",\"description\":\"Information about a pre-modifier group configured for this restaurant, including an array of pre-modifiers contained in the group.\\n\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"A descriptive name for this pre-modifier group, for example, \\\"Sandwich Pre-mods\\\".\\n\"},\"guid\":{\"description\":\"A unique identifier for this pre-modifier group, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"preModifiers\":{\"description\":\"An array of `PreModifier` objects that are contained in this pre-modifier group. Pre-modifiers alter the display of modifier options on receipts and tickets to satisfy guest requests such as EXTRA or ON THE SIDE for modifier options. Pre-modifiers can also be configured to modify the cost of the modifier options they are applied to, for example, by charging more for an EXTRA serving of a modifier option.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PreModifier\"}}}},\"PreModifier\":{\"type\":\"object\",\"description\":\"Information about a pre-modifier configured for this restaurant.\\n\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"A descriptive name for this pre-modifier, for example, \\\"NO\\\" or \\\"EXTRA\\\".\\n\"},\"guid\":{\"description\":\"A unique identifier for this pre-modifier group, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"fixedPrice\":{\"description\":\"An optional fixed price for this pre-modifier. The fixed price is added to the cost of the modifier option that the pre-modifier is applied to.\\n\\nA PreModifier object has two optional values, `fixedPrice` and `multiplicationFactor`, that both alter the price of a modifier option when the pre-modifier is applied to it. However, these values cannot be used at the same time. If you specify a `fixedPrice` value for a premodifier, then `multiplicationFactor` is null. If you specify a `multiplicationFactor` for a pre-modifier, then `fixedPrice` is null. If you choose not to assign either a fixed price or a multiplication factor to a pre-modifier, then the `fixedPrice` value is 0 and the `multiplicationFactor` is null.\\n\",\"type\":\"number\",\"format\":\"double\",\"nullable\":true},\"multiplicationFactor\":{\"description\":\"An optional number that specifies how much the cost of a modifier option is multiplied by when this pre-modifier is applied to it. For example, an EXTRA pre-modifier option could specify a `multiplicationFactor` of 1.5 to indicate that adding extra cheese to a menu item costs one and a half times the regular price of the cheese modifier option.\\n\\nA PreModifier object has two optional values, `fixedPrice` and `multiplicationFactor`, that both alter the price of a modifier option when the pre-modifier is applied to it. However, these values cannot be used at the same time. If you specify a `fixedPrice` value for a premodifier, then `multiplicationFactor` is null. If you specify a `multiplicationFactor` for a premodifier, then `fixedPrice` is null. If you choose not to assign either a fixed price or a multiplication factor to a pre-modifier, then the `fixedPrice` value is 0 and the `multiplicationFactor` is null.\\n\",\"type\":\"number\",\"format\":\"double\",\"nullable\":true},\"displayMode\":{\"description\":\"A string that indicates how the pre-modifier is displayed on tickets and receipts:\\n  * PREFIX: The pre-modifier name is placed before the modifier option name, for example, \\\"EXTRA Cheese\\\".\\n  * SUFFIX: The pre-modifier name is placed after the modifier option name, for example, \\\"Cheese EXTRA\\\".\\n\",\"type\":\"string\",\"enum\":[\"PREFIX\",\"SUFFIX\"]},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"chargeAsExtra\":{\"type\":\"boolean\",\"description\":\"When true, selecting this pre-modifier adds an additional portion of the modifier to the menu item and adds the price of the additional portion to the menu item according to the rules listed below.\\n\\nIf the modifier group that the modifier belongs to:\\n* Uses the **No charge** option, the Toast platform uses the modifier's <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminBasingModifierOptionsOnExistingMenuItems\\\">override price</a> or, if no override price exists, the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> price as the price of the additional portion.\\n* Uses the **Individual** option where each modifier has its own price, the Toast platform uses the modifier's override price or, if no override price exists, the item reference price as the price of the additional portion.\\n* Uses the **Group** option where all modifiers in the group share a price, the Toast platform uses the group price as the price of the additional portion.\\n\\nAdditionally, if the modifier group that the modifier belongs to uses:\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSizePrice.html#adminSizePricingForModifierGroups\\\">Size</a> pricing, the Toast platform uses the size price that matches the size of the menu item when determining the price of the additional portion.\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSequencePrice.html\\\">Sequence</a> pricing, the Toast platform treats the additional portion as the next modifier in the sequence and prices it using the sequence pricing rules that have been specified.\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSizeSequencePrice.html\\\">Size/sequence</a> pricing, the Toast platform matches the size of the additional portion to the size of the menu item and then treats it as the next modifier in the sequence when determining the price of the additional portion.\\n\\nThe `chargeAsExtra` value is `null` if it has not been set.\\n\",\"nullable\":true},\"plu\":{\"type\":\"string\",\"description\":\"The price lookup (PLU) code for this pre-modifier. The PLU code can contain both numbers and letters. This value contains an empty string if a PLU code has not been defined.\\n\"}}},\"SalesCategory\":{\"type\":\"object\",\"description\":\"A descriptive category, for example, \\\"Food\\\" or \\\"Liquor\\\" that, when applied to the menu items and modifier options in your menu, allow you to view sales data by category. Null if no sales category has been defined.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this sales category, for example, \\\"Food\\\" or \\\"Liquor\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this sales category, assigned by the Toast POS system.\\n\",\"type\":\"string\"}}},\"ItemTag\":{\"type\":\"object\",\"description\":\"A descriptive term that identifies a characteristic of a menu item or menu group, for example, vegetarian, gluten-free, or alcohol.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this item tag, for example, \\\"Vegetarian\\\" or \\\"Alcohol\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this item tag category, assigned by the Toast POS system.\\n\",\"type\":\"string\"}}},\"ContentAdvisories\":{\"type\":\"object\",\"description\":\"Information about the contents of this menu item or modifier, for example, whether it contains alcohol.\\n\",\"properties\":{\"alcohol\":{\"$ref\":\"#/components/schemas/Alcohol\"}}},\"AllergenItem\":{\"type\":\"object\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"properties\":{\"guid\":{\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"type\":\"string\",\"format\":\"uuid\"},\"code\":{\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"type\":\"string\"},\"groupGuid\":{\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"groupCode\":{\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"type\":\"string\",\"nullable\":true},\"presenceType\":{\"type\":\"string\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"enum\":[\"CONTAINS\",\"TRACES\"],\"nullable\":true}}},\"Alcohol\":{\"type\":\"object\",\"description\":\"Information about whether this menu item or modifier contains alcohol and may require, \\nor benefit from, additional handling. For example, a delivery partner may need \\nto identify a menu item or modifier as containing alcohol to ensure that delivery drivers\\nrequest identification before giving it to a customer.\\n\",\"properties\":{\"containsAlcohol\":{\"type\":\"string\",\"description\":\"A string that indicates whether the menu item or modifier contains alcohol. Possible values \\ninclude:\\n\\n* `YES`: The menu item or modifier contains alcohol.\\n* `NO`: The menu item or modifier does not contain alcohol.\\n     \\nThe `containsAlcohol` value may also be `null`. A `null` value indicates that the corresponding UI option in Toast Web has not been configured for this menu item or modifier.\\n\",\"enum\":[\"YES\",\"NO\"]}}},\"Portion\":{\"type\":\"object\",\"description\":\"A container for the modifier groups that can be applied to a portion of a menu item.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this portion, for example, \\\"1st Half\\\" or \\\"2nd Half\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this portion, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"modifierGroupReferences\":{\"type\":\"array\",\"description\":\"An array of `referenceId`s for `ModifierGroup` objects. These objects define the modifier groups that can be applied to this portion.\\n\",\"minItems\":0,\"items\":{\"type\":\"integer\"}},\"priceScaleFactor\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"A multiplier that adjusts the cost of modifiers in this portion.\\n\",\"nullable\":true}}},\"Availability\":{\"type\":\"object\",\"description\":\"Information about when a menu is available for use.\\n\",\"properties\":{\"alwaysAvailable\":{\"type\":\"boolean\",\"description\":\"Indicates whether this menu is available 24 hours per day, 7 days a week. If `alwaysAvailable` is FALSE, then a `schedule` value is included in the `Availability` object to define the specific times and days a menu is available. If `alwaysAvailable` is TRUE, then the `schedule` value is omitted. \\n\"},\"schedule\":{\"type\":\"array\",\"description\":\"An array of `Schedule` objects that indicate the specific days and times a menu is available. If `alwaysAvailable` is TRUE, then the menu is available 24 hours per day, 7 days per week, and this `schedule` value is omitted from the `Availabilty` object.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Schedule\"}}}},\"Schedule\":{\"type\":\"object\",\"description\":\"A multi-use object that is used to:\\n\\n* Define when a menu is available.\\n* Define when a time-specific price is available for a menu item or modifier option.\\n\\nA `Schedule` object defines a set of days of the week and a set of time ranges for those days. Days that have identical time ranges are grouped into a single `Schedule` object, for example, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, and FRIDAY in the example below have identical time ranges and are in the same `Schedule` object while SATURDAY and SUNDAY are in a separate `Schedule` object because their time ranges differ from the weekday time ranges.\\n\\n```\\n\\\"availability\\\": {\\n  \\\"alwaysAvailable\\\": false,\\n  \\\"schedule\\\": [\\n    {\\n      \\\"days\\\": [\\n        \\\"MONDAY\\\", \\n        \\\"TUESDAY\\\", \\n        \\\"WEDNESDAY\\\", \\n        \\\"THURSDAY\\\"\\n      ],\\n      \\\"timeRanges\\\": [\\n        {\\n          \\\"start\\\": \\\"09:00\\\",\\n          \\\"end\\\": \\\"18:00\\\"\\n        }\\n      ]\\n    },\\n    {\\n      \\\"days\\\": [\\n        \\\"FRIDAY\\\", \\n        \\\"SATURDAY\\\"\\n      ],\\n      \\\"timeRanges\\\": [\\n        {\\n          \\\"start\\\": \\\"09:00\\\",\\n          \\\"end\\\": \\\"18:00\\\"\\n        },\\n        {\\n          \\\"start\\\": \\\"20:00\\\",\\n          \\\"end\\\": \\\"23:00\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\\n```\\n\\nTime ranges are in 24-hour HH:MM format.\\n\\nIf a day is not represented in the `Schedule` objects, the menu or time-specific price is not available on that day.      \\n\",\"properties\":{\"days\":{\"type\":\"array\",\"description\":\"An array of days of the week that are associated with identical time ranges. The time ranges are defined in a corresponding `timeRanges` value. Names of the days are in upper case, for example, MONDAY.\\n\",\"items\":{\"type\":\"string\",\"description\":\"A day of the week, for example, SUNDAY or THURSDAY.\",\"enum\":[\"SUNDAY\",\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\"]}},\"timeRanges\":{\"type\":\"array\",\"description\":\"An array of `TimeRange` objects that define the time ranges that a menu or a time-specific price is available on the days defined by the corresponding `days` value. A `TimeRange` object contains a `start` time and an `end` time, expressed in the restaurant’s local time. If both the `start` and `end` times for a given day are 00:00, it indicates that the menu or the time-specific price is available 24 hours on the associated days. Time ranges may also run overnight, for example, a time range that starts at \\\"07:00\\\" and ends at \\\"03:00\\\" runs from 7am until 3am the next day. \\n\",\"items\":{\"$ref\":\"#/components/schemas/TimeRange\"}}}},\"TimeRange\":{\"type\":\"object\",\"description\":\"Represents a time range for when a menu or a time-specific price is available.\\n\",\"properties\":{\"start\":{\"type\":\"string\",\"description\":\"The start time of the time range. Expressed in the restaurant’s local time.\\n\"},\"end\":{\"type\":\"string\",\"description\":\"The end time of the time range. Expressed in the restaurant’s local time.\\n\"}}},\"PricingRules\":{\"type\":\"object\",\"description\":\"The PricingRules object is a multi-use object that provides pricing rules for:\\n  * A menu item or modifier option <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> that uses the Time Specific Price or Size Price pricing strategy.\\n  * A modifier group that uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy.\\n\",\"properties\":{\"timeSpecificPricingRules\":{\"description\":\"An array of `TimeSpecificPrice` objects that define the time-specific prices for a menu item or modifier option <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> that uses the Time Specific Price pricing strategy. If the menu item or modifier option item reference does not use time-specific prices, this array is empty.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TimeSpecificPrice\"}},\"sizeSpecificPricingGuid\":{\"description\":\"The GUID of a Size modifier group that defines sizes and prices for a menu item or a modifier option <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> that uses the Size Price pricing strategy.\\n\\nIf the menu item or modifier option item reference does not use the Size Price pricing strategy, then `sizeSpecificPricingGuid` is null.\\n\\nThe Toast POS system automatically creates a Size modifier group when you choose the Size Price pricing strategy for a menu item or modifier option item reference and stores the sizes and prices you specify in it. You use the `sizeSpecificPricingGuid` value to locate the correct Size modifier group to use when pricing a menu item or modifier option item reference that uses size pricing. In the JSON fragment below, you can see that the Cheese Pizza menu item uses the SIZE_PRICE pricing strategy and the Size modifier group where the sizes and prices for Cheese Pizza are defined has a GUID that ends in `31b0`.\\n\\n```\\n{\\n  \\\"restaurantGuid\\\": \\\"2071fb81-988b-4d75-b8dc-c5c17cff9706\\\",\\n  ...\\n  \\\"menus\\\": [\\n    {\\n      \\\"name\\\": \\\"Dinner\\\",\\n      \\\"guid\\\": \\\"ddd681de-3c12-4d45-b8b1-a5b2ea898210\\\",\\n      ...\\n      \\\"menuGroups\\\": [\\n        {\\n          \\\"name\\\": \\\"Pizza\\\",\\n          \\\"guid\\\": \\\"dc868006-919a-4950-a4cc-3a03f9770fd7\\\",\\n          ...\\n          \\\"menuItems\\\": [\\n            {\\n              \\\"name\\\": \\\"Cheese Pizza\\\",\\n              \\\"guid\\\": \\\"95c5d500-8d92-46f2-bec4-fb2a42a46621\\\",\\n              ...\\n              \\\"price\\\": null,\\n              \\\"pricingStrategy\\\": \\\"SIZE_PRICE\\\",\\n              \\\"pricingRules\\\": {\\n                \\\"timeSpecificPricingRules\\\": [],\\n                \\\"sizeSpecificPricingGuid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n                \\\"sizeSequencePricingRules\\\": []\\n              },\\n              ...\\n              \\\"modifierGroupReferences\\\": [\\n                2,\\n                6,\\n                ...\\n              ],\\n              ...\\n            }\\n          ]\\n        }\\n      ]\\n    }\\n  ],\\n  \\\"modifierGroupReferences\\\": {\\n    ...\\n    \\\"2\\\": {\\n      \\\"referenceId\\\": 2,\\n      \\\"name\\\": \\\"Size\\\",\\n      \\\"guid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n      ...\\n      \\\"pricingStrategy\\\": \\\"NONE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierOptionReferences\\\": [\\n        12,\\n        13\\n      ],\\n      ...\\n    },\\n    ...\\n  },\\n  \\\"modifierOptionReferences\\\": {\\n    ...\\n    \\\"12\\\": {\\n      \\\"referenceId\\\": 12,\\n      \\\"name\\\": \\\"Small\\\",\\n      \\\"guid\\\": \\\"352244f2-a952-4a3a-a3ae-7775fa221ce7\\\",\\n      ...\\n      \\\"price\\\": 8.0,\\n      \\\"pricingStrategy\\\": \\\"BASE_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    \\\"13\\\": {\\n      \\\"referenceId\\\": 13,\\n      \\\"name\\\": \\\"Large\\\",\\n      \\\"guid\\\": \\\"4ff89bca-b448-4892-bc4c-62c37a28ac44\\\",\\n      ...\\n      \\\"price\\\": 10.0,\\n      \\\"pricingStrategy\\\": \\\"BASE_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    }\\n    ...\\n  }\\n}\\n```\\n\\n\\nWhen the `PricingRules` object appears in the context of a modifier\\ngroup, the `sizeSpecificPricingGuid` value it contains is also used to\\nfind matching sizes between menu items and any modifier options that\\nuse the Size Price or Size/Sequence Pricing pricing strategies (for\\nexample, toppings on a small pizza cost $1 while toppings on a large\\npizza cost $2). In this scenario, the Toast POS system locates the\\nmodifier option size that matches the menu item size and uses the\\nprice defined for that size of the modifier option. The sizes for the\\nmenu item are defined in the Size modifier group specified by the\\n`sizeSpecificPricingGuid` value. The sizes for the modifier options\\nare defined in objects contained in the `sizeSequencePricingRules`\\narray that is contained in the modifier group's `PricingRules` object.\\nSizes are considered matching when their names are identical. For\\ndetailed information on the **Size Price** and **Size/Sequence Price**\\npricing strategies, see [Pricing\\nStrategies](https://doc.toasttab.com/doc/platformguide/adminPricingStrategies.html)\\nin the _Toast Platform Guide_.\\n\\nIn the example below, the Cheese Pizza menu item and the Toppings\\nmodifier group use the `SIZE_PRICE` pricing strategy. The menu item\\nsizes and prices are defined in the Size modifier group with a GUID\\nending in `31b0`. The sizes and prices for the modifier options are\\ndefined in the `sizeSequencePricingRules` value that is a child of the\\nToppings modifier group.\\n\\n```\\n{\\n  \\\"restaurantGuid\\\": \\\"2071fb81-988b-4d75-b8dc-c5c17cff9706\\\",\\n  ...\\n  \\\"menus\\\": [\\n    {\\n      \\\"name\\\": \\\"Dinner\\\",\\n      \\\"guid\\\": \\\"ddd681de-3c12-4d45-b8b1-a5b2ea898210\\\",\\n      ...\\n      \\\"menuGroups\\\": [\\n        {\\n          \\\"name\\\": \\\"Pizza\\\",\\n          \\\"guid\\\": \\\"dc868006-919a-4950-a4cc-3a03f9770fd7\\\",\\n          ...\\n          \\\"menuItems\\\": [\\n            {\\n              \\\"name\\\": \\\"Cheese Pizza\\\",\\n              \\\"guid\\\": \\\"95c5d500-8d92-46f2-bec4-fb2a42a46621\\\",\\n              ...\\n              \\\"price\\\": null,\\n              \\\"pricingStrategy\\\": \\\"SIZE_PRICE\\\",\\n              \\\"pricingRules\\\": {\\n                \\\"timeSpecificPricingRules\\\": [],\\n                \\\"sizeSpecificPricingGuid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n                \\\"sizeSequencePricingRules\\\": []\\n              },\\n              ...\\n              \\\"modifierGroupReferences\\\": [\\n                2,\\n                3,\\n                ...\\n              ],\\n              ...\\n            }\\n          ]\\n        }\\n      ]\\n    }\\n  ],\\n  \\\"modifierGroupReferences\\\": {\\n    ...\\n    \\\"2\\\": {\\n      \\\"referenceId\\\": 2,\\n      \\\"name\\\": \\\"Size\\\",\\n      \\\"guid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n      ...\\n      \\\"pricingStrategy\\\": \\\"NONE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierOptionReferences\\\": [\\n        12,\\n        13\\n      ],\\n      ...\\n    },\\n    \\\"3\\\": {\\n      \\\"referenceId\\\": 3,\\n      \\\"name\\\": \\\"Toppings\\\",\\n      \\\"guid\\\": \\\"58b79986-f88f-411d-ba18-14b1e2441e9d\\\",\\n      ...\\n      \\\"pricingStrategy\\\": \\\"SIZE_PRICE\\\",\\n      \\\"pricingRules\\\": {\\n        \\\"timeSpecificPricingRules\\\": [],\\n        \\\"sizeSpecificPricingGuid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n        \\\"sizeSequencePricingRules\\\": [\\n          {\\n            \\\"sizeName\\\": \\\"Small\\\",\\n            \\\"sizeGuid\\\": \\\"352244f2-a952-4a3a-a3ae-7775fa221ce7\\\",\\n            \\\"sequencePrices\\\": [\\n              {\\n                \\\"sequence\\\": 1,\\n                \\\"price\\\": 2.0\\n              }\\n            ]\\n          },\\n          {\\n            \\\"sizeName\\\": \\\"Large\\\",\\n            \\\"sizeGuid\\\": \\\"4ff89bca-b448-4892-bc4c-62c37a28ac44\\\",\\n            \\\"sequencePrices\\\": [\\n              {\\n                \\\"sequence\\\": 1,\\n                \\\"price\\\": 4.0\\n              }\\n            ]\\n          }\\n        ]\\n      },\\n      ...\\n      \\\"modifierOptionReferences\\\": [\\n        10,\\n        11\\n      ],\\n      ...\\n    },\\n    ...\\n  },\\n  \\\"modifierOptionReferences\\\": {\\n    ...\\n    \\\"10\\\": {\\n      \\\"referenceId\\\": 10,\\n      \\\"name\\\": \\\"Mushrooms\\\",\\n      \\\"guid\\\": \\\"fa24fee9-76c4-40ba-ae3c-7dfccafdd8d3\\\",\\n      ...\\n      \\\"price\\\": null,\\n      \\\"pricingStrategy\\\": \\\"GROUP_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    \\\"11\\\": {\\n      \\\"referenceId\\\": 11,\\n      \\\"name\\\": \\\"Onions\\\",\\n      \\\"guid\\\": \\\"afee6be7-8280-4c69-a170-9fdf4c76bf7b\\\",\\n      ...\\n      \\\"price\\\": null,\\n      \\\"pricingStrategy\\\": \\\"GROUP_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    \\\"12\\\": {\\n      \\\"referenceId\\\": 12,\\n      \\\"name\\\": \\\"Small\\\",\\n      \\\"guid\\\": \\\"352244f2-a952-4a3a-a3ae-7775fa221ce7\\\",\\n      ...\\n      \\\"price\\\": 8.0,\\n      \\\"pricingStrategy\\\": \\\"BASE_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    \\\"13\\\": {\\n      \\\"referenceId\\\": 13,\\n      \\\"name\\\": \\\"Large\\\",\\n      \\\"guid\\\": \\\"4ff89bca-b448-4892-bc4c-62c37a28ac44\\\",\\n      ...\\n      \\\"price\\\": 10.0,\\n      \\\"pricingStrategy\\\": \\\"BASE_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    ...\\n  }\\n}  \\n```     \\n\",\"type\":\"string\",\"nullable\":true},\"sizeSequencePricingRules\":{\"type\":\"array\",\"description\":\"An array of `SizeSequencePricingRule` objects that define the prices for the modifier options in a modifier group that uses the Size Price, Sequence Price, or Size/Sequence Pricing pricing strategy. If the modifier group does not use one of these pricing strategies, this array is empty.\\n\",\"items\":{\"$ref\":\"#/components/schemas/SizeSequencePricingRule\"}}}},\"TimeSpecificPrice\":{\"type\":\"object\",\"description\":\"Represents the pricing rules for a menu item that uses a time-specific price.\\n\",\"properties\":{\"timeSpecificPrice\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The price of the menu item during the periods of time defined by the associated `schedule` array.\\n\"},\"basePrice\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The base price of the menu item, used for time periods when a time-specific price has not been defined.\\n\"},\"schedule\":{\"type\":\"array\",\"description\":\"An array of `Schedule` objects that indicate the specific days and times that a time-specific price is available.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Schedule\"}}}},\"SizeSequencePricingRule\":{\"type\":\"object\",\"description\":\"A multi-use object that defines the pricing rules for modifier options that belong to a modifier group that uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy. The contents of this object depend on the pricing strategy that is in effect.\\n\",\"properties\":{\"sizeName\":{\"type\":\"string\",\"description\":\"A string that represents the size of a modifier option in this modifier group, for example, Small, Medium, or Large.\\n\\nWith Size Price and the Size/Sequence Price pricing strategies, the price of a modifier option changes based on the size of the menu item it is applied to, for example, a topping costs $1 on a small pizza and $2 on a large pizza. To determine which size and size-based price to use for a modifier option, the Toast POS system matches the size name of the modifier option to the size name of the menu item. For example, the Small size of a modifier option would match the Small size of a menu item. The `sizeName` value of the `SizeSequencePricingRule` object represents the modifier option size while the `sizeGuid` value represents the matching menu item size.\\n\\nThe Toast POS system does allow a configuration where the size of the modifier option is specified independently from the size of the menu item it applies to. In this scenario, you could order a Large menu item and apply a Small size of the modifier option to it. This configuration is unusual but the menus API supports it. When this configuration is in use, the `sizeName` value is populated with the modifier option size but the `sizeGuid` value that represents the menu item size will be null because there is no matching menu item size.\\n\\nThe `sizeName` value is null if the modifier group uses the Sequence Price pricing strategy because this strategy does not use sizes.\\n\\nSee the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingStrategiesOverview.html\\\">Pricing strategies</a> section in the Toast Platform Guide for information on the Size Price, Sequence Price, and Size/Sequence Price pricing strategies.\\n\",\"nullable\":true},\"sizeGuid\":{\"type\":\"string\",\"description\":\"The GUID of the modifier option where a menu item size has been defined that matches the `sizeName` value. For example, if a menu item has Small and Large sizes, those sizes are represented in a Size modifier group with a Small modifier option and a Large modifier option. It is the GUID of one of those size modifier options that appears in this value. If the `sizeName` value is Small, then the `sizeGuid` value would contain the Small modifier option’s GUID.\\n\\nWith Size Price and the Size/Sequence Price pricing strategies, the price of a modifier option changes based on the size of the menu item it is applied to, for example, a topping costs $1 on a small pizza and $2 on a large pizza. To determine which size and size-based price to use for a modifier option, the Toast POS system matches the size name of the modifier option to the size name of the menu item. For example, the Small size of a modifier option would match the Small size of a menu item. The `sizeName` value represents the modifier option size while the `sizeGuid` value represents the matching menu item size.\\n\\nThe Toast POS system does allow a configuration where the size of the modifier option is specified independently from the size of the menu item it applies to. In this scenario, you could order a Large menu item and apply a Small size of the modifier option to it. This configuration is unusual but the menus API supports it. When this configuration is in use, the `sizeName` value is populated with the modifier option size but there is no corresponding `sizeGuid` for the menu item size.\\n\\nThe `sizeGuid` value is null if the modifier group uses the Sequence Price pricing strategy because this strategy does not use sizes.\\n\\nSee the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingStrategiesOverview.html\\\">Pricing strategies</a> section in the Toast Platform Guide for information on the Size Price, Sequence Price, and Size/Sequence Price pricing strategies.\\n\",\"nullable\":true},\"sequencePrices\":{\"type\":\"array\",\"description\":\"An array of `SequencePrices` objects that define the size, sequence, or size/sequence prices for the modifier options in this modifier group.\\n\\nBecause they are multi use objects, the `SequencePrices` objects always contain `sequence` and `price` values for all three pricing strategies. However, the `sequence` is always 1 for the Size Price pricing strategy because only one price is defined per size for that strategy. For example, the `sequencePrices` value for a modifier group priced using the Size Price pricing strategy looks similar to the following:\\n```\\n\\\"sizeSequencePricingRules\\\": [\\n      {\\n        \\\"sizeName\\\": \\\"Small\\\",\\n        \\\"sizeGuid\\\": \\\"e02d1a57-5f9f-4800-a8c3-a5fe1a0b029b\\\",\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 2\\n          }\\n        ]\\n      },\\n      {\\n        \\\"sizeName\\\": \\\"Large\\\",\\n        \\\"sizeGuid\\\": \\\"0e206b2d-72ab-46d1-b273-a5425cbef9a5\\\",\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 4\\n          }\\n        ]\\n      }\\n    ]\\n```             \\n\\nThe modifier options in this group cost $2.00 for the Small size and $4.00 for the Large size.\\n\\nThe `sequencePrices` value for a modifier group priced using the Sequence Price pricing strategy looks like this:\\n```\\n\\\"sizeSequencePricingRules\\\": [\\n      {\\n        \\\"sizeName\\\": null,\\n        \\\"sizeGuid\\\": null,\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 1\\n          },\\n          {\\n            \\\"sequence\\\": 2,\\n            \\\"price\\\": 2\\n          },\\n          {\\n            \\\"sequence\\\": 3,\\n            \\\"price\\\": 2.5\\n          }\\n        ]\\n      }\\n    ]\\n```\\n\\nThe first modifier option in this group costs $1.00, the second modifier option costs $2.00, and any additional modifier options from this group costs $2.50.\\n\\nThe `sequencePrices` value for a modifier group using the Size/Sequence Price pricing strategy looks like this:\\n```\\n\\\"sizeSequencePricingRules\\\": [\\n      {\\n        \\\"sizeName\\\": \\\"Small\\\",\\n        \\\"sizeGuid\\\": \\\"e02d1a57-5f9f-4800-a8c3-a5fe1a0b029b\\\",\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 1\\n          },\\n          {\\n            \\\"sequence\\\": 2,\\n            \\\"price\\\": 2\\n          }\\n        ]\\n      },\\n      {\\n        \\\"sizeName\\\": \\\"Large\\\",\\n        \\\"sizeGuid\\\": \\\"0e206b2d-72ab-46d1-b273-a5425cbef9a5\\\",\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 3\\n          },\\n          {\\n            \\\"sequence\\\": 2,\\n            \\\"price\\\": 4\\n          }\\n        ]\\n      }\\n    ]\\n```\\n\\nThe first modifier option on a Small menu item costs $1.00 and additional modifier options on a Small cost $2.00, while the first modifier option on a Large menu item costs $3.00 and additional modifier options on a Large cost $4.00.\\n\",\"items\":{\"$ref\":\"#/components/schemas/SequencePrice\"}}}},\"SequencePrice\":{\"type\":\"object\",\"description\":\"Defines the size, sequence, or size/sequence prices for modifier options contained in a modifier group that uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy.\\n\",\"properties\":{\"sequence\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Specifies the order of the prices.\\n\\nFor modifier groups that use the Size Price pricing strategy, the `sequence` is always 1 because only one price is defined per size for that strategy.\\n\\nFor modifier groups that use the Sequence Price or Size/Sequence Price pricing strategy, this value starts at 1 and increases with each successive price in the sequence. For example, in the JSON snippet below, `\\\"sequence\\\":1` defines the first price in the sequence and `\\\"sequence\\\":2` defines the second price in the sequence.\\n```\\n\\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 3\\n          },\\n          {\\n            \\\"sequence\\\": 2,\\n            \\\"price\\\": 4\\n          }\\n        ]\\n```\\n\"},\"price\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The price for a modifier option when it is ordered at the specified point in the sequence.\\n\"}}},\"Image\":{\"type\":\"string\",\"description\":\"The URL to an image that has been uploaded for this menu entity. This value is null if no image has been specified.\\n\",\"nullable\":true},\"Visibility\":{\"type\":\"array\",\"description\":\"An array of strings that indicate where this menu entity is visible:\\n\\n* POS: The menu entity is visible in the Toast POS app. \\n\\n* KIOSK: The menu entity is visible on a Toast kiosk. \\n\\n* TOAST_ONLINE_ORDERING: The menu entity is visible in the Toast online\\n  ordering site for this restaurant. \\n\\n* ORDERING_PARTNERS: The restaurants wants this menu entity to be visible\\n  on online ordering sites that integrate with the Toast POS system using the orders API. \\n\\n* GRUBHUB: Deprecated. The menu entity is included during a menu sync to\\n  Grubhub and will be visible on the Grubhub online ordering service after a\\n  menu sync has completed. _Note:_ Conceptually, the _Grubhub_ configuration\\n  option that was associated with the `GRUBHUB` string in this array has\\n  been replaced by the more general _Online orders: Ordering partners_\\n  configuration option and restaurants that used the _Grubhub_ option have\\n  been automatically migrated to the new _Online orders: Ordering partners_\\n  option. This means that any menu entity that had the _Grubhub_ option set\\n  to _Yes_ will now have the _Online orders: Ordering partners_ option\\n  enabled and the `ORDERING_PARTNERS` enum will be present in the\\n  `visibility` array for it. To support backwards compatibility, the\\n  `visibility` array for these entities will also continue to contain the\\n  `GRUBHUB` enum for a short period of time. See <a\\n  href=\\\"https://doc.toasttab.com/doc/devguide/apiDeprecatedApiFunctions.html#apiMenuEntityVisibilityEnhancements\\\">Menu\\n  Visibility Enhancements (Rolled Out)</a> for more information.\\n\\nThe `visibility` array is empty if the menu entity is not configured to be visible for any of the use cases listed above.\\n\",\"items\":{\"type\":\"string\",\"enum\":[\"POS\",\"KIOSK\",\"GRUBHUB\",\"TOAST_ONLINE_ORDERING\",\"ORDERING_PARTNERS\"]}},\"MultiLocationId\":{\"type\":\"string\",\"description\":\"An identifier that is used to identify and consolidate menu entities that are versions of each other.\\n\\n`multiLocationId` replaces `masterId`. `multiLocationId` and `masterId` always have the same value.\\n\\nMenu entities can be versioned. Those versions can be assigned to specific restaurant locations, or groups of locations, in a management group. For example, you could have two versions of a burger, one for a Boston location and another for a New York City location. Versioned menu entities share the majority of, but not all of, their data. For example, the Boston version is called the Minuteman Burger and has pickles, while the New York City version is called the Empire Burger and does not.\\n\\nYou use the `multiLocationId` to identify menu entities that are versions of each other. To continue the example above, the Minuteman Burger in the JSON returned for the Boston location has the same `multilocationId` as the Empire Burger in the JSON returned for the New York City location. These matching `multlocationId` values indicate that the two items are related versions of the same item. In Toast reports, this allows a restaurant to track sales of the burger across both locations.\\n\\nThe Toast POS system ensures that once a `multilocationId` value is assigned to a set of versions within a management group, that `multiLocationId` is not used for any other version sets in the same management group. It does not guarantee, however, that the `multiLocationId` is not used by another management group to identify a set of versions within it.\\n\\nSee <a href=\\\"https://doc.toasttab.com/doc/devguide/portalToastIdentifiers.html\\\">Toast identifiers</a> in the Toast Developer Guide for more information on the `multiLocationId` and its relationship to other Toast identifiers.\\n\\nSee <a href=\\\"https://doc.toasttab.com/doc/platformguide/sharingMenusAndOtherInformationAmongRestaurants.html\\\">Enterprise module overview</a> in the Toast Platform Guide for more information on the enterprise module and versioning.\\n\"},\"MasterId\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"This value is deprecated. Instead of `masterId`, use `multiLocationId`.\\n\\nAn identifier that is used to identify and consolidate menu entities that are versions of each other.\\n\"},\"PosName\":{\"type\":\"string\",\"description\":\"The button label name that appears for this menu entity in the Toast POS app. `posName` contains an empty string if a `posName` has not been defined for the menu entity and the `name` value is used for the button label instead.\\n\"},\"PosButtonColorLight\":{\"type\":\"string\",\"description\":\"The color of the menu entity's button on the Toast POS app, when the app is running in light mode.\\n     \\nWhen an employee configures a POS button's color, they select a color pairing that consists of two colors, one for light mode and one for dark mode. `posButtonColorLight` contains the HEX code for the light mode color.\\n\\n`posButtonColorLight` defaults to `#f7f7f7`, the HEX code when the `WHITE` color pairing is chosen.\\n\\nThe following list shows the possible HEX codes for `posButtonColorLight`, with the associated color pairing in parentheses.\\n\\n* #f7f7f7 (WHITE)\\n* #ffe6e9 (TERRACOTTA_1)\\n* #efa49f (TERRACOTTA_2)\\n* #f07166 (TERRACOTTA_3)\\n* #e45a4e (TERRACOTTA_4)\\n* #fbd9b6 (ORANGE_1)\\n* #f7be6e (ORANGE_2)\\n* #f98c1f (ORANGE_3)\\n* #e56f1a (ORANGE_4)    \\n* #fbf5b6 (YELLOW_1)\\n* #fed850 (YELLOW_2)\\n* #e9b10c (YELLOW_3)\\n* #c78605 (YELLOW_4)      \\n* #e8f7d4 (GRASS_1)\\n* #afe26c (GRASS_2)\\n* #71b314 (GRASS_3)\\n* #32a206 (GRASS_4)      \\n* #e3f0fb (SKY_1)\\n* #9fc5f0 (SKY_2)\\n* #77a5e4 (SKY_3)\\n* #558edd (SKY_4)      \\n* #f1e3fd (LAVENDER_1)\\n* #dab2f7 (LAVENDER_2)\\n* #b26ee2 (LAVENDER_3)\\n* #a270db (LAVENDER_4)      \\n* #d0d0d0 (GRAY_1)\\n* #c3c3c3 (GRAY_2)\\n* #b1b1b1 (GRAY_3)\\n* #989898 (GRAY_4)\\n\"},\"PosButtonColorDark\":{\"type\":\"string\",\"description\":\"The color of the menu entity's button on the Toast POS app, when the app is running in dark mode.\\n     \\nWhen an employee configures a POS button's color, they select a color pairing that consists of two colors, one for light mode and one for dark mode. `posButtonColorDark` contains the HEX code for the dark mode color.\\n\\n`posButtonColorDark` defaults to `#1a1c23`, the HEX code when the `WHITE` color pairing is chosen.\\n\\nThe following list shows the possible HEX codes for `posButtonColorDark`, with the associated color pairing in parentheses.\\n\\n* #1a1c23 (WHITE)\\n* #7e635d (TERRACOTTA_1)\\n* #74504D (TERRACOTTA_2)\\n* #722e25 (TERRACOTTA_3)\\n* #561408 (TERRACOTTA_4)\\n* #8f5f3d (ORANGE_1)\\n* #7e4116 (ORANGE_2)\\n* #803500 (ORANGE_3)\\n* #682d03 (ORANGE_4)    \\n* #7e6b44 (YELLOW_1)\\n* #7b5f27 (YELLOW_2)\\n* #7c5000 (YELLOW_3)\\n* #633d09 (YELLOW_4)      \\n* #657552 (GRASS_1)\\n* #556e34 (GRASS_2)\\n* #37570a (GRASS_3)\\n* #113a00 (GRASS_4)      \\n* #637486 (SKY_1)\\n* #4d6074 (SKY_2)\\n* #2a456b (SKY_3)\\n* #213554 (SKY_4)      \\n* #78668a (LAVENDER_1)\\n* #5e4776 (LAVENDER_2)\\n* #402960 (LAVENDER_3)\\n* #25174f (LAVENDER_4)      \\n* #6c6c6c (GRAY_1)\\n* #5f5f5f (GRAY_2)\\n* #474747 (GRAY_3)\\n* #404040 (GRAY_4)\\n\"},\"Length\":{\"type\":\"number\",\"description\":\"The length of the item or modifier. Use the `dimensionUnitOfMeasure` value to determine the unit of measurement.\\n\\nThe `length` value is `null` if no length is specified for the item or modifier.\\n\\nYou can use the `length`, `height`, and `width` values to determine the overall size of the item or modifier. This information is useful, for example, when determining shipping costs or choosing the size of delivery vehicle to use.\\n\",\"format\":\"float\",\"nullable\":true},\"Height\":{\"type\":\"number\",\"description\":\"The height of the item or modifier. Use the `dimensionUnitOfMeasure` value to determine the unit of measurement.\\n\\nThe `height` value is `null` if no height is specified for the item or modifier.\\n\\nYou can use the `length`, `height`, and `width` values to determine the overall size of the item or modifier. This information is useful, for example, when determining shipping costs or choosing the size of delivery vehicle to use.\\n\",\"format\":\"float\",\"nullable\":true},\"Width\":{\"type\":\"number\",\"description\":\"The width of the item or modifier. Use the `dimensionUnitOfMeasure` value to determine the unit of measurement.\\n\\nThe `width` value is `null` if no width is specified for the item or modifier.\\n\\nYou can use the `length`, `height`, and `width` values to determine the overall size of the item or modifier. This information is useful, for example, when determining shipping costs or choosing the size of delivery vehicle to use.\\n\",\"format\":\"float\",\"nullable\":true},\"DimensionUnitOfMeasure\":{\"type\":\"string\",\"enum\":[\"IN\",\"CM\",\"FT\",\"M\",\"MM\",\"YD\"],\"description\":\"The unit of measure assigned to the `length`, `height`, and `width` values.\\n    \\nPossible values include:\\n    \\n* IN: Inches\\n* CM: Centimeters\\n* FT: Feet\\n* M: Meters\\n* MM: Millimeters\\n* YD: Yards\\n    \\n`dimensionUnitOfMeasure` is `null` if no unit of measurement has been specified.\\n\",\"nullable\":true},\"Weight\":{\"type\":\"number\",\"description\":\"The weight of the item or modifier. Use the `weightUnitOfMeasure` value to determine the unit of measurement.\\n\\nTh `weight` value is `null` if no weight is specified for the item or modifier.\\n    \\nYou can use the `weight` value when determining shipping costs or choosing a delivery vehicle to use.\\n\",\"format\":\"float\",\"nullable\":true},\"WeightUnitOfMeasure\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\"],\"description\":\"The unit of measure assigned to the `weight` value.\\n    \\nPossible values include:\\n    \\n* NONE: No unit of measurement is assigned. `weightUnitOfMeasure` can also be `null`. `NONE` and `null` are equivalent. \\n* LB: Pounds\\n* OZ: Ounces\\n* KG: Kilograms\\n* G: Grams\\n\",\"nullable\":true},\"Images\":{\"type\":\"array\",\"description\":\"An array of strings that contain URLs for images that have been uploaded for this item or modifier. The array is empty if no images have been uploaded.\\n    \\n_Note:_ The `images` array contains multiple URLs for multiple images for the same item or modifier. The older `image` value contains a single URL for a single image.\\n\",\"items\":{\"type\":\"string\"}},\"GuestCount\":{\"type\":\"number\",\"description\":\"The number of guests the item or modifier is expected to serve. This value is `null` if no guest count is specified.\\n\",\"format\":\"float\",\"nullable\":true},\"CatalogProductInfo\":{\"type\":\"object\",\"description\":\"Contains retail catalog product information for a menu item.\\n\",\"properties\":{\"product\":{\"$ref\":\"#/components/schemas/CatalogProduct\"},\"productVariant\":{\"$ref\":\"#/components/schemas/CatalogProductVariant\"}},\"nullable\":true},\"CatalogProduct\":{\"type\":\"object\",\"description\":\"Retail catalog product information for a menu item.\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier of the retail product in the retail product catalog. This is different from the menu item identifier.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the product, for example, \\\"T-Shirt\\\".\\n\"},\"description\":{\"type\":\"string\",\"description\":\"The description of the product.\\n\",\"nullable\":true},\"type\":{\"type\":\"string\",\"enum\":[\"SINGLE\",\"OPTION\",\"UNSPECIFIED\"],\"description\":\"The type of product. Possible values include:\\n\\n* `SINGLE`: The product has exactly one variant and does not have any options.\\n* `OPTION`: The product is an option-type product and will contain at least one variant and at least one option.\\n* `UNSPECIFIED`: Product type is not specified or unknown.\\n\"},\"images\":{\"type\":\"array\",\"description\":\"List of image URLs for the product. A product can have different images than its variants.\\n\",\"items\":{\"type\":\"string\"}},\"availableOptions\":{\"type\":\"array\",\"description\":\"List of available options for the product.\\n\",\"items\":{\"$ref\":\"#/components/schemas/CatalogProductOption\"}}}},\"CatalogProductVariant\":{\"type\":\"object\",\"description\":\"The specific version of the retail product that this menu item represents, defined by a unique combination of option values (for example, a T-Shirt with options `Red` and size `Small`).\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier for the product variant.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the variant, for example, \\\"T-Shirt - Small\\\".\\n\"},\"description\":{\"type\":\"string\",\"description\":\"The description of the variant.\\n\",\"nullable\":true},\"selectedOptions\":{\"type\":\"array\",\"description\":\"List of selected options for the variant.\\n\",\"items\":{\"$ref\":\"#/components/schemas/CatalogProductVariantOption\"}}}},\"CatalogProductOption\":{\"type\":\"object\",\"description\":\"An option for a retail product.\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier for the product option.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the product option, for example, \\\"size\\\".\\n\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"The sort order of the product option.\\n\"},\"values\":{\"type\":\"array\",\"description\":\"List of values for the product option.\\n\",\"items\":{\"$ref\":\"#/components/schemas/CatalogProductOptionValue\"}}}},\"CatalogProductVariantOption\":{\"type\":\"object\",\"description\":\"A selected option for a retail product variant.\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier for the product variant option.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the product variant option, for example, \\\"size\\\".\\n\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"The sort order of the product variant option.\\n\"},\"value\":{\"$ref\":\"#/components/schemas/CatalogProductOptionValue\"}}},\"CatalogProductOptionValue\":{\"type\":\"object\",\"description\":\"A value within a catalog product option.\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier for the product option value.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the product option value, for example, \\\"small\\\".\\n\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"The sort order of the product option value.\\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-menus-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"menus.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/menus.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"menus","isDefault":true,"id":"menus","title":"menus","link":null}]},{"id":"e49ec0ff-1342-5b61-a3ed-baf3f58a37cfoverview/__redocly content redirect/menusv3/overview/","definitionId":"menusV3","link":"/menusv3/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/menusV3.reference.page.yaml","info":{"version":"3.4.1","title":"Menus API","description":"Returns information about a restaurant's menus.\n\n_Important:_ Ordering integrations should use menus API V3. Other integration types should continue to use menus API V2 until further notice. See <a href=\"https://doc.toasttab.com/doc/devguide/apiComparingMenusAPIV2AndV3.html\">Comparing menus API V2 and V3</a> for more information.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"menusV3","label":"Menus V3","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-menus-api-v3.yaml"},"apiVersions":[{"definitionId":"menusV3","isDefault":true,"title":"menusV3","id":"menusV3"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"3.4.1\",\"title\":\"Menus API\",\"description\":\"Returns information about a restaurant's menus.\\n\\n_Important:_ Ordering integrations should use menus API V3. Other integration types should continue to use menus API V2 until further notice. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiComparingMenusAPIV2AndV3.html\\\">Comparing menus API V2 and V3</a> for more information.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/menus\":{\"get\":{\"operationId\":\"menusGet\",\"summary\":\"Get menus\",\"description\":\"Get menus\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier for the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}}],\"responses\":{\"200\":{\"description\":\"Successful operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Restaurant\"}}}},\"404\":{\"description\":\"No published data was found for the restaurant. Ensure that the restaurant GUID is correct and that its data has been published.\"},\"503\":{\"description\":\"Unable to retrieve menus for the restaurant due to a service outage.\"}},\"security\":[{\"oauth2\":[\"menus.channel:read\"]}]}},\"/metadata\":{\"get\":{\"operationId\":\"metadataGet\",\"summary\":\"Get menu last modified timestamp\\n\",\"description\":\"A lightweight endpoint that allows you to determine if a restaurant's menu data has been updated. Toast support strongly recommends that you do not make a call to the `/menus` endpoint unless the date and time returned by the `/metadata` endpoint is more recent than the `lastUpdated` date and time. While this recommendation applies to all clients of the menus API, it is particularly important for clients that have limited bandwidth.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier for the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}}],\"responses\":{\"200\":{\"description\":\"successful operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Metadata\"}}}}},\"security\":[{\"oauth2\":[\"menus.channel:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/menus/v3\"}],\"components\":{\"securitySchemes\":{\"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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"menus.channel:read\":\"Allows reading from menus API V3.\\n\"}}}}},\"schemas\":{\"Metadata\":{\"type\":\"object\",\"description\":\"Information about the last date and time that this restaurant's menu data was updated.\\n\",\"properties\":{\"restaurantGuid\":{\"description\":\"A unique identifier for this restaurant, assigned by the Toast POS system.\\n\",\"type\":\"string\",\"format\":\"uuid\"},\"lastUpdated\":{\"description\":\"The most recent date and time that this menu's data was published. Use this value to determine if you need to refresh your menu data. The `lastUpdated` value uses the absolute timestamp format describe in the <a href=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Dates and timestamps</a> section of the Toast Developer Guide.\\n\",\"type\":\"string\"}}},\"Restaurant\":{\"type\":\"object\",\"description\":\"Information about the restaurant whose menu data has been retrieved.\\n\",\"properties\":{\"restaurantGuid\":{\"description\":\"A unique identifier for this restaurant, assigned by the Toast POS system.\\n\",\"type\":\"string\",\"format\":\"uuid\"},\"lastUpdated\":{\"description\":\"The most recent date and time that this menu's data was published. Use this value to determine if you need to refresh your menu data. The `lastUpdated` value uses the absolute timestamp format describe in the <a href=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Dates and timestamps</a> section of the Toast Developer Guide.\\n\",\"type\":\"string\"},\"restaurantTimeZone\":{\"description\":\"The name of the restaurant's time zone in the IANA time zone database https://www.iana.org/time-zones. For example, \\\"America/New_York\\\".\\n\",\"type\":\"string\"},\"menus\":{\"type\":\"array\",\"description\":\"An array of `Menu` objects that represent the published menus used by this restaurant.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Menu\"}},\"modifierGroupReferences\":{\"description\":\"A map of `ModifierGroup` objects that define the modifier groups used by this restaurant. Each `ModifierGroup` object is presented as a key/value pair. A pair's key matches the `referenceId` of the object contained in the pair's value, as shown below:\\n```\\n  \\\"modifierGroupReferences\\\": {\\n    ...\\n    \\\"3\\\": {\\n      \\\"referenceId\\\": 3,\\n      \\\"name\\\": \\\"Toppings\\\",\\n      \\\"guid\\\": \\\"58b79986-f88f-411d-ba18-14b1e2441e9d\\\",\\n        ...\\n      },\\n      ...\\n      \\\"modifierOptionReferences\\\": [\\n        10,\\n        11\\n      ],\\n      ...\\n    },\\n    ...\\n  },\\n```\\n\\nOther menu entities refer to modifier groups using their `referenceId`. Having a key that matches the `referenceId` allows you to locate the correct modifier group in the `modifierGroupReferences` map. For more information on the `referenceId` value, see the <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUnderstandingGuidsEntityIdentifiersAndMultilocationIds_V2.html\\\">Understanding GUIDs, referenceIds, and multilocationIds</a> section of the Toast Developer Guide.\\n\",\"properties\":{\"identifier\":{\"type\":\"integer\"}},\"additionalProperties\":{\"$ref\":\"#/components/schemas/ModifierGroup\"}},\"modifierOptionReferences\":{\"description\":\"A map of `ModifierOption` objects that define the modifier options used by this restaurant. Each `ModifierOption` object is presented as a key/value pair. A pair's key matches the `referenceId` of the object contained in the pair's value, as shown below:\\n```\\n\\\"modifierOptionReferences\\\": {\\n  ...\\n  \\\"10\\\": {\\n    \\\"referenceId\\\": 10,\\n    \\\"name\\\": \\\"Mushrooms\\\",\\n    \\\"guid\\\": \\\"fa24fee9-76c4-40ba-ae3c-7dfccafdd8d3\\\",\\n    ...\\n  },\\n  \\\"11\\\": {\\n    \\\"referenceId\\\": 11,\\n    \\\"name\\\": \\\"Onions\\\",\\n    \\\"guid\\\": \\\"afee6be7-8280-4c69-a170-9fdf4c76bf7b\\\",\\n    ...\\n  },\\n  ...\\n}\\n```\\n\\nOther menu entities refer to modifier options using their `referenceId`. Having a key that matches the `referenceId` allows you to locate the correct modifier option in the `modifierOptionReferences` map. For more information on the `referenceId` value, see the <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUnderstandingGuidsEntityIdentifiersAndMultilocationIds_V2.html\\\">Understanding GUIDs, referenceIds, and multilocationIds</a> section of the Toast Developer Guide.\\n\",\"properties\":{\"identifier\":{\"type\":\"integer\"}},\"additionalProperties\":{\"$ref\":\"#/components/schemas/ModifierOption\"}},\"preModifierGroupReferences\":{\"description\":\"A map of `PreModifierGroup` objects that define the premodifier groups used by this restaurant. Each `PreModifierGroup` object is presented as a key/value pair. A pair's key matches the `referenceId` of the object contained in the pair's value, as shown below:\\n```\\n\\\"preModifierGroupReferences\\\": {\\n  \\\"22\\\": {\\n    \\\"referenceId\\\": 22,\\n    \\\"guid\\\": \\\"07a1a94d-6f7b-46d5-a916-a07fa16bb8e8\\\",\\n    \\\"name\\\": \\\"PreModGroup\\\",\\n    \\\"preModifiers\\\": [\\n      {\\n        \\\"guid\\\": \\\"ad45e697-9356-468e-b7b4-1b23f4d4b8a5\\\",\\n        \\\"name\\\": \\\"EXTRA\\\",\\n        \\\"fixedPrice\\\": 1.0,\\n        \\\"multiplicationFactor\\\": null,\\n        \\\"displayMode\\\": \\\"PREFIX\\\"\\n      },\\n      {\\n        \\\"guid\\\": \\\"483dd4cf-acea-4373-ae76-5f7efd0d529d\\\",\\n        \\\"name\\\": \\\"NO\\\",\\n        \\\"fixedPrice\\\": 0.0,\\n        \\\"multiplicationFactor\\\": null,\\n        \\\"displayMode\\\": \\\"PREFIX\\\"\\n      }\\n    ]\\n  },\\n},            \\n```\\n\\nOther menu entities refer to premodifier groups using their `referenceId`. Having a key that matches the `referenceId` allows you to locate the correct premodifier group in the `preModifierGroupReferences` map. For more information on the `referenceId` value, see the <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUnderstandingGuidsEntityIdentifiersAndMultilocationIds_V2.html\\\">Understanding GUIDs, referenceIds, and multilocationIds</a> section of the Toast Developer Guide.          \\n\",\"properties\":{\"identifier\":{\"type\":\"integer\"}},\"additionalProperties\":{\"$ref\":\"#/components/schemas/PreModifierGroup\"}}}},\"Menu\":{\"type\":\"object\",\"description\":\"Information about a menu configured for this restaurant.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this menu, for example, \\\"Food\\\" or \\\"Drinks\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this menu, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"description\":{\"description\":\"An optional short description for this menu.\\n\",\"type\":\"string\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"highResImage\":{\"type\":\"string\",\"description\":\"The URL to a high resolution image that has been uploaded for this menu. The image file must be in JPG, PNG, or SVG format. The `highResImage` value is only available if the Toast Kiosk module has been enabled for this restaurant. This value is null if no high resolution image has been specified.\\n\",\"nullable\":true},\"image\":{\"$ref\":\"#/components/schemas/Image\"},\"availability\":{\"type\":\"object\",\"description\":\"An `Availability` object with information about the days and times this menu is available. If the menu is available 24 hours per day, 7 days per week, this `Availability` object contains a single value, `alwaysAvailable`, that is set to TRUE. If the menu is not available 24 hours per day, 7 days per week, the `alwaysAvailable` value is set to FALSE and the object will also contain a `schedule` value that provides detailed information about the specific days and times this menu is available.\\n\\n**_Important_**\\nThe orders API does not validate against the availability settings of a menu, meaning it is possible to submit an order for an item on a menu when it is not currently available. For this reason, it is particularly important that you check a menu’s `availability` value before placing an order from it.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Availability\"}},\"menuGroups\":{\"type\":\"array\",\"description\":\"An array of the `MenuGroup` objects contained in this menu.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/MenuGroup\"}}}},\"MenuGroup\":{\"type\":\"object\",\"description\":\"Information about a menu group configured for this restaurant, including an array of menu items contained in the group.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this menu group, for example, \\\"Appetizers\\\" or \\\"Sandwiches\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this menu group, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"description\":{\"description\":\"An optional short description of this menu group.\\n\",\"type\":\"string\"},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"image\":{\"$ref\":\"#/components/schemas/Image\"},\"itemTags\":{\"type\":\"array\",\"description\":\"An array of `ItemTag` objects that are assigned to this menu group. Item tags are used to assign identifying characteristics, for example, vegetarian, gluten-free, or alcohol.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ItemTag\"}},\"menuGroups\":{\"type\":\"array\",\"description\":\"An array of the `MenuGroup` objects that are children of this menu group. The array is empty if the menu group has no child menu groups.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/MenuGroup\"}},\"menuItems\":{\"type\":\"array\",\"description\":\"An array of the `MenuItem` objects contained in this menu group.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/MenuItem\"}}}},\"MenuItem\":{\"type\":\"object\",\"description\":\"Information about a menu item configured for this restaurant.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this menu item, for example, \\\"Caesar Salad\\\" or \\\"Turkey Sandwich\\\".\\n\\nTo avoid menu ingestion failures, if the `name` value is an empty string or `null`, the menus API updates it to the string `Missing name` in the returned menus data.\\n\\nNote that, while this solution allows menu ingestion to proceed without failure, it does allow a menu item with the name `Missing name` to appear in a restaurant’s menu, creating potential confusion for guests and employees. Also, the menus API only updates the returned data. It does not update the menu item in the Toast database, meaning the name will still be blank when looking at the menu item in Toast Web.\\n\\nTo fix the issue in Toast Web, the restaurant must identify the parent menu entity for the menu item or modifier, view its details page in Toast Web, and then locate and fix the item with the blank name.\\n\",\"type\":\"string\"},\"kitchenName\":{\"type\":\"string\",\"description\":\"The name of the menu item as it appears on kitchen tickets. The `kitchenName` can include both numbers and letters. This value contains an empty string if a kitchen name has not been configured for the menu item.\\n\"},\"guid\":{\"description\":\"A unique identifier for this menu item, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"description\":{\"description\":\"An optional short description of this menu item.\\n\",\"type\":\"string\"},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"image\":{\"$ref\":\"#/components/schemas/Image\"},\"price\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The price of this menu item.\\n\\nIn Toast Web, menu items may have prices assigned to them individually, or they may inherit them from a parent menu group. The `price` value reflects the menu item's fully resolved pricing configuration in the following ways:\\n\\n  * For base prices, the `price` value is populated with the specified base price.\\n  \\n  * For menu-specific prices, the `price` value is resolved based on the current menu. For example, consider a menu item that is included in both Lunch and Dinner menus and is priced at $10 for the Lunch menu and $12 for the Dinner menu. In the fully resolved JSON returned by the menus API, this menu item would appear twice, once as a child of the Lunch menu with a `price` value of $10, and again as a child of the Dinner menu with a `price` value of $12.\\n  \\n  If this same menu item is added to a Breakfast menu but a menu-specific price is not defined for the Breakfast menu, then the `price` value for the instance of the menu item that appears in the Breakfast menu JSON is populated with the base price from the menu-specific price configuration. Menu-specific price configurations include a base price that functions as a default price when a menu-specific price cannot be resolved.\\n\\n  * For location-specific prices, the `price` value is resolved based on the current location. For example, consider a menu item that costs $15 in the Boston location and $20 in the New York location. When you retrieve menu data for the Boston location, this menu item's `price` value is $15. When you retrieve menu data for the New York location, the menu item's `price` value is $20.\\n  \\n  * For time-specific prices, the `price` value is populated with the base price that is specified as part of the time-specific price configuration. This base price functions as a default price for the menu item during times of the day when a time-specific price has not been defined. For example, consider a menu item that costs $8 from noon to 2pm and $10 during the rest of the day. The `price` value for this item would be $10. You must use the `pricingStrategy` and `pricingRules` values for this menu item to calculate the price of the item during time periods for which a time-specific price has been defined.\\n  \\n  * For size prices, the `price` value is null. You must use this menu item's `pricingStrategy` and `pricingRules` values to calculate the price of the item for different sizes.\\n  \\n  * For open prices, the `price` value is null.\\n\\n  \\n  If the menu item is priced using a price level, the `price` value reflects the pricing strategy used for that price level, using the same logic described above. For example, consider a price level that applies a size price to the menu items it is assigned to. In this scenario, the `price` value is null and you must use the menu item's `pricingStrategy` and `pricingRules` values to calculate the price of the item for different sizes.\\n\\n  For more information on menu item pricing and pricing strategies, see the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminToastPosPricingFeatures.html\\\">Menu Pricing</a> section in the Toast Platform Guide.\\n\",\"nullable\":true},\"pricingStrategy\":{\"type\":\"string\",\"enum\":[\"BASE_PRICE\",\"MENU_SPECIFIC_PRICE\",\"TIME_SPECIFIC_PRICE\",\"SIZE_PRICE\",\"OPEN_PRICE\"],\"description\":\"A string that represents the pricing strategy used for this menu item.\\n\\nYou use the `pricingStrategy` value, in conjunction with the `pricingRules` value, to calculate the price for a menu item that uses the Time Specific Price or Size Price pricing strategy.\\n\\nIn Toast Web, menu items may have pricing strategies assigned to them individually, or they may inherit them from a parent menu group. The `pricingStrategy` value indicates the menu item's fully resolved pricing strategy. If the menu item is priced using the:\\n  * Base Price pricing strategy, then the `pricingStrategy` value is BASE_PRICE.\\n  * Menu Specific Price pricing strategy, then the `pricingStrategy` value is MENU_SPECIFIC_PRICE.\\n  * Time Specific Price pricing strategy, then the `pricingStrategy` value is TIME_SPECIFIC_PRICE.\\n  * Size Price pricing strategy, then the `pricingStrategy` value is SIZE_PRICE.\\n  * Open Price pricing strategy, then the `pricingStrategy` value is OPEN_PRICE.\\n\\nIf the menu item is priced using the Location Specific Price pricing strategy, then the `pricingStrategy` value indicates which pricing strategy is used at the current location. For example, consider a menu item that uses a menu-specific price at the Boston location and a base price at the New York location. When you retrieve the menu data for the Boston location, the `pricingStrategy` for the menu item is MENU_SPECIFIC_PRICE. When you retrieve menu data for the New York location, the `pricingStrategy` for the menu item is BASE_PRICE.\\n\\nIf the menu item is priced using a price level, then the `pricingStrategy` value indicates which pricing strategy is used for that price level. For example, if the \\\"Draft Beer\\\" pricing level uses a time-specific price, then the `pricingStrategy` value for a menu item that is assigned the \\\"Draft Beer\\\" pricing level is TIME_SPECIFIC_PRICE.\\n\\nIf the `pricingStrategy` value is BASE_PRICE or MENU_SPECIFIC_PRICE, you can retrieve the menu item's price from its `price` value.\\n\\nIf the `pricingStrategy` value is TIME_SPECIFIC_PRICE or SIZE_PRICE, you must use the rules provided in _this menu item's_ `pricingRules` value to calculate the price for it.\\n\"},\"pricingRules\":{\"type\":\"object\",\"description\":\"A `PricingRules` object with information about how to calculate the price for this menu item. You use a menu item's `pricingRules` value, in conjunction with its `pricingStrategy` value, to calculate a price for a menu item that uses a size-specific or time-specific price.\\n\\nThe `pricingRules` object takes different forms depending on the pricing strategy configured for the menu item. Use the `pricingStrategy` value to determine which pricing strategy has been used so that you can properly interpret the data in the `pricingRules` object. For the BASE_PRICE, and MENU_SPECIFIC_PRICE pricing strategies, the `pricingRules` object is null because you can retrieve the price from the `price` value without additional calculation. For the OPEN_PRICE pricing strategy, the `pricingRules` object is also null (the price of an open menu item is specified when it is ordered). For the TIME_SPECIFIC_PRICE and SIZE_PRICE pricing strategies, the `PricingRules` object contains additional values that you use to calculate the menu item's price.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PricingRules\"},\"nullable\":true},\"isDeferred\":{\"type\":\"boolean\",\"description\":\"Indicates whether this menu item should be considered deferred revenue.\\n\"},\"isDiscountable\":{\"type\":\"boolean\",\"description\":\"Indicates whether this menu item can be discounted.\\n\\n**_Important_** The orders API _does not validate_ against the `isDiscountable` value. If you submit an order that applies a discount to a menu item whose `isDiscountable` value is FALSE, the orders API will not fail the order but it will set the discount amount on the menu item to $0.00. If you are using the menus API to build an ordering application, be sure to inspect the `isDiscountable` value of the menu items to ensure that your ordering application does not allow an item to be discounted if its `isDiscountable` value is FALSE.\\n\"},\"salesCategory\":{\"$ref\":\"#/components/schemas/SalesCategory\"},\"taxInfo\":{\"type\":\"array\",\"description\":\"An array of GUIDs for the tax rates that apply to this menu item.\\n\\nNote that a menu item's tax rates may get overridden if a modifier option is applied to it and that modifier option is configured so that it overrides its parent menu item's tax rates. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUsingTaxInfoAndModifierOptionTaxInfoToCalculateTaxesForMenuItemsAndModOptions.html\\\">Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options</a> in the Toast Developer Guide for more information.   \\n          \\nTo retrieve full configuration data for a tax rate, use the `/taxRates/{guid}` endpoint in the configuration API.\\n\\n_Important:_ The `taxInfo` value is intended to help you display prices but the `/prices` endpoint of the orders API is the only supported way to determine the prices of orders that you submit to the orders API. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiOrderPrices.html\\\">Order prices</a> in the Toast Developer Guide for more information.\\n\",\"items\":{\"type\":\"string\"}},\"taxInclusion\":{\"type\":\"string\",\"enum\":[\"TAX_INCLUDED\",\"TAX_NOT_INCLUDED\",\"SMART_TAX\"],\"description\":\"A string that represents the tax inclusion setting for this menu item. Possible values include:\\n\\n* `TAX_INCLUDED`: The menu item's price includes taxes. You should not display additional tax on top of the menu item price in your ordering UI.\\n* `TAX_NOT_INCLUDED`: The menu item's price does not include taxes. You should display tax values alongside the menu item price in your ordering UI.\\n* `SMART_TAX`: The menu item is using smart tax, a feature that allows a restaurant to configure menu item prices to include or not include taxes, depending on the section of the restaurant that the item is ordered in (for example, the bar or the dining room). For example, a guest can order an item at either the bar or in the main dining room. To prevent bartenders from having to handle coins, which can slow down service, and to make tipping easier, the restaurant wants the price of the item to be a whole number that includes tax when it is ordered at the bar. In the main dining room, where speed of service is less of a concern, the restaurant doesn't want the item's price to include tax, so that it doesn't lose out on the extra revenue.\\n\\nTypically, the smart tax setting is used for in-store workflows where the efficiency of money handling is a priority. As such, it doesn't apply to online ordering integrations. If a menu item's `taxInclusion` value is set to `SMART_TAX`, your ordering integration should treat the menu item as if tax is not included. For more information on the smart tax feature, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSmartTax.html\\\">Smart tax</a> in the Toast Platform Guide.\\n\\n_Note:_ A menu item's tax inclusion setting is inherited by any modifiers that are applied to that menu item. For more information, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminTaxesOnModifiers.html#adminModifierTaxInteraction\\\">Tax functionality interaction</a> in the Toast Platform Guide.\\n\"},\"itemTags\":{\"type\":\"array\",\"description\":\"An array of `ItemTag` objects that are assigned to this menu item. Item tags are used to assign identifying characteristics to a menu item, for example, vegetarian, gluten-free, or alcohol.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ItemTag\"}},\"plu\":{\"type\":\"string\",\"description\":\"The price lookup (PLU) code for this menu item. The PLU code can include both numbers and letters. This value contains an empty string if a PLU code has not been defined.\\n\"},\"sku\":{\"type\":\"string\",\"description\":\"The stock keeping unit (SKU) identifier for this menu item. The SKU identifier can include both numbers and letters. This value contains an empty string if a SKU has not been defined.\\n\"},\"calories\":{\"type\":\"integer\",\"description\":\"The number of calories in this menu item. The calories value can be any positive or negative integer, or zero. This value is null if a calories amount has not been configured for the menu item.\\n\",\"nullable\":true},\"contentAdvisories\":{\"$ref\":\"#/components/schemas/ContentAdvisories\"},\"unitOfMeasure\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"],\"description\":\"The unit of measure used to determine the price of the item. For example, $10.00 per gram.\\n\\nThe default is `NONE`, which means that the item is not meant to be measured during a sale.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\"},\"portions\":{\"type\":\"array\",\"description\":\"An array of `Portion` objects that define the portions that can be used with this menu item. For example, for a pizza menu item, you could define 1st Half and 2nd Half portions. See <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPortionsOverview.html\\\">Portions overview</a> in the Toast Platform Guide for more information on portions.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/Portion\"}},\"prepTime\":{\"type\":\"integer\",\"description\":\"The amount of time, in seconds, that it takes to prepare this menu item. This value is null if a prep time has not been specified for the menu item.<br>\\n<br>\\n*Related topics*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminFireByPrepTime.html\\\">Using prep times to automate item firing</a><br>\\n\",\"format\":\"int32\",\"nullable\":true},\"prepStations\":{\"type\":\"array\",\"description\":\"An array of GUIDs for the prep stations that have been assigned to this menu item. This array is empty if no prep stations have been assigned.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html\\\">Routing to prep stations</a>\\n\",\"items\":{\"type\":\"string\"}},\"modifierGroupReferences\":{\"type\":\"array\",\"description\":\"An array of `referenceId`s for `ModifierGroup` objects. These objects define the modifier groups that apply to this menu item.\\n\",\"minItems\":0,\"items\":{\"type\":\"integer\"}},\"eligiblePaymentAssistancePrograms\":{\"type\":\"array\",\"description\":\"An array of strings that indicate which payment assistance programs may be used to pay for this menu item. Possible values include:\\n\\n* `SNAP`: Supplemental Nutrition Assistance Program\\n* `EBT_CASH`: Electronic Benefit Transfer Cash\\n\\nThe array is empty if no payment assistance programs have been assigned to the menu item.\\n\",\"items\":{\"type\":\"string\"}},\"allergens\":{\"type\":\"array\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AllergenItem\"},\"nullable\":true},\"length\":{\"$ref\":\"#/components/schemas/Length\"},\"height\":{\"$ref\":\"#/components/schemas/Height\"},\"width\":{\"$ref\":\"#/components/schemas/Width\"},\"dimensionUnitOfMeasure\":{\"$ref\":\"#/components/schemas/DimensionUnitOfMeasure\"},\"weight\":{\"$ref\":\"#/components/schemas/Weight\"},\"weightUnitOfMeasure\":{\"$ref\":\"#/components/schemas/WeightUnitOfMeasure\"},\"images\":{\"$ref\":\"#/components/schemas/Images\"},\"guestCount\":{\"$ref\":\"#/components/schemas/GuestCount\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"A number determining the order in which this item should appear on kitchen tickets. The sort order value can be any positive or negative integer, or zero. This value is null if a sort order has not been configured for the menu item.\\n\",\"nullable\":true},\"catalogProductInfo\":{\"$ref\":\"#/components/schemas/CatalogProductInfo\"},\"isComboParent\":{\"type\":\"boolean\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\",\"nullable\":true}}},\"ModifierGroup\":{\"type\":\"object\",\"description\":\"Information about a modifier group configured for this restaurant, including an array of modifier options contained in the group.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this modifier group, for example, \\\"Pizza Toppings\\\" or \\\"Salad Dressings\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this modifier group, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"referenceId\":{\"description\":\"An integer identifier that is used to refer to this modifier group by items and portions that use it.\\n\",\"type\":\"integer\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"pricingStrategy\":{\"type\":\"string\",\"description\":\"A string that represents the pricing strategy used for this modifier group.\\n\\nIf there is no additional charge for the modifier options in this group, or if the modifier options in the group are priced individually, then the `pricingStrategy` value is NONE.\\n\\nIf the modifier group is priced at the group level and is using the:\\n  * Fixed Price pricing strategy, then the `pricingStrategy` value is NONE.\\n  * Sequence Price pricing strategy, then the `pricingStrategy` value is SEQUENCE_PRICE.\\n  * Size Price pricing strategy, then the `pricingStrategy` value is SIZE_PRICE.\\n  * Size/Sequence Price pricing strategy, then the `pricingStrategy` value is SIZE_SEQUENCE_PRICE.\\n\\n  \\nIf the `pricingStrategy` value is NONE,  then the prices for the modifier options in this group are resolved down to the modifier option level and you can retrieve them from the `price` value of the individual `ModifierOption` objects.\\n\\nIf the `pricingStrategy` value is SIZE_PRICE, SEQUENCE_PRICE, or SIZE_SEQUENCE_PRICE, then you must use the rules provided in _this modifier group's_ `pricingRules` value to calculate the prices for the modifier options in the group.\\n\"},\"pricingRules\":{\"type\":\"object\",\"description\":\"A `PricingRules` object with information for calculating the prices for the modifier options contained in this modifier group. You use a modifier group's `pricingRules` object, in conjunction with its `pricingStrategy` value, to calculate prices for the group's modifier options when the group uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy.\\n\\nThe `pricingRules` object takes different forms depending on the pricing strategy configured for the modifier group. Use the `pricingStrategy` value to determine which pricing strategy has been used so that you can properly interpret the data in the `pricingRules` object. If the `pricingStrategy` value is NONE, the `pricingRules` object is null because you can retrieve the price from a `ModifierOption` object's `price` value without additional calculation. For the SIZE_PRICE, SEQUENCE_PRICE, and SIZE_SEQUENCE_PRICE pricing strategies, the `pricingRules` object contains additional values that you use to calculate the modifier option prices.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PricingRules\"},\"nullable\":true},\"defaultOptionsChargePrice\":{\"description\":\"Indicates whether the prices associated with any default modifiers in this group are added to the cost of the menu items they modify.\\n\\nValues are:\\n  * NO: The default modifier price is ignored. No change is made to the cost of the menu item.\\n  * YES: The default modifier price is added to the menu item price. YES is the default setting for `defaultOptionsChargePrice`.\\n\\nFor example, consider a scenario where Cheese is a default modifier for a Burger menu item (this means that Cheese is always included as a modifier option when you order a Burger unless it is explicitly removed). The price of the Cheese modifier option is $1 while the price of the Burger is $8. When `defaultOptionsChargePrice` is set to NO, a Burger costs $8 (the Cheese default modifier price is not added to the Burger price). When `defaultOptionsChargePrice` is set to YES, a Burger costs $9 (the Cheese default modifier price is added to the Burger price). If the Cheese default modifier is removed from the Burger menu item, the price of the Burger remains $8. Removing a default modifier from a menu item does not change the menu item’s price, regardless of the `defaultOptionsChargePrice` setting.\\n\\nThe `defaultOptionsChargePrice` value must be set to NO in order to use substitution pricing. See `defaultOptionsSubstitutionPricing` for more information.\\n\",\"type\":\"string\",\"enum\":[\"NO\",\"YES\"]},\"defaultOptionsSubstitutionPricing\":{\"description\":\"Indicates whether substitution pricing is enabled for the modifier group.\\n\\nIn Toast Web, you must set the `defaultOptionsChargePrice` configuration for a modifier group to NO before you can enable substitution pricing for the group. This means that the costs of default modifiers in the group do not increase the price of the menu items they apply to. These default modifiers continue to have a monetary value, however. By enabling substitution pricing, you are configuring the modifier group so that if any of its default modifiers are removed from a menu item, the monetary value of those default modifiers can be applied to the purchase of other modifier options within the same modifier group (even though the cost of those default modifiers was not explicitly added to the cost of the menu item).\\n\\nFor example, a guest orders a salad that comes with chicken by default but asks to substitute salmon for the chicken. The price of the chicken option is $7. The price of the salmon option is $9. In this case, the Toast POS system calculates the difference and charges the substitution price of $2 for the salmon (not the regular price of $9).\\n\\nValues for `defaultOptionsSubstitutionPricing` include:\\n  * YES: Substitution pricing is enabled. Substitution pricing allows a guest to remove one or more default modifiers from a menu item and apply the value of those modifiers toward the purchase of one or more other modifier options in the same modifier group.\\n  * NO: Substitution pricing is not enabled. Removing a default modifier from a menu item has no impact on the price of the menu item or on any other modifier options that get added. For example, a guest orders a burger that comes with cheese by default but asks to substitute bacon instead of cheese. The price of the burger is $8. The price of the default cheese modifier is $1 but it is not added to the cost of the burger because `defaultOptionsChargePrice` is set to NO. The price of the bacon modifier option is $3. In this scenario, the customer would pay $11, $8 for the burger and $3 for the bacon. No credit is given for removing the cheese modifier option. `NO` is the default setting for `defaultOptionsSubstitutionPricing`.\\n\\nRemoving default modifiers from a menu item never reduces the price of the menu item. If you remove the chicken from a $10 salad that includes chicken by default, the price of the salad remains $10. If you remove the chicken and substitute other modifier options that cost less than the chicken, the price of the salad remains $10. If you remove the chicken and replace it with modifier options that cost more than the chicken, the price increases by the difference in modifier option cost if you have substitution pricing enabled.\\n\",\"type\":\"string\",\"enum\":[\"NO\",\"YES\"]},\"minSelections\":{\"type\":\"integer\",\"description\":\"The minimum number of modifier options that a customer can choose from this modifier group.\\n\\nIf a server is not required to select a modifier option from this modifier group, `minSelections` is set to 0.\\n\\nIf a server must select a modifier option from this modifier group, `minSelections` must be set to 1 or higher. For example, a Temperature modifier group could be set to 1 to require a server to choose a temperature (Rare, Medium Rare, Medium, or Well Done) when placing a steak order. The orders API rejects an order if it does not follow the `minSelections` requirement for a modifier group.\\n\\nThe `minSelections` and `maxSelections` values can be used in conjunction with one another. For example, consider the following modifier group configuration:\\n\\n* Modifier Group: Cheese\\n* Modifier Options: ( Cheddar, American, Swiss )\\n* maxSelections: 2\\n* minSelections: 1\\n\\nWith this configuration:\\n  * You can select AT MOST two different cheeses from this group to apply to the menu item (the `maxSelections` value).\\n  * You must select AT LEAST one cheese from this group to apply to the menu item (the `minSelections` value).\\n\"},\"maxSelections\":{\"type\":\"integer\",\"description\":\"The maximum number of modifier options that a customer can choose from this modifier group. `maxSelections` is null if a customer can choose an unlimited number of modifier options from this modifier group. It is 1 if the modifier group is not enabled for multiple selections. The orders API rejects an order if it does not follow the `maxSelections` requirement for a modifier group.\\n\\nThe `minSelections` and `maxSelections` values can be used in conjunction with one another. For example, consider the following modifier group configuration:\\n\\n* Modifier Group: Cheese\\n* Modifier Options: ( Cheddar, American, Swiss )\\n* maxSelections: 2\\n* minSelections: 1\\n\\nWith this configuration:\\n  * You can select AT MOST two different cheeses from this group to apply to the menu item (the `maxSelections` value).\\n  * You must select AT LEAST one cheese from this group to apply to the menu item (the `minSelections` value).\\n\",\"nullable\":true},\"requiredMode\":{\"description\":\"Specifies how the modifier group appears and behaves in the Toast POS app. Values include:\\n  * REQUIRED: Forces a server to make a selection from the modifier group before continuing to the next screen in the Toast POS app. Note that the orders API rejects an order if a modifier option is not included for a modifier group whose `requiredMode` value is set to REQUIRED.\\n  * OPTIONAL FORCE SHOW: Prompts the server to view the modifier group but does not force them to choose a modifier option from it before continuing to the next screen in the Toast POS app. This setting is typically used for upselling.\\n  * OPTIONAL: The modifier group does not appear when an associated menu item is selected but the server can access it on the Toast POS app if necessary.\\n\",\"type\":\"string\",\"enum\":[\"REQUIRED\",\"OPTIONAL_FORCE_SHOW\",\"OPTIONAL\"]},\"isMultiSelect\":{\"type\":\"boolean\",\"description\":\"Indicates whether you can select more than one modifier option from this modifier group.\\n\\nThe `isMultiSelect` value provides similar information to the `maxSelections` value in a different format. If `isMultiSelect` is TRUE, then by definition more than one modifier option can be selected from the modifier group, so `maxSelections` must be greater than 1 or null (a null value indicates that an unlimited number of selections can be made from the modifier group). If `isMultiSelect` is FALSE, then only one modifier option may be selected from the modifier group and the Toast POS system enforces a setting of 1 for `maxSelections`.\\n\\nAlso, if `isMultiSelect` is FALSE for a modifier group, the Toast POS system enforces a setting of FALSE for the `allowsDuplicates`  value of the group’s modifier options. This prevents more than one instance of a modifier option being selected for the group. Similarly, the orders API rejects any orders that specify more than one modifier option for a modifier group whose `isMultiSelect` value is FALSE.\\n\"},\"preModifierGroupReference\":{\"type\":\"integer\",\"description\":\"The `referenceId` of a `PreModifierGroup` object. This object defines the premodifiers that can be applied to the modifier options contained in this modifier group. Premodifiers alter the display of modifier options on receipts and tickets to satisfy guest requests such as EXTRA or ON THE SIDE. Premodifiers can also be configured to modify the cost of the modifier options they are applied to, for example, by charging more for an EXTRA serving of a modifier option.\\n\"},\"modifierOptionReferences\":{\"type\":\"array\",\"description\":\"An array of `referenceId`s for `ModifierOption` objects. These objects define the modifier options contained in this modifier group.\\n\",\"minItems\":0,\"items\":{\"type\":\"integer\"}}}},\"ModifierOption\":{\"type\":\"object\",\"description\":\"Information about a modifier option configured for this restaurant.\\n\",\"properties\":{\"referenceId\":{\"description\":\"An integer identifier that is used to refer to this modifier option by modifier option groups that contain it.\\n\",\"type\":\"integer\"},\"name\":{\"description\":\"A descriptive name for this modifier option, for example, \\\"Cheese\\\" or \\\"Pepperoni\\\".\\n          \\nTo avoid menu ingestion failures, if the `name` value for a modifier option is an empty string or `null`, the menus API updates it to the string `Missing name` in the returned menus data. A modifier option has a blank name if both its item reference name and its modifier override name are missing.\\n\\nNote that, while this solution allows menu ingestion to proceed without failure, it does allow a modifier option with the name `Missing name` to appear in a restaurant’s menu, creating potential confusion for guests and employees. Also, the menus API only updates the returned data. It does not update the modifier option in the Toast database, meaning the name will still be blank when looking at the modifier option in Toast Web.\\n\\nTo fix the issue in Toast Web, the restaurant must identify the parent menu entity for the modifier option, view its details page in Toast Web, and then locate and fix the modifier option with the blank name.\\n\\nFor a detailed description of a modifier option's item reference, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">Understanding a modifier option’s item reference</a> in the Toast Platform Guide.\\n\",\"type\":\"string\"},\"kitchenName\":{\"description\":\"The name of the modifier option as it appears on kitchen tickets. The `kitchenName` can include both numbers and letters. This value contains an empty string if a kitchen name has not been configured for the modifier option.\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this modifier option's item reference, assigned by the Toast POS system. For a detailed description of a modifier option's item reference, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">Understanding a modifier option’s item reference</a> in the Toast Platform Guide.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"masterId\":{\"$ref\":\"#/components/schemas/MasterId\"},\"description\":{\"description\":\"An optional short description of this modifier option.\\n\",\"type\":\"string\"},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"prepStations\":{\"type\":\"array\",\"description\":\"An array of GUIDs for the prep stations that have been assigned to this modifier option.\\n\\nIf a modifier option's item reference has prep stations assigned to it, then the modifier option uses those prep stations. If the modifier option's item reference *does not* have prep stations assigned to it, then the modifier option inherits the prep stations of the menu group, menu item, or modifier (in the case of nested modifiers) it is modifying.\\n\\nThe array is empty if no prep stations have been assigned to the modifier option.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html\\\">Routing to prep stations</a>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">Understanding a modifier option’s item reference</a>\\n\",\"items\":{\"type\":\"string\"}},\"image\":{\"$ref\":\"#/components/schemas/Image\"},\"price\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The price of this modifier option.\\n\\nIn Toast Web, a modifier option may:\\n  * Inherit its price from a parent modifier group.\\n  * Use the price specified for its modifier option <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a>.\\n  * Specify a price that overrides the price defined for its item reference.\\n\\nThe `price` value is populated differently depending on which of these pricing scenarios is used for the modifier option. The sections below describe how the `price` value is populated in these different scenarios.\\n\\n_Note:_ To determine how a modifier option has been priced, you can inspect the modifier option's `pricingStrategy` value. If it is GROUP_PRICE, then the modifier option is inheriting its price from a parent modifier group. If it is any value other than GROUP_PRICE (for example, MENU_SPECIFIC_PRICE or TIME_SPECIFIC PRICE), then the modifier option is using either the price specified for its item reference or an override price (override prices always use the BASE_PRICE strategy).\\n\\n_Modifier Option Inherits Its Price from a Parent Modifier Group_\\n\\nIf the modifier option inherits its price from a parent modifier group and that group uses the:\\n  * Fixed Price pricing strategy, then the modifier option's `price` value is populated with the fixed price specified for the parent modifier group. No additional calculations are required.\\n  * Size Price, Sequence Price, or Size/Sequence pricing strategy, then the modifier option's `price` value is null. You must use the _parent modifier group's_ `pricingStrategy` and `pricingRules` values to calculate the modifier option's price.\\n\\n_Modifier Option Specifies an Override Price_\\n\\nIf the modifier option specifies an override price, the `price` value is set to that override price. No additional calculations are required.\\n\\n_Modifier Option Uses the Price from Its Item Reference_\\n\\nIf a modifier option uses the price from its underlying item reference, then the `price` value is populated using the same logic as the `price` value for a `MenuItem` object:\\n  * For base prices, the `price` value is populated with the specified base price.\\n  * For menu-specific prices, the `price` value is resolved based on the current menu. For example, consider a modifier option that is included in both Lunch and Dinner menus and is priced at $1 for the Lunch menu and $2 for the Dinner menu. In the fully resolved JSON returned by the menus API, this modifier option would appear twice, once as a child of the Lunch menu with a `price` value of $1, and again as a child of the Dinner menu with a `price` value of $2.\\n\\n  If this same modifier option is added to a Breakfast menu but a menu-specific price is not defined for the Breakfast menu, then the `price` value for the instance of the modifier option that appears in the Breakfast menu JSON is populated with the base price from the menu-specific price configuration. Menu-specific price configurations include a base price that functions as a default price when a menu-specific price cannot be resolved.\\n  \\n  * For location-specific prices, the `price` value is resolved based on the current location. For example, consider a modifier option that costs $2 in the Boston location and $3 in the New York location. When you retrieve menu data for the Boston location, this modifier option's `price` value is $2. When you retrieve menu data for the New York location, the modifier option's `price` value is $3.\\n  * For time-specific prices, the `price` value is populated with the base price that is specified as part of the time-specific price configuration. This base price functions as a default price for the modifier option during times of the day when a time-specific price has not been defined. For example, consider a modifier option that costs $1 from noon to 2pm and $2 during the rest of the day. The `price` value for this item would be $2. You must use _this modifier option's_ `pricingStrategy` and `pricingRules` values to calculate the price of the modifier option during time periods for which a time-specific price has been defined.\\n  * For size prices, the `price` value is null. You must use _this modifier option's_ `pricingStrategy` and `pricingRules` values to calculate the price of the modifier option for different sizes.\\n  * For open prices, the `price` value is null.\\n\\nIf the modifier option is priced using a price level, the `price` value reflects the pricing strategy used for the price level, using the same logic described above. For example, consider a price level that applies a size price to the modifier option it is assigned to. In this case, the `price` value for the modifier option is null and you must use this modifier option's `pricingStrategy` and `pricingRules` values to calculate the price of the modifier option for different sizes.\\n_Note:_ For detailed information on modifier option pricing and pricing strategies, see the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminToastPosPricingFeatures.html\\\">Menu pricing</a> section in the Toast Platform Guide.\\n\",\"nullable\":true},\"pricingStrategy\":{\"type\":\"string\",\"description\":\"A string that indicates how this modifier option has been priced. If `pricingStrategy` is:\\n  * GROUP_PRICE, then the modifier option inherits its price from a parent modifier group.\\n  * Any value other than GROUP_PRICE (for example, MENU_SPECIFIC_PRICE or TIME_SPECIFIC PRICE), then the modifier option is using either the price specified for its <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> or an override price (override prices always use the BASE_PRICE strategy).\\n\\nIf the modifier option is using the price of its underlying item reference, and that item reference is priced using the Location Specific Price pricing strategy, then the `pricingStrategy` value indicates which pricing strategy is used at the current location. For example, consider a modifier option that uses a menu-specific price at the Boston location and a base price at the New York location. When you retrieve the menu data for the Boston location, the `pricingStrategy` for the modifier option is MENU_SPECIFIC_PRICE. When you retrieve menu data for the New York location, the `pricingStrategy` for the modifier option is BASE_PRICE.\\n\\nIf the modifier option is using the price of its underlying item reference, and that item reference is priced using a price level, then the `pricingStrategy` value indicates which pricing strategy is used for that price level. For example, if the \\\"Special Toppings\\\" price level uses a time-specific price, then the `pricingStrategy` value for a modifier option that is assigned the \\\"Special Toppings\\\" price level is TIME_SPECIFIC_PRICE.\\n\\nIt is important to understand which `pricingRules` object to use when modifier option prices must be calculated. If the `pricingStrategy` value is:\\n  * BASE_PRICE or MENU_SPECIFIC_PRICE,  then you can retrieve the modifier option's price from its `price` value. No additional calculations are required.\\n  * GROUP_PRICE, then you must use the `pricingStrategy` and `pricingRules` values from _the modifier option's parent modifier group_ to calculate the modifier option's price.\\n  * TIME_SPECIFIC_PRICE or SIZE_PRICE, then you must use the rules provided in _this modifier option's_ `pricingRules` value to calculate the price for the modifier option.\\n\"},\"pricingRules\":{\"type\":\"object\",\"description\":\"A `PricingRules` object with information about how to calculate the price for this modifier option. You use a modifier option's `pricingRules` object, in conjunction with its `pricingStrategy` value, to calculate a price for the modifier option when the modifier option is _individually priced_ and its `price` value is null.\\n\\n_Note:_ If the modifier option is priced at the group level, you must use the `pricingRules` object of its parent modifier group to calculate its price. A modifier option is priced at the group level if its `pricingStrategy` value is GROUP_PRICE.\\n\\nThe `pricingRules` object takes different forms depending on the pricing strategy configured for the modifier option. Use the `pricingStrategy` value to determine which pricing strategy has been used so that you can properly interpret the data in the `pricingRules` object. For the BASE_PRICE, and MENU_SPECIFIC_PRICE pricing strategies, the `pricingRules` object is null because you can retrieve the price from the `price` value without additional calculation. For the OPEN_PRICE pricing strategy, the `pricingRules` object is also null (the price of a modifier option whose item reference uses the Open Price pricing strategy is specified at the time that the modifier option is ordered). For the TIME_SPECIFIC_PRICE and SIZE_PRICE pricing strategies, the `pricingRules` object contains additional values that you use to calculate the modifier option's price.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PricingRules\"},\"nullable\":true},\"salesCategory\":{\"$ref\":\"#/components/schemas/SalesCategory\"},\"taxInfo\":{\"type\":\"array\",\"description\":\"The `taxInfo` value on the `ModifierOption` object has been deprecated. An upcoming release will introduce new configuration settings for the taxes on a modifier option. The `taxInfo` value will not accurately represent these additional configurations. Your integration should switch to using the `modifierOptionTaxInfo` value instead. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUsingTaxInfoAndModifierOptionTaxInfoToCalculateTaxesForMenuItemsAndModOptions.html\\\">Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options</a> in the Toast Developer Guide for more information. \\n\",\"items\":{\"type\":\"string\"}},\"modifierOptionTaxInfo\":{\"$ref\":\"#/components/schemas/ModifierOptionTaxInfo\"},\"itemTags\":{\"type\":\"array\",\"description\":\"An array of `ItemTag` objects that are assigned to this modifier option. Item tags are used to assign identifying characteristics to a modifier option, for example, vegetarian, gluten-free, alcohol.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ItemTag\"}},\"plu\":{\"type\":\"string\",\"description\":\"The price lookup (PLU) code for this modifier option. The PLU code can contain both numbers and letters. This value contains an empty string if a PLU code has not been defined.\\n\"},\"sku\":{\"type\":\"string\",\"description\":\"The stock keeping unit (SKU) identifier for this modifier option. The SKU identifier can contain both numbers and letters. This value contains an empty string if a SKU has not been defined.\\n\"},\"calories\":{\"type\":\"integer\",\"description\":\"The number of calories in this modifier option. The calories value can be any positive or negative integer, or zero. This value is null if a calories amount has not been configured for the modifier option.\\n\",\"nullable\":true},\"contentAdvisories\":{\"$ref\":\"#/components/schemas/ContentAdvisories\"},\"unitOfMeasure\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"],\"description\":\"The unit of measure used to determine the price of the modifier option. For example, $10.00 per gram. \\nThe default is `NONE`, which means that the item is not meant to be measured during a sale.\\n\\nValues are:\\n * `NONE` - The item is not meant to be measured.\\n * `LB` - Weighed in pounds.\\n * `OZ` - Weighed in ounces.\\n * `KG` - Weighed in kilograms.\\n * `G` - Weighed in grams.\\n * `GAL` - Measured in gallons.\\n * `L` - Measured in liters.\\n * `ML` - Measured in milliliters.\\n * `FL_OZ` - Measured in fluid ounces.\\n * `M` - Measured in meters.\\n * `CM` - Measured in centimeters.\\n * `FT` - Measured in feet.\\n * `IN` - Measured in inches.\\n * `YD` - Measured in yards.\\n\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"Indicates whether this modifier option is included on the menu item by default.\\n\\n_Important:_ If a menu item is configured to use default modifiers and you submit an order to the orders API for that menu item but you omit those default modifiers, then the Toast POS system assumes you want to omit the default modifiers and they will not be included in the order. For example, consider a Burger menu item that has Lettuce and Tomato as default modifiers. If you submit an order to the orders API for the Burger menu item but omit the Lettuce and Tomato default modifiers in the request, the order ticket will include the Burger but not the Lettuce and Tomato modifier options.\\n\"},\"allowsDuplicates\":{\"type\":\"boolean\",\"description\":\"Indicates whether the modifier option may be added to a menu item multiple times.\\n\\nIf a modifier option belongs to a modifier group whose `isMultiSelect` value is FALSE, then the Toast POS system sets the modifier option’s `allowsDuplicates` value to FALSE to prevent more than one modifier option being selected for the group.\\n\"},\"portions\":{\"type\":\"array\",\"description\":\"An array of `Portion` objects that define the portions that this modifier option can be added to. For example, for a pizza menu item, you could define 1st Half and 2nd Half portions and this modifier option could be added to either portion. See <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPortionsOverview.html\\\">Portions overview</a> in the Toast Platform Guide for more information.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/Portion\"}},\"prepTime\":{\"type\":\"integer\",\"description\":\"The amount of time, in seconds, that it takes to prepare this modifier option. This value is null if a prep time has not been specified for the modifier option.<br>\\n<br>\\n*Related topics*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminFireByPrepTime.html\\\">Using prep times to automate item firing</a><br>\\n\",\"format\":\"int32\",\"nullable\":true},\"modifierGroupReferences\":{\"type\":\"array\",\"description\":\"An array of `referenceId`s for `ModifierGroup` objects. These objects define nested modifier groups contained in this modifier option. For example, you can have an entree that has a Sides modifier group that contains a Salad modifier option. The Salad modifier option has its own modifier group, Salad Dressing, that includes Ranch, Vinaigrette, and Blue Cheese modifier options. Salad Dressing is a nested modifier group and the individual salad dressings are nested modifier options.\\n\",\"minItems\":0,\"items\":{\"type\":\"integer\"}},\"length\":{\"$ref\":\"#/components/schemas/Length\"},\"height\":{\"$ref\":\"#/components/schemas/Height\"},\"width\":{\"$ref\":\"#/components/schemas/Width\"},\"dimensionUnitOfMeasure\":{\"$ref\":\"#/components/schemas/DimensionUnitOfMeasure\"},\"weight\":{\"$ref\":\"#/components/schemas/Weight\"},\"weightUnitOfMeasure\":{\"$ref\":\"#/components/schemas/WeightUnitOfMeasure\"},\"images\":{\"$ref\":\"#/components/schemas/Images\"},\"guestCount\":{\"$ref\":\"#/components/schemas/GuestCount\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"A number determining the order in which this modifier option should appear on kitchen tickets. The sort order value can be any positive or negative integer, or zero. This value is null if a sort order has not been configured for the modifier option.\\n\",\"nullable\":true},\"allergens\":{\"type\":\"array\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AllergenItem\"},\"nullable\":true}}},\"ModifierOptionTaxInfo\":{\"type\":\"object\",\"description\":\"Information about the tax rates and tax behavior of this modifier option.\\n\\n_Note:_ The `modifierOptionTaxInfo` value always reflects the parent menu item tax rate, unless Toast grants the restaurant the ability to override modifier tax rates. If this permission is not granted, then even if the restaurant configured the modifier with a different tax rate, `modifierOptionTaxInfo` reflects the parent menu item tax rate.\\n\\nNote that there are other tax-related features that can impact the tax of a modifier option, such as tax inclusion and smart tax, that are not returned in this `ModifierOptionTaxInfo` object. For more information, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminTaxesOnModifiers.html\\\">Tax on modifiers</a> and <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminTaxesOnModifiers.html#adminModifierTaxInteraction\\\">Tax functionality interaction</a>.\\n\\n_Important:_ The `ModifierOptionTaxInfo` object is intended to help you display prices but the `/prices` endpoint of the orders API is the only supported way to determine the prices of orders that you submit to the orders API. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiOrderPrices.html\\\">Order prices</a> in the Toast Developer Guide for more information.\\n\",\"properties\":{\"taxRateGuids\":{\"type\":\"array\",\"description\":\"An array of GUIDs for the tax rates that apply to this modifier option.\\n\\nThe `taxRateGuids` value includes different tax rate GUIDs, depending on whether the modifier option is configured in Toast Web to use its own tax rates or to inherit tax rates from a menu item it has been applied to. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUsingTaxInfoAndModifierOptionTaxInfoToCalculateTaxesForMenuItemsAndModOptions.html\\\">Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options</a> in the Toast Developer Guide for more information.\\n                   \\nTo retrieve full configuration data for a tax rate, use the `/taxRates/{guid}` endpoint in the configuration API.\\n\",\"items\":{\"type\":\"string\"}},\"overrideItemTaxRates\":{\"description\":\"Indicates whether the tax rates configured for this modifier option override the tax rates configured for a menu item that this modifier option has been applied to. For example, if the menu item is configured for a 6.25% tax rate and the modifier option is configured for a 2.75% tax rate, when that modifier option is applied to the menu item, both are taxed at the 2.75% tax rate.\\n\\nNote that the menu item's tax rate is overridden only if the modifier option is added to the menu item on a Toast POS device. The modifier option may be available to apply to the menu item, but if it is not actually added to the menu item on a Toast POS device, then the menu item's tax rate is not overridden. See <a href=\\\"https://doc.toasttab.com/doc/devguide/apiUsingTaxInfoAndModifierOptionTaxInfoToCalculateTaxesForMenuItemsAndModOptions.html\\\">Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options</a> in the Toast Developer Guide for more information.\\n\",\"type\":\"boolean\"}}},\"PreModifierGroup\":{\"type\":\"object\",\"description\":\"Information about a pre-modifier group configured for this restaurant, including an array of pre-modifiers contained in the group.\\n\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"A descriptive name for this pre-modifier group, for example, \\\"Sandwich Pre-mods\\\".\\n\"},\"guid\":{\"description\":\"A unique identifier for this pre-modifier group, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"preModifiers\":{\"description\":\"An array of `PreModifier` objects that are contained in this pre-modifier group. Pre-modifiers alter the display of modifier options on receipts and tickets to satisfy guest requests such as EXTRA or ON THE SIDE for modifier options. Pre-modifiers can also be configured to modify the cost of the modifier options they are applied to, for example, by charging more for an EXTRA serving of a modifier option.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PreModifier\"}}}},\"PreModifier\":{\"type\":\"object\",\"description\":\"Information about a pre-modifier configured for this restaurant.\\n\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"A descriptive name for this pre-modifier, for example, \\\"NO\\\" or \\\"EXTRA\\\".\\n\"},\"guid\":{\"description\":\"A unique identifier for this pre-modifier group, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"multiLocationId\":{\"$ref\":\"#/components/schemas/MultiLocationId\"},\"fixedPrice\":{\"description\":\"An optional fixed price for this pre-modifier. The fixed price is added to the cost of the modifier option that the pre-modifier is applied to.\\n\\nA PreModifier object has two optional values, `fixedPrice` and `multiplicationFactor`, that both alter the price of a modifier option when the pre-modifier is applied to it. However, these values cannot be used at the same time. If you specify a `fixedPrice` value for a premodifier, then `multiplicationFactor` is null. If you specify a `multiplicationFactor` for a pre-modifier, then `fixedPrice` is null. If you choose not to assign either a fixed price or a multiplication factor to a pre-modifier, then the `fixedPrice` value is 0 and the `multiplicationFactor` is null.\\n\",\"type\":\"number\",\"format\":\"double\",\"nullable\":true},\"multiplicationFactor\":{\"description\":\"An optional number that specifies how much the cost of a modifier option is multiplied by when this pre-modifier is applied to it. For example, an EXTRA pre-modifier option could specify a `multiplicationFactor` of 1.5 to indicate that adding extra cheese to a menu item costs one and a half times the regular price of the cheese modifier option.\\n\\nA PreModifier object has two optional values, `fixedPrice` and `multiplicationFactor`, that both alter the price of a modifier option when the pre-modifier is applied to it. However, these values cannot be used at the same time. If you specify a `fixedPrice` value for a premodifier, then `multiplicationFactor` is null. If you specify a `multiplicationFactor` for a premodifier, then `fixedPrice` is null. If you choose not to assign either a fixed price or a multiplication factor to a pre-modifier, then the `fixedPrice` value is 0 and the `multiplicationFactor` is null.\\n\",\"type\":\"number\",\"format\":\"double\",\"nullable\":true},\"displayMode\":{\"description\":\"A string that indicates how the pre-modifier is displayed on tickets and receipts:\\n  * PREFIX: The pre-modifier name is placed before the modifier option name, for example, \\\"EXTRA Cheese\\\".\\n  * SUFFIX: The pre-modifier name is placed after the modifier option name, for example, \\\"Cheese EXTRA\\\".\\n\",\"type\":\"string\",\"enum\":[\"PREFIX\",\"SUFFIX\"]},\"posName\":{\"$ref\":\"#/components/schemas/PosName\"},\"posButtonColorLight\":{\"$ref\":\"#/components/schemas/PosButtonColorLight\"},\"posButtonColorDark\":{\"$ref\":\"#/components/schemas/PosButtonColorDark\"},\"chargeAsExtra\":{\"type\":\"boolean\",\"description\":\"When true, selecting this pre-modifier adds an additional portion of the modifier to the menu item and adds the price of the additional portion to the menu item according to the rules listed below.\\n\\nIf the modifier group that the modifier belongs to:\\n* Uses the **No charge** option, the Toast platform uses the modifier's <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminBasingModifierOptionsOnExistingMenuItems\\\">override price</a> or, if no override price exists, the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> price as the price of the additional portion.\\n* Uses the **Individual** option where each modifier has its own price, the Toast platform uses the modifier's override price or, if no override price exists, the item reference price as the price of the additional portion.\\n* Uses the **Group** option where all modifiers in the group share a price, the Toast platform uses the group price as the price of the additional portion.\\n\\nAdditionally, if the modifier group that the modifier belongs to uses:\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSizePrice.html#adminSizePricingForModifierGroups\\\">Size</a> pricing, the Toast platform uses the size price that matches the size of the menu item when determining the price of the additional portion.\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSequencePrice.html\\\">Sequence</a> pricing, the Toast platform treats the additional portion as the next modifier in the sequence and prices it using the sequence pricing rules that have been specified.\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSizeSequencePrice.html\\\">Size/sequence</a> pricing, the Toast platform matches the size of the additional portion to the size of the menu item and then treats it as the next modifier in the sequence when determining the price of the additional portion.\\n\\nThe `chargeAsExtra` value is `null` if it has not been set.\\n\",\"nullable\":true},\"plu\":{\"type\":\"string\",\"description\":\"The price lookup (PLU) code for this pre-modifier. The PLU code can contain both numbers and letters. This value contains an empty string if a PLU code has not been defined.\\n\"}}},\"SalesCategory\":{\"type\":\"object\",\"description\":\"A descriptive category, for example, \\\"Food\\\" or \\\"Liquor\\\" that, when applied to the menu items and modifier options in your menu, allow you to view sales data by category. Null if no sales category has been defined.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this sales category, for example, \\\"Food\\\" or \\\"Liquor\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this sales category, assigned by the Toast POS system.\\n\",\"type\":\"string\"}}},\"ItemTag\":{\"type\":\"object\",\"description\":\"A descriptive term that identifies a characteristic of a menu item or menu group, for example, vegetarian, gluten-free, or alcohol.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this item tag, for example, \\\"Vegetarian\\\" or \\\"Alcohol\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this item tag category, assigned by the Toast POS system.\\n\",\"type\":\"string\"}}},\"ContentAdvisories\":{\"type\":\"object\",\"description\":\"Information about the contents of this menu item or modifier, for example, whether it contains alcohol.\\n\",\"properties\":{\"alcohol\":{\"$ref\":\"#/components/schemas/Alcohol\"}}},\"AllergenItem\":{\"type\":\"object\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"properties\":{\"guid\":{\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"type\":\"string\",\"format\":\"uuid\"},\"code\":{\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"type\":\"string\"},\"groupGuid\":{\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"groupCode\":{\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"type\":\"string\",\"nullable\":true},\"presenceType\":{\"type\":\"string\",\"description\":\"Reserved for future functionality. Not currently supported for external integrations.\\n\",\"enum\":[\"CONTAINS\",\"TRACES\"],\"nullable\":true}}},\"Alcohol\":{\"type\":\"object\",\"description\":\"Information about whether this menu item or modifier contains alcohol and may require, \\nor benefit from, additional handling. For example, a delivery partner may need \\nto identify a menu item or modifier as containing alcohol to ensure that delivery drivers\\nrequest identification before giving it to a customer.\\n\",\"properties\":{\"containsAlcohol\":{\"type\":\"string\",\"description\":\"A string that indicates whether the menu item or modifier contains alcohol. Possible values \\ninclude:\\n\\n* `YES`: The menu item or modifier contains alcohol.\\n* `NO`: The menu item or modifier does not contain alcohol.\\n     \\nThe `containsAlcohol` value may also be `null`. A `null` value indicates that the corresponding UI option in Toast Web has not been configured for this menu item or modifier.\\n\",\"enum\":[\"YES\",\"NO\"]}}},\"Portion\":{\"type\":\"object\",\"description\":\"A container for the modifier groups that can be applied to a portion of a menu item.\\n\",\"properties\":{\"name\":{\"description\":\"A descriptive name for this portion, for example, \\\"1st Half\\\" or \\\"2nd Half\\\".\\n\",\"type\":\"string\"},\"guid\":{\"description\":\"A unique identifier for this portion, assigned by the Toast POS system.\\n\",\"type\":\"string\"},\"modifierGroupReferences\":{\"type\":\"array\",\"description\":\"An array of `referenceId`s for `ModifierGroup` objects. These objects define the modifier groups that can be applied to this portion.\\n\",\"minItems\":0,\"items\":{\"type\":\"integer\"}},\"priceScaleFactor\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"A multiplier that adjusts the cost of modifiers in this portion.\\n\",\"nullable\":true}}},\"Availability\":{\"type\":\"object\",\"description\":\"Information about when a menu is available for use.\\n\",\"properties\":{\"alwaysAvailable\":{\"type\":\"boolean\",\"description\":\"Indicates whether this menu is available 24 hours per day, 7 days a week. If `alwaysAvailable` is FALSE, then a `schedule` value is included in the `Availability` object to define the specific times and days a menu is available. If `alwaysAvailable` is TRUE, then the `schedule` value is omitted. \\n\"},\"schedule\":{\"type\":\"array\",\"description\":\"An array of `Schedule` objects that indicate the specific days and times a menu is available. If `alwaysAvailable` is TRUE, then the menu is available 24 hours per day, 7 days per week, and this `schedule` value is omitted from the `Availabilty` object.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Schedule\"}}}},\"Schedule\":{\"type\":\"object\",\"description\":\"A multi-use object that is used to:\\n\\n* Define when a menu is available.\\n* Define when a time-specific price is available for a menu item or modifier option.\\n\\nA `Schedule` object defines a set of days of the week and a set of time ranges for those days. Days that have identical time ranges are grouped into a single `Schedule` object, for example, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, and FRIDAY in the example below have identical time ranges and are in the same `Schedule` object while SATURDAY and SUNDAY are in a separate `Schedule` object because their time ranges differ from the weekday time ranges.\\n\\n```\\n\\\"availability\\\": {\\n  \\\"alwaysAvailable\\\": false,\\n  \\\"schedule\\\": [\\n    {\\n      \\\"days\\\": [\\n        \\\"MONDAY\\\", \\n        \\\"TUESDAY\\\", \\n        \\\"WEDNESDAY\\\", \\n        \\\"THURSDAY\\\"\\n      ],\\n      \\\"timeRanges\\\": [\\n        {\\n          \\\"start\\\": \\\"09:00\\\",\\n          \\\"end\\\": \\\"18:00\\\"\\n        }\\n      ]\\n    },\\n    {\\n      \\\"days\\\": [\\n        \\\"FRIDAY\\\", \\n        \\\"SATURDAY\\\"\\n      ],\\n      \\\"timeRanges\\\": [\\n        {\\n          \\\"start\\\": \\\"09:00\\\",\\n          \\\"end\\\": \\\"18:00\\\"\\n        },\\n        {\\n          \\\"start\\\": \\\"20:00\\\",\\n          \\\"end\\\": \\\"23:00\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\\n```\\n\\nTime ranges are in 24-hour HH:MM format.\\n\\nIf a day is not represented in the `Schedule` objects, the menu or time-specific price is not available on that day.      \\n\",\"properties\":{\"days\":{\"type\":\"array\",\"description\":\"An array of days of the week that are associated with identical time ranges. The time ranges are defined in a corresponding `timeRanges` value. Names of the days are in upper case, for example, MONDAY.\\n\",\"items\":{\"type\":\"string\",\"description\":\"A day of the week, for example, SUNDAY or THURSDAY.\",\"enum\":[\"SUNDAY\",\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\"]}},\"timeRanges\":{\"type\":\"array\",\"description\":\"An array of `TimeRange` objects that define the time ranges that a menu or a time-specific price is available on the days defined by the corresponding `days` value. A `TimeRange` object contains a `start` time and an `end` time, expressed in the restaurant’s local time. If both the `start` and `end` times for a given day are 00:00, it indicates that the menu or the time-specific price is available 24 hours on the associated days. Time ranges may also run overnight, for example, a time range that starts at \\\"07:00\\\" and ends at \\\"03:00\\\" runs from 7am until 3am the next day. \\n\",\"items\":{\"$ref\":\"#/components/schemas/TimeRange\"}}}},\"TimeRange\":{\"type\":\"object\",\"description\":\"Represents a time range for when a menu or a time-specific price is available.\\n\",\"properties\":{\"start\":{\"type\":\"string\",\"description\":\"The start time of the time range. Expressed in the restaurant’s local time.\\n\"},\"end\":{\"type\":\"string\",\"description\":\"The end time of the time range. Expressed in the restaurant’s local time.\\n\"}}},\"PricingRules\":{\"type\":\"object\",\"description\":\"The PricingRules object is a multi-use object that provides pricing rules for:\\n  * A menu item or modifier option <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> that uses the Time Specific Price or Size Price pricing strategy.\\n  * A modifier group that uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy.\\n\",\"properties\":{\"timeSpecificPricingRules\":{\"description\":\"An array of `TimeSpecificPrice` objects that define the time-specific prices for a menu item or modifier option <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> that uses the Time Specific Price pricing strategy. If the menu item or modifier option item reference does not use time-specific prices, this array is empty.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TimeSpecificPrice\"}},\"sizeSpecificPricingGuid\":{\"description\":\"The GUID of a Size modifier group that defines sizes and prices for a menu item or a modifier option <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> that uses the Size Price pricing strategy.\\n\\nIf the menu item or modifier option item reference does not use the Size Price pricing strategy, then `sizeSpecificPricingGuid` is null.\\n\\nThe Toast POS system automatically creates a Size modifier group when you choose the Size Price pricing strategy for a menu item or modifier option item reference and stores the sizes and prices you specify in it. You use the `sizeSpecificPricingGuid` value to locate the correct Size modifier group to use when pricing a menu item or modifier option item reference that uses size pricing. In the JSON fragment below, you can see that the Cheese Pizza menu item uses the SIZE_PRICE pricing strategy and the Size modifier group where the sizes and prices for Cheese Pizza are defined has a GUID that ends in `31b0`.\\n\\n```\\n{\\n  \\\"restaurantGuid\\\": \\\"2071fb81-988b-4d75-b8dc-c5c17cff9706\\\",\\n  ...\\n  \\\"menus\\\": [\\n    {\\n      \\\"name\\\": \\\"Dinner\\\",\\n      \\\"guid\\\": \\\"ddd681de-3c12-4d45-b8b1-a5b2ea898210\\\",\\n      ...\\n      \\\"menuGroups\\\": [\\n        {\\n          \\\"name\\\": \\\"Pizza\\\",\\n          \\\"guid\\\": \\\"dc868006-919a-4950-a4cc-3a03f9770fd7\\\",\\n          ...\\n          \\\"menuItems\\\": [\\n            {\\n              \\\"name\\\": \\\"Cheese Pizza\\\",\\n              \\\"guid\\\": \\\"95c5d500-8d92-46f2-bec4-fb2a42a46621\\\",\\n              ...\\n              \\\"price\\\": null,\\n              \\\"pricingStrategy\\\": \\\"SIZE_PRICE\\\",\\n              \\\"pricingRules\\\": {\\n                \\\"timeSpecificPricingRules\\\": [],\\n                \\\"sizeSpecificPricingGuid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n                \\\"sizeSequencePricingRules\\\": []\\n              },\\n              ...\\n              \\\"modifierGroupReferences\\\": [\\n                2,\\n                6,\\n                ...\\n              ],\\n              ...\\n            }\\n          ]\\n        }\\n      ]\\n    }\\n  ],\\n  \\\"modifierGroupReferences\\\": {\\n    ...\\n    \\\"2\\\": {\\n      \\\"referenceId\\\": 2,\\n      \\\"name\\\": \\\"Size\\\",\\n      \\\"guid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n      ...\\n      \\\"pricingStrategy\\\": \\\"NONE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierOptionReferences\\\": [\\n        12,\\n        13\\n      ],\\n      ...\\n    },\\n    ...\\n  },\\n  \\\"modifierOptionReferences\\\": {\\n    ...\\n    \\\"12\\\": {\\n      \\\"referenceId\\\": 12,\\n      \\\"name\\\": \\\"Small\\\",\\n      \\\"guid\\\": \\\"352244f2-a952-4a3a-a3ae-7775fa221ce7\\\",\\n      ...\\n      \\\"price\\\": 8.0,\\n      \\\"pricingStrategy\\\": \\\"BASE_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    \\\"13\\\": {\\n      \\\"referenceId\\\": 13,\\n      \\\"name\\\": \\\"Large\\\",\\n      \\\"guid\\\": \\\"4ff89bca-b448-4892-bc4c-62c37a28ac44\\\",\\n      ...\\n      \\\"price\\\": 10.0,\\n      \\\"pricingStrategy\\\": \\\"BASE_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    }\\n    ...\\n  }\\n}\\n```\\n\\n\\nWhen the `PricingRules` object appears in the context of a modifier group, the `sizeSpecificPricingGuid` value it contains is also used to find matching sizes between menu items and any modifier options that use the Size Price or Size/Sequence Pricing pricing strategies (for example, toppings on a small pizza cost $1 while toppings on a large pizza cost $2). In this scenario, the Toast POS system locates the modifier option size that matches the menu item size and uses the price defined for that size of the modifier option. The sizes for the menu item are defined in the Size modifier group specified by the `sizeSpecificPricingGuid` value. The sizes for the modifier options are defined in objects contained in the `sizeSequencePricingRules` array that is contained in the modifier group's `PricingRules` object. Sizes are considered matching when their names are identical. See “Pricing Strategies” in the Toast Administrator’s Guide (https://doc.toasttab.com/0IV1p/adminPricingStrategies.html) for detailed information on the Size Price and Size/Sequence Price pricing strategies.\\n\\nIn the example below, the Cheese Pizza menu item and the Toppings modifier group use the SIZE_PRICE pricing strategy. The menu item sizes and prices are defined in the Size modifier group with a GUID ending in `31b0`. The sizes and prices for the modifier options are defined in the `sizeSequencePricingRules` value that is a child of the Toppings modifier group.\\n\\n```\\n{\\n  \\\"restaurantGuid\\\": \\\"2071fb81-988b-4d75-b8dc-c5c17cff9706\\\",\\n  ...\\n  \\\"menus\\\": [\\n    {\\n      \\\"name\\\": \\\"Dinner\\\",\\n      \\\"guid\\\": \\\"ddd681de-3c12-4d45-b8b1-a5b2ea898210\\\",\\n      ...\\n      \\\"menuGroups\\\": [\\n        {\\n          \\\"name\\\": \\\"Pizza\\\",\\n          \\\"guid\\\": \\\"dc868006-919a-4950-a4cc-3a03f9770fd7\\\",\\n          ...\\n          \\\"menuItems\\\": [\\n            {\\n              \\\"name\\\": \\\"Cheese Pizza\\\",\\n              \\\"guid\\\": \\\"95c5d500-8d92-46f2-bec4-fb2a42a46621\\\",\\n              ...\\n              \\\"price\\\": null,\\n              \\\"pricingStrategy\\\": \\\"SIZE_PRICE\\\",\\n              \\\"pricingRules\\\": {\\n                \\\"timeSpecificPricingRules\\\": [],\\n                \\\"sizeSpecificPricingGuid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n                \\\"sizeSequencePricingRules\\\": []\\n              },\\n              ...\\n              \\\"modifierGroupReferences\\\": [\\n                2,\\n                3,\\n                ...\\n              ],\\n              ...\\n            }\\n          ]\\n        }\\n      ]\\n    }\\n  ],\\n  \\\"modifierGroupReferences\\\": {\\n    ...\\n    \\\"2\\\": {\\n      \\\"referenceId\\\": 2,\\n      \\\"name\\\": \\\"Size\\\",\\n      \\\"guid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n      ...\\n      \\\"pricingStrategy\\\": \\\"NONE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierOptionReferences\\\": [\\n        12,\\n        13\\n      ],\\n      ...\\n    },\\n    \\\"3\\\": {\\n      \\\"referenceId\\\": 3,\\n      \\\"name\\\": \\\"Toppings\\\",\\n      \\\"guid\\\": \\\"58b79986-f88f-411d-ba18-14b1e2441e9d\\\",\\n      ...\\n      \\\"pricingStrategy\\\": \\\"SIZE_PRICE\\\",\\n      \\\"pricingRules\\\": {\\n        \\\"timeSpecificPricingRules\\\": [],\\n        \\\"sizeSpecificPricingGuid\\\": \\\"23c02762-9d6a-4d3f-a298-71c989bf31b0\\\",\\n        \\\"sizeSequencePricingRules\\\": [\\n          {\\n            \\\"sizeName\\\": \\\"Small\\\",\\n            \\\"sizeGuid\\\": \\\"352244f2-a952-4a3a-a3ae-7775fa221ce7\\\",\\n            \\\"sequencePrices\\\": [\\n              {\\n                \\\"sequence\\\": 1,\\n                \\\"price\\\": 2.0\\n              }\\n            ]\\n          },\\n          {\\n            \\\"sizeName\\\": \\\"Large\\\",\\n            \\\"sizeGuid\\\": \\\"4ff89bca-b448-4892-bc4c-62c37a28ac44\\\",\\n            \\\"sequencePrices\\\": [\\n              {\\n                \\\"sequence\\\": 1,\\n                \\\"price\\\": 4.0\\n              }\\n            ]\\n          }\\n        ]\\n      },\\n      ...\\n      \\\"modifierOptionReferences\\\": [\\n        10,\\n        11\\n      ],\\n      ...\\n    },\\n    ...\\n  },\\n  \\\"modifierOptionReferences\\\": {\\n    ...\\n    \\\"10\\\": {\\n      \\\"referenceId\\\": 10,\\n      \\\"name\\\": \\\"Mushrooms\\\",\\n      \\\"guid\\\": \\\"fa24fee9-76c4-40ba-ae3c-7dfccafdd8d3\\\",\\n      ...\\n      \\\"price\\\": null,\\n      \\\"pricingStrategy\\\": \\\"GROUP_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    \\\"11\\\": {\\n      \\\"referenceId\\\": 11,\\n      \\\"name\\\": \\\"Onions\\\",\\n      \\\"guid\\\": \\\"afee6be7-8280-4c69-a170-9fdf4c76bf7b\\\",\\n      ...\\n      \\\"price\\\": null,\\n      \\\"pricingStrategy\\\": \\\"GROUP_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    \\\"12\\\": {\\n      \\\"referenceId\\\": 12,\\n      \\\"name\\\": \\\"Small\\\",\\n      \\\"guid\\\": \\\"352244f2-a952-4a3a-a3ae-7775fa221ce7\\\",\\n      ...\\n      \\\"price\\\": 8.0,\\n      \\\"pricingStrategy\\\": \\\"BASE_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    \\\"13\\\": {\\n      \\\"referenceId\\\": 13,\\n      \\\"name\\\": \\\"Large\\\",\\n      \\\"guid\\\": \\\"4ff89bca-b448-4892-bc4c-62c37a28ac44\\\",\\n      ...\\n      \\\"price\\\": 10.0,\\n      \\\"pricingStrategy\\\": \\\"BASE_PRICE\\\",\\n      \\\"pricingRules\\\": null,\\n      ...\\n      \\\"modifierGroupReferences\\\": []\\n    },\\n    ...\\n  }\\n}  \\n```     \\n\",\"type\":\"string\",\"nullable\":true},\"sizeSequencePricingRules\":{\"type\":\"array\",\"description\":\"An array of `SizeSequencePricingRule` objects that define the prices for the modifier options in a modifier group that uses the Size Price, Sequence Price, or Size/Sequence Pricing pricing strategy. If the modifier group does not use one of these pricing strategies, this array is empty.\\n\",\"items\":{\"$ref\":\"#/components/schemas/SizeSequencePricingRule\"}}}},\"TimeSpecificPrice\":{\"type\":\"object\",\"description\":\"Represents the pricing rules for a menu item that uses a time-specific price.\\n\",\"properties\":{\"timeSpecificPrice\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The price of the menu item during the periods of time defined by the associated `schedule` array.\\n\"},\"basePrice\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The base price of the menu item, used for time periods when a time-specific price has not been defined.\\n\"},\"schedule\":{\"type\":\"array\",\"description\":\"An array of `Schedule` objects that indicate the specific days and times that a time-specific price is available.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Schedule\"}}}},\"SizeSequencePricingRule\":{\"type\":\"object\",\"description\":\"A multi-use object that defines the pricing rules for modifier options that belong to a modifier group that uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy. The contents of this object depend on the pricing strategy that is in effect.\\n\",\"properties\":{\"sizeName\":{\"type\":\"string\",\"description\":\"A string that represents the size of a modifier option in this modifier group, for example, Small, Medium, or Large.\\n\\nWith Size Price and the Size/Sequence Price pricing strategies, the price of a modifier option changes based on the size of the menu item it is applied to, for example, a topping costs $1 on a small pizza and $2 on a large pizza. To determine which size and size-based price to use for a modifier option, the Toast POS system matches the size name of the modifier option to the size name of the menu item. For example, the Small size of a modifier option would match the Small size of a menu item. The `sizeName` value of the `SizeSequencePricingRule` object represents the modifier option size while the `sizeGuid` value represents the matching menu item size.\\n\\nThe Toast POS system does allow a configuration where the size of the modifier option is specified independently from the size of the menu item it applies to. In this scenario, you could order a Large menu item and apply a Small size of the modifier option to it. This configuration is unusual but the menus API supports it. When this configuration is in use, the `sizeName` value is populated with the modifier option size but the `sizeGuid` value that represents the menu item size will be null because there is no matching menu item size.\\n\\nThe `sizeName` value is null if the modifier group uses the Sequence Price pricing strategy because this strategy does not use sizes.\\n\\nSee the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingStrategiesOverview.html\\\">Pricing strategies</a> section in the Toast Platform Guide for information on the Size Price, Sequence Price, and Size/Sequence Price pricing strategies.\\n\",\"nullable\":true},\"sizeGuid\":{\"type\":\"string\",\"description\":\"The GUID of the modifier option where a menu item size has been defined that matches the `sizeName` value. For example, if a menu item has Small and Large sizes, those sizes are represented in a Size modifier group with a Small modifier option and a Large modifier option. It is the GUID of one of those size modifier options that appears in this value. If the `sizeName` value is Small, then the `sizeGuid` value would contain the Small modifier option’s GUID.\\n\\nWith Size Price and the Size/Sequence Price pricing strategies, the price of a modifier option changes based on the size of the menu item it is applied to, for example, a topping costs $1 on a small pizza and $2 on a large pizza. To determine which size and size-based price to use for a modifier option, the Toast POS system matches the size name of the modifier option to the size name of the menu item. For example, the Small size of a modifier option would match the Small size of a menu item. The `sizeName` value represents the modifier option size while the `sizeGuid` value represents the matching menu item size.\\n\\nThe Toast POS system does allow a configuration where the size of the modifier option is specified independently from the size of the menu item it applies to. In this scenario, you could order a Large menu item and apply a Small size of the modifier option to it. This configuration is unusual but the menus API supports it. When this configuration is in use, the `sizeName` value is populated with the modifier option size but there is no corresponding `sizeGuid` for the menu item size.\\n\\nThe `sizeGuid` value is null if the modifier group uses the Sequence Price pricing strategy because this strategy does not use sizes.\\n\\nSee the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingStrategiesOverview.html\\\">Pricing strategies</a> section in the Toast Platform Guide for information on the Size Price, Sequence Price, and Size/Sequence Price pricing strategies.\\n\",\"nullable\":true},\"sequencePrices\":{\"type\":\"array\",\"description\":\"An array of `SequencePrices` objects that define the size, sequence, or size/sequence prices for the modifier options in this modifier group.\\n\\nBecause they are multi use objects, the `SequencePrices` objects always contain `sequence` and `price` values for all three pricing strategies. However, the `sequence` is always 1 for the Size Price pricing strategy because only one price is defined per size for that strategy. For example, the `sequencePrices` value for a modifier group priced using the Size Price pricing strategy looks similar to the following:\\n```\\n\\\"sizeSequencePricingRules\\\": [\\n      {\\n        \\\"sizeName\\\": \\\"Small\\\",\\n        \\\"sizeGuid\\\": \\\"e02d1a57-5f9f-4800-a8c3-a5fe1a0b029b\\\",\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 2\\n          }\\n        ]\\n      },\\n      {\\n        \\\"sizeName\\\": \\\"Large\\\",\\n        \\\"sizeGuid\\\": \\\"0e206b2d-72ab-46d1-b273-a5425cbef9a5\\\",\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 4\\n          }\\n        ]\\n      }\\n    ]\\n```             \\n\\nThe modifier options in this group cost $2.00 for the Small size and $4.00 for the Large size.\\n\\nThe `sequencePrices` value for a modifier group priced using the Sequence Price pricing strategy looks like this:\\n```\\n\\\"sizeSequencePricingRules\\\": [\\n      {\\n        \\\"sizeName\\\": null,\\n        \\\"sizeGuid\\\": null,\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 1\\n          },\\n          {\\n            \\\"sequence\\\": 2,\\n            \\\"price\\\": 2\\n          },\\n          {\\n            \\\"sequence\\\": 3,\\n            \\\"price\\\": 2.5\\n          }\\n        ]\\n      }\\n    ]\\n```\\n\\nThe first modifier option in this group costs $1.00, the second modifier option costs $2.00, and any additional modifier options from this group costs $2.50.\\n\\nThe `sequencePrices` value for a modifier group using the Size/Sequence Price pricing strategy looks like this:\\n```\\n\\\"sizeSequencePricingRules\\\": [\\n      {\\n        \\\"sizeName\\\": \\\"Small\\\",\\n        \\\"sizeGuid\\\": \\\"e02d1a57-5f9f-4800-a8c3-a5fe1a0b029b\\\",\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 1\\n          },\\n          {\\n            \\\"sequence\\\": 2,\\n            \\\"price\\\": 2\\n          }\\n        ]\\n      },\\n      {\\n        \\\"sizeName\\\": \\\"Large\\\",\\n        \\\"sizeGuid\\\": \\\"0e206b2d-72ab-46d1-b273-a5425cbef9a5\\\",\\n        \\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 3\\n          },\\n          {\\n            \\\"sequence\\\": 2,\\n            \\\"price\\\": 4\\n          }\\n        ]\\n      }\\n    ]\\n```\\n\\nThe first modifier option on a Small menu item costs $1.00 and additional modifier options on a Small cost $2.00, while the first modifier option on a Large menu item costs $3.00 and additional modifier options on a Large cost $4.00.\\n\",\"items\":{\"$ref\":\"#/components/schemas/SequencePrice\"}}}},\"SequencePrice\":{\"type\":\"object\",\"description\":\"Defines the size, sequence, or size/sequence prices for modifier options contained in a modifier group that uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy.\\n\",\"properties\":{\"sequence\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Specifies the order of the prices.\\n\\nFor modifier groups that use the Size Price pricing strategy, the `sequence` is always 1 because only one price is defined per size for that strategy.\\n\\nFor modifier groups that use the Sequence Price or Size/Sequence Price pricing strategy, this value starts at 1 and increases with each successive price in the sequence. For example, in the JSON snippet below, `\\\"sequence\\\":1` defines the first price in the sequence and `\\\"sequence\\\":2` defines the second price in the sequence.\\n```\\n\\\"sequencePrices\\\": [\\n          {\\n            \\\"sequence\\\": 1,\\n            \\\"price\\\": 3\\n          },\\n          {\\n            \\\"sequence\\\": 2,\\n            \\\"price\\\": 4\\n          }\\n        ]\\n```\\n\"},\"price\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The price for a modifier option when it is ordered at the specified point in the sequence.\\n\"}}},\"Image\":{\"type\":\"string\",\"description\":\"The URL to an image that has been uploaded for this menu entity. This value is null if no image has been specified.\\n\",\"nullable\":true},\"MultiLocationId\":{\"type\":\"string\",\"description\":\"An identifier that is used to identify and consolidate menu entities that are versions of each other.\\n\\n`multiLocationId` replaces `masterId`. `multiLocationId` and `masterId` always have the same value.\\n\\nMenu entities can be versioned. Those versions can be assigned to specific restaurant locations, or groups of locations, in a management group. For example, you could have two versions of a burger, one for a Boston location and another for a New York City location. Versioned menu entities share the majority of, but not all of, their data. For example, the Boston version is called the Minuteman Burger and has pickles, while the New York City version is called the Empire Burger and does not.\\n\\nYou use the `multiLocationId` to identify menu entities that are versions of each other. To continue the example above, the Minuteman Burger in the JSON returned for the Boston location has the same `multilocationId` as the Empire Burger in the JSON returned for the New York City location. These matching `multlocationId` values indicate that the two items are related versions of the same item. In Toast reports, this allows a restaurant to track sales of the burger across both locations.\\n\\nThe Toast POS system ensures that once a `multilocationId` value is assigned to a set of versions within a management group, that `multiLocationId` is not used for any other version sets in the same management group. It does not guarantee, however, that the `multiLocationId` is not used by another management group to identify a set of versions within it.\\n\\nSee <a href=\\\"https://doc.toasttab.com/doc/devguide/portalToastIdentifiers.html\\\">Toast identifiers</a> in the Toast Developer Guide for more information on the `multiLocationId` and its relationship to other Toast identifiers.\\n\\nSee <a href=\\\"https://doc.toasttab.com/doc/platformguide/sharingMenusAndOtherInformationAmongRestaurants.html\\\">Enterprise module overview</a> in the Toast Platform Guide for more information on the enterprise module and versioning.\\n\"},\"MasterId\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"This value is deprecated. Instead of `masterId`, use `multiLocationId`.\\n\\nAn identifier that is used to identify and consolidate menu entities that are versions of each other.\\n\"},\"PosName\":{\"type\":\"string\",\"description\":\"The button label name that appears for this menu entity in the Toast POS app. `posName` contains an empty string if a `posName` has not been defined for the menu entity and the `name` value is used for the button label instead.\\n\"},\"PosButtonColorLight\":{\"type\":\"string\",\"description\":\"The color of the menu entity's button on the Toast POS app, when the app is running in light mode.\\n     \\nWhen an employee configures a POS button's color, they select a color pairing that consists of two colors, one for light mode and one for dark mode. `posButtonColorLight` contains the HEX code for the light mode color.\\n\\n`posButtonColorLight` defaults to `#f7f7f7`, the HEX code when the `WHITE` color pairing is chosen.\\n\\nThe following list shows the possible HEX codes for `posButtonColorLight`, with the associated color pairing in parentheses.\\n\\n* #f7f7f7 (WHITE)\\n* #ffe6e9 (TERRACOTTA_1)\\n* #efa49f (TERRACOTTA_2)\\n* #f07166 (TERRACOTTA_3)\\n* #e45a4e (TERRACOTTA_4)\\n* #fbd9b6 (ORANGE_1)\\n* #f7be6e (ORANGE_2)\\n* #f98c1f (ORANGE_3)\\n* #e56f1a (ORANGE_4)    \\n* #fbf5b6 (YELLOW_1)\\n* #fed850 (YELLOW_2)\\n* #e9b10c (YELLOW_3)\\n* #c78605 (YELLOW_4)      \\n* #e8f7d4 (GRASS_1)\\n* #afe26c (GRASS_2)\\n* #71b314 (GRASS_3)\\n* #32a206 (GRASS_4)      \\n* #e3f0fb (SKY_1)\\n* #9fc5f0 (SKY_2)\\n* #77a5e4 (SKY_3)\\n* #558edd (SKY_4)      \\n* #f1e3fd (LAVENDER_1)\\n* #dab2f7 (LAVENDER_2)\\n* #b26ee2 (LAVENDER_3)\\n* #a270db (LAVENDER_4)      \\n* #d0d0d0 (GRAY_1)\\n* #c3c3c3 (GRAY_2)\\n* #b1b1b1 (GRAY_3)\\n* #989898 (GRAY_4)\\n\"},\"PosButtonColorDark\":{\"type\":\"string\",\"description\":\"The color of the menu entity's button on the Toast POS app, when the app is running in dark mode.\\n     \\nWhen an employee configures a POS button's color, they select a color pairing that consists of two colors, one for light mode and one for dark mode. `posButtonColorDark` contains the HEX code for the dark mode color.\\n\\n`posButtonColorDark` defaults to `#1a1c23`, the HEX code when the `WHITE` color pairing is chosen.\\n\\nThe following list shows the possible HEX codes for `posButtonColorDark`, with the associated color pairing in parentheses.\\n\\n* #1a1c23 (WHITE)\\n* #7e635d (TERRACOTTA_1)\\n* #74504D (TERRACOTTA_2)\\n* #722e25 (TERRACOTTA_3)\\n* #561408 (TERRACOTTA_4)\\n* #8f5f3d (ORANGE_1)\\n* #7e4116 (ORANGE_2)\\n* #803500 (ORANGE_3)\\n* #682d03 (ORANGE_4)    \\n* #7e6b44 (YELLOW_1)\\n* #7b5f27 (YELLOW_2)\\n* #7c5000 (YELLOW_3)\\n* #633d09 (YELLOW_4)      \\n* #657552 (GRASS_1)\\n* #556e34 (GRASS_2)\\n* #37570a (GRASS_3)\\n* #113a00 (GRASS_4)      \\n* #637486 (SKY_1)\\n* #4d6074 (SKY_2)\\n* #2a456b (SKY_3)\\n* #213554 (SKY_4)      \\n* #78668a (LAVENDER_1)\\n* #5e4776 (LAVENDER_2)\\n* #402960 (LAVENDER_3)\\n* #25174f (LAVENDER_4)      \\n* #6c6c6c (GRAY_1)\\n* #5f5f5f (GRAY_2)\\n* #474747 (GRAY_3)\\n* #404040 (GRAY_4)\\n\"},\"Length\":{\"type\":\"number\",\"description\":\"The length of the item or modifier. Use the `dimensionUnitOfMeasure` value to determine the unit of measurement.\\n\\nThe `length` value is `null` if no length is specified for the item or modifier.\\n\\nYou can use the `length`, `height`, and `width` values to determine the overall size of the item or modifier. This information is useful, for example, when determining shipping costs or choosing the size of delivery vehicle to use.\\n\",\"format\":\"float\",\"nullable\":true},\"Height\":{\"type\":\"number\",\"description\":\"The height of the item or modifier. Use the `dimensionUnitOfMeasure` value to determine the unit of measurement.\\n\\nThe `height` value is `null` if no height is specified for the item or modifier.\\n\\nYou can use the `length`, `height`, and `width` values to determine the overall size of the item or modifier. This information is useful, for example, when determining shipping costs or choosing the size of delivery vehicle to use.\\n\",\"format\":\"float\",\"nullable\":true},\"Width\":{\"type\":\"number\",\"description\":\"The width of the item or modifier. Use the `dimensionUnitOfMeasure` value to determine the unit of measurement.\\n\\nThe `width` value is `null` if no width is specified for the item or modifier.\\n\\nYou can use the `length`, `height`, and `width` values to determine the overall size of the item or modifier. This information is useful, for example, when determining shipping costs or choosing the size of delivery vehicle to use.\\n\",\"format\":\"float\",\"nullable\":true},\"DimensionUnitOfMeasure\":{\"type\":\"string\",\"enum\":[\"IN\",\"CM\",\"FT\",\"M\",\"MM\",\"YD\"],\"description\":\"The unit of measure assigned to the `length`, `height`, and `width` values.\\n    \\nPossible values include:\\n    \\n* IN: Inches\\n* CM: Centimeters\\n* FT: Feet\\n* M: Meters\\n* MM: Millimeters\\n* YD: Yards\\n    \\n`dimensionUnitOfMeasure` is `null` if no unit of measurement has been specified.\\n\",\"nullable\":true},\"Weight\":{\"type\":\"number\",\"description\":\"The weight of the item or modifier. Use the `weightUnitOfMeasure` value to determine the unit of measurement.\\n\\nTh `weight` value is `null` if no weight is specified for the item or modifier.\\n    \\nYou can use the `weight` value when determining shipping costs or choosing a delivery vehicle to use.\\n\",\"format\":\"float\",\"nullable\":true},\"WeightUnitOfMeasure\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\"],\"description\":\"The unit of measure assigned to the `weight` value.\\n    \\nPossible values include:\\n    \\n* NONE: No unit of measurement is assigned. `weightUnitOfMeasure` can also be `null`. `NONE` and `null` are equivalent. \\n* LB: Pounds\\n* OZ: Ounces\\n* KG: Kilograms\\n* G: Grams\\n\",\"nullable\":true},\"Images\":{\"type\":\"array\",\"description\":\"An array of strings that contain URLs for images that have been uploaded for this item or modifier. The array is empty if no images have been uploaded.\\n    \\n_Note:_ The `images` array contains multiple URLs for multiple images for the same item or modifier. The older `image` value contains a single URL for a single image.\\n\",\"items\":{\"type\":\"string\"}},\"GuestCount\":{\"type\":\"number\",\"description\":\"The number of guests the item or modifier is expected to serve. This value is `null` if no guest count is specified.\\n\",\"format\":\"float\",\"nullable\":true},\"CatalogProductInfo\":{\"type\":\"object\",\"description\":\"Contains retail catalog product information for a menu item.\\n\",\"properties\":{\"product\":{\"$ref\":\"#/components/schemas/CatalogProduct\"},\"productVariant\":{\"$ref\":\"#/components/schemas/CatalogProductVariant\"}},\"nullable\":true},\"CatalogProduct\":{\"type\":\"object\",\"description\":\"Retail catalog product information for a menu item.\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier of the retail product in the retail product catalog. This is different from the menu item identifier.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the product, for example, \\\"T-Shirt\\\".\\n\"},\"description\":{\"type\":\"string\",\"description\":\"The description of the product.\\n\",\"nullable\":true},\"type\":{\"type\":\"string\",\"enum\":[\"SINGLE\",\"OPTION\",\"UNSPECIFIED\"],\"description\":\"The type of product. Possible values include:\\n\\n* `SINGLE`: The product has exactly one variant and does not have any options.\\n* `OPTION`: The product is an option-type product and will contain at least one variant and at least one option.\\n* `UNSPECIFIED`: Product type is not specified or unknown.\\n\"},\"images\":{\"type\":\"array\",\"description\":\"List of image URLs for the product. A product can have different images than its variants.\\n\",\"items\":{\"type\":\"string\"}},\"availableOptions\":{\"type\":\"array\",\"description\":\"List of available options for the product.\\n\",\"items\":{\"$ref\":\"#/components/schemas/CatalogProductOption\"}}}},\"CatalogProductVariant\":{\"type\":\"object\",\"description\":\"The specific version of the retail product that this menu item represents, defined by a unique combination of option values (for example, a T-Shirt with options `Red` and size `Small`).\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier for the product variant.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the variant, for example, \\\"T-Shirt - Small\\\".\\n\"},\"description\":{\"type\":\"string\",\"description\":\"The description of the variant.\\n\",\"nullable\":true},\"selectedOptions\":{\"type\":\"array\",\"description\":\"List of selected options for the variant.\\n\",\"items\":{\"$ref\":\"#/components/schemas/CatalogProductVariantOption\"}}}},\"CatalogProductOption\":{\"type\":\"object\",\"description\":\"An option for a retail product.\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier for the product option.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the product option, for example, \\\"size\\\".\\n\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"The sort order of the product option.\\n\"},\"values\":{\"type\":\"array\",\"description\":\"List of values for the product option.\\n\",\"items\":{\"$ref\":\"#/components/schemas/CatalogProductOptionValue\"}}}},\"CatalogProductVariantOption\":{\"type\":\"object\",\"description\":\"A selected option for a retail product variant.\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier for the product variant option.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the product variant option, for example, \\\"size\\\".\\n\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"The sort order of the product variant option.\\n\"},\"value\":{\"$ref\":\"#/components/schemas/CatalogProductOptionValue\"}}},\"CatalogProductOptionValue\":{\"type\":\"object\",\"description\":\"A value within a catalog product option.\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique identifier for the product option value.\\n\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the product option value, for example, \\\"small\\\".\\n\"},\"sortOrder\":{\"type\":\"integer\",\"description\":\"The sort order of the product option value.\\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-menus-api-v3.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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"menusV3.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/menusV3.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"menusV3","isDefault":true,"id":"menusV3","title":"menusV3","link":null}]},{"id":"7a5bbce0-d1e5-5c19-9d85-ef69a2674a87overview/__redocly content redirect/ordermgmt.configuration/overview/","definitionId":"orderManagementConfiguration","link":"/ordermgmt.configuration/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/ordermgmt.configuration.reference.page.yaml","info":{"version":"1.0.1","title":"Order Management Configuration API","description":"\nReturns a restaurant location's online ordering schedule for takeout and/or delivery, including overrides, and the maximum number of days in the future a guest can place an online order.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"orderManagementConfiguration","label":"Order management configuration","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-ordermgmt-config-api-docs.yaml"},"apiVersions":[{"definitionId":"orderManagementConfiguration","isDefault":true,"title":"orderManagementConfiguration","id":"orderManagementConfiguration"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.1\",\"title\":\"Order Management Configuration API\",\"description\":\"\\nReturns a restaurant location's online ordering schedule for takeout and/or delivery, including overrides, and the maximum number of days in the future a guest can place an online order.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"tags\":[{\"name\":\"Ordering Schedule\",\"description\":\"Operations related to online ordering schedules\"}],\"paths\":{\"/published/orderingSchedule\":{\"get\":{\"operationId\":\"orderingScheduleGet\",\"summary\":\"Get online ordering schedule\",\"description\":\"Get a restaurant location's online ordering schedule.\\n\",\"tags\":[\"Ordering Schedule\"],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier of the restaurant location whose online ordering schedule is to be retrieved.\",\"in\":\"header\",\"required\":true,\"example\":\"00000000-05f4-55a4-0000-0000020f4be3\",\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"A `OrderingSchedule` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/OrderingSchedule\"}}}}},\"security\":[{\"oauth2\":[\"digital_schedule:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/ordermgmt-config/v1\"}],\"components\":{\"securitySchemes\":{\"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.\\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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"digital_schedule:read\":\"Allows reading from the order management configuration API.\\n\"}}}}},\"schemas\":{\"OrderingSchedule\":{\"type\":\"object\",\"description\":\"A representation of an array of `servicePeriods` objects.\\n\",\"properties\":{\"servicePeriods\":{\"description\":\"An array of `servicePeriods` objects that contain information about the days and times when the restaurant location accepts online orders.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ServicePeriod\"}},\"overrides\":{\"description\":\"An array of `override` objects that contain information about planned overrides. `Overrides` only affect online ordering.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/DateOverride\"}},\"scheduledOrderMaxDays\":{\"description\":\"Number of days an online order can be placed into the future.\\n\",\"type\":\"integer\"},\"lastOrderConfiguration\":{\"description\":\"Allows guests to place online orders until the restaurant's closing time or closing time minus prep time.\\n\",\"type\":\"string\",\"enum\":[\"UNTIL_CLOSING_TIME\",\"UNTIL_PREPTIME_CUTOFF\"]},\"timeZoneId\":{\"description\":\"The time zone of the restaurant location. This is the same time zone used in the restaurant's hours of operation.\\n\",\"type\":\"string\",\"example\":\"America/New_York\"}}},\"ServicePeriod\":{\"type\":\"object\",\"description\":\"An array of `servicePeriods` objects that contain information about the days and times when the restaurant location accepts online orders.\\n\",\"properties\":{\"diningOptionBehavior\":{\"description\":\"The dining option behavior the online ordering schedule is returned for. Options are TAKE_OUT or DELIVERY. First-party delivery must be enabled to display DELIVERY hours.\\n\",\"type\":\"string\",\"enum\":[\"TAKE_OUT\",\"DELIVERY\"]},\"dayPeriods\":{\"description\":\"An array of `DayPeriods` objects that contain information about the specific day and time range when the restaurant accepts online orders.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/DayPeriod\"}}}},\"DayPeriod\":{\"type\":\"object\",\"description\":\"Holds information about the specific day and time range when the restaurant location accepts online orders.\\n\",\"properties\":{\"day\":{\"description\":\"The day the online ordering schedule is returned for.\",\"type\":\"string\",\"enum\":[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"]},\"timeRanges\":{\"description\":\"Contains a key value pair detailing the start and end time for online ordering in HH:MM format.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TimeRange\"}}}},\"TimeRange\":{\"type\":\"object\",\"description\":\"The time range when the restaurant is accepting online orders.\\n\",\"properties\":{\"start\":{\"type\":\"string\",\"format\":\"time\",\"description\":\"The local time in HH:MM format when the restaurant's online ordering hours start.\"},\"end\":{\"type\":\"string\",\"format\":\"time\",\"description\":\"The local time in HH:MM format when the restaurant's online ordering hours end.\"}}},\"DateOverride\":{\"type\":\"object\",\"description\":\"An array of `Overrides` objects that indicate the specific days and times when the restaurant's online ordering schedule is different from its hours of operation.\\n\",\"properties\":{\"description\":{\"description\":\"Description of the planned override.\",\"type\":\"string\"},\"diningOptionBehavior\":{\"description\":\"The `diningOptionBehavior` the override applies to. Can be TAKE_OUT or DELIVERY or both.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"TAKE_OUT\",\"DELIVERY\"]}},\"businessDate\":{\"description\":\"The day when the override applies in YYYYMMDD format.\",\"type\":\"integer\"},\"timeRanges\":{\"description\":\"The time range when the override starts and ends.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/OverrideTimeRanges\"}}}},\"OverrideTimeRanges\":{\"type\":\"object\",\"description\":\"The time range when the planned override starts and ends.\\n\",\"properties\":{\"start\":{\"description\":\"The local time in HH:MM format when the override starts.\",\"type\":\"string\",\"format\":\"time\"},\"end\":{\"description\":\"The local time in HH:MM format when the override ends.\",\"type\":\"string\",\"format\":\"time\"}}}}}}},\"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-ordermgmt-config-api-docs.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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"ordermgmt.configuration.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/ordermgmt.configuration.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"orderManagementConfiguration","isDefault":true,"id":"orderManagementConfiguration","title":"orderManagementConfiguration","link":null}]},{"id":"627d884a-80b1-551f-94f2-104ea8ab0e51overview/__redocly content redirect/orders/overview/","definitionId":"orders","link":"/orders/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/orders.reference.page.yaml","info":{"version":"2.9.0","title":"Toast Orders API","description":"The orders API includes operations that create, update, and retrieve information about restaurant\nguest orders.\n\nInformation on orders includes the checks, items ordered,\nprices, payments, discounts, and customer data.\n\nYou can create a new order. The orders API includes an operation to retrieve the order prices before you `POST` the order.\n\nYou can add items to an existing check.\n\nThe orders API also allows you to retrieve payment information for the order and add a credit card payment to the order.\nYou cannot update an existing payment, but you can update the tip amount.\n\nFor delivery orders, you can update the delivery information.\n\nYou can retrieve the applicable discounts for an order, and then add a discount to a menu item selection or a check.\n\nThe orders API supports email addresses that: \n  - Are up to 53 characters long. \n  - Start with the email prefix, ends with the email domain name, where the prefix and domain are separated by an @. \n  - Use the following supported characters:\n    - a-z\n    - A-Z\n    - 0-9\n    - _ (underscore)\n    - International characters are not supported\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"orders","label":"Orders","settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"C#"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":false,"downloadDefinitionUrl":"https://doc.toasttab.com/toast-api-specifications/toast-orders-api.yaml","sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true,"showAccessMode":true},"apiVersions":[{"definitionId":"orders","isDefault":true,"title":"orders","id":"orders"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"2.9.0\",\"title\":\"Toast Orders API\",\"description\":\"The orders API includes operations that create, update, and retrieve information about restaurant\\nguest orders.\\n\\nInformation on orders includes the checks, items ordered,\\nprices, payments, discounts, and customer data.\\n\\nYou can create a new order. The orders API includes an operation to retrieve the order prices before you `POST` the order.\\n\\nYou can add items to an existing check.\\n\\nThe orders API also allows you to retrieve payment information for the order and add a credit card payment to the order.\\nYou cannot update an existing payment, but you can update the tip amount.\\n\\nFor delivery orders, you can update the delivery information.\\n\\nYou can retrieve the applicable discounts for an order, and then add a discount to a menu item selection or a check.\\n\\nThe orders API supports email addresses that: \\n  - Are up to 53 characters long. \\n  - Start with the email prefix, ends with the email domain name, where the prefix and domain are separated by an @. \\n  - Use the following supported characters:\\n    - a-z\\n    - A-Z\\n    - 0-9\\n    - _ (underscore)\\n    - International characters are not supported\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"tags\":[{\"name\":\"Orders\",\"description\":\"Related to orders made by restaurant guests. For example, a restaurant\\nguest orders items from a menu. Toast platform orders include one or\\nmore guest check.\\n\"},{\"name\":\"Payments\",\"description\":\"Related to guests' payments for restaurant orders. Toast platform\\npayments apply to a check in an order.\\n\"},{\"name\":\"Discounts\",\"description\":\"Related to price reduction applied to restaurant orders. For example, a\\nrestaurant might apply a discount for a promotion.\\n\"}],\"paths\":{\"/payments\":{\"get\":{\"tags\":[\"Payments\"],\"summary\":\"Get payment identifiers\",\"description\":\"Returns a list of the GUIDs for each payment made during\\none restaurant business day.\\n\\nThe specific hours that make up a business\\nday depend on the business day cutoff in the restaurant configuration,\\nwhich is available from the restaurants API in the `closeoutHour`\\nproperty.\\n\\nThe business day for a restaurant is based on its local time (not UTC\\nor local time for an API client).\\n\\nYou must include one of the\\n`paidBusinessDate`, `refundBusinessDate`, or `voidBusinessDate` query\\nparameters.\\n\",\"operationId\":\"paymentsGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The GUID of the restaurant used as the context of the request.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"paidBusinessDate\",\"description\":\"Returns a list of the payments that were made during\\none business day.\\n\\nSpecify the business day in the format yyyyMMdd.\\nFor example, `20170101`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"refundBusinessDate\",\"description\":\"Returns a list of the payments that were refunded\\nduring one business day.\\n\\nSpecify the business day in the format\\nyyyyMMdd. For example, `20170101`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"voidBusinessDate\",\"description\":\"Returns a list of the payments that were voided during\\none business day.\\n\\nSpecify the business day in the format yyyyMMdd.\\nFor example, `20170101`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"A JSON array of the GUID identifiers for the payments.\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}},\"400\":{\"description\":\"The API cannot process the request.\"}},\"security\":[{\"oauth2\":[\"orders:read\"]}]}},\"/payments/{guid}\":{\"get\":{\"tags\":[\"Payments\"],\"summary\":\"Get a payment\",\"description\":\"Returns a JSON `Payment` object containing detailed information about a  single payment, specified by its GUID.\",\"operationId\":\"paymentsGuidGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The GUID of the restaurant used as the context of the request.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The GUID for the payment you want to return.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a JSON `Payment` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Payment\"}}}},\"400\":{\"description\":\"The GUID was malformed.\"},\"404\":{\"description\":\"The specified payment was not found.\"}},\"security\":[{\"oauth2\":[\"orders:read\"]}]}},\"/prices\":{\"post\":{\"tags\":[\"Orders\"],\"summary\":\"Get order prices\",\"description\":\"Calculates the check price amounts, tax amounts, and service\\ncharges for an `Order` object you supply as a _required message\\nbody parameter_.\\n\\nThe `prices` endpoint validates the order you\\nsubmit to ensure all referenced data exists and that you include\\nitem selections in the expected structure with all required modifier\\noptions.\\n\\nSome values that would be present in the response data when\\ncreating an order are not present in the response data for the `prices`\\nendpoint. For example, the order GUID is not set because the\\nToast platform does not create persistent data for the order.\\n\\nThe calculated price can change between requests to the\\n`prices` endpoint with the same `Order` object if enough time\\npasses between the requests. The difference in price is\\npossible because the restaurant configuration can change and\\nbecause some pricing configuration is based on time and date\\nschedules.\\n\",\"operationId\":\"pricesPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier of the restaurant to be used for this price\\ncalculation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}},\"description\":\"A _required_ JSON `Order` object containing information about\\nthe checks, item selections, modifier options, and other parts\\nof the order.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Success. The response body contains a JSON `Order` object with\\nvalues for check amounts, taxes, service charges, and other parts\\nof the order.\\n\\nBecause this endpoint only calculates prices,\\nno parts of the order persist in the Toast platform. There are no\\nGUIDs in the response object.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"400\":{\"description\":\"Either the request contains data that is not supported by\\nthe current version of the API as described, or the order\\ncontains an item that is negatively priced.\\n\"},\"403\":{\"description\":\"The API client does not have access to the restaurant, the\\nAPI client does not have the `orders:read` scope, or both.\\n\"},\"404\":{\"description\":\"An entity referenced in the order does not exist, or\\nbelongs to a restaurant that the API client is not\\nauthorized to access.\\n\"},\"413\":{\"description\":\"The number of checks in the submitted order exceeds the limit.\\n\"},\"415\":{\"description\":\"The request did not have `application/json` in the\\n`Content-Type` HTTP header field.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` that is attached to the error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"orders.orders:write\"]}]}},\"/orders/{guid}\":{\"get\":{\"tags\":[\"Orders\"],\"summary\":\"Get an order\",\"description\":\"Retrieves detailed information about a single order, specified by its GUID.\",\"operationId\":\"ordersGuidGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier of the restaurant where this order was placed.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The GUID for the order to be returned.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"A JSON Order object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"400\":{\"description\":\"The GUID was malformed.\"},\"404\":{\"description\":\"The specified order was not found.\"},\"500\":{\"description\":\"There was a problem serializing the order entity.\"}},\"security\":[{\"oauth2\":[\"orders:read\"]}]}},\"/ordersBulk\":{\"get\":{\"tags\":[\"Orders\"],\"summary\":\"Get multiple orders\",\"description\":\"Returns an array of `Order` objects containing detailed\\ninformation about all of the orders opened during a period of time.\\n\\nYou can return the orders for either a specific period of time\\nor for one business day.\\n\\n* Specify both `startDate` and `endDate` to return the orders\\n  modified during that period of time.\\n\\n* Specify the `businessDate` to return the orders promised\\n  during that business day.\\n\",\"operationId\":\"ordersBulkGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier for the restaurant that processed the orders.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"startDate\",\"description\":\"The inclusive start date and time. The results include orders with a modified\\ndate and time that occur at or after the `startDate`,\\nbut before the `endDate`.\\n\\nUse ISO-8601 format for the date and time, including a decimal fraction of\\na second. For example, `2016-01-01T14:13:12.000+0400`. URL encode the date\\nand time value.\\n\\nThe date must be after\\n2015-12-01T00:00:00.000+0000.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"endDate\",\"description\":\"The exclusive end date and time. The results exclude any orders that have\\na modified date and time that occurs at or after `endDate`.\\n\\nUse ISO-8601 format for the date and time, including a decimal\\nfraction of a second. For example, `2016-01-01T14:13:12.000+0400`. URL\\nencode the date and time value.\\n\\nThe `endDate` date and time\\nmust be later than the `startDate` parameter value.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"businessDate\",\"description\":\"The business date that same-day orders opened or that\\nscheduled orders are promised, in the format `yyyymmdd`.\\n\\nThe business day of an order is determined by the time the\\norder is opened or promised in the local time zone, and the\\nrestaurant's business day cutoff time, which is available\\nfrom  the `General` object of the restaurants API in the\\n`closeoutHour` property.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageSize\",\"description\":\"The maximum number of objects to return in the array. If the\\nnumber of objects selected by your request is greater than\\nthe `pageSize`, the API uses response pagination for the\\nremaining objects.\\n\\nThe maximum `pageSize` is `100`.\\n\\nFor more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html).\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\"}},{\"name\":\"page\",\"description\":\"The sequence number of the set of objects to return in\\npaginated response data.\\n\\nFor example, if you set the\\n`pageSize` parameter to `10`, and you set `page` to `2`, the\\nAPI returns a set of objects that starts with the eleventh\\nobject.\\n\\nFor more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html).\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\"}}],\"responses\":{\"200\":{\"description\":\"A JSON array of `Order` objects for each order processed\\nduring the period of time that you specify in your request.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Order\"}}}}},\"400\":{\"description\":\"The request contains data that is not supported by the API.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. The\\n`requestId` that is attached to this error can be referenced by\\nthe Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"orders:read\"]}]}},\"/orders/{orderGuid}/checks/{checkGuid}/payments\":{\"post\":{\"tags\":[\"Payments\"],\"summary\":\"Post payments\",\"description\":\"Adds one or more payments to a check in an existing order. Include\\ninformation about the payments in an array of `Payment` objects in the\\nmessage body. Specify the Toast platform GUID of the order\\nand check in REST path parameters.\\n\\nFor more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiAddingPaymentsToACheck.html).\\n\",\"operationId\":\"ordersChecksPaymentsPost\",\"parameters\":[{\"name\":\"orderGuid\",\"description\":\"The Toast platform identifier of the order that you are\\nadding payments to.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"checkGuid\",\"description\":\"The Toast platform identifier of the check that you are\\nadding payments to.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Payment\"}}}},\"description\":\"An array of JSON `Payment` objects containing information about the payments you are adding.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"A JSON `Order` object that includes the payments that you added.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"400\":{\"description\":\"The API cannot process the request.\"}},\"security\":[{\"oauth2\":[\"orders.payments:write\"]}]}},\"/orders/{orderGuid}/checks/{checkGuid}/payments/{paymentGuid}\":{\"patch\":{\"tags\":[\"Payments\"],\"summary\":\"Update a tip amount\",\"description\":\"Updates the tip amount in an existing payment for a check in an\\norder. Include the new `tipAmount` value in a `Payment` object\\nin the message body.\\n\\nThis endpoint does not allow any other\\n`Payment` object value for a `PATCH` request.\\n\\nSpecify the Toast\\nplatform GUID of the order, check, and payment in REST path\\nparameters.\\n\\nFor more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiUpdatingTipsInAPayment.html).\\n\",\"operationId\":\"ordersOrderGuidChecksCheckGuidPaymentsPaymentGuidPatch\",\"parameters\":[{\"name\":\"orderGuid\",\"description\":\"The Toast platform identifier of the order that you are\\nupdating a tip in.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"checkGuid\",\"description\":\"The Toast platform identifier of the check that you are\\nupdating a tip in.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"paymentGuid\",\"description\":\"The Toast platform identifier of the payment that you are\\nupdating a tip in.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdatePaymentRequest\"}}},\"description\":\"A JSON `Payment` object\\ncontaining the `tipAmount` value that will replace any\\nexisting tip amount for the payment.\\n\\nDo not include any\\nvalue other than `tipAmount`.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"A JSON `Order` object\\nthat includes the tip amount that you updated.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"400\":{\"description\":\"The API cannot process the request.\"}},\"security\":[{\"oauth2\":[\"orders.payments:write\"]}]}},\"/orders/{orderGuid}/checks/{checkGuid}/selections\":{\"post\":{\"tags\":[\"Orders\"],\"summary\":\"Add items to a check\",\"description\":\"Adds one or more items to an existing check in an order.\\n\\nInclude information about the items in an array of `Selection` objects in the\\nmessage body.\\n\\nSpecify the Toast platform GUID of the order and\\ncheck in REST path parameters.\\n\\nFor more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiAddingItemsToACheck.html).\\n\",\"operationId\":\"ordersOrderGuidChecksCheckGuidSelectionsPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier of the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"orderGuid\",\"description\":\"The Toast platform identifier of the order that you are\\nadding items to.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"checkGuid\",\"description\":\"The Toast platform identifier of the check that you are\\nadding items to.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Selection\"}}}},\"description\":\"An array of JSON `Selection` objects that identify the menu items you are adding.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Success. The response body contains the full order JSON, including the `Selection` objects with the items from the original check and the newly added ones you included.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"400\":{\"description\":\"The request contains data that is not supported by the API.\\n\"},\"404\":{\"description\":\"An entity referenced in the order does not exist at the restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. The `requestId` that is attached to this error can be referenced by the Toast support team.\\n\"}},\"security\":[{\"oauth2\":[\"orders.items:write\"]}]}},\"/orders/{orderGuid}/checks/{checkGuid}/appliedDiscounts\":{\"post\":{\"tags\":[\"Discounts\"],\"summary\":\"Add check-level discounts\",\"description\":\"Adds one or more check-level discounts to a check in an\\nexisting order. Include an array of `Discount` objects in the\\nmessage body.\\n\\nFor more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiDiscountingOrders.html#apiAddingDiscountsToChecks).\\n\",\"operationId\":\"ordersChecksAppliedDiscountsPost\",\"parameters\":[{\"name\":\"orderGuid\",\"description\":\"The Toast platform identifier of the order that you are\\nadding a discount to.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"checkGuid\",\"description\":\"The Toast platform identifier of the check that you are\\nadding a discount to.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/AppliedDiscountArray\"},\"responses\":{\"200\":{\"description\":\"A JSON `Order` object that includes the discount you added.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"400\":{\"description\":\"The API cannot process the request.\"}},\"security\":[{\"oauth2\":[\"orders.discounts:write\"]}]}},\"/orders/{orderGuid}/checks/{checkGuid}/selections/{selectionGuid}/appliedDiscounts\":{\"post\":{\"tags\":[\"Discounts\"],\"summary\":\"Add item-level discounts\",\"description\":\"Adds one or more item-level discounts to menu item selections\\nin a check in an existing order. Include an array of `Discount` objects in the\\nmessage body.\\n\\nFor more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiDiscountingOrders.html#apiAddingDiscountsToChecks).\\n\",\"operationId\":\"ordersChecksSelectionsAppliedDiscountsPost\",\"parameters\":[{\"name\":\"orderGuid\",\"description\":\"The Toast platform identifier of the order that you are\\nadding a discount to.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"checkGuid\",\"description\":\"The Toast platform identifier of the check that you are\\nadding a discount to.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"selectionGuid\",\"description\":\"The Toast platform identifier of the menu item selection\\nthat you are adding a discount to.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/AppliedDiscountArray\"},\"responses\":{\"200\":{\"description\":\"A JSON `Order` object that includes the discount you added.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"400\":{\"description\":\"The API cannot process the request.\"}},\"security\":[{\"oauth2\":[\"orders.discounts:write\"]}]}},\"/orders/{orderGuid}/deliveryInfo\":{\"patch\":{\"tags\":[\"Orders\"],\"summary\":\"Update delivery information\",\"description\":\"Updates the delivery information of an order that uses the `DELIVERY` dining option.\\nYou can use this endpoint to update the delivery time, dispatch time, the\\nemployee who is delivering the order, the delivery state, and the delivery notes.\\n\\nSpecify the Toast platform GUID of the\\norder in the `PATCH` path parameters. Returns a JSON\\n`Order` object if successful.\\n\\nOnce an order's `deliveryState` is `DELIVERED`, updates are no longer accepted. \\n\\nFor more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiUpdatingDeliveryInfoForAnOrder.html).\\n\",\"operationId\":\"ordersOrderGuidDeliveryInfoPatch\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier of the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"orderGuid\",\"description\":\"The Toast platform identifier of the order that you are\\nupdating the delivery information for.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"deliveredDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which the order was delivered.\\n\"},\"dispatchedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which the order was dispatched. If `dispatchedDate` is not specified, it is set to the current system time.\\n\"},\"deliveryState\":{\"type\":\"string\",\"description\":\"The delivery state of the order.\\n\",\"enum\":[\"PENDING\",\"IN_PROGRESS\",\"PICKED_UP\",\"DELIVERED\"]},\"deliveryEmployee\":{\"type\":\"string\",\"format\":\"UUID\",\"description\":\"The Toast platform identifier of the employee who is delivering the order.\\n\"},\"notes\":{\"type\":\"string\",\"description\":\"Delivery notes provided by the guest who placed the order. **Writing to this field overwrites the guest’s original notes and may result in the loss of important order information.** Do not replace or remove the guest's notes.\"}}}}},\"description\":\"A JSON `DeliveryInfo` object\\ncontaining the delivery information you want to update for an order.\\n\\nYou can update any combination of the `deliveredDate`, `dispatchedDate`, `deliveryState`,\\n`deliveryEmployee`, or `notes` values. \\n\\nThese are the only values you can update with this endpoint.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Success. The response body contains the full order JSON, including information you updated in the `deliveryInfo` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"400\":{\"description\":\"The request contains data that is not supported by the API.\\n\"}},\"security\":[{\"oauth2\":[\"orders.delivery_info:write\"]}]}},\"/orders/{orderGuid}/void\":{\"post\":{\"tags\":[\"Orders\"],\"summary\":\"Void an order\",\"description\":\"Voids an order, and (if specified) its selections and payments. Only Orders with `OTHER` payment types can be voided.\\n\\nA request body that contains the `selections` and `payments` objects with each `voidAll` value set to `true` is required to void an order. The response body is the modified Order object.\\n\\nFor more information, see [Void an order](https://doc.toasttab.com/doc/devguide/apiVoidOrder.html).\\n\",\"operationId\":\"voidOrder\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier of the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"orderGuid\",\"in\":\"path\",\"required\":true,\"description\":\"The GUID of the order to be voided.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"selections\":{\"type\":\"object\",\"properties\":{\"voidAll\":{\"type\":\"boolean\",\"default\":false}}},\"payments\":{\"type\":\"object\",\"properties\":{\"voidAll\":{\"type\":\"boolean\",\"default\":false}}}}}}}},\"responses\":{\"200\":{\"description\":\"Modified order object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"400\":{\"description\":\"Malformed order GUID or other validation errors.\\n\"},\"404\":{\"description\":\"Order not found.\"}},\"security\":[{\"oauth2\":[\"orders:void\",\"orders.channel:void\"]}]}},\"/orders\":{\"post\":{\"tags\":[\"Orders\"],\"summary\":\"Post an order\",\"description\":\"Submits an order to the server. Returns a JSON `Order` object if successful.\",\"operationId\":\"ordersPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier for the restaurant where this order was placed.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Order\"}}},\"description\":\"A JSON object containing information about an order.\",\"required\":true},\"responses\":{\"200\":{\"description\":\"A JSON `Order` object that has been persisted in Toast. The returned Order contains generated property values for the check amounts, taxes, service charges, and GUIDs for persisted entities.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/OrderResponse\"},\"examples\":{\"response\":{\"value\":{\"guid\":\"89488287-f259-435b-a654-0bc391596af0\",\"entityType\":\"Order\",\"externalId\":null,\"revenueCenter\":null,\"server\":{\"guid\":\"c89d1e72-1888-469f-a24b-506c66eafab7\",\"entityType\":\"RestaurantUser\",\"externalId\":null},\"lastModifiedDevice\":{\"id\":null},\"source\":\"API\",\"voidDate\":null,\"duration\":null,\"businessDate\":20210730,\"paidDate\":null,\"restaurantService\":null,\"voided\":false,\"estimatedFulfillmentDate\":\"2021-07-30T12:12:46.235+0000\",\"table\":null,\"requiredPrepTime\":\"PT15M\",\"approvalStatus\":\"NEEDS_APPROVAL\",\"deliveryInfo\":{\"address1\":\"401 Park Drive\",\"address2\":\"Suite 801\",\"city\":\"Boston\",\"state\":\"MA\",\"zipCode\":\"02215\",\"latitude\":42.3446671,\"longitude\":-71.1023575,\"notes\":\"Please ring the doorbell.\",\"deliveredDate\":null,\"dispatchedDate\":null,\"deliveryEmployee\":null,\"deliveryState\":null},\"serviceArea\":null,\"curbsidePickupInfo\":null,\"numberOfGuests\":1,\"diningOption\":{\"guid\":\"18855a26-40d4-4a8f-b484-c6af211dd597\",\"entityType\":\"DiningOption\",\"externalId\":null},\"openedDate\":\"2021-07-30T11:57:46.235+0000\",\"voidBusinessDate\":null,\"checks\":[{\"guid\":\"cbcb6fd5-d973-4e44-9b91-2abcee5ea6cd\",\"entityType\":\"Check\",\"externalId\":null,\"displayNumber\":\"pdesjardins-api-1627646263\",\"payments\":[{\"guid\":\"88642b2d-c359-4b96-bb8e-9cb3f5c2ac6a\",\"entityType\":\"OrderPayment\",\"externalId\":null,\"originalProcessingFee\":null,\"server\":null,\"cashDrawer\":null,\"lastModifiedDevice\":{\"id\":null},\"refundStatus\":\"NONE\",\"type\":\"OTHER\",\"voidInfo\":null,\"checkGuid\":\"cbcb6fd5-d973-4e44-9b91-2abcee5ea6cd\",\"otherPayment\":{\"guid\":\"0dc19214-d29e-4ab9-a773-27e5812999c7\",\"entityType\":\"AlternatePaymentType\",\"externalId\":null},\"paidDate\":\"2021-07-30T11:57:46.237+0000\",\"orderGuid\":\"89488287-f259-435b-a654-0bc391596af0\",\"cardEntryMode\":null,\"paymentStatus\":\"CAPTURED\",\"amount\":8.5,\"tipAmount\":0,\"amountTendered\":null,\"cardType\":null,\"houseAccount\":null,\"mcaRepaymentAmount\":null,\"createdDevice\":{\"id\":null},\"paidBusinessDate\":20210730,\"last4Digits\":null,\"refund\":null}],\"appliedDiscounts\":[],\"lastModifiedDevice\":{\"id\":null},\"voidDate\":null,\"paidDate\":null,\"appliedLoyaltyInfo\":null,\"voided\":false,\"paymentStatus\":\"OPEN\",\"amount\":5,\"tabName\":null,\"taxExempt\":false,\"openedDate\":\"2021-07-30T11:57:46.235+0000\",\"totalAmount\":5,\"selections\":[{\"guid\":\"2c8b6ece-c503-4f85-aed7-6a8c6526ba0d\",\"entityType\":\"MenuItemSelection\",\"externalId\":null,\"deferred\":false,\"preDiscountPrice\":5,\"voidReason\":null,\"optionGroup\":null,\"displayName\":\"蟹餅  CRAB CAKES\",\"appliedDiscounts\":[],\"modifiers\":[],\"seatNumber\":-1,\"voidDate\":null,\"fulfillmentStatus\":\"NEW\",\"optionGroupPricingMode\":null,\"salesCategory\":{\"guid\":\"c0915e46-341e-4ec0-b46e-cb87fab729fd\",\"entityType\":\"SalesCategory\",\"externalId\":null},\"selectionType\":\"NONE\",\"price\":5,\"voided\":false,\"appliedTaxes\":[],\"itemGroup\":{\"guid\":\"881472e6-dd94-48c6-b5c6-25e51a864208\",\"entityType\":\"MenuGroup\",\"externalId\":null},\"item\":{\"guid\":\"9c59d4ab-8242-450f-8f36-b16e1b3ab802\",\"entityType\":\"MenuItem\",\"externalId\":null},\"taxInclusion\":\"NOT_INCLUDED\",\"quantity\":1,\"receiptLinePrice\":5,\"unitOfMeasure\":\"NONE\",\"refundDetails\":null,\"tax\":0,\"diningOption\":{\"guid\":\"18855a26-40d4-4a8f-b484-c6af211dd597\",\"entityType\":\"DiningOption\",\"externalId\":null},\"voidBusinessDate\":null,\"createdDate\":\"2021-07-30T11:57:46.269+0000\",\"preModifier\":null,\"modifiedDate\":\"2021-07-30T11:57:46.269+0000\"}],\"voidBusinessDate\":null,\"createdDate\":\"2021-07-30T11:57:46.282+0000\",\"deleted\":false,\"createdDevice\":{\"id\":null},\"closedDate\":null,\"deletedDate\":null,\"modifiedDate\":\"2021-07-30T11:57:46.282+0000\",\"taxAmount\":0,\"appliedServiceCharges\":[],\"customer\":{\"guid\":\"970e92e6-33b3-4caa-876b-2c6ef528ef4e\",\"entityType\":\"Customer\",\"firstName\":\"Severe\",\"lastName\":\"Thibault\",\"phone\":\"5555555555\",\"email\":\"severe@example.com\"}}],\"deleted\":false,\"createdDevice\":{\"id\":null},\"createdDate\":\"2021-07-30T11:57:46.286+0000\",\"closedDate\":null,\"deletedDate\":null,\"modifiedDate\":\"2021-07-30T11:57:46.286+0000\",\"promisedDate\":null,\"pricingFeatures\":[\"TAXESV2\"]}}}}}},\"400\":{\"description\":\"Either the request contains data that is not supported by the current version of the API as described (e.g. specifying credit card as the payment type.), or the order contains an item that is negatively priced.\"},\"404\":{\"description\":\"An entity referenced in the order does not exist, or belongs to a restaurant the authenticated client is not authorized to access.\"},\"413\":{\"description\":\"The number of checks in the submitted order exceeds the limit.\"},\"415\":{\"description\":\"The request did not have \\\"application/json\\\" in the Content-Type header.\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast.\"}},\"security\":[{\"oauth2\":[\"orders.orders:write\"]}]},\"get\":{\"tags\":[\"Orders\"],\"summary\":\"Get order identifiers (deprecated)\",\"deprecated\":true,\"description\":\"Returns a list of the GUIDs of all orders opened during a period of\\ntime. You can return the list of orders for either a period of up to\\none hour or for one business day.\\n* Specify both `startDate` and `endDate` to return the list of orders\\n  modified during a period of up to one hour.\\n* Specify the `businessDate` to return the list of orders promised\\n  for delivery during a business day.\\n\",\"operationId\":\"ordersGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier for the restaurant to retrieve orders from.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"startDate\",\"description\":\"\\\\\\nThe inclusive start date and time. The results exclude orders with an earlier modified date and time.\\nUse ISO-8601 format for the date and time, including a decimal fraction of a second. For example, `2016-01-01T14:13:12.000+0400`. URL encode the date and time value.\\nThe date must be after 2015-12-01T00:00:00.000+0000.\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"endDate\",\"description\":\"\\nThe exclusive end date and time. The results exclude orders with an equal\\nor later modified date and time.\\n\\nUse ISO-8601 format for the date and time, including a decimal fraction of a\\nsecond. For example,\\n`2016-01-01T14:13:12.000+0400`. URL encode the date and time value.\\n\\nThe `endDate` date and time must be later than the `startDate`\\nparameter value.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"businessDate\",\"description\":\"The business date that same-day orders opened or that\\nscheduled orders are promised, in the format `yyyyMMdd`.\\n\\nThe business day of an order is determined by the time the order is opened or\\npromised in the local time zone, and by the restaurant's business day\\ncutoff time, which is available from  the `General` object of the\\nrestaurants API in the `closeoutHour` property.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"A JSON array of the GUID identifiers for orders.\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}},\"400\":{\"description\":\"The request contains data that is not supported by the current version of the API as described. For example, specifying credit card as the payment type.\"},\"500\":{\"description\":\"An unexpected internal error occurred. The `requestId` that is attached to this error can be referenced by Toast.\"}},\"security\":[{\"oauth2\":[\"orders:read\"]}]}},\"/applicableDiscounts\":{\"post\":{\"tags\":[\"Discounts\"],\"summary\":\"Get applicable discounts\",\"description\":\"Returns an array of `ApplicableDiscount`\\nobjects that contain information about the discounts that apply\\nto the checks and menu item selections in an order.\\n\\nEach `ApplicableDiscount` object contains information that you can\\nuse to determine which items and checks are eligible for the\\ndiscount.\\n\\nIf you include a `promoCode` value in the\\n`ApplicableDiscount` object, the `applicableDiscounts` endpoint\\nreturns the only the discounts that are associated with that\\npromotional code.\\n\",\"operationId\":\"applicableDiscountsPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier of the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ApplicableDiscountsRequest\"}}},\"description\":\"A JSON `ApplicableDiscountsRequest` object containing\\ninformation about an order, and an optional `promoCode`.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"A JSON array of `ApplicableDiscount` objects.\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"ApplicableDiscounts\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ApplicableDiscount\"}}}}},\"400\":{\"description\":\"Invalid arguments\"},\"500\":{\"description\":\"An unexpected internal error occurred. The `requestId` that is attached to this error can be referenced by Toast.\"}},\"security\":[{\"oauth2\":[\"orders.orders:write\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/orders/v2\"}],\"components\":{\"requestBodies\":{\"AppliedDiscountArray\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscount\"}}}},\"description\":\"A JSON array of `AppliedDiscount` objects that identify the discounts you are adding.\\n\",\"required\":true}},\"securitySchemes\":{\"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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"orders:read\":\"Allows reading from the orders API with the exception of guest information.\\n\\nIf your API client creates orders, then to read orders, it must have both the orders:read scope and the \\norders.channel:read scope.\\n\",\"orders.channel:read\":\"Allows API clients that submit orders to the Toast platform to read from the orders API.\\n\\nTo read orders, the API client must have both the orders:read scope and the orders.channel:read scope.\\n\\nAPI clients that have the orders.channel:read scope can only read the orders that they submitted. They cannot\\nread orders from any other source.\\n\",\"delivery_info.address:read\":\"Allows reading guest delivery address information from the orders API.\\nOptionally used in conjunction with the `orders:read` scope to return\\nthe `deliveredDate`, `dispatchedDate`, `deliveryEmployee`, and `deliveryState`\\nfields as part of the `deliveryInfo` field on the Order object.\\n\",\"guest.pi:read\":\"Allows reading guest and curbside pickup information from the orders API.\\nOptionally used in conjunction with the `orders:read` scope to return the\\n`email` and `phone` fields as part of the `checks[].customer` object.\\n\",\"orders.delivery_info:write\":\"Allows updating delivery information from the orders API.\\n\",\"orders.discounts:write\":\"Allows adding discounts to orders using the orders API.\\n\",\"orders.items:write\":\"Allows adding items to orders using the orders API.\\n\",\"orders.orders:write\":\"Allows posting orders orders using the orders API.\\n\",\"orders.payments:write\":\"Allows adding payments and tips to existing orders using the orders API.\\n\"}}}}},\"schemas\":{\"Order\":{\"type\":\"object\",\"description\":\"A Toast platform order is composed of one or more checks. Each check has \\none or more menu item selections.\\n\\nThe `externalId` value for an order must be unique. If you submit an order\\nwith an `externalId` that already exists for another order, the request\\nwill fail. You can use this behavior to implement idempotent order\\nsubmission by always providing a consistent `externalId` for each unique\\norder attempt.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"diningOption\",\"checks\"],\"properties\":{\"openedDate\":{\"description\":\"The business date of the order.\\n\\nFor dine-in and as soon as possible (ASAP) orders, `openedDate` should match `createdDate`.\\n\\nFor scheduled orders, `openedDate` should match `promisedDate`.\\n\\nIf you do not provide a value for \\n`openedDate` value when you `POST` a new order, the\\nbusiness date of the order is set to the restaurant\\nbusiness day that corresponds to the current date and\\ntime.\\n\\nThe business date of an order is affected by the\\nbusiness date cutoff time for a restaurant, which is\\navailable from the restaurants API in the `closeoutHour` property.\\n\",\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2025-02-07T08:00:00.000-0800\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date that the order, or a check or menu item selection in the order, was modified.\",\"example\":\"2025-02-07T08:00:00.000-0800\"},\"promisedDate\":{\"description\":\"For scheduled orders, the date and time that the order is scheduled to be fulfilled.\\n\\nFor dine-in and as soon as possible (ASAP) orders, `promisedDate` is `null`.\\n\",\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2025-05-01T08:00:00.000-0800\"},\"channelGuid\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\",\"format\":\"uuid\"},\"diningOption\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"checks\":{\"type\":\"array\",\"description\":\"The checks for this order. Most orders have one check.\\n\\nIf the check is split, then there are multiple checks.\\n\",\"minItems\":1,\"items\":{\"$ref\":\"#/components/schemas/Check\"}},\"table\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"serviceArea\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"restaurantService\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"revenueCenter\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"source\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"Indicates the way that the order was placed.\\n\\nValid values:\\n\\n* `In Store`\\n* `Online`\\n* `Order-and-Pay-at-Table`\\n* `API`\\n* `Kiosk`\\n* `Caller Id`\\n* `Google`\\n* `Invoice`\\n* `Toast Pickup App`\\n* `Toast Local`\\n* `Toast Pay`\\n* `Branded Online Ordering`\\n* `Catering`\\n* `Catering Online Ordering`\\n* `Toast Tables`\\n* `eCommerce Online ordering`\\n* `Branded Mobile App`\\n* `Grubhub` (deprecated)\\n\\nResponse only.\\n\"},\"duration\":{\"x-toast-read-only\":true,\"type\":\"integer\",\"description\":\"The number of seconds between creation and payment. Response only.\"},\"deliveryInfo\":{\"$ref\":\"#/components/schemas/DeliveryInfo\"},\"requiredPrepTime\":{\"type\":\"string\",\"format\":\"ISO-8601\",\"description\":\"The amount of time that it will take to prepare the order. This value overrides the \\ndefault `deliveryPrepTime` or `takeoutPrepTime` that normally controls auto-firing for scheduled orders.\\n\\nYou can use `requiredPrepTime` to handle atypical orders that will take more time than usual for a restaurant to prepare.\\n\\nExpress the required preparation time in ISO-8601 duration format. Must be greater than zero and be an \\nincrement of five minutes. For example, the value \\\"PT15M\\\" sets the required preparation time for the order to 15 minutes.\\n\"},\"estimatedFulfillmentDate\":{\"x-toast-read-only\":true,\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the order is expected to be ready for pickup or to be delivered.\\n\\nThis value is only set when the order dining option uses the `DELIVERY` or `TAKE_OUT` dining behavior. For other dining options, the value is `null`.\\n\\nResponse only.\\n\",\"example\":\"2025-05-01T08:00:00.000-0800\"},\"numberOfGuests\":{\"type\":\"integer\",\"description\":\"The number of restaurant guests that are associated with the\\norder. For example, for a dine-in order, this might be the\\nnumber of guests at a table.\\n\"},\"voided\":{\"x-toast-read-only\":true,\"type\":\"boolean\",\"description\":\"Set to `true` if this order was voided. Response only.\"},\"voidDate\":{\"x-toast-read-only\":true,\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this order was voided. Response only.\",\"example\":\"2025-02-07T08:00:00.000-0800\"},\"voidBusinessDate\":{\"x-toast-read-only\":true,\"type\":\"integer\",\"description\":\"The business date (yyyyMMdd) on which this order was voided. Response only.\"},\"paidDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date on which this order received payment. If not specified when `POST`ing, it is set to the current system time.\",\"example\":\"2025-02-07T08:00:00.000-0800\"},\"closedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date on which the order payment status changed to `CLOSED`.\\n\\nThis status is not returned for the order. The order is simply `CLOSED` when all of the checks on the order are `CLOSED`.\\n\",\"example\":\"2025-02-07T08:00:00.000-0800\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time when the order was deleted.\\n\\nThe `deletedDate` value only\\napplies when the `deleted` value is `true`.\\n\\nIf `deleted` is `false`, the value\\nof `deletedDate` is the UNIX epoch, `1970-01-01T00:00:00.000+0000`.\\n\",\"example\":\"2025-02-07T08:00:00.000-0800\"},\"deleted\":{\"x-toast-read-only\":true,\"type\":\"boolean\",\"description\":\"Set to `true` if this order is deleted. Response only.\\n\\nFor example, if you combine a\\ncheck into another order, the original order for the check is deleted.\\n\"},\"businessDate\":{\"x-toast-read-only\":true,\"type\":\"integer\",\"description\":\"The business date (yyyyMMdd) on which the order was fulfilled. Response only.\"},\"server\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"pricingFeatures\":{\"type\":\"array\",\"description\":\"Pricing features that this order is using.\",\"items\":{\"type\":\"string\",\"description\":\"A specific pricing feature used to price out the order.\",\"enum\":[\"TAXESV2\",\"TAXESV3\"]}},\"approvalStatus\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The current state of the order in the restaurant order\\nfulfillment process. For example, the `approvalStatus`\\ncan indicate that an order is waiting for a restaurant\\nemployee to approve it or that the order is in a\\nrestaurant kitchen being fulfilled. Response only.\\n\\nValid values:\\n\\n* `NEEDS_APPROVAL` - The order is created but will\\nnot be fulfilled by the restaurant until an employee\\napproves it.\\n\\n* `APPROVED` - The order is being fulfilled by the\\nrestaurant or it was fulfilled in the past. Orders\\nremain in this state indefinitely after they are\\nfulfilled.\\n\\n* `FUTURE` - The order is expected to be fulfilled by the\\nrestaurant at a future date and time. Restaurant\\nemployees will receive information about the order at the\\ndate and time that it is ready to be fulfilled.\\n\\n* `NOT_APPROVED` - Restaurant employees received\\ninformation about the order but did not approve it for\\nfulfillment. An order enters this state after a period of\\ntime passes without a restaurant employee approving it.\\n\",\"enum\":[\"NEEDS_APPROVAL\",\"APPROVED\",\"FUTURE\",\"NOT_APPROVED\"]},\"createdDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"createdDate\":{\"description\":\"The date and time that the Toast platform received the order.\",\"type\":\"string\",\"format\":\"date-time\",\"example\":\"2025-02-07T08:00:00.000-0800\"},\"lastModifiedDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"curbsidePickupInfo\":{\"$ref\":\"#/components/schemas/CurbsidePickupInfo\"},\"marketplaceFacilitatorTaxInfo\":{\"$ref\":\"#/components/schemas/MarketplaceFacilitatorTaxInfo\"},\"createdInTestMode\":{\"type\":\"boolean\",\"description\":\"Indicates whether the order was created while the restaurant was\\nin test mode.\\n\\nFor more information, see [this _Toast Central_\\narticle](https://central.toasttab.com/s/article/Test-Mode-Enable-and-Disable-1492802389999)\\n\"},\"appliedPackagingInfo\":{\"$ref\":\"#/components/schemas/AppliedPackagingInfo\"},\"excessFood\":{\"x-toast-read-only\":true,\"type\":\"boolean\",\"description\":\"Indicates whether the order was created to track excess food (for example, food waste) rather than a \\nstandard guest order. Response only.\\n\\nFor more information on the differences between guest orders and excess food orders, see \\n[Daily order for tracking excess food](https://doc.toasttab.com/doc/devguide/apiDailyOrderForTrackingExcessFood.html).\\n\"},\"displayNumber\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"Response only. Generally starts at one each day and counts up. Not guaranteed to be unique, can be empty if unset.\"}}}]},\"Check\":{\"type\":\"object\",\"description\":\"Represents a single check within an order.\\n\\nThe `externalId` value for a check must be unique. If you submit a check\\nwith an `externalId` that already exists for another check, the request\\nwill fail. You can use this behavior to implement idempotent check\\nsubmission by always providing a consistent `externalId` for each unique\\ncheck attempt.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"selections\"],\"properties\":{\"createdDate\":{\"description\":\"The date and time that the Toast platform received the check.\",\"type\":\"string\",\"format\":\"date-time\"},\"openedDate\":{\"description\":\"The date on which this check was opened. If not specified, it is set to the current system time.\",\"type\":\"string\",\"format\":\"date-time\"},\"closedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date on which this check's payment status was set to `CLOSED`.\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date on which this check was modified.\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this check was deleted.\\n\\n`deletedDate` is only applicable when `deleted` is true.\\n\\nIf `deleted` is false, then `deletedDate` is set to the UNIX epoch, `1970-01-01T00:00:00.000+0000`.\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"Set to `true` if this check was deleted.\"},\"selections\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Selection\"}},\"customer\":{\"$ref\":\"#/components/schemas/Customer\"},\"appliedLoyaltyInfo\":{\"$ref\":\"#/components/schemas/AppliedLoyaltyInfo\"},\"taxExempt\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Set to `true` if this check is tax exempt.\"},\"displayNumber\":{\"type\":\"string\",\"description\":\"Generally starts at one each day and counts up. The Toast platform fills this in if it is not specified when the order is POSTed. Not guaranteed to be unique.\"},\"appliedServiceCharges\":{\"type\":\"array\",\"description\":\"Any restaurant-configured service charges that applied to this check.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedServiceCharge\"}},\"amount\":{\"x-toast-read-only\":true,\"type\":\"number\",\"format\":\"double\",\"description\":\"The total calculated price of the check including discounts and service charges. The `amount` does not include gratuity or taxes. Response only.\"},\"taxAmount\":{\"x-toast-read-only\":true,\"type\":\"number\",\"format\":\"double\",\"description\":\"The calculated tax amount. Includes service charge and item level taxes. Response only.\"},\"totalAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The total calculated price of this check including discounts and taxes. Not affected by refunds.\"},\"payments\":{\"type\":\"array\",\"description\":\"Payments made on this check.\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/Payment\"}},\"tabName\":{\"type\":\"string\",\"description\":\"The name of the tab on this check. This displays on the KDS (Kitchen Display System) for pending orders.\\n\\nThe `tabName` value can contain up to 255 characters.\\n\"},\"paymentStatus\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The payment status of this check.\\n\\nValid values:\\n\\n* `OPEN` - There is an outstanding balance.\\n\\n* `PAID` - A credit card payment was applied, but the tip has not been adjusted.\\n\\n* `CLOSED`  - There is no remaining amount due on this check. For credit card payments, the payment has been adjusted to reflect the tip. Toast does not prevent a `CLOSED` check from transitioning back to `OPEN` or `PAID`.\\n\\nResponse only.\\n\",\"enum\":[\"OPEN\",\"PAID\",\"CLOSED\"]},\"appliedDiscounts\":{\"type\":\"array\",\"description\":\"The discounts applied to this check. In a `POST` request, only one `appliedDiscount` is allowed per check.\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscount\"}},\"voided\":{\"x-toast-read-only\":true,\"type\":\"boolean\",\"description\":\"True if this check is voided. Response only.\"},\"voidDate\":{\"x-toast-read-only\":true,\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date when this check was voided. Response only.\"},\"voidBusinessDate\":{\"x-toast-read-only\":true,\"type\":\"integer\",\"description\":\"The business date (yyyyMMdd) on which this check was voided. Response only.\"},\"paidDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date when this check received payment. If not specified when `POST`ing, it is set to the current system time.\"},\"createdDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"lastModifiedDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"duration\":{\"x-toast-read-only\":true,\"type\":\"integer\",\"description\":\"The number of seconds between creation and payment. Response only.\"},\"openedBy\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}}]},\"AppliedLoyaltyInfo\":{\"type\":\"object\",\"description\":\"Information about the customer loyalty program account associated with a check.\",\"required\":[\"loyaltyIdentifier\",\"vendor\"],\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"loyaltyIdentifier\":{\"type\":\"string\",\"description\":\"An identifier for the loyalty program account. For `POST` orders, this identifier is transmitted to the loyalty program service provider to associate the check with the loyalty account.\"},\"maskedLoyaltyIdentifier\":{\"type\":\"string\",\"description\":\"A representation of the identifier of the loyalty program\\naccount that can be displayed securely. For example:\\n`************1234`. The Toast POS displays this string to\\nrestaurant employees and guests.\\n\\nYou can optionally include this\\nvalue when you `POST` an order. It is\\navailable in response data when you `GET` the order.\\n\\nIf you do not provide a `maskedLoyaltyIdentifier` when you\\n`POST` an order, this value is `null` in response data.\\n\\nThe Toast POS app displays a masked representation of the\\n`loyaltyIdentifier`. All characters except the last four\\nare hidden.\\n\"},\"vendor\":{\"type\":\"string\",\"description\":\"The specific loyalty program service provider that supports the loyalty account.\",\"enum\":[\"TOAST\",\"PUNCHH\",\"PUNCHH2\",\"PAYTRONIX\",\"APPFRONT\",\"INTEGRATION\"]},\"accrualFamilyGuid\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"Response only. An internal Toast platform identifier for loyalty\\nprogram transactions.\\n\\nThis is not returned from the initial\\n`POST` order request and is available at a later time.\\n\"},\"accrualText\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"Response only. A description of the loyalty program transaction\\nto print on the customer's receipt. For example,\\n\\\"Earned 27 points.\\\"\\n\\nThe maximum length of the description string\\nis 255 characters.\\n\\nThis is not returned from the initial\\n`POST` order request and is available at a later time.\\n\"}}}]},\"Selection\":{\"type\":\"object\",\"description\":\"A `Selection` object can represent either a primary item (for example,\\n`Check.selections`) or a modifier (`Selection.modifiers`) selection.\\nQuantity defaults to `1`.\\n\\nFor a `POST` operation, all selections must have valid `item` and\\n`itemGroup` fields. The `item` and `itemGroup` values can be `null` for\\n`GET` requests. For example, they are `null` for gift cards and on special\\nrequests.\\n\\nTo specify a modifier selection, add it to the `modifiers` list of\\nanother selection. Each modifier selection must have its `optionGroup` field\\nset correctly, because a `MenuItem` can be included in multiple\\n`MenuOptionGroups`, potentially with different prices or sizing.\\n\\nThe `externalId` value for a selection must be unique. If you submit a\\nselection with an `externalId` that already exists for another selection,\\nthe request will fail. You can use this behavior to implement idempotent\\nselection submission by always providing a consistent `externalId` for\\neach unique selection attempt.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"item\",\"quantity\"],\"properties\":{\"item\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"itemGroup\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"optionGroup\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"preModifier\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"quantity\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Quantity ordered. For items sold by weight, a decimal number. For discrete items, a counting number.\"},\"seatNumber\":{\"x-toast-read-only\":true,\"type\":\"integer\",\"description\":\"Indicates which guest seat at a restaurant table ordered\\na menu item selection. Restaurant employees can choose the\\nseat number when they add a menu item to a guest check.\\n\\n* A positive integer value indicates the seat number for\\n  the menu item.\\n\\n* `0` - Indicates that the menu item is shared by\\n  multiple guests.\\n\\n* `-1` - Indicates that the restaurant employee did not\\n  select a seat for the menu item.\\n\\nResponse only.\\n\"},\"unitOfMeasure\":{\"type\":\"string\",\"description\":\"The unit of measure used to weigh, determine size, or otherwise\\nquantify the item.\\n\\nThe default is `NONE`, which means that the item is not meant to\\nbe measured during a sale.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"]},\"selectionType\":{\"type\":\"string\",\"description\":\"Specifies whether this selection is a special request or other off-menu sale.\\n\\nIf `null` or `NONE`, describes a normal modifier or item selection.\\n\\n`TOAST_CARD_SELL` and `TOAST_CARD_RELOAD` are currently response-only.\\n\",\"enum\":[\"NONE\",\"OPEN_ITEM\",\"SPECIAL_REQUEST\",\"PORTION\",\"HOUSE_ACCOUNT_PAY_BALANCE\",\"TOAST_CARD_SELL\",\"TOAST_CARD_RELOAD\"]},\"salesCategory\":{\"$ref\":\"#/components/schemas/ConfigReference\"},\"appliedDiscounts\":{\"x-toast-read-only\":true,\"type\":\"array\",\"description\":\"The itemized discounts that are applied to this item. Response only.\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscount\"}},\"deferred\":{\"type\":\"boolean\",\"description\":\"Whether this selection is a deferred revenue transaction, such as a gift card sale.\"},\"preDiscountPrice\":{\"x-toast-read-only\":true,\"type\":\"number\",\"description\":\"Gross sale price for this selection. Excludes tax. Response only.\",\"format\":\"double\"},\"price\":{\"x-toast-read-only\":true,\"type\":\"number\",\"format\":\"double\",\"description\":\"Net price for this selection. The final price of the item after considering discounts (including discounts at the check level), quantity adjustments, and modifier prices at the time the item was selected for purchase. Response only.\"},\"tax\":{\"x-toast-read-only\":true,\"type\":\"number\",\"format\":\"double\",\"description\":\"The total tax amount for this selection. Response only.\"},\"voided\":{\"x-toast-read-only\":true,\"type\":\"boolean\",\"description\":\"Set to `true` if this selection is voided. Response only.\"},\"voidDate\":{\"x-toast-read-only\":true,\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this selection was voided. Response only.\"},\"voidBusinessDate\":{\"x-toast-read-only\":true,\"type\":\"integer\",\"description\":\"The business date (yyyyMMdd) on which this selection was voided. Response only.\"},\"voidReason\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"refundDetails\":{\"$ref\":\"#/components/schemas/RefundDetails\"},\"displayName\":{\"type\":\"string\",\"description\":\"The display name of the selection.\\n\\nCan be used to set a special request value.\\n\\nOtherwise, it is generated from this selection's item property.\\n\"},\"plu\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The price look-up (PLU) code for the menu item selection used for pricing and inventory management.\"},\"premodifierPlu\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The Price Look-Up (PLU) code for the premodifier associated with this menu item selection. This is a unique identifier used for pricing and inventory management purposes. Currently this field is read only.\"},\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this selection was created. If not specified, defaults to the current time.\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this selection was last modified. If not specified, defaults to the current time.\"},\"modifiers\":{\"type\":\"array\",\"description\":\"A list of modifiers that apply to this selection.\",\"items\":{\"$ref\":\"#/components/schemas/Selection\"}},\"fulfillmentStatus\":{\"x-toast-read-only\":true,\"type\":\"string\",\"default\":\"NEW\",\"description\":\"Indicates the stage of the preparation workflow that the\\nmenu item selection is in.\\n\\nThe `fulfillmentStatus` of a\\nmenu item selection changes as restaurant employees move\\nthe item through the functions of the Toast POS, for\\nexample order entry and the kitchen display system (KDS).\\nResponse only.\\n\\nValid values:\\n\\n* `NEW` - The menu item selection was added to a\\n  check but is not yet sent to the KDS for\\n  preparation.\\n\\n* `HOLD` - A restaurant employee paused the menu\\n  item selection so that it does not appear in the\\n  KDS for preparation.\\n\\n* `SENT` - The menu item selection was fired and\\n  appears in the KDS for preparation.\\n\\n* `READY` - Preparation is complete. The menu item\\n  selection is fulfilled and no longer appears in\\n  the KDS. If your restaurant does not use the Toast platform\\n  KDS, then order items do not reach the `READY`\\n  status.\\n\",\"enum\":[\"NEW\",\"HOLD\",\"SENT\",\"READY\"]},\"fulfillment\":{\"$ref\":\"#/components/schemas/Fulfillment\"},\"taxInclusion\":{\"type\":\"string\",\"description\":\"Indicates whether the menu item price includes one or more tax\\namounts. If the menu item is a modifier for another menu item\\nselection, it always inherits the tax inclusion behavior of the menu\\nitem that it applies to.\\n\\nValid values:\\n* `INCLUDED` - The menu item price includes one or more tax amounts.\\n* `NOT_INCLUDED` - The menu item price does not include any tax\\n  amounts.\\n* `INHERITED` - The menu item is a modifier for another menu item\\n  selection in the check. The `taxInclusion` value of the parent menu\\n  item selection applies to the modifier. If a menu item selection\\n  *that is not a modifier* inherits tax inclusion behavior from a\\n  menu or menu group, the `taxInclusion` value is either\\n  `INCLUDED` or `NOT_INCLUDED`.\\n\",\"enum\":[\"INCLUDED\",\"NOT_INCLUDED\",\"INHERITED\"]},\"appliedTaxes\":{\"x-toast-read-only\":true,\"type\":\"array\",\"description\":\"An array of `AppliedTaxRate` objects that contain information about tax payments made for the selection. Response only.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedTaxRate\"}},\"diningOption\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"openPriceAmount\":{\"description\":\"A non-negative currency amount that sets the price of a\\nmenu item that is configured to use the *Open Price*\\npricing strategy. If you do not supply an\\n`openPriceAmount` value for an open price menu item, the\\norders API sets the price to 0.00.\\n\\nIf a menu item is configured to use tax-inclusive\\npricing, the orders API calculates the base price and tax\\namount based on the open price that you specify. _The\\nopen-price amount includes both the base-price and\\ninclusive tax amount._\\n\\n`POST` only. The `openPriceAmount` value is not\\npresent in orders API return data. It is used to\\npopulate `receiptLinePrice`.\\n\",\"type\":\"number\",\"format\":\"double\"},\"receiptLinePrice\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The price of the menu item selection without any quantity, taxes, \\ndiscounts, and modifier adjustments. If the menu item has taxes included, the `receiptLinePrice` value shows the original price, including taxes.\\n\\nFor example, if the menu item selection is for two orders of fries, \\n`receiptLinePrice` is the price of one order of fries. If a menu item selection \\nis for three large drinks, receiptLinePrice is the price of one large drink.\\n\\nPopulated based on the menu configuration, or using the value provided in \\n`externalPriceAmount` or `openPriceAmount`.\\n\"},\"optionGroupPricingMode\":{\"type\":\"string\",\"description\":\"Information about how the modifier group affects the pricing of its parent item.\",\"enum\":[\"INCLUDED\",\"FIXED_PRICE\",\"ADJUSTS_PRICE\",\"REPLACES_PRICE\",\"LOCATION_SPECIFIC_PRICE\"]},\"externalPriceAmount\":{\"description\":\"The menu item price that was calculated by the\\nmarketplace facilitator organization that created the\\norder.\\n\\n`POST` only. The orders API does not include the\\n`externalPriceAmount` value in return data. It is\\nused to populate `receiptLinePrice`.\\n\\n**Note**: you can only include this information if your\\nToast API client is associated with a designated\\nmarketplace facilitator organization. Most Toast API\\nclients do not create marketplace facilitator orders.\\n\",\"type\":\"number\",\"format\":\"double\"},\"splitOrigin\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}}]},\"Fulfillment\":{\"type\":\"object\",\"description\":\"Information about the fulfillment requirements for a menu item selection.\\n\",\"properties\":{\"quantity\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The quantity required for fulfillment.\"},\"unit\":{\"type\":\"string\",\"description\":\"The unit of measure for the fulfillment quantity.\"}}},\"Payment\":{\"type\":\"object\",\"description\":\"Defines a payment.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"type\",\"amount\",\"tipAmount\"],\"properties\":{\"paidDate\":{\"description\":\"The date on which the payment was made.\",\"type\":\"string\",\"format\":\"date-time\"},\"paidBusinessDate\":{\"x-toast-read-only\":true,\"description\":\"The business date (yyyyMMdd) on which this payment was first applied. Response only.\",\"type\":\"integer\"},\"type\":{\"type\":\"string\",\"description\":\"The payment method.\\n\\nWhen `POST`ing, only `OTHER` and `CREDIT` payment types are supported. For cash payments, you create an external cash payment type in Other Payment Options.\\n\\nAll other types are response only.\\n\\nValid values:\\n\\n* `CASH` - The guest paid in cash.\\n* `CREDIT` - The guest used a credit card.\\n* `GIFTCARD` - The guest used a gift card.\\n* `HOUSE_ACCOUNT` - The guest used funds from their house account.\\n* `REWARDCARD` - The guest used the available balance on a rewards card.\\n* `LEVELUP` - The guest used the LevelUp app.\\n* `TOAST_SV` - The guest used their Toast Cash stored value.\\n* `OTHER` - The payment type is a custom type configured by the restaurant.\\n* `UNDETERMINED` - The payment type cannot be determined.\\n\",\"enum\":[\"CASH\",\"CREDIT\",\"GIFTCARD\",\"HOUSE_ACCOUNT\",\"REWARDCARD\",\"LEVELUP\",\"TOAST_SV\",\"OTHER\",\"UNDETERMINED\"]},\"cardEntryMode\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"Indicates how credit card data was obtained. Response only.\\n\\nValid values:\\n\\n* `SWIPED` - The credit card was swiped through a card reader.\\n* `KEYED` - The restaurant employee typed the card number into a device.\\n* `ONLINE` - The credit card information was entered online.\\n* `EMV_CHIP_SIGN` - The credit card was inserted into a chip reader.\\n* `TOKENIZED` - The credit card number is tokenized, meaning that it is replaced by a series of randomly generated numbers. The authorizer is able to use the token to authorize the actual credit card.\\n* `PRE_AUTHED` - The credit card was pre-authorized for an initial amount. An example of pre-authorization is swiping a credit card to start a bar tab. The final payment is authorized when the order is complete.\\n* `SAVED_CARD` - The credit card information was retrieved from the guest's account.\\n* `FUTURE_ORDER` - The credit card payment was included on a scheduled order.\\n* `CONTACTLESS` - The guest used a contactless payment option to provide the credit card number.\\n* `APPLE_PAY_CNP` - The guest used the Apple Pay app to make the payment.\\n* `GOOGLE_PAY_CNP` - The guest used the Google Pay app to make the payment.\\n* `INCREMENTAL_PRE_AUTHED` - An additional payment was added to a pre-authorized card. For example, a guest uses a credit card to open a bar tab. As they continue to order more drinks, the pre-authorized amount is updated. The final payment is authorized when the order is complete.\\n* `PARTNER_ECOM_COF` - The restaurant has the credit card on file.\\n* `CLICK_TO_PAY_CNP` - The guest used Click to Pay to make the payment.\\n\",\"enum\":[\"SWIPED\",\"KEYED\",\"ONLINE\",\"EMV_CHIP_SIGN\",\"TOKENIZED\",\"PRE_AUTHED\",\"SAVED_CARD\",\"FUTURE_ORDER\",\"CONTACTLESS\",\"APPLE_PAY_CNP\",\"GOOGLE_PAY_CNP\",\"INCREMENTAL_PRE_AUTHED\",\"PARTNER_ECOM_COF\",\"CLICK_TO_PAY_CNP\"]},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of this payment, excluding tips.\"},\"tipAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount tipped on this payment.\"},\"amountTendered\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount tendered for this payment. The amount tendered does not include the tip.\"},\"cardType\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The type of credit card that was used. Response only.\",\"enum\":[\"VISA\",\"MASTERCARD\",\"AMEX\",\"DISCOVER\",\"JCB\",\"DINERS\",\"CIT\",\"MAESTRO\",\"LASER\",\"SOLO\",\"INTERAC\",\"EFTPOS\",\"WRIGHT_EXPRESS\",\"VOYAGER\",\"UNKNOWN\"]},\"first6Digits\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The first 6 digits of the card that was used. Response only.\"},\"last4Digits\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The last 4 digits of the credit card that was used. Response only.\"},\"originalProcessingFee\":{\"x-toast-read-only\":true,\"type\":\"number\",\"format\":\"double\",\"description\":\"The original processing fee for this payment. Populated after the payment is captured. Response only.\"},\"server\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"cashDrawer\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"refundStatus\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"Indicates whether the payment was refunded. Response only.\\n\\nValid values:\\n* `NONE` - The payment was not refunded.\\n* `PARTIAL` - The payment was partially refunded.\\n* `FULL` - The payment was refunded in full.\\n\",\"enum\":[\"NONE\",\"PARTIAL\",\"FULL\"]},\"refund\":{\"$ref\":\"#/components/schemas/Refund\"},\"paymentStatus\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The status of this payment when the type is `CREDIT`. Response only.\\n\\nValid values:\\n\\n* `OPEN` - The payment has not been presented for processing.\\n* `PROCESSING` - The payment is being processed.\\n* `AUTHORIZED_AT_RISK` - (DEPRECATED) This value is no longer used.\\n* `AUTHORIZED` - The payment is approved but not yet captured. The card is valid and the funds are available.\\n* `ERROR` - An error occurred during the payment processing.\\n* `ERROR_NETWORK` - Unable to connect to the payment authorizer.\\n* `DENIED` - The payment request was denied. For example, the provided credit card is over its limit.\\n* `PROCESSING_VOID` - A void request for the payment is being processed.\\n* `VOIDED_AT_RISK` - This value is no longer used.\\n* `CANCELLED` - The payment is canceled.\\n* `CAPTURE_IN_PROGRESS` - The payment is in the process of being captured.\\n* `CAPTURED` - The payment has been captured. When the payment is captured, the guest account is charged for the transaction amount.\\n* `VOIDED` - The payment is voided.\\n\",\"enum\":[\"OPEN\",\"PROCESSING\",\"AUTHORIZED_AT_RISK\",\"AUTHORIZED\",\"ERROR\",\"ERROR_NETWORK\",\"DENIED\",\"PROCESSING_VOID\",\"VOIDED_AT_RISK\",\"CANCELLED\",\"CAPTURE_IN_PROGRESS\",\"CAPTURED\",\"VOIDED\"]},\"voidInfo\":{\"$ref\":\"#/components/schemas/VoidInformation\"},\"houseAccount\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"otherPayment\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"createdDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"lastModifiedDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"mcaRepaymentAmount\":{\"x-toast-read-only\":true,\"description\":\"The total currency amount withheld as payments or repayments that\\napply to your business. For example, the `mcaRepaymentAmount` might include:\\n\\n* Toast Capital payments\\n* Marketplace facilitator tax\\n* Toast Delivery Services costs\\n* Instant deposits\\n\\nThe MCA repayment amount is set at the time the payment is\\ncaptured, which is typically hours after the actual restaurant\\nguest payment.\\n\\nUntil the `mcaRepaymentAmount` is set, this value is `null`.\\n\\nThe `mcaRepaymentAmount` _might_ be updated when the payment is\\nsettled, which is typically one or more days after the actual\\nguest payment. Response only.\\n\\nYou can use the following resources to find more specific\\ninformation about the payment and repayment amounts that are\\nincluded in `mcaRepaymentAmount`.\\n\\n* [Toast Capital payments](https://www.toasttab.com/restaurants/admin/capital/)\\n* [Marketplace facilitator tax](https://www.toasttab.com/restaurants/admin/reports/home#sales-summary)\\n* [Marketplace facilitator tax in API data](https://doc.toasttab.com/openapi/orders/tag/Data-definitions/schema/MarketplaceFacilitatorTaxInfo/)\\n* [Instant deposits](https://www.toasttab.com/restaurants/admin/instant-deposit)\\n* [Toast Delivery Services fees and tips](https://www.toasttab.com/restaurants/admin/reports/home#sales-summary)\\n* [Toast Delivery Services fees and tips description](https://www.toasttab.com/restaurants/admin/reports/home#sales-summary)\\n\\n_Important_: Some of the resources listed here require access to\\nToast products as a restaurant employee or operator. If your\\norganization provides an integration service you might not have\\naccess to the Toast products used by the restaurants you integrate\\nwith. Toast support cannot provide access to Toast product\\ninformation. That information is only available to direct Toast\\nproduct users.\\n\",\"type\":\"number\",\"format\":\"double\"},\"cardPaymentId\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"**Note:** this value is in limited release. Your orders API\\nintegration might not include the `cardPaymentId` value.\\n\\nA unique identifier for the credit card used for a\\n`CREDIT` type payment. The identifier string is generated\\nby the Toast platform and _does not include any\\ninformation related to or associated with the actual\\ncredit card account._ The identifier is unique within\\nyour restaurant management group.\\n\\nThe value is `null` for the following payment types:\\n\\n* Payment types other than `CREDIT`\\n* Credit card payments entered using EMV (chip cards)\\n* Credit card payments entered by keying in card numbers\\n\\nResponse only.\\n\"},\"orderGuid\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The Toast platform identifier for the order that contains the payment. Response only.\"},\"checkGuid\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The Toast platform identifier for the check that contains the payment. Response only.\"},\"tenderTransactionGuid\":{\"type\":\"string\",\"description\":\"For internal use only.\"},\"networkTransactionIdentifier\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"Card network identifier for transactions. Response only.\\n\\nFor more information, see [networkTransactionIdentifier in order payments](https://doc.toasttab.com/doc/apiordersdraftdoc/apiOrdersPaymentNetworkTransactionIdentifier.html).\\n\"}}}]},\"GiftCardInfo\":{\"type\":\"object\",\"description\":\"Reserved for future use.\",\"required\":[\"cardNumberIdentifier\",\"last4CardDigits\"],\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"last4CardDigits\":{\"type\":\"string\",\"description\":\"The last 4 digits of the gift card that was used.\"},\"first5CardDigits\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The first 5 digits of the gift card that was used. Response only.\"}}}]},\"Customer\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"required\":[\"firstName\",\"lastName\",\"email\",\"phone\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"The first name, or given name, of the guest.\\n\"},\"lastName\":{\"type\":\"string\",\"description\":\"The last name, or surname, of the guest.\\n\"},\"phone\":{\"type\":\"string\",\"description\":\"The telephone number of the guest.\\n\"},\"phoneCountryCode\":{\"type\":\"string\",\"description\":\"The international phone country code for the number of the guest.\\n\"},\"email\":{\"type\":\"string\",\"description\":\"The email address corresponding to the guest who placed the order.\\n\\nThe email address is the key that identifies a unique restaurant guest. All distinct guests should have distinct email addresses.\\n\"}}}]},\"DeliveryInfo\":{\"type\":\"object\",\"description\":\"Information related to delivery orders. Required if the dining option behavior is `DELIVERY`.\",\"required\":[\"address1\",\"city\",\"state\",\"zipCode\"],\"properties\":{\"address1\":{\"type\":\"string\",\"description\":\"The first line of the street address of the delivery destination.\\n\"},\"address2\":{\"type\":\"string\",\"description\":\"The second line of the street address of the delivery destination.\\n\"},\"city\":{\"type\":\"string\",\"description\":\"The name of the city or town of the delivery destination.\\n\"},\"administrativeArea\":{\"type\":\"string\",\"description\":\"The geographic or government division, larger than a city/town, for\\nthe delivery destination. For example, the name of a province, county,\\nregion, or state might be the `administrativeArea` value for a\\ndelivery address. This value is optional, not all delivery addresses\\ninclude a regional area name other than a `city`. If you include the \\n`state` value, you would typically _not_ include an `administrativeArea`.\\n\"},\"state\":{\"type\":\"string\",\"format\":\"ISO 3166-2\",\"description\":\"The postal abbreviation of the state or province of the\\ndelivery destination.\\n\\nThe abbreviation must be in ISO 3166-2\\nformat (two capital letters).\\n\"},\"zipCode\":{\"type\":\"string\",\"description\":\"The postal or zip code of the delivery destination.\\n\"},\"country\":{\"type\":\"string\",\"description\":\"The two-digit ISO-3166-2 country code of the delivery destination.\\n\"},\"latitude\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The north/south geographic coordinate of the delivery\\ndestination, in decimal format.\\n\"},\"longitude\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The east/west geographic coordinate of the delivery\\ndestination, in decimal format.\\n\"},\"notes\":{\"description\":\"Additional instructions or information about the delivery.\\n\",\"type\":\"string\"},\"deliveredDate\":{\"x-toast-read-only\":true,\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the delivery employee indicated in the Toast POS app that\\nthe order was delivered. Response only.\\n\\nThis value is only set when the dining option for the order is\\n`DELIVERY`. For other dining options, the value is `null`.\\n\",\"example\":\"2025-02-07T08:00:00.000-0800\"},\"dispatchedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the restaurant indicated in the Toast POS app that the\\norder was available for delivery and assigned to a delivery\\nemployee.\\n\\nThis value is only set when the\\ndining option for the order is `DELIVERY`. For other dining\\noptions, the value is `null`.\\n\",\"example\":\"2025-02-07T08:00:00.000-0800\"},\"deliveryEmployee\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"deliveryState\":{\"description\":\"An internal representation of the state of a delivery order.\\n\\nValid values:\\n\\n* `PENDING` - The delivery is not dispatched. This corresponds to the **Unassigned** tab of\\nthe Delivery screen of the Toast POS app.\\n\\n* `IN_PROGRESS` - The order is on the way to the destination. This corresponds to \\nthe **En Route** tab of the Delivery screen of the Toast POS app.\\n\\n* `PICKED_UP` - The employee who delivers the order has picked up the order from the\\nrestaurant.\\n\\n* `DELIVERED` - The order was delivered. This corresponds to the **Delivered** tab of the\\nDelivery screen of the Toast POS app.\\n\",\"type\":\"string\",\"enum\":[\"PENDING\",\"IN_PROGRESS\",\"PICKED_UP\",\"DELIVERED\"]}}},\"AppliedServiceCharge\":{\"type\":\"object\",\"description\":\"A service charge that is added to a check. A service charge can represent an upcharge such as a gratuity or a delivery fee.\\n\\nWhether the upcharge is taxable is defined in the restaurant-configured `serviceCharge`.\\n\\nThe fields on the `AppliedServiceCharge` are calculated based on the referenced `ServiceCharge` configuration.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"serviceCharge\"],\"properties\":{\"chargeAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The final applied amount excluding tax. Required if `chargeType` is `OPEN`.\"},\"serviceCharge\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"chargeType\":{\"x-toast-read-only\":true,\"description\":\"The type of service charge. Response only.\\n\\nValid values:\\n\\n* `FIXED` - The service charge is for a specific currency amount.\\n\\n* `PERCENT` - The service charge is for a percentage of the check amount.\\n\\n* `OPEN` - The service charge is not configured with an amount. The amount is specified by the restaurant employee.\\n\",\"type\":\"string\",\"enum\":[\"FIXED\",\"PERCENT\",\"OPEN\"]},\"name\":{\"x-toast-read-only\":true,\"description\":\"The configured human readable label for the service charge. Response only.\",\"type\":\"string\"},\"delivery\":{\"x-toast-read-only\":true,\"description\":\"Whether this service charge is a delivery charge. Response only.\",\"type\":\"boolean\"},\"takeout\":{\"x-toast-read-only\":true,\"description\":\"Whether this service charge is a takeout charge. Response only.\",\"type\":\"boolean\"},\"dineIn\":{\"x-toast-read-only\":true,\"description\":\"Whether this service charge is a dine-in charge. Response only.\",\"type\":\"boolean\"},\"gratuity\":{\"x-toast-read-only\":true,\"description\":\"Whether this service charge is a gratuity. Can be used to derive required tip amount on the check. Response only.\",\"type\":\"boolean\"},\"taxable\":{\"x-toast-read-only\":true,\"description\":\"Whether this service charge is taxable. Response only.\",\"type\":\"boolean\"},\"appliedTaxes\":{\"type\":\"array\",\"description\":\"Taxes applied to the service charge.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedTaxRate\"}},\"serviceChargeCalculation\":{\"type\":\"string\",\"description\":\"Defines whether a `PERCENT` service charge is applied before (`PRE_DISCOUNT`) or after (`POST_DISCOUNT`) discounts.\\n\\nThis field is `null` for `FIXED` and `OPEN` service charges.\\n\",\"enum\":[\"PRE_DISCOUNT\",\"POST_DISCOUNT\"]},\"refundDetails\":{\"$ref\":\"#/components/schemas/RefundDetails\"},\"serviceChargeCategory\":{\"x-toast-read-only\":true,\"description\":\"The type of service charge. Default is `SERVICE_CHARGE`. Response only.\\n\\nValid values:\\n\\n* `SERVICE_CHARGE` - The default type for a service charge.\\n\\n* `CREDIT_CARD_SURCHARGE` - A fee assessed _only_ on payment transactions that use a credit card.\\n\\n* `FUNDRAISING_CAMPAIGN` - Service charge associated with fundraising.\\n\\n* `CASH_ROUNDING` - Adjustment to the check total to account for cash payments with minimum denominations greater than 0.01.\\n\",\"type\":\"string\",\"enum\":[\"SERVICE_CHARGE\",\"CREDIT_CARD_SURCHARGE\",\"FUNDRAISING_CAMPAIGN\",\"CASH_ROUNDING\"]},\"paymentGuid\":{\"x-toast-read-only\":true,\"description\":\"The Toast platform unique identifier for the payment the fee is linked to. The `paymentGuid` value is always `null` unless the `serviceChargeCategory` object value is `CREDIT_CARD_SURCHARGE` or `CASH_ROUNDING`. Response only.\",\"type\":\"string\"}}}]},\"AppliedTaxRate\":{\"type\":\"object\",\"description\":\"A tax rate that is applied to an item or service charge.\",\"required\":[\"taxRate\"],\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"entityType\":{\"description\":\"The type of object this is.\",\"type\":\"string\"},\"taxRate\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the tax rate.\"},\"rate\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The tax rate, which can be a fixed amount, a percentage, or null.\"},\"taxAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The tax amount that was actually applied.\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the tax rate. Default is `PERCENT`.\\n\\nThe value `EXTERNAL` indicates that the tax is for a marketplace\\nfacilitator order, and that the marketplace facilitator\\norganization calculated the tax amount.\\n\",\"enum\":[\"PERCENT\",\"FIXED\",\"NONE\",\"TABLE\",\"EXTERNAL\"]},\"facilitatorCollectAndRemitTax\":{\"type\":\"boolean\",\"description\":\"Indicates whether the marketplace facilitator that\\nreceived a guest order remitted the tax amount on behalf\\nof the Toast platform restaurant.\\n\\nYou can use this information to identify tax amounts that\\nhave already been paid by an ordering service provider\\nand do not need to be paid again.\\n\\n* `true` - The marketplace facilitator paid the tax\\namount on behalf of the Toast platform restaurant\\nlocation.\\n\\n* `false` - The marketplace facilitator has not paid the\\ntax amount. The Toast platform restaurant location may be\\nrequired to pay the tax amount.\\n\\n**Note**: Toast API response data is not guidance or\\nadvice for tax compliance.\\n\"},\"displayName\":{\"type\":\"string\",\"description\":\"The name of the tax rate as it appears on guest receipts.\"},\"jurisdiction\":{\"type\":\"string\",\"description\":\"The state or province of the tax rate for reporting purposes.\"},\"jurisdictionType\":{\"type\":\"string\",\"description\":\"The jurisdiction type (ex. STATE, COUNTY, etc.) of the tax rate for reporting purposes.\"}}}]},\"AppliedDiscountTrigger\":{\"type\":\"object\",\"description\":\"The Selection that triggered the application of this discount\",\"properties\":{\"selection\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"quantity\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the selection used to trigger the applied discount.\"}}},\"AppliedDiscount\":{\"type\":\"object\",\"description\":\"A discount applied to a check or item. The Toast platform calculates service\\ncharges before it applies discounts. The system calculates tax after applying\\ndiscounts.\\n\\nIn a `POST` request, you cannot apply open percent discounts. You can apply open amount discounts.\\nYou can only apply one discount to a menu item selection. For more information, see\\n[the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiDiscountingOrders.html).\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the applied discount.\"},\"discountAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The discount amount. This amount is subtracted from the check or item.\"},\"nonTaxDiscountAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount that a discount reduces a menu item price,\\nexcluding any discount amount applied to taxes.\\n\\nIn most cases, a discount only applies to the menu item price, and\\nthe `nonTaxDiscountAmount` is the same as the `discountAmount`.\\n\\nIf you apply a discount to a menu item that includes tax in\\nits price, the `nonTaxDiscountAmount` is less than `discountAmount`.\\n\"},\"discount\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"triggers\":{\"x-toast-read-only\":true,\"type\":\"array\",\"description\":\"Optional items that triggered this discount. Response only.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscountTrigger\"}},\"approver\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"processingState\":{\"x-toast-read-only\":true,\"readOnly\":true,\"type\":\"string\",\"description\":\"Applies to loyalty program discounts only. Loyalty\\nprogram reward discounts are validated and then applied,\\nor redeemed, by the third-party loyalty program service\\nprovider depending on the state of the Toast platform order.\\n\\nThis field's value is `null` if the order discount is a Toast discount.\\n\\nThis value indicates the state of the discount in that\\nvalidation and application process. Response only.\\n\\nValid values:\\n\\n* `PENDING_APPLIED` - The loyalty program\\n  service provider confirmed that the reward discount\\n  is valid for the order and customer. The reward is not yet\\n  redeemed, or applied to the customer's loyalty\\n  account.\\n* `APPLIED` - The reward discount is\\n  redeemed. The reward is no longer available from the\\n  customer's loyalty program account.\\n* `PENDING_VOID` - The reward discount was\\n  removed from the Toast platform order. The reward is not\\n  available from the customer's loyalty program account\\n  until the loyalty program service provider processes\\n  the void operation.\\n* `VOID` - The reward discount was removed\\n  from the Toast platform order and the reward is available from\\n  the customer's loyalty program account again.\\n\",\"enum\":[\"PENDING_APPLIED\",\"APPLIED\",\"PENDING_VOID\",\"VOID\"]},\"appliedDiscountReason\":{\"$ref\":\"#/components/schemas/AppliedDiscountReason\"},\"loyaltyDetails\":{\"$ref\":\"#/components/schemas/LoyaltyDetails\"},\"comboItems\":{\"x-toast-read-only\":true,\"type\":\"array\",\"description\":\"A list of menu item selections that this combo discount applies to. Empty for non-combo discounts. Response only.\",\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"appliedPromoCode\":{\"type\":\"string\",\"description\":\"The promo code that was applied for this discount.\\n\\nFor a POSTed order, the Toast platform cannot validate the promo code.\\n\"},\"discountType\":{\"type\":\"string\",\"description\":\"The behavior of this discount.\\n\\nValid values:\\n* `BOGO` - Buy One, Get One. The guest receives a discount based on purchasing a specific item or items.\\n* `PERCENT` - The guest receives a specific percentage off of the price.\\n* `FIXED` - The guest receives a fixed currency amount off of the price.\\n* `OPEN_PERCENT` - The guest receives a percentage off of the price. The percentage is specified when the order is placed.\\n* `OPEN_FIXED` - The guest receives a currency amount off of the price. The amount is specified when the order is placed.\\n* `FIXED_TOTAL` - The guest pays a specified discounted price when they purchase specific items. Also referred to as a combo discount.\\n\",\"enum\":[\"BOGO\",\"PERCENT\",\"FIXED\",\"OPEN_PERCENT\",\"OPEN_FIXED\",\"FIXED_TOTAL\"]},\"discountPercent\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The percent value (0-100) of the applied discount when the `discountType` is `PERCENT` or `OPEN_PERCENT`. For other discount types, this value is `null`.\"}}}]},\"AppliedDiscountReason\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the reason for the applied discount.\"},\"description\":{\"type\":\"string\",\"description\":\"An optional description for the reason for the applied discount.\"},\"comment\":{\"type\":\"string\",\"description\":\"An optional comment on the reason for the applied discount.\"},\"discountReason\":{\"$ref\":\"#/components/schemas/ToastReference\"}}},\"LoyaltyDetails\":{\"type\":\"object\",\"description\":\"Information about the loyalty program discount that is applied to a check. The loyalty program account is identified in the `AppliedLoyaltyInfo` value for the check.\",\"required\":[\"vendor\",\"referenceId\"],\"properties\":{\"vendor\":{\"type\":\"string\",\"description\":\"The specific loyalty program service provider that supports the loyalty account.\",\"enum\":[\"TOAST\",\"PUNCHH\",\"PUNCHH2\",\"PAYTRONIX\",\"APPFRONT\",\"INTEGRATION\"]},\"referenceId\":{\"type\":\"string\",\"description\":\"The identifier of the loyalty program discount that\\nis recognized by the loyalty program service provider.\\n\\nThe Toast platform transmits the discount identifier to the service\\nprovider to determine the validity and amount of the discount.\\n\"}}},\"Refund\":{\"type\":\"object\",\"description\":\"A currency amount removed from a guest payment.\",\"properties\":{\"refundAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the refund, excluding the tip.\"},\"tipRefundAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the tip refund.\"},\"refundDate\":{\"description\":\"The date and time when the refund was made.\",\"type\":\"string\",\"format\":\"date-time\"},\"refundBusinessDate\":{\"x-toast-read-only\":true,\"description\":\"The business date (yyyyMMdd) on which this refund was created. Response only.\",\"type\":\"integer\"},\"refundTransaction\":{\"$ref\":\"#/components/schemas/RefundTransaction\"}}},\"RefundTransaction\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"An identifier for the refund transaction. You can use the identifier to associate items and service charges that were refunded in the same transaction.\\n\"}]},\"Device\":{\"type\":\"object\",\"description\":\"The *Device ID* value that the Toast platform assigns to a specific Toast POS device.\\n\\nThe `id` value is a unique identifier for a device.\\n\\nTo find the ID for a Toast POS device, from the overflow  menu (⋮) select *Device Status* and then select the *Device* tab.\\n\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"The physical id of the device\"}}},\"VoidInformation\":{\"type\":\"object\",\"description\":\"Information about a void applied to a check or item.\",\"properties\":{\"voidUser\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"voidApprover\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"voidDate\":{\"description\":\"The date on which the void was made.\",\"type\":\"string\",\"format\":\"date-time\"},\"voidBusinessDate\":{\"x-toast-read-only\":true,\"description\":\"The business date (yyyyMMdd) on which the void was made. Response only.\",\"type\":\"integer\"},\"voidReason\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}},\"ConfigReference\":{\"type\":\"object\",\"description\":\"A wrapper object containing identifier values for Toast platform entities.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"multiLocationId\":{\"description\":\"A consistent identifier for Toast platform entities, such\\nas menu items, that applies to all versions of a shared\\nentity at all locations in a restaurant group.\\n\\nFor example, you can use the `multiLocationId` value to\\nidentify menu entities that are versions of a shared menu\\nentity. For more information about the menus API `multilocationId` value, see\\n[the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiUnderstandingGuidsEntityIdentifiersAndMultilocationIds_V2.html#apiMultilocationIdValues_V2).\\n\",\"type\":\"string\"},\"externalId\":{\"description\":\"An external identifier that is prefixed by a naming\\nauthority. Deprecated for use in `ConfigReference`.\\n\",\"type\":\"string\"}}}]},\"ExternalReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID or a partner's identifier.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"externalId\":{\"description\":\"External identifier string that is prefixed by the naming authority. You can use the orders API to set an `externalId` for an order and then GET the order with that `externalId`.\",\"type\":\"string\"}}}]},\"ToastReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID.\",\"required\":[\"guid\",\"entityType\"],\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast platform.\",\"type\":\"string\"},\"entityType\":{\"x-toast-read-only\":true,\"description\":\"The type of object this is. Response only.\",\"type\":\"string\"}}},\"OrderResponse\":{\"type\":\"object\",\"properties\":{\"orders\":{\"type\":\"array\",\"minItems\":0,\"maxItems\":1,\"items\":{\"$ref\":\"#/components/schemas/Order\"}}}},\"ApplicableDiscountsRequest\":{\"type\":\"object\",\"description\":\"A wrapper object that contains an `Order` object and an optional\\npromotional code.\\n\\nYou include an `ApplicableDiscountsRequest`\\nobject in the message body of a `POST` request to the\\n`applicableDiscounts` endpoint.\\n\",\"required\":[\"order\"],\"properties\":{\"order\":{\"$ref\":\"#/components/schemas/Order\"},\"promoCode\":{\"description\":\"An optional promotional code. If you include a promotional\\ncode, the `applicableDiscounts` endpoint returns only\\ndiscounts that are associated with that promotional code.\\n\",\"type\":\"string\"}}},\"ApplicableDiscount\":{\"type\":\"object\",\"description\":\"A wrapper object that contains information about a discount that you\\ncan apply to an order, and which checks or menu item selections\\nyou can apply it to.\\n\",\"required\":[\"discount\"],\"properties\":{\"discount\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"applicableChecks\":{\"description\":\"If the discount is applicable to a check, this value holds an\\narray of `ExternalReference` objects containing the identifiers of the checks.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"applicableSelections\":{\"description\":\"If the discount is applicable to a menu item selection, this\\nvalue holds an array of `ExternalReference` objects containing\\nthe identifiers of the menu items.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}}},\"UpdatePaymentRequest\":{\"type\":\"object\",\"description\":\"A wrapper object containing payment fields that you can update.\\n\",\"properties\":{\"tipAmount\":{\"description\":\"The amount tipped on a payment.\\n\",\"type\":\"number\",\"format\":\"double\",\"example\":3.25}}},\"CurbsidePickupInfo\":{\"type\":\"object\",\"description\":\"Information that the restaurant can use to identify a guest when they arrive\\noutside the restaurant to pick up their order. `transportDescription` is a required field.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"transportColor\":{\"description\":\"The color of the guest's vehicle if they will arrive at the restaurant in a vehicle to pick up their order.\\n\",\"type\":\"string\",\"maxLength\":20},\"transportDescription\":{\"description\":\"Information about how the guest will arrive at the restaurant to pick up their order.\\n\\nFor example, the make and model of the vehicle the guest will arrive in.\\n\",\"type\":\"string\",\"maxLength\":100},\"notes\":{\"description\":\"Extra notes.\\n\",\"type\":\"string\",\"maxLength\":100}}}]},\"DeliveryServiceInfo\":{\"type\":\"object\",\"description\":\"Reserved for future use.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"providerId\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\",\"maxLength\":255},\"providerName\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\",\"maxLength\":36},\"driverName\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\",\"maxLength\":255},\"driverPhoneNumber\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\",\"maxLength\":30},\"providerInfo\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\",\"format\":\"byte\"},\"originalQuotedDeliveryDate\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\",\"format\":\"ISO-8601\"}}}]},\"RefundDetails\":{\"type\":\"object\",\"description\":\"Information about refunded currency amounts for an item\\nselection, modifier option, or service charge. The refund\\ninformation includes separate values for the pre-tax value\\nbeing refunded and the tax amount being refunded.\\n\",\"properties\":{\"refundAmount\":{\"description\":\"The value of the menu item or service charge (excluding taxes) being\\nrefunded. Includes the value of any nested modifier options that\\nincreased the price of the item or modifier option (an upcharge for\\nthe modifier option).\\n\",\"type\":\"number\",\"format\":\"double\"},\"taxRefundAmount\":{\"description\":\"The tax amount being refunded.\\n\",\"type\":\"number\",\"format\":\"double\"},\"refundTransaction\":{\"$ref\":\"#/components/schemas/RefundTransaction\"}}},\"MarketplaceFacilitatorTaxInfo\":{\"type\":\"object\",\"description\":\"Information about the taxes that a marketplace facilitator\\norganization remits on behalf of a Toast platform restaurant.\\n`POST` only. The orders API does not include the\\n`MarketplaceFacilitatorTaxInfo` object in response data.\\n\\n**Note**: you can only include this information if your\\nToast API client is associated with a designated\\nmarketplace facilitator organization. Most Toast API\\nclients do not create marketplace facilitator orders.\\n\",\"properties\":{\"facilitatorCollectAndRemitTaxOrder\":{\"description\":\"Indicates whether a marketplace facilitator organization has\\npaid the tax amounts for an order on behalf of the restaurant\\nthat fulfills the order.\\n\\nIf you include this value, you indicate that the marketplace\\nfacilitator order uses the prices and tax amounts calculated\\nby the Toast platform.\\n\\nIf you include this value, you *must not* include the `taxes`\\nvalue and you *must not* include the `externalPriceAmount`\\nfor menu item selections in the order.\\n\",\"type\":\"boolean\"},\"taxes\":{\"description\":\"An array of `AppliedTaxRate` objects that describe the tax\\namounts that apply to a marketplace facilitator order.\\n\\nIf you include this value, you must include an `externalPriceAmount`\\nfor each menu item selection in the order.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppliedTaxRate\"}}}},\"AppliedPackagingInfo\":{\"type\":\"object\",\"description\":\"Information describing the guest's packaging preferences for this order, for example utensils, napkins, condiments.\\n\\nFor more information, see [Packaging preferences](https://doc.toasttab.com/doc/devguide/apiOrdersPackagingPreferences.html)\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"appliedPackagingItems\":{\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/components/schemas/AppliedPackagingItem\"}}}}]},\"AppliedPackagingItem\":{\"type\":\"object\",\"description\":\"Indicates the guest preference for an individual packaging item in this order.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"required\":[\"itemConfigId\",\"inclusion\"],\"properties\":{\"itemConfigId\":{\"type\":\"string\",\"description\":\"The identifier GUID of the packaging preference option.\\n\"},\"inclusion\":{\"type\":\"string\",\"description\":\"The packaging preference choice that the guest selected in your ordering interface.\\n\",\"enum\":[\"YES\",\"NO\"]},\"itemTypes\":{\"x-toast-read-only\":true,\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"The packaging item types relevant for this packaging item as configured by the restaurant in Toast Web. Response only.\\n\"},\"guestDisplayName\":{\"x-toast-read-only\":true,\"type\":\"string\",\"description\":\"The guest-facing name, configured by the restaurant in Toast Web, for this packaging item. Response only.\\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,\"downloadDefinitionUrl\":\"https://doc.toasttab.com/toast-api-specifications/toast-orders-api.yaml\",\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"showAccessMode\":true,\"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":"2024-09-05T12:56:37.000Z","redocInfoPageId":"orders.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/orders.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"orders","isDefault":true,"id":"orders","title":"orders","link":null}]},{"id":"c5354231-d4e7-5bb2-8f85-699e1cae7379overview/__redocly content redirect/packaging/overview/","definitionId":"packaging","link":"/packaging/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/packaging.reference.page.yaml","info":{"version":"1.0.0","title":"Packaging configuration API","description":"The packaging configuration API allows you to retrieve a restaurant's packaging preferences configuration and apply it to a takeout or delivery order. \n\nPackaging preferences can be configured in Toast Web at **Takeout and Delivery > Packaging Preferences**. \n\nInformation on packaging includes:\n  - A restaurant's overall packaging configuration.\n  - Specific packaging item identifiers that can be included in an order.\n  \n  Once you obtain a restaurant's packaging preference configuration, you can include applicable `PackagingItem` objects in orders for that restaurant. For more information about creating orders, and using the orders API, see [Orders API overview](https://doc.toasttab.com/doc/devguide/portalOrdersApiOverview.html).\n","contact":{"name":"toast.org"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"packaging","label":"Packaging configuration","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/packaging-api.yaml"},"apiVersions":[{"definitionId":"packaging","isDefault":true,"title":"packaging","id":"packaging"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.3\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Packaging configuration API\",\"description\":\"The packaging configuration API allows you to retrieve a restaurant's packaging preferences configuration and apply it to a takeout or delivery order. \\n\\nPackaging preferences can be configured in Toast Web at **Takeout and Delivery > Packaging Preferences**. \\n\\nInformation on packaging includes:\\n  - A restaurant's overall packaging configuration.\\n  - Specific packaging item identifiers that can be included in an order.\\n  \\n  Once you obtain a restaurant's packaging preference configuration, you can include applicable `PackagingItem` objects in orders for that restaurant. For more information about creating orders, and using the orders API, see [Orders API overview](https://doc.toasttab.com/doc/devguide/portalOrdersApiOverview.html).\\n\",\"contact\":{\"name\":\"toast.org\"}},\"servers\":[{\"url\":\"https://toast-api-server/packaging\"}],\"paths\":{\"/v1/published/packagingConfig\":{\"get\":{\"summary\":\"Get a restaurant's published packaging configuration\",\"operationId\":\"getPackagingConfig\",\"security\":[{\"OAuth2\":[\"packaging:read\"]}],\"parameters\":[{\"in\":\"header\",\"name\":\"Toast-Restaurant-External-ID\",\"schema\":{\"type\":\"string\"},\"required\":true}],\"responses\":{\"200\":{\"description\":\"A restaurant's packaging configuration. You can expect a `200` response\\neven if your restaurant does not have a published packaging configuration. If the restaurant does not have a published configuration, an empty, disabled packaging config is returned.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PackagingConfig\"}}}}}}}},\"components\":{\"securitySchemes\":{\"OAuth2\":{\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"packaging:read\":\"Allows to read from packaging service\"}}}}},\"schemas\":{\"PackagingConfig\":{\"type\":\"object\",\"description\":\"Specific options for how a restaurant packages a guest's takeout or delivery order based on guest requests or specifications.\",\"required\":[\"enabled\",\"items\"],\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"`TRUE`: packaging options should be shown to guests during\\nthe online ordering checkout experience. \\n\\n`FALSE`: packaging options should not be shown to guests during the online ordering checkout experience. \\n\"},\"guestMessage\":{\"type\":\"string\",\"description\":\"An optional message that restaurants can use to describe the use for packaging preferences. This field is not meant to individually reference packaging preference items and instead should provide further details regarding the use of packaging preferences.\\nFor example, a restaurant may want to communicate the following to their takeout guests, \\\"California law now requires us to ask if you want disposable items.\\\"\\n\"},\"items\":{\"type\":\"array\",\"description\":\"Different types of packaging preference items such as utensils, napkins, straws, bags, or condiments. Items are configured in Toast Web at **Takeout and Delivery > Packaging Preferences**.\",\"items\":{\"$ref\":\"#/components/schemas/PackagingItem\"}}}},\"PackagingItem\":{\"type\":\"object\",\"description\":\"Configuration for a type of packaging\",\"required\":[\"id\",\"itemTypes\",\"guestDisplayName\",\"guestInclusionType\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Unique identifier for a packaging item.\"},\"itemTypes\":{\"type\":\"array\",\"description\":\"The possible packaging values like UTENSILS, NAPKINS, BAGS, STRAWS or CONDIMENTS. Packaging preferences can be configured in Toast Web at **Takeout and Delivery > Packaging Preferences**.\",\"items\":{\"type\":\"string\"}},\"guestDisplayName\":{\"type\":\"string\",\"description\":\"A question to be shown to guests that asks if they want to include utensils in their order. For example, \\\"Include Utensils?\\\"\"},\"guestDescription\":{\"type\":\"string\",\"description\":\"A longer description for the packaging item. Max 60 characters. This description is optional.\"},\"guestInclusionType\":{\"type\":\"string\",\"description\":\"`guestInclusionType` is an indication of what action the guest must take to include or exclude a packaging item.\\n\\nDetails:\\n  * `OPT_IN` - The guest creating an order must take an action to receive the packaging item. For example, if there is a checkbox for \\\"UTENSILS\\\", and it is unchecked by default, the guest must check it for their order to include utensils.\\n  * `OPT_OUT` - The guest creating an order must take an action to _not_ receive the packaging item. For example, if there is a checkbox for \\\"UTENSILS\\\", and it is checked by default, the guest must uncheck it for their order to not include utensils.\\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/packaging-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"packaging.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/packaging.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"packaging","isDefault":true,"id":"packaging","title":"packaging","link":null}]},{"id":"76deaa57-0927-538c-8af4-302f931b8d6eoverview/__redocly content redirect/partners/overview/","definitionId":"partners","link":"/partners/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/partners.reference.page.yaml","info":{"version":"1.0.1","title":"Partners API","description":"Returns information about the Toast restaurants that a partner \nAPI client can access.\n","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"partners","label":"Partners","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-partners-api.yaml"},"apiVersions":[{"definitionId":"partners","isDefault":true,"title":"partners","id":"partners"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.1\",\"title\":\"Partners API\",\"description\":\"Returns information about the Toast restaurants that a partner \\nAPI client can access.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/restaurants\":{\"get\":{\"operationId\":\"restaurantsGet\",\"summary\":\"Get accessible restaurants\",\"description\":\"Returns an array of `PartnerAccessExternalRep` \\nobjects that contain information about the Toast restaurants that your partner \\nAPI client can access. If a `lastModified` date is specified, the API returns \\nall objects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"lastModified\",\"description\":\"Limits the return data to restaurants that changed their \\naccess configuration for a partner API client after a \\nspecific date and time.\\n\\nRestaurants returned either:\\n\\n* Gave access to a partner API client for a partner \\n  integration service after a specific date and time.\\n\\n* Modified the configuration for a partner integration \\n  after a specific date and time. \\n\\nYou must specify the date and time as a UTC timestamp in \\nISO 8601 format, for example: \\n`2020-03-01T00:00:00.000-0000`. URL encode the timestamp. \\nFor example, `2020-03-01T00%3A00%3A00.000-0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\"}}],\"responses\":{\"200\":{\"description\":\"Returns the list of external partner accesses\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PartnerAccessExternalRep\"}}}}},\"403\":{\"description\":\"Your Toast API client does not have permission to use the \\n`/restaurants` endpoint.\\n\"}},\"security\":[{\"oauth2\":[]}]}},\"/connectedRestaurants\":{\"get\":{\"operationId\":\"connectedRestaurantsGet\",\"summary\":\"Get connected restaurants\",\"description\":\"Returns a `PaginatedResponse` object that contains a paginated array of\\nthe restaurants that have connected to your integrated partner service.\\nInformation about each restaurant is included in the array as a\\n`PartnerAccessExternalRep` object.\\n\\nUse the `pageSize` query parameter to control the number of restaurants\\nreturned in the response. The default `pageSize` is 100. The maximum\\n`pageSize` is 200.\\n\\nRequest the next page of restaurant information using the `pageToken`\\nquery parameter. You get the token string for the next page from the\\n`nextPageToken` value of the `PaginatedResponse` object for a page of\\nresults. You can also get the token strings for the first and next pages\\nfrom [the `link` response header\\nfields](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link).\\n\",\"parameters\":[{\"name\":\"lastModified\",\"description\":\"Limits the return data to restaurants that changed their access\\nconfiguration for your partner service after a specific date and\\ntime. You can use this parameter to identify new or updated\\nrestaurants connected to your partner service.\\n\\nThe restaurants included in the response data either:\\n\\n* Gave access to your integrated partner service after a specific\\n  date and time.\\n\\n* Modified the configuration for your integrated partner service after\\n  a specific date and time. \\n\\nYou must [specify the date and\\ntime](https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html)\\nas a UTC timestamp in ISO 8601 format, for example:\\n`2020-03-01T00:00:00.000-0000`. URL-encode the timestamp. For\\nexample, `2020-03-01T00%3A00%3A00.000-0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\"}},{\"name\":\"pageSize\",\"description\":\"Controls the number of `PartnerAccessExternalRep` objects that the\\nendpoint will return in each page of response data. The default page\\nsize is `100`. The maximum page size is `200`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"maximum\":200}},{\"name\":\"pageToken\",\"description\":\"Returns a specific set of restaurants in the response value. You get\\nthe token string for the next page of connected restaurants from the\\n`nextPageToken` value of the `PaginatedResponse` object for a page\\nof results. You can also get the token strings for the first and\\nnext pages from [the `link` response header\\nfields](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link).\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PaginatedResponse` object that contains a paginated array of\\nthe restaurants that have connected to your integrated partner service.\\n\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PaginatedResponse\"}}}}},\"403\":{\"description\":\"Your Toast API client does not have permission to use the \\n`/connectedRestaurants` endpoint.\\n\"}},\"security\":[{\"oauth2\":[]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/partners/v1\"}],\"components\":{\"securitySchemes\":{\"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. \\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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{}}}}},\"schemas\":{\"PartnerAccessExternalRep\":{\"type\":\"object\",\"description\":\"Information about a Toast platform restaurant.\\n\",\"properties\":{\"restaurantGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique Toast POS identifier for the restaurant.\\n\",\"example\":\"e728cd53-2fa7-4e63-8f8f-93e78ea66b03\"},\"managementGroupGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The guid of the management group containing the restaurant.\\n\",\"example\":\"bdfda703-2a83-4e0f-9b8a-8ea0ee6cab79\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant is actively using the Toast \\nplatform. For example, if a restaurant is no longer operating, \\nor is no longer using the Toast platform, this value is `true`.\\n\"},\"restaurantName\":{\"type\":\"string\",\"description\":\"The human-readable name of the restaurant location.\\n\",\"example\":\"Main Street Cafe\"},\"locationName\":{\"type\":\"string\",\"description\":\"The identifier of a specific restaurant location, set on the \\n*Restaurant Info* page of Toast Web. \\nFor example, a restaurant group might assign a location code \\nsuch as #1234 to a specific location.\\n\",\"example\":\"123 Main Street\"},\"createdByEmailAddress\":{\"type\":\"string\",\"description\":\"The email address of the restaurant employee who connected the\\nrestaurant to your integrated partner service, or who edited the\\nconnection details.\\n\",\"example\":\"clefebvre@mainstreetcafe.com\"},\"externalGroupRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant group that is recognized by your\\nintegrated partner service. This information is entered by the\\nrestaurant administrator. If you need information about the restaurant\\ngroup in this data string, you instruct the restaurant administrator\\nto enter it in the Toast platform configuration for the integration\\npartner connection.\\n\"},\"externalRestaurantRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant location that is recognized by your\\nintegrated partner service. This information is entered by the\\nrestaurant administrator. If you need information about the restaurant\\nlocation in this data string, you instruct the restaurant\\nadministrator to enter it in the Toast platform configuration for the\\nintegration partner connection.\\n\"},\"modifiedDate\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\",\"example\":1678846869551},\"createdDate\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"The date and time that the partner connection was created in epoch\\ntime (milliseconds since 1970-01-01 00:00:00).\\n\",\"example\":1643858534451},\"isoModifiedDate\":{\"type\":\"string\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in ISO8601 format.\\n\",\"example\":\"2023-03-12T08:32:34.008Z\"},\"isoCreatedDate\":{\"type\":\"string\",\"description\":\"The date and time that the partner connection was created in ISO8601\\nformat.\\n\",\"example\":\"2022-05-17T10:21:38.008Z\"}}},\"PartnerAccessExternalWebhookRep\":{\"type\":\"object\",\"description\":\"Information about a Toast platform restaurant.\\n\",\"properties\":{\"restaurantGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique Toast platform identifier for the restaurant.\\n\",\"example\":\"e728cd53-2fa7-4e63-8f8f-93e78ea66b03\"},\"managementGroupGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique Toast platform identifier for the management group\\ncontaining the restaurant.\\n\",\"example\":\"bdfda703-2a83-4e0f-9b8a-8ea0ee6cab79\"},\"restaurantName\":{\"type\":\"string\",\"description\":\"The human-readable name of the restaurant location.\\n\"},\"locationName\":{\"type\":\"string\",\"description\":\"The identifier of a specific restaurant location, set on the\\n*Restaurant Info* page of Toast Web.\\nFor example, a restaurant group might assign a location code\\nsuch as `Location1234` to a specific location.\\n\",\"example\":\"Location1234\"},\"externalGroupRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant group that is recognized by your\\nintegrated partner service. This information is entered by the\\nrestaurant administrator. If you need information about the restaurant\\ngroup in this data string, you instruct the restaurant administrator\\nto enter it in the Toast platform configuration for the integration\\npartner connection.\\n\"},\"externalRestaurantRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant location that is recognized by your\\nintegrated partner service. This information is entered by the\\nrestaurant administrator. If you need information about the restaurant\\nlocation in this data string, you instruct the restaurant\\nadministrator to enter it in the Toast platform configuration for the\\nintegration partner connection.\\n\"},\"modifiedDate\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\",\"example\":1678846869551},\"createdDate\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"The date and time that the partner connection was created in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\",\"example\":1643858534451},\"isoModifiedDate\":{\"type\":\"string\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in ISO8601 format.\\n\",\"example\":\"2023-03-12T08:32:34.008Z\"},\"isoCreatedDate\":{\"type\":\"string\",\"description\":\"The date and time that the partner connection was created in ISO8601 format.\\n\",\"example\":\"2022-05-17T10:21:38.008Z\"},\"createdByFirstName\":{\"type\":\"string\",\"description\":\"The first name of the restaurant employee who initiated the event.\\n\",\"example\":\"Clemence\"},\"createdByLastName\":{\"type\":\"string\",\"description\":\"The last name of the restaurant employee who initiated the event.\\n\",\"example\":\"Lefebvre\"},\"createdByEmailAddress\":{\"type\":\"string\",\"description\":\"The email address of the restaurant employee who connected the\\nrestaurant to your integrated partner service, or who edited the\\nconnection details.\\n\",\"example\":\"clefebvre@mainstreetcafe.com\"},\"createdByPhoneNumber\":{\"type\":\"string\",\"description\":\"The phone number of the user who initiated the event.\\n\",\"example\":\"9876543210\"},\"restaurantPhoneNumber\":{\"type\":\"string\",\"description\":\"The phone number of the restaurant.\\n\",\"example\":\"8765432109\"},\"restaurantAddressLine1\":{\"type\":\"string\",\"description\":\"The physical address of the restaurant location.\\n\",\"example\":\"123 Main Street\"},\"restaurantAddressLine2\":{\"type\":\"string\",\"description\":\"Optional additional physical address of the restaurant location.\\n\",\"example\":\"Suite 321\"},\"restaurantCity\":{\"type\":\"string\",\"description\":\"The city in which the restaurant is located.\\n\",\"example\":\"Gatineau\"},\"restaurantState\":{\"type\":\"string\",\"description\":\"The state in which the restaurant is located.\\n\",\"example\":\"Massachusetts\"},\"restaurantZipCode\":{\"type\":\"string\",\"description\":\"The zip code of the restaurant location.\\n\",\"example\":\"01234\"},\"restaurantLatitude\":{\"type\":\"string\",\"description\":\"The latitude of the restaurant location.\\n\"},\"restaurantLongitude\":{\"type\":\"string\",\"description\":\"The longitude of the restaurant location.\\n\"},\"restaurantCountryCode\":{\"type\":\"string\",\"description\":\"The ISO 3166-1 alpha-2 country code of the restaurant location.\\n\",\"example\":\"US\"},\"restaurantTimezone\":{\"type\":\"string\",\"description\":\"The IANA time zone identifier of the restaurant location.\\nFor example, `America/New_York`.\\n\",\"example\":\"America/New_York\"}}},\"PaginatedResponse\":{\"type\":\"object\",\"description\":\"A wrapper object containing paginated sets of response data. The `results`\\nvalue is an array of `PartnerAccessExternalRep` objects, which hold\\ninformation about Toast platform restaurants. Also includes pagination\\ndetails such as how many pages are included in the response, or the total\\nnumber of objects in the `results` array.\\n\",\"example\":{\"currentPageNum\":1,\"results\":[{\"restaurantGuid\":\"7ab295f6-8dc8-4cb6-8cdb-072b83e84184\",\"managementGroupGuid\":\"75063706-dd6e-4da6-8bb6-3a99e218e686\",\"restaurantName\":\"Main Street Cafe\",\"locationName\":\"123 Main Street\",\"createdByEmailAddress\":\"clefebvre@mainstreetcafe.com\",\"externalGroupRef\":\"\",\"externalRestaurantRef\":\"\",\"modifiedDate\":1678823073353,\"createdDate\":1678823073353,\"isoModifiedDate\":\"2023-03-14T19:44:33.353Z\",\"isoCreatedDate\":\"2023-03-14T19:44:33.353Z\"}],\"totalResultCount\":3222,\"pageSize\":1,\"currentPageToken\":\"cDoxLHM6MQ==\",\"nextPageToken\":\"cDoyLHM6MQ==\",\"totalCount\":3222,\"nextPageNum\":2,\"lastPageNum\":3222},\"properties\":{\"currentPageNum\":{\"type\":\"integer\",\"description\":\"The active page within all repsonse pages. You can see the total amount of pages at the end of the response in the `lastPageNum` field.\\n\",\"example\":12},\"results\":{\"type\":\"array\",\"description\":\"An array of `PartnerAccessExternalRep` objects that include\\ninformation about Toast platform restaurants.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PartnerAccessExternalRep\"}},\"totalResultCount\":{\"type\":\"integer\",\"description\":\"The total number of records returned.\\n\",\"example\":1234},\"pageSize\":{\"type\":\"integer\",\"description\":\"The number of restaurants returned in each page of response data.\\n\",\"example\":100},\"currentPageToken\":{\"type\":\"string\",\"description\":\"A string that identifies the current page of response data.\\n\",\"example\":\"cDoxLHM6MQ==\"},\"nextPageToken\":{\"type\":\"string\",\"description\":\"A string that identifies the following page of response data.\\n\",\"example\":\"cDoyLHM6MQ==\"},\"totalCount\":{\"type\":\"integer\",\"description\":\"The total number of results within the response record.\\n\",\"example\":1234},\"nextPageNum\":{\"type\":\"integer\",\"description\":\"The next available page in the data. `Null` if the current page of\\nresults is the last available page.\\n\",\"example\":14},\"lastPageNum\":{\"type\":\"integer\",\"description\":\"The last page number in the response data.\\n\",\"example\":13},\"previousPageNum\":{\"type\":\"integer\",\"description\":\"The page number for the page previous to your current page in\\nsequential order. `Null` if there are no pages previous to your\\ncurrent page.\\n\",\"example\":12}}}}}}},\"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-partners-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"partners.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/partners.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"partners","isDefault":true,"id":"partners","title":"partners","link":null}]},{"id":"5194d001-bbe0-59ea-8e0c-9a88fcb92ef4overview/__redocly content redirect/rx.availability.service/overview/","definitionId":"restaurantAvailabilityService","link":"/rx.availability.service/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/rx.availability.service.reference.page.yaml","info":{"version":"1.0.1","title":"Restaurant Availability Service API","description":"Returns a restaurant's availability to accept online orders.","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"restaurantAvailabilityService","label":"Restaurant availability","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-restaurant-availability-api-docs.yaml"},"apiVersions":[{"definitionId":"restaurantAvailabilityService","isDefault":true,"title":"restaurantAvailabilityService","id":"restaurantAvailabilityService"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.1\",\"title\":\"Restaurant Availability Service API\",\"description\":\"Returns a restaurant's availability to accept online orders.\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/availability\":{\"get\":{\"operationId\":\"availabilityGet\",\"summary\":\"Get online ordering availability\",\"description\":\"Returns a restaurant's current availability to accept online orders. A restaurant's availability is either `ONLINE` or `OFFLINE`. When a restaurant is offline, you can still place orders via the orders API, however Toast support recommends waiting until the restaurant's status is online.\\n\",\"tags\":[\"availability\"],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the context for this operation.\",\"in\":\"header\",\"required\":true,\"example\":\"00000000-05f4-55a4-0000-0000020f4be3\",\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successful operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RestaurantAvailability\"}}}}},\"security\":[{\"oauth2\":[\"restaurants:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/restaurant-availability/v1\"}],\"components\":{\"securitySchemes\":{\"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. \\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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"restaurants:read\":\"Allows reading from the restaurant availability API.\\n\"}}}}},\"schemas\":{\"RestaurantAvailability\":{\"type\":\"object\",\"description\":\"A representation of the restaurant's online ordering availability.\\n\",\"properties\":{\"restaurantGuid\":{\"description\":\"The Toast platform GUID of the restaurant location.\\n\",\"type\":\"string\"},\"status\":{\"description\":\"The restaurant's online ordering availability status. The `status` value can be: \\n* `ONLINE` - The restaurant's auto-fire device is approving online orders. \\n* `OFFLINE` - The restaurant's auto-fire device has stopped approving online orders.\\n\",\"type\":\"string\",\"enum\":[\"ONLINE\",\"OFFLINE\"]},\"reasonKey\":{\"description\":\"The machine-readable reason why the restaurant is available or unavailable to accept online orders. The `reasonKey` value can be: \\n* `AVAILABILITY_ONLINE` \\n* `AVAILABILITY_OFFLINE`\\n\",\"type\":\"string\",\"enum\":[\"AVAILABILITY_ONLINE\",\"AVAILABILITY_OFFLINE\"]},\"reason\":{\"description\":\"The human-readable reason why the restaurant is available or unavailable to accept online orders.\\n\",\"type\":\"string\"}}}}}}},\"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-restaurant-availability-api-docs.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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"rx.availability.service.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/rx.availability.service.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"restaurantAvailabilityService","isDefault":true,"id":"restaurantAvailabilityService","title":"restaurantAvailabilityService","link":null}]},{"id":"8c588b53-bdc0-5144-bfce-bad61ebb15dcoverview/__redocly content redirect/restaurants/overview/","definitionId":"restaurants","link":"/restaurants/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/restaurants.reference.page.yaml","info":{"title":"Restaurants API","description":"Returns information about the configuration of restaurant. \n","version":"1.0.0","contact":{"name":"Toast developer support"}},"data":{"redirect":true,"type":"reference-docs","definitionId":"restaurants","label":"Restaurants","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-restaurants-api.yaml"},"apiVersions":[{"definitionId":"restaurants","isDefault":true,"title":"restaurants","id":"restaurants"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Restaurants API\",\"description\":\"Returns information about the configuration of restaurant. \\n\",\"version\":\"1.0.0\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/restaurants/{restaurantGUID}\":{\"get\":{\"operationId\":\"restaurantsRestaurantGuidGet\",\"summary\":\"Get restaurant configuration information\",\"description\":\"Returns a `RestaurantInfo` object\\nthat contains detailed information about the configuration of a\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"restaurantGUID\",\"description\":\"The Toast GUID of the restaurant that you want to get \\ninformation about.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast GUID of the restaurant that you want to get \\ninformation about.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"includeArchived\",\"description\":\"Set `includeArchived` to `true` if the API should return information\\nabout the restaurant even if it is archived. The `General` object in\\nthe response includes an `archived` value that your integration can\\nuse to determine whether a restaurant is archived or not. A common\\nreason for a restaurant being archived is if it was created in\\nerror. Set `includeArchived` to `false` if the API should _not_\\nreturn information about the restaurant if it is archived. Defaults\\nto `false` if omitted.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"default\":false}}],\"responses\":{\"200\":{\"description\":\"A `RestaurantInfo` object that contains detailed \\ninformation about the configuration of a restaurant.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RestaurantInfo\"}}}},\"404\":{\"description\":\"If the restaurant GUID you provided is invalid, the API will return\\nan HTTP 404 response. The API will also return an HTTP 404 response\\nif you provided the GUID of an archived restaurant and you have not\\nset the `includeArchived` query parameter to `true`.\\n\"}},\"security\":[{\"oauth2\":[\"restaurants:read\"]}]}},\"/groups/{managementGroupGUID}/restaurants\":{\"get\":{\"operationId\":\"groupsManagementGroupGuidRestaurantsGet\",\"summary\":\"Get restaurants in a management group\",\"description\":\"Returns an array of `Restaurant` objects that are a part of the \\nrestaurant management group you specify in the \\n`managementGroupGUID` path parameter. Each `Restaurant` object \\ncontains the unique Toast platform identifier for the restaurant in \\nits `guid` value.\\n\",\"parameters\":[{\"name\":\"managementGroupGUID\",\"in\":\"path\",\"description\":\"The GUID of the restaurant management group.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast GUID of one restaurant location in the management \\ngroup.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"An array of `Restaurant` objects.\\n\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Restaurant\"}}}}}},\"security\":[{\"oauth2\":[\"restaurants:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/restaurants/v1\"}],\"components\":{\"securitySchemes\":{\"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. \\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\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"restaurants:read\":\"Allows reading from the restaurants API.\\n\"}}}}},\"schemas\":{\"General\":{\"type\":\"object\",\"description\":\"General information about a restaurant location.\\n\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The guest-facing name of the restaurant. For example, the\\n`name` of a restaurant might be `Tommy's Burgers`.\\n\"},\"locationName\":{\"type\":\"string\",\"description\":\"A name used externally to differentiate multiple locations, like Neighborhood, Square, City, or Hotel.\"},\"locationCode\":{\"type\":\"string\",\"description\":\"A code used internally to differentiate multiple locations, typically a 3 or 4 letter code.\"},\"description\":{\"type\":\"string\",\"description\":\"A description of the restaurant, such as information about the atmosphere and food.\"},\"timeZone\":{\"type\":\"string\",\"description\":\"The name of the restaurant's time zone in the <a \\nhref=\\\"https://www.iana.org/time-zones\\\">IANA time zone \\ndatabase</a>. For example, `America/New_York`.\\n\"},\"closeoutHour\":{\"type\":\"integer\",\"description\":\"The hour of the day that separates one business day from the\\nnext, also known as the \\\"business day cutoff time\\\". This is \\nin the time zone of the restaurant. The `closeoutHour` is set \\nto a value from 0-12 (midnight to noon) in the Business Day \\nCutoff field in Toast Web.\\n\"},\"managementGroupGuid\":{\"type\":\"string\",\"description\":\"The unique identifier of the restaurant group for the restaurant.\"},\"currencyCode\":{\"type\":\"string\",\"description\":\"The ISO-4217 currency code used in this restaurant\"},\"firstBusinessDate\":{\"type\":\"integer\",\"description\":\"The first business date (yyyyMMdd) is the day a restaurant began using the Toast platform. The\\n`firstBusinessDate` is also the first day on which time entries can be created for employees.\\n\"},\"archived\":{\"type\":\"boolean\",\"description\":\"Returns `true` if the restaurant has been archived from the Toast platform, otherwise returns `false`. A\\ncommon reason for archiving a restaurant is if the restaurant was created in error.\\n\",\"default\":false}}},\"Location\":{\"type\":\"object\",\"description\":\"Information about the physical location of a restaurant.\",\"properties\":{\"address1\":{\"type\":\"string\",\"description\":\"The first line of the street address of the restaurant.\"},\"address2\":{\"type\":\"string\",\"description\":\"The second line of the street address of the restaurant.\"},\"city\":{\"type\":\"string\",\"description\":\"The city or town of the restaurant. restaurant.\"},\"stateCode\":{\"type\":\"string\",\"description\":\"Deprecated. Get the state or province of a restaurant in the\\n`administrativeArea` value.\\n\\nThe abbreviation of the state or province of the restaurant.\\n\"},\"administrativeArea\":{\"type\":\"string\",\"description\":\"The name of the geographical division (for example, state, province,\\nor county) that the restaurant is located in.\\n\"},\"zipCode\":{\"type\":\"string\",\"description\":\"The ZIP or postal code of the restaurant.\"},\"country\":{\"type\":\"string\",\"description\":\"The nation of the restaurant.\"},\"phone\":{\"type\":\"string\"},\"phoneCountryCode\":{\"type\":\"string\",\"description\":\"A numeric code corresponding to one or more countries,\\nused as a telephone number prefix when making \\ninternational telephone calls.\\n\"},\"latitude\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The north/south geographic coordinate of the restaurant, in decimal degrees.\"},\"longitude\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The east/west geographic coordinate of the restaurant, in decimal degrees.\"}}},\"URLs\":{\"type\":\"object\",\"description\":\"Web addresses for the restaurant.\",\"properties\":{\"website\":{\"type\":\"string\",\"description\":\"The primary website for the restaurant.\"},\"facebook\":{\"type\":\"string\",\"description\":\"A Facebook™ page for the restaurant.\"},\"twitter\":{\"type\":\"string\",\"description\":\"A Twitter™ handle for the restaurant.\"},\"orderOnline\":{\"type\":\"string\",\"description\":\"A URL for the online ordering site for the restaurant.\"},\"purchaseGiftCard\":{\"type\":\"string\",\"description\":\"A URL for the gift card purchasing site for the restaurant.\"},\"checkGiftCard\":{\"type\":\"string\",\"description\":\"A URL for a site at which guests can find balances and other information about gift cards.\"}}},\"Image\":{\"type\":\"object\",\"description\":\"Information about an image.\",\"properties\":{\"width\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The width of the image, in pixels.\"},\"height\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The height of the image, in pixels.\"},\"url\":{\"type\":\"string\"},\"heightWidthRatio\":{\"type\":\"number\",\"format\":\"float\",\"description\":\"The ratio of height to width\"}}},\"Hours\":{\"type\":\"object\",\"description\":\"The period of time that the restaurant offers a service. For\\nexample, a service might be named \\\"lunch\\\" and it might be offered\\nbetween `10:00:00.000` and `16:00:00.000`.\\n\",\"properties\":{\"startTime\":{\"type\":\"string\",\"description\":\"The time of day that the service begins.\"},\"endTime\":{\"type\":\"string\",\"description\":\"The time of day that the service ends.\"}}},\"Service\":{\"type\":\"object\",\"description\":\"A time-based division of the operation of the restaurant. For\\nexample, a service might be named `lunch` and it might be\\navailable between specific hours during the day.\\n\",\"properties\":{\"name\":{\"type\":\"string\"},\"hours\":{\"$ref\":\"#/components/schemas/Hours\"},\"overnight\":{\"type\":\"boolean\",\"description\":\"Indicates whether any portion of the period of time that a\\nservice is available occurs after 00:00 (midnight) and before\\nthe business day cutoff time for the restaurant which is \\navailable in the `closeoutHour` property. An\\novernight shift spans two calendar dates but occurs during\\none business day.\\n\"}}},\"DaySchedule\":{\"type\":\"object\",\"description\":\"Information about the services and hours that are scheduled for a\\nrestaurant during a type of day. For example, a restaurant might\\nhave different services available on a type of day named\\n`weekday` than it does on a type of day named `weekend`.\\n\",\"properties\":{\"scheduleName\":{\"type\":\"string\",\"description\":\"The name of the type of day. For example, `weekday`.\"},\"services\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Service\"},\"description\":\"An array of `Service` objects that are available during the\\ntype of day.\\n\"},\"openTime\":{\"type\":\"string\",\"description\":\"The time of day that the first service for the type of day\\nbegins. For example, the first service might begin at\\n`06:00:00.000`.\\n\"},\"closeTime\":{\"type\":\"string\",\"description\":\"The time of day that the last service for the type of day\\nends. For example, the last service might end at\\n`02:00:00.000`.\\n\"}}},\"WeekSchedule\":{\"type\":\"object\",\"description\":\"The day schedule used for each day of the week. A day schedule is \\nthe set of services (for example, \\\"lunch\\\") that a restaurant \\noffers and the hours that it offers each one. If a day of the \\nweek value in this object is `null`, the restaurant is closed on \\nthat day. Values for each day of the week are identifiers for day \\nschedules in the map of `DaySchedule` objects in the \\n`daySchedules` value of the `Schedules` object.\\n\",\"properties\":{\"monday\":{\"type\":\"string\",\"description\":\"A key identifier for the `DaySchedule` object\\nthat represents the services and hours for the restaurant on\\nthis day of the week.\\n\"},\"tuesday\":{\"type\":\"string\",\"description\":\"A key identifier for the `DaySchedule` object\\nthat represents the services and hours for the restaurant on\\nthis day of the week.\\n\"},\"wednesday\":{\"type\":\"string\",\"description\":\"A key identifier for the `DaySchedule` object\\nthat represents the services and hours for the restaurant on\\nthis day of the week.\\n\"},\"thursday\":{\"type\":\"string\",\"description\":\"A key identifier for the `DaySchedule` object\\nthat represents the services and hours for the restaurant on\\nthis day of the week.\\n\"},\"friday\":{\"type\":\"string\",\"description\":\"A key identifier for the `DaySchedule` object\\nthat represents the services and hours for the restaurant on\\nthis day of the week.\\n\"},\"saturday\":{\"type\":\"string\",\"description\":\"A key identifier for the `DaySchedule` object\\nthat represents the services and hours for the restaurant on\\nthis day of the week.\\n\"},\"sunday\":{\"type\":\"string\",\"description\":\"A key identifier for the `DaySchedule` object\\nthat represents the services and hours for the restaurant on\\nthis day of the week.\\n\"}}},\"Schedules\":{\"type\":\"object\",\"description\":\"Describes the types of service and hours of operation for the\\nrestaurant over a one week period. The schedules object contains\\nservice and hour schedules for types of days and the types of\\ndays for each day of the calendar week.\\n\",\"properties\":{\"daySchedules\":{\"type\":\"object\",\"description\":\"A map of `DaySchedule` objects.\\nThe value names in this object are key identifiers that are\\nused to associate a day schedule with a day of the week in\\nthe `weekSchedule` value.\\n\",\"properties\":{\"identifier\":{\"type\":\"string\"}},\"additionalProperties\":{\"$ref\":\"#/components/schemas/DaySchedule\"}},\"weekSchedule\":{\"$ref\":\"#/components/schemas/WeekSchedule\"}}},\"Delivery\":{\"type\":\"object\",\"description\":\"Information about delivery service provided by the restaurant.\",\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant provides delivery service\\nand has enabled the delivery configuration in Toast Web.\\n\"},\"minimum\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The minimum order price that is qualified for delivery. For\\nexample, a restaurant might not deliver orders that cost less\\nthan $25.00.\\n\"},\"area\":{\"type\":\"string\",\"description\":\"The geographic area in which the restaurant provides delivery\\nservice. The delivery area is represented by an encoded set\\nof latitude and longitude coordinates that describe a polygon\\narea on a map. The coordinates are encoded using the Google\\nmaps encoded polyline algorithm format. See [more information\\nabout the way that the encoded polyline algorithm format\\nencodes location coordinates]\\n(https://developers.google.com/maps/documentation/utilities/polylinealgorithm).\\nYou can decode the coordinates of the delivery area using any\\nsoftware that supports the encoded polyline algorithm format.\\nFor example, you can decode the coordinates using [the Mapline\\nPolyline decoding program]\\n(https://github.com/mapbox/polyline). The delivery area\\ncoordinates are a JSON array of decimal degree latitude and\\nlongitude pairs. For example,\\n`[[42.36083,-71.14798],[42.34028,-71.15673],[42.3272,-71.14386]]`.\\n\"}}},\"OnlineOrdering\":{\"type\":\"object\",\"description\":\"Information about the web-based ordering configuration for the\\nrestaurant.\\n\",\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant has enabled the Toast online \\nordering module. This value is `true` if the module has ever \\nbeen enabled. The value _does not_ indicate that a restaurant \\nis accepting online orders or that the restaurant is using \\nthe Toast online ordering feature.\\n\"},\"scheduling\":{\"type\":\"boolean\",\"description\":\"Indicates whether the online ordering function for the\\nrestaurant allows guests to place orders that will be\\nfulfilled in the future. If this value is `false`, orders\\nwill be fulfilled as soon as possible.\\n\"},\"specialRequests\":{\"type\":\"boolean\",\"description\":\"Indicates whether the online ordering function for the\\nrestaurant allows guests to include written notes with\\nadditional instructions for their orders.\\n\"},\"specialRequestsMessage\":{\"type\":\"string\",\"description\":\"A written message that is shown to guests when they\\ninclude additional instructions with an order. For example,\\nthe message might be \\\"no substitutions.\\\"\\n\"},\"paymentOptions\":{\"$ref\":\"#/components/schemas/PaymentOptions\"}}},\"PaymentOptions\":{\"type\":\"object\",\"description\":\"Information about the forms of payment that the restaurant will\\naccept for orders.\\n\",\"properties\":{\"delivery\":{\"$ref\":\"#/components/schemas/DeliveryPaymentOptions\"},\"takeout\":{\"$ref\":\"#/components/schemas/TakeoutPaymentOptions\"},\"ccTip\":{\"type\":\"boolean\",\"description\":\"enables credit card tips\"}}},\"DeliveryPaymentOptions\":{\"type\":\"object\",\"description\":\"Information about the forms of payment that the restaurant will\\naccept for delivery orders.\\n\",\"properties\":{\"cash\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant accepts cash payment for\\ndelivery orders that are placed online.\\n\"},\"ccSameDay\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant accepts online credit card\\npayment for delivery orders that are delivered on the same\\nday.\\n\"},\"ccFuture\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant accepts online credit card\\npayment for delivery orders that are to be delivered on a day\\nafter the guest places the order.\\n\"}}},\"TakeoutPaymentOptions\":{\"type\":\"object\",\"description\":\"Information about the forms of payment that the restaurant will\\naccept for orders that a guest picks up in person.\\n\",\"properties\":{\"cash\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant accepts cash payment for\\ntakeout orders that are placed online.\\n\"},\"ccSameDay\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant accepts online credit card\\npayment for takeout orders that the guest will pick up on\\nthe same day.\\n\"},\"ccFuture\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant accepts online credit card\\npayment for takeout orders that the guest will pick up on\\na day after the guest places the order.\\n\"},\"ccInStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant accepts credit card payment\\nat the time the guest picks up a takeout order.\\n\"}}},\"PrepTimes\":{\"type\":\"object\",\"description\":\"Information about the scheduled availability of the dining\\noptions that are provided by the restaurant.\\n\",\"properties\":{\"deliveryPrepTime\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The amount of time, in minutes, that it takes to prepare an\\nonline delivery order.\\n\"},\"deliveryTimeAfterOpen\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The amount of time, in minutes, that it takes for delivery\\nservice to become available after the restaurant opens.\\n\"},\"deliveryTimeBeforeClose\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The amount of time, in minutes, before the restaurant closing\\ntime that delivery service becomes unavailable.\\n\"},\"takeoutPrepTime\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The amount of time, in minutes, that it takes to prepare an\\nonline takeout order.\\n\"},\"takeoutTimeAfterOpen\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The amount of time, in minutes, that it takes for takeout\\nservice to become available after the restaurant opens.\\n\"},\"takeoutTimeBeforeClose\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The amount of time, in minutes, before the restaurant closing\\ntime that takeout service becomes unavailable.\\n\"},\"takeoutThrottlingTime\":{\"type\":\"integer\",\"description\":\"The amount of time, in minutes, that an online takeout order\\nis delayed before the Toast POS fires it in the kitchen.\\n\"},\"deliveryThrottlingTime\":{\"type\":\"integer\",\"description\":\"The amount of time, in minutes, that an online delivery order\\nis delayed before the Toast POS fires it in the kitchen.\\n\"}}},\"RestaurantInfo\":{\"type\":\"object\",\"description\":\"Information about the configuration of a restaurant in the Toast\\nPOS.\\n\",\"properties\":{\"guid\":{\"type\":\"string\"},\"general\":{\"$ref\":\"#/components/schemas/General\"},\"urls\":{\"$ref\":\"#/components/schemas/URLs\"},\"location\":{\"$ref\":\"#/components/schemas/Location\"},\"schedules\":{\"$ref\":\"#/components/schemas/Schedules\"},\"delivery\":{\"$ref\":\"#/components/schemas/Delivery\"},\"onlineOrdering\":{\"$ref\":\"#/components/schemas/OnlineOrdering\"},\"prepTimes\":{\"$ref\":\"#/components/schemas/PrepTimes\"}}},\"Restaurant\":{\"type\":\"object\",\"description\":\"The Toast POS GUID for a restaurant\\n\",\"properties\":{\"guid\":{\"type\":\"string\",\"description\":\"The unique identifier that the Toast POS assigns to a\\nrestaurant.\\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-restaurants-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"restaurants.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/restaurants.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"restaurants","isDefault":true,"id":"restaurants","title":"restaurants","link":null}]},{"id":"2160ab56-ea1a-55d1-9329-e20e2436fcffoverview/__redocly content redirect/stock/overview/","definitionId":"stock","link":"/stock/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/stock.reference.page.yaml","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"},"data":{"redirect":true,"type":"reference-docs","definitionId":"stock","label":"Stock","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"},"apiVersions":[{"definitionId":"stock","isDefault":true,"title":"stock","id":"stock"}],"isDefaultApiVersion":true,"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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"stock.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/stock.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"stock","isDefault":true,"id":"stock","title":"stock","link":null}]},{"id":"e06f6ae0-b8bb-5018-a294-8d1399df5d48overview/__redocly content redirect/tender/overview/","definitionId":"tender","link":"/tender/overview/","sourcePath":"/data/toasttab/redocly-portal-configuration-prod/tender.reference.page.yaml","info":{"version":"0.1.0","title":"Toast Tender Integration API","description":"This API specification describes the interface that the Toast POS \nsystem calls when it processes tender transactions.\n\nImplement this REST API to allow the Toast POS system to process \ntender transactions, allowing payments and discounts to be applied\nto a check.\n"},"data":{"redirect":true,"type":"reference-docs","definitionId":"tender","label":"Tender integration specification","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-tender-api.yaml"},"apiVersions":[{"definitionId":"tender","isDefault":true,"title":"tender","id":"tender"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"0.1.0\",\"title\":\"Toast Tender Integration API\",\"description\":\"This API specification describes the interface that the Toast POS \\nsystem calls when it processes tender transactions.\\n\\nImplement this REST API to allow the Toast POS system to process \\ntender transactions, allowing payments and discounts to be applied\\nto a check.\\n\"},\"paths\":{\"/yourendpointname\":{\"post\":{\"summary\":\"Provides information about a tender transaction to a tender provider.\\n\",\"description\":\"Provides information about a tender transaction processed by \\nthe Toast POS system. The transaction information in the \\nmessage body is intended to allow a tender provider to \\nperform corresponding operations on the tender account, \\nmaintained by that provider. The response to this message\\nallows the Toast POS system to update the check, including posting\\npayments and discounts to the check.\\n\\nYou define the endpoint name for this implementation. The Toast \\nPOS system makes requests to the REST path that you supply \\nduring integration setup.\\n\\nEach `POST` request to the endpoint includes a \\n`Toast-Transaction-Type` header parameter value to indicate the \\ntype of tender transaction it represents. The supported \\ntransaction types are:\\n\\n* Retrieve discounts that are available on a given check.\\n* Retrieve payments that are available on a given check.\\n* Redeem retrieved payments and/or discounts.\\n* Add a tip to a previously confirmed payment.\\n* Reverse a previous redemption or gratuity.\\n* Request configured search terms for the restaurant.\\n* Search for an account.\\n\\nThe <a \\nhref=\\\"#/definitions/TenderTransaction\\\">`TenderTransaction`</a>\\nobject in the message body includes a set of information that \\nis specific for each transaction type.\\n\\nThe response time for a tender transaction request must be \\nless than 500ms on average. A response time of greater than\\n5000ms will be considered a timeout.\\n\\nAll tender transactions must be considered idempotent. The \\nimplementation must handle multiple requests with the same \\n`Toast-Transaction-GUID`, `Toast-Transaction-Type`, and \\n`tenderIdentifier`.\\n\",\"parameters\":[{\"name\":\"Toast-Transaction-GUID\",\"description\":\"A unique identifier of the tender transaction, defined \\nby the Toast POS system. This value is\\nreferenced if there is a future reverse transaction call.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The unique identifier of the restaurant, defined by the \\nToast POS system.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Alternate-Payment-Type-GUID\",\"description\":\"The unique identifier of the Alternate Payment Type used to pay for this Tender transaction.\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Toast-Transaction-Type\",\"description\":\"The type of tender transaction that occurred. Values are:\\n<ul>\\n  <li>TENDER_RETRIEVE_DISCOUNTS</li>\\n  <li>TENDER_RETRIEVE_PAYMENTS</li>\\n  <li>TENDER_REDEEM</li>\\n  <li>TENDER_GRATUITY</li>\\n  <li>TENDER_REVERSE</li>\\n  <li>TENDER_SEARCH_CONFIG</li>\\n  <li>TENDER_SEARCH</li>\\n</ul>\\n\\n</ul>\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\",\"enum\":[\"TENDER_SEARCH\",\"TENDER_SEARCH_CONFIG\",\"TENDER_RETRIEVE_DISCOUNTS\",\"TENDER_RETRIEVE_PAYMENTS\",\"TENDER_REDEEM\",\"TENDER_GRATUITY\",\"TENDER_REVERSE\"]}},{\"name\":\"Authorization\",\"description\":\"An API key used to authenticate the request. This API key is provided by the tender partner and can be found in the request header. For more information, see [Authenticating outbound API requests](https://doc.toasttab.com/doc/devguide/apiAuthenticatingRequestsFromToastApiClients.html).\\n\",\"in\":\"header\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TenderTransaction\"}}},\"description\":\"A <a \\nhref=\\\"#/definitions/TenderTransaction\\\">`TenderTransaction`</a> \\nobject containing information about the tender \\ntransaction that the Toast POS system is requesting.\\n\"},\"responses\":{\"200\":{\"description\":\"OK. The `transactionStatus` value of the \\n`TenderTransactionResponse` object is `ACCEPT`.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TenderTransactionResponse\"}}}},\"400\":{\"description\":\"Bad request. The `transactionStatus` value of the \\n`TenderTransactionResponse` object is one of:\\n\\n* `ERROR_INVALID_TOAST_TRANSACTION_TYPE`\\n* `ERROR_INVALID_INPUT_PROPERTIES`\\n* `ERROR_INVALID_TOKEN`\\n* `ERROR_INVALID_RESTAURANT`\\n* `ERROR_TRANSACTION_DOES_NOT_EXIST`\\n* `ERROR_TRANSACTION_CANNOT_BE_REVERSED`\\n* `ERROR_ACCOUNT_INVALID`\\n* `ERROR_ACCOUNT_NO_POST`\\n* `ERROR_INSUFFICIENT_FUNDS`\\n* `ERROR_UNABLE_TO_PROCESS`\\n* `FOLIO_IN_USE`\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TenderTransactionResponse\"}}}},\"500\":{\"description\":\"Internal server error.\"}}}}},\"servers\":[{\"url\":\"/yourapiname/v1\"}],\"components\":{\"schemas\":{\"TenderTransaction\":{\"type\":\"object\",\"description\":\"Information about a tender transaction in the Toast POS \\nsystem. Tender providers are expected to handle that \\ntransaction.\\n\\nThe set of information in this object depends on the tender \\ntransaction type. The transaction type is specified in the \\n`Toast-Transaction-Type` header parameter for the request.\\n\\nThe `TenderTransaction` object includes the following values \\nfor specific transaction types:\\n\\n* `TENDER_RETRIEVE_DISCOUNTS` - includes a `discountsTransactionInformation` value.\\n* `TENDER_RETRIEVE_PAYMENTS` - includes a `paymentsTransactionInformation` value.\\n* `TENDER_REDEEM` - includes a `redeemTransactionInformation` value.\\n* `TENDER_GRATUITY` - includes a `gratuityTransactionInformation` value.\\n* `TENDER_REVERSE` - includes a `reverseTransactionInformation` value.\\n* `TENDER_SEARCH_CONFIG` - no additional values.\\n* `TENDER_SEARCH` - includes an `searchTransactionInformation` value.\\n\",\"properties\":{\"searchTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationSearch\"},\"discountsTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationDiscounts\"},\"paymentsTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationPayments\"},\"redeemTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationRedeem\"},\"gratuityTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationGratuity\"},\"reverseTransactionInformation\":{\"$ref\":\"#/components/schemas/TransactionInformationReverse\"}}},\"TransactionInformationSearch\":{\"type\":\"object\",\"description\":\"A request to search for all tender accounts that match the given search terms.\\n\",\"properties\":{\"swipeData\":{\"description\":\"Decrypted data from card swipe.\\n\",\"type\":\"string\"},\"searchTerms\":{\"description\":\"A list of terms to search against. These terms are customizable based on \\nthe provider and customer. For example, many customers may want to search \\nby name, but hotels may want to search by room number.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/KeyValue\"}}}},\"TransactionInformationDiscounts\":{\"type\":\"object\",\"description\":\"A request for the provider to return a list of\\ndiscounts (if any) that apply to the given check.\\nThe Toast POS system will then send a `TENDER_RETRIEVE_PAYMENTS` request with the discounts\\napplied to the check.\\n\",\"properties\":{\"tenderIdentifier\":{\"description\":\"The unique identifier of a tender guest. This is obtained by entering a name or an email address,\\nor anything else accepted by both the customer and the partner.\\n\",\"type\":\"string\"},\"accountInfo\":{\"$ref\":\"#/components/schemas/AccountInfo\"},\"orderGuid\":{\"description\":\"The GUID of the order this check belongs to. Orders can have multiple\\nchecks, but only one check will be relevant for the transaction. The\\norder GUID can be used to later retrieve information about the order\\nand check from the Toast Orders API.\\n\",\"type\":\"string\",\"format\":\"guid\"},\"check\":{\"$ref\":\"#/components/schemas/Check\"},\"totalDiscountable\":{\"description\":\"Total amount that can be discounted on the check.\\n\",\"type\":\"number\",\"format\":\"double\"}}},\"TransactionInformationPayments\":{\"type\":\"object\",\"description\":\"A request for the provider to return a list of\\npayments that apply to the check.\\nThe Toast POS system will then send a `TENDER_REDEEM` request with the discounts\\nand payments applied to the check.\\n\",\"properties\":{\"tenderIdentifier\":{\"description\":\"The unique identifier of a tender guest. This is obtained by entering a name or an email address, or anything else accepted by both the customer and the partner.\\n\",\"type\":\"string\"},\"accountInfo\":{\"$ref\":\"#/components/schemas/AccountInfo\"},\"amount\":{\"description\":\"The amount of the requested tender. Breakdown details can be found\\nin the check object. If not present, the requested amount is\\nthe full amount owed on the check.\\n\",\"type\":\"number\",\"format\":\"double\"},\"tipAmount\":{\"description\":\"The amount of the requested gratuity, in addition to the amount requested\\nfor actual payment of the check.\\n\",\"type\":\"number\",\"format\":\"double\"},\"orderGuid\":{\"description\":\"The GUID of the order this check belongs to. Orders can have multiple\\nchecks, but only one check will be relevant for the transaction. The\\norder GUID can be used to later retrieve information about the order\\nand check from the Toast Orders API.\\n\",\"type\":\"string\",\"format\":\"guid\"},\"check\":{\"$ref\":\"#/components/schemas/Check\"},\"tenderDiscountsApplied\":{\"description\":\"The list of tender discounts retrieved by the previous `TENDER_RETRIEVE_DISCOUNTS`\\ncall that were applied to the check.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderDiscount\"}},\"tenderCouponsApplied\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderCoupon\"}}}},\"TransactionInformationRedeem\":{\"type\":\"object\",\"description\":\"A request for the provider to mark as consumed the discounts and payments\\nincluded in this message, that were previously retrieved with\\n`TENDER_RETRIEVE_DISCOUNTS` and `TENDER_RETRIEVE_PAYMENTS` calls.\\n\",\"properties\":{\"tenderIdentifier\":{\"description\":\"The unique identifier of a tender guest. This is obtained by entering a name or an email address, or anything else accepted by both the customer and the partner.\\n\",\"type\":\"string\"},\"accountInfo\":{\"$ref\":\"#/components/schemas/AccountInfo\"},\"orderGuid\":{\"description\":\"The GUID of the order this check belongs to. Orders can have multiple\\nchecks, but only one check will be relevant for the transaction. The\\norder GUID can be used to later retrieve information about the order\\nand check from the Toast Orders API.\\n\",\"type\":\"string\",\"format\":\"guid\"},\"check\":{\"$ref\":\"#/components/schemas/Check\"},\"tenderPaymentsApplied\":{\"description\":\"The list of tender payments retrieved by the previous `TENDER_RETRIEVE_PAYMENTS`\\ncall that were applied to the check.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderPayment\"}},\"tenderDiscountsApplied\":{\"description\":\"The list of tender discounts retrieved by the previous `TENDER_RETRIEVE_DISCOUNTS`\\ncall that were applied to the check.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderDiscount\"}},\"tenderCouponsApplied\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderCoupon\"}}}},\"TransactionInformationGratuity\":{\"type\":\"object\",\"description\":\"A request to add an additional gratuity to a existing tender transaction.\\n\",\"properties\":{\"accountInfo\":{\"$ref\":\"#/components/schemas/AccountInfo\"},\"transactionToUpdate\":{\"description\":\"The identifier of an earlier tender transaction. This \\nidentifier is provided in the `Toast-Transaction-GUID` header \\nparameter. This is the transaction for which an additional \\ngratuity is being requested.\\n\",\"type\":\"string\",\"format\":\"guid\"},\"additionalGratuity\":{\"description\":\"A gratuity the user wishes to add to the tender payment. This is \\non top of any gratuity already applied. The tender provider should\\nadd a new payment or update an existing payment to handle the \\nadditional gratuity amount, if possible.\\n\",\"type\":\"number\",\"format\":\"double\"},\"checkInfo\":{\"$ref\":\"#/components/schemas/CheckInfo\"},\"tenderCouponsApplied\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderCoupon\"}}}},\"TransactionInformationReverse\":{\"type\":\"object\",\"description\":\"A request to reverse discounts and/or payments made as part of a previous transaction.\\n\",\"properties\":{\"tenderIdentifier\":{\"description\":\"The unique identifier of a tender guest. This is obtained by entering a name or an email address,\\nor anything else accepted by both the customer and the partner.\\n\",\"type\":\"string\"},\"accountInfo\":{\"$ref\":\"#/components/schemas/AccountInfo\"},\"transactionToUpdate\":{\"description\":\"The identifier of an earlier tender transaction. This \\nidentifier is provided in the `Toast-Transaction-GUID` header \\nparameter. The discounts and/or payments to reverse must have been added as part of\\nthis transaction. The only transactions that can be reversed are the `TENDER_REDEEM`\\nand `TENDER_GRATUITY` transactions.\\n\",\"type\":\"string\",\"format\":\"guid\"},\"discountsToRemove\":{\"description\":\"A list of reference IDs for discounts that are to be reversed. These discounts have\\nbeen removed from the check and must be added back to the users account, if applicable.\\n\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"paymentsToRemove\":{\"description\":\"A list of reference IDs for payments that are to be reversed. These payments have\\nbeen removed from the check and the funds used must be added back to the users account,\\nif applicable.\\n\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"tenderDiscountsToRemove\":{\"description\":\"Includes the information on the discounts to be refunded.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderDiscount\"}},\"tenderPaymentsToRemove\":{\"description\":\"Includes the information on the payments to be refunded.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderPayment\"}},\"tenderCouponsToRemove\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderCoupon\"}},\"checkInfo\":{\"$ref\":\"#/components/schemas/CheckInfo\"},\"originalTransactionStatus\":{\"$ref\":\"#/components/schemas/TenderTransactionStatus\"},\"orderGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"Unique Toast order identifier associated with the refunded transaction.\\n\"}}},\"TenderTransactionResponse\":{\"type\":\"object\",\"description\":\"Information about a tender transaction from the tender \\nprovider. The Toast POS system uses this information to \\ncomplete guests' tender transactions.\\n\\nThe set of information in this object depends on the tender \\ntransaction type. The transaction type is specified in the \\n`Toast-Transaction-Type` header parameter for the request.\\n\\nAll `TenderTransactionResponse` objects must include a \\n`transactionStatus` value.\\n\\nThe `TenderTransactionResponse` object includes the following values \\nfor specific transaction types:\\n\\n* `TENDER_RETRIEVE_DISCOUNTS` - includes a `discountsResponse` value.\\n* `TENDER_RETRIEVE_PAYMENTS` - includes a `paymentsResponse` value.\\n* `TENDER_REDEEM` - no additional fields\\n* `TENDER_GRATUITY` - includes a `gratuityResponse` value.\\n* `TENDER_REVERSE` - no additional fields.\\n* `TENDER_SEARCH_CONFIG` - includes a `searchConfigResponse` value.\\n* `TENDER_SEARCH` - includes an `searchResponse` value.\\n\",\"properties\":{\"transactionStatus\":{\"$ref\":\"#/components/schemas/TenderTransactionStatus\"},\"searchConfigResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseSearchConfig\"},\"searchResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseSearch\"},\"discountsResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseDiscounts\"},\"paymentsResponse\":{\"$ref\":\"#/components/schemas/TransactionResponsePayments\"},\"gratuityResponse\":{\"$ref\":\"#/components/schemas/TransactionResponseGratuity\"}}},\"TenderTransactionStatus\":{\"description\":\"Indicates the result of a tender transaction, reported by the\\ntender service provider. This property must be present on all\\nresponses. Possible values are:\\n\\n<ul>\\n  <li>`ACCEPT` - The tender service provider processed the transaction successfully.</li>\\n  <li>`ERROR_INVALID_TOAST_TRANSACTION_TYPE` - The requested Toast-Transaction-Type is not valid.</li>\\n  <li>`ERROR_INVALID_INPUT_PROPERTIES` - The specified JSON properties in the request body are not valid.</li>\\n  <li>`ERROR_INVALID_TOKEN` - The token supplied in the `Authorization` header field is invalid.</li>\\n  <li>`ERROR_INVALID_RESTAURANT` - The restaurant specified by the `Toast-Restaurant-External-ID` is invalid.</li>\\n  <li>`ERROR_ACCOUNT_INVALID` - The tender identifier provided did not correspond to an account, or the account\\n    is not valid at the current restaurant.</li>\\n  <li>`ERROR_ACCOUNT_NO_POST` - The tender identifier provided corresponded to an account which has no card on file or\\n    has been marked as \\\"no post\\\".\\n  <li>`ERROR_FOLIO_IN_USE` - Some property management systems limit guest folio access to one source at a time. If the front desk agent is using the property management system to access a guest folio, it may be locked and therefore unavailable for room charge posting during that time.</li>\\n  <li>`ERROR_INSUFFICIENT_FUNDS` - The payment or tip, specified in TENDER_RETRIEVE_PAYMENTS or TENDER_RETRIEVE_GRATUITY,\\n    cannot be retrieved because the tender account does not have sufficient balance.</li>\\n  <li>`ERROR_UNABLE_TO_PROCESS` - The transaction cannot be processed by the partner.</li>\\n  <li>`ERROR_TRANSACTION_DOES_NOT_EXIST` - The transaction that is being requested to be reversed or updated\\n    does not exist. Only occurs on a `TENDER_REVERSE` or `TENDER_GRATUITY` response.</li>\\n  <li>`ERROR_TRANSACTION_CANNOT_BE_REVERSED` - The specified transaction cannot be reversed. Only `TENDER_REDEEM`\\n    and `TENDER_GRATUITY` transactions can be reversed.</li>\\n</ul>\\n\",\"type\":\"string\",\"enum\":[\"ACCEPT\",\"ERROR_INVALID_TOAST_TRANSACTION_TYPE\",\"ERROR_INVALID_INPUT_PROPERTIES\",\"ERROR_INVALID_TOKEN\",\"ERROR_INVALID_RESTAURANT\",\"ERROR_TRANSACTION_DOES_NOT_EXIST\",\"ERROR_TRANSACTION_CANNOT_BE_REVERSED\",\"ERROR_ACCOUNT_INVALID\",\"ERROR_ACCOUNT_NO_POST\",\"ERROR_FOLIO_IN_USE\",\"ERROR_INSUFFICIENT_FUNDS\",\"ERROR_UNABLE_TO_PROCESS\"]},\"TransactionResponseSearchConfig\":{\"type\":\"object\",\"description\":\"A list of search terms supported by the tender provider. This will populate\\nthe list of search terms displayed by the Toast POS system when a search is requested.\\n\",\"properties\":{\"searchTermNames\":{\"$ref\":\"#/components/schemas/KeyValue\"}}},\"TransactionResponseSearch\":{\"type\":\"object\",\"description\":\"A list of accounts matching the search terms submitted as part of a search request.\\n\",\"properties\":{\"searchResults\":{\"description\":\"Accounts matching the search terms submitted as part of a `TENDER_SEARCH`\\nrequest.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AccountInfo\"}},\"maxCouponsApplicable\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"integer\"}}},\"TransactionResponseDiscounts\":{\"type\":\"object\",\"description\":\"A list of discounts that apply to the given check with the given\\naccount identifier.\\n\",\"properties\":{\"account\":{\"$ref\":\"#/components/schemas/AccountInfo\"},\"tenderDiscounts\":{\"description\":\"Includes the information on the discounts to be applied to the current\\ncheck.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderDiscount\"}}}},\"TransactionResponsePayments\":{\"type\":\"object\",\"description\":\"A list of discounts that apply to the given check with the given\\naccount identifier.\\n\",\"properties\":{\"account\":{\"$ref\":\"#/components/schemas/AccountInfo\"},\"tenderPayments\":{\"description\":\"A list of the tender payments to be applied to the check.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderPayment\"}}}},\"TransactionResponseGratuity\":{\"type\":\"object\",\"description\":\"Response to a request to update the gratuity amount on an already tendered\\npayment.\\n\",\"properties\":{\"account\":{\"$ref\":\"#/components/schemas/AccountInfo\"},\"tenderPayments\":{\"description\":\"The list of payments that were updated or added to cover the requested gratuity.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderPayment\"}}}},\"AccountInfo\":{\"type\":\"object\",\"description\":\"Information related to a given tender user.\",\"properties\":{\"tenderIdentifier\":{\"description\":\"A unique identifier for this account.\",\"type\":\"string\"},\"properties\":{\"$ref\":\"#/components/schemas/KeyValue\"},\"tenderCoupons\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TenderCoupon\"}}}},\"TenderPayment\":{\"type\":\"object\",\"description\":\"Payment returned by the tender provider to be applied to the check.\\n\",\"properties\":{\"name\":{\"description\":\"Name of this payment. This name is displayed on the check.\\nRequired.\\n\",\"type\":\"string\"},\"identifier\":{\"description\":\"A unique identifier for this payment, provided by the tender provider. \\nNote that multiple payments of the same type must still have unique identifiers.\\nRequired.\\n\",\"type\":\"string\"},\"type\":{\"type\":\"string\",\"description\":\"The payment method.\",\"enum\":[\"CREDIT\",\"STORED_VALUE\",\"REWARD\",\"OTHER\",\"UNDETERMINED\"]},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of this payment, excluding tips. Required.\"},\"tipAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount tipped on this payment.\"},\"paymentGuid\":{\"description\":\"If this payment was applied to the check by the Toast POS system, this will indicate the \\nGUID of the payment object that corresponds to this tender payment.\\nRequest only.\\n\",\"type\":\"string\",\"format\":\"guid\"}}},\"TenderDiscount\":{\"type\":\"object\",\"description\":\"A discount to be applied to a check. In response to a `TENDER_RETRIEVE_DISCOUNTS`\\nrequest, the Toast POS system attempts to apply the discount to the check.\\nIn the `TENDER_RETRIEVE_PAYMENTS` and `TENDER_REDEEM`\\nrequest, the successfully applied discounts are included.\\n\",\"properties\":{\"name\":{\"description\":\"Name of this discount. This name is displayed on the check and in the restaurants reports.\\nRequired.\\n\",\"type\":\"string\"},\"identifier\":{\"description\":\"A unique identifier for this discount, provided by the tender provider. \\nNote that multiple discounts of the same type must still have unique identifiers.\\nRequired.\\n\",\"type\":\"string\"},\"amount\":{\"description\":\"Amount that will be discounted from the item or check. This cannot be more than\\nthe pre-tax total of the item or check. Required.\\n\",\"type\":\"number\",\"format\":\"double\"},\"selectionGuid\":{\"description\":\"GUID of the selection this discount applies to. Required only if this\\nis an item-level discount.\\n\",\"type\":\"string\",\"format\":\"guid\"},\"appliedDiscountGuid\":{\"description\":\"If this discount was applied to the check by the Toast POS system, this will indicate the \\nGUID of the appliedDiscount object that corresponds to this tender discount.\\nRequest only.\\n\",\"type\":\"string\",\"format\":\"guid\"}}},\"TenderCoupon\":{\"type\":\"object\",\"description\":\"Reserved for future use.\\n\",\"properties\":{\"name\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\"},\"identifier\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\"},\"status\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\",\"enum\":[\"AVAILABLE\",\"CONSUMED\"]},\"value\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"number\",\"format\":\"double\"},\"consumedTime\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"info\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\"}}},\"KeyValue\":{\"type\":\"object\",\"description\":\"An abstract key-value pair, used anytime the Toast POS system needs to submit or accept one\\nor more configurable values.\\n\",\"properties\":{\"key\":{\"description\":\"The key of the key-value pair.\",\"type\":\"string\"},\"value\":{\"description\":\"The value of the key-value pair.\",\"type\":\"string\"},\"tenderPropertyType\":{\"description\":\"An optional type describing the purpose of a key-value pair. If provided, allows\\nToast to use a key-value pair in a specialized way, such as displaying the room ID on receipts\\n\",\"type\":\"string\",\"enum\":[\"FOLIO\",\"GUEST_NAME\",\"GUEST_SURNAME\",\"RESULT_NUMBER\",\"ROOM_ID\",\"OTHER\"]},\"maxLength\":{\"description\":\"An optional maximum length of input value. Used for Tender search to limit the length of the input.\\n\",\"type\":\"string\"}}},\"RevenueCenter\":{\"type\":\"object\",\"description\":\"A data object with fields that allow reference to a Toast entity by Toast GUID\\n\",\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast platform\",\"type\":\"string\",\"format\":\"guid\"},\"name\":{\"description\":\"The name of the revenue center\",\"type\":\"string\"}}},\"Check\":{\"type\":\"object\",\"description\":\"Represents a single check within an order.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"selections\"],\"properties\":{\"openedDate\":{\"description\":\"The date on which this check was opened. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"closedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date on which this check's payment status \\nwas set to CLOSED. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date on which this check was modified. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this check was deleted. `deletedDate` \\nis only applicable when deleted is true (by default the \\nvalue will be set to 1970-01-01T00:00:00.000+0000). <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"True if this check has been deleted.\"},\"selections\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Selection\"}},\"customer\":{\"$ref\":\"#/components/schemas/Customer\"},\"appliedLoyaltyInfo\":{\"$ref\":\"#/components/schemas/AppliedLoyaltyInfo\"},\"taxExempt\":{\"type\":\"boolean\",\"default\":false,\"description\":\"True if this check is tax exempt. Tax exempt number is not yet supported.\"},\"displayNumber\":{\"type\":\"string\",\"description\":\"Generally starts at one each day and counts up. Not guaranteed to be unique.\"},\"appliedServiceCharges\":{\"type\":\"array\",\"description\":\"Any restaurant-configured service charges that applied to this check.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedServiceCharge\"}},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The dollar amount due on this check in USD, after discounts but before tax.\"},\"taxAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The computed tax amount in USD. Includes service charge and item level taxes.\"},\"totalAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The total amount due on this check in USD, including discounts and taxes.\"},\"payments\":{\"type\":\"array\",\"description\":\"Payments made on this check\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/Payment\"}},\"tabName\":{\"type\":\"string\",\"description\":\"The name of the tab on this check. This will show up on the KDS (Kitchen Display System) for pending orders. The length of `tabName` can be up to 255 characters.\"},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The payment status of this check. OPEN means there is an outstanding balance. PAID means a credit card payment has been applied but the tip has not been adjusted. CLOSED means there is no remaining amount due on this check. Toast does not prevent a CLOSED check from transitioning back to OPEN or PAID.\",\"enum\":[\"OPEN\",\"PAID\",\"CLOSED\"]},\"appliedDiscounts\":{\"type\":\"array\",\"description\":\"The discounts applied to this check.\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscount\"}},\"voided\":{\"type\":\"boolean\",\"description\":\"True if this check has been voided.\"},\"voidDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this check was voided. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"voidBusinessDate\":{\"type\":\"integer\",\"description\":\"The business date (yyyyMMdd) on which this check was \\nvoided.\\n\"},\"paidDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The most recent date on which this check received \\npayment. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"createdDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"lastModifiedDevice\":{\"$ref\":\"#/components/schemas/Device\"}}}]},\"CheckInfo\":{\"type\":\"object\",\"description\":\"Information about a check associated with a transaction\",\"required\":[\"guid\",\"displayNumber\"],\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast platform\",\"type\":\"string\",\"format\":\"guid\"},\"displayNumber\":{\"description\":\"The display number of the check\",\"type\":\"string\"}}},\"AppliedLoyaltyInfo\":{\"type\":\"object\",\"description\":\"Information about the customer loyalty program account associated with a check.\",\"required\":[\"loyaltyIdentifier\",\"vendor\"],\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"loyaltyIdentifier\":{\"type\":\"string\",\"description\":\"An identifier for the loyalty program account.\"},\"vendor\":{\"type\":\"string\",\"description\":\"The specific loyalty program service provider that supports the loyalty account. For all interactions with the Loyalty Integration API, this value will be INTEGRATION.\",\"enum\":[\"INTEGRATION\"]},\"accrualFamilyGuid\":{\"type\":\"string\",\"description\":\"An internal Toast POS identifier for loyalty program transactions.\"},\"accrualText\":{\"type\":\"string\",\"description\":\"A description of the loyalty program transaction that will be printed on the customer's receipt. For example, \\\"Earned 27 points.\\\" The maximum length of the description string is 255 characters.\"}}}]},\"Selection\":{\"type\":\"object\",\"description\":\"\\\"A `Selection` object can represent either a primary item (i.e. `Check.selections`) or a modifier (`Selection.modifiers`) selection. Quantity defaults to 1.\\n<br><br>\\nSpecify a modifier selection by adding it to the `modifiers` list of another selection. For each modifier selection, its `optionGroup` field must be set correctly, because a `MenuItem` can be included in multiple `MenuOptionGroups`, potentially with different prices or sizing.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"item\",\"quantity\"],\"properties\":{\"item\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"itemGroup\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"optionGroup\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"preModifier\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"quantity\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Quantity ordered. A decimal number for items sold by weight; a counting number for discrete items.\"},\"unitOfMeasure\":{\"type\":\"string\",\"description\":\"The unit of measure required for weighing the item. Default is NONE, which means the item is not meant to be weighed.\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\"]},\"selectionType\":{\"type\":\"string\",\"description\":\"Specifies whether this selection is a special request or other off-menu sale. If left null or NONE, describes a normal modifier or item selection.\",\"enum\":[\"NONE\",\"OPEN_ITEM\",\"SPECIAL_REQUEST\",\"PORTION\"]},\"salesCategory\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"appliedDiscounts\":{\"type\":\"array\",\"description\":\"The itemized discounts applied to this item.\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscount\"}},\"deferred\":{\"type\":\"boolean\",\"description\":\"Whether this selection is a deferred revenue transaction, e.g. gift card sales.\"},\"preDiscountPrice\":{\"type\":\"number\",\"description\":\"Gross sale price for this selection. Excludes tax.\",\"format\":\"double\"},\"price\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Net price for this selection. The final price of the item after considering discounts (including discounts at the check level), quantity adjustments, and modifier prices at the time the item was selected for purchase.\"},\"tax\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The total tax amount for this selection.\"},\"voided\":{\"type\":\"boolean\",\"description\":\"True if this selection has been voided.\"},\"voidDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this selection was voided. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"voidBusinessDate\":{\"type\":\"integer\",\"description\":\"The business date (yyyyMMdd) on which this selection was \\nvoided.\\n\"},\"voidReason\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"displayName\":{\"type\":\"string\",\"description\":\"The display name of the selection. This field can be used to set a special request value, otherwise it will be generated from the `item` property of this `Selection`.\"},\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this selection was created. Defaults to \\ncurrent time if not specified. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date on which this selection was last modified. \\nDefaults to current time if not specified. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"modifiers\":{\"type\":\"array\",\"description\":\"A list of modifiers applying to this selection.\",\"items\":{\"$ref\":\"#/components/schemas/Selection\"}},\"fulfillmentStatus\":{\"type\":\"string\",\"default\":\"NEW\",\"description\":\"Indicates the stage of the preparation workflow that the \\nmenu item selection is in. The `fulfillmentStatus` of a \\nmenu item selection changes as restaurant employees move \\nthe item through the functions of the Toast POS system, for \\nexample order entry and the kitchen display system (KDS).\\nResponse only. \\n<ul>\\n  <li>`NEW` - the menu item selection has been added to a \\n    check but has not been sent to the KDS for \\n    preparation.</li>\\n  <li>`HOLD` - a restaurant employee has paused the menu \\n    item selection so that it does not appear in the \\n    KDS for preparation.</li>\\n  <li>`SENT` - the menu item selection has been fired and \\n    appears in the KDS for preparation.</li>\\n  <li>`READY` - preparation is complete, the menu item \\n    selection has been fulfilled and no longer appears in \\n    the KDS. If your restaurant does not use the Toast POS \\n    KDS, items in an order will not reach the `READY` \\n    status.</li>\\n</ul>\\n\",\"enum\":[\"NEW\",\"HOLD\",\"SENT\",\"READY\"]},\"taxInclusion\":{\"type\":\"string\",\"description\":\"Indicates whether the menu item price includes one or more tax\\namounts. If the menu item is a modifier for another menu item\\nselection, it always inherits the tax inclusion behavior of the menu\\nitem it applies to. Values are:\\n* `INCLUDED` - the menu item price includes one or more tax amounts.\\n* `NOT_INCLUDED` - the menu item price does not include any tax\\n  amounts.\\n* `INHERITED` - the menu item is a modifier for another menu item\\n  selection in the check. The `taxInclusion` value of the parent menu\\n  item selection applies to the modifier. If a menu item selection\\n  *that is not a modifier* inherits tax inclusion behavior from a\\n  menu or menu group, the `taxInclusion` value will be either\\n  `INCLUDED` or `NOT_INCLUDED`.\\n\",\"enum\":[\"INCLUDED\",\"NOT_INCLUDED\",\"INHERITED\"]},\"appliedTaxes\":{\"type\":\"array\",\"description\":\"An array of `AppliedTaxRate` objects that contain information about tax payments made for the selection.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedTaxRate\"}}}}]},\"Payment\":{\"type\":\"object\",\"description\":\"Defines a payment.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"type\",\"amount\",\"tipAmount\"],\"properties\":{\"paidDate\":{\"description\":\"The date on which the payment was made. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"paidBusinessDate\":{\"description\":\"The business date (yyyyMMdd) on which this payment was \\nfirst applied.\\n\",\"type\":\"integer\"},\"type\":{\"type\":\"string\",\"description\":\"The payment method.\",\"enum\":[\"CASH\",\"CREDIT\",\"GIFTCARD\",\"HOUSE_ACCOUNT\",\"REWARDCARD\",\"LEVELUP\",\"TENDER\",\"OTHER\",\"UNDETERMINED\"]},\"cardEntryMode\":{\"type\":\"string\",\"description\":\"Indicates how credit card data was obtained.\",\"enum\":[\"SWIPED\",\"KEYED\",\"ONLINE\",\"EMV_CHIP_SIGN\",\"TOKENIZED\",\"PRE_AUTHED\",\"SAVED_CARD\",\"FUTURE_ORDER\"]},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of this payment, excluding tips.\"},\"tipAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount tipped on this payment.\"},\"amountTendered\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount tendered for this payment.\"},\"cardType\":{\"type\":\"string\",\"description\":\"The type of card used.\",\"enum\":[\"VISA\",\"MASTERCARD\",\"AMEX\",\"DISCOVER\",\"JCB\",\"DINERS\",\"CIT\",\"MAESTRO\",\"LASER\",\"SOLO\",\"UNKNOWN\"]},\"last4Digits\":{\"type\":\"string\",\"description\":\"The last 4 digits of the card used.\"},\"originalProcessingFee\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The original processing fee for this payment. The original processing fee value is populated after the payment has been captured.\"},\"cashDrawer\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"refundStatus\":{\"type\":\"string\",\"enum\":[\"NONE\",\"PARTIAL\",\"FULL\"]},\"refund\":{\"$ref\":\"#/components/schemas/Refund\"},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The status of this payment when the type is CREDIT.\",\"enum\":[\"OPEN\",\"PROCESSING\",\"AUTHORIZED_AT_RISK\",\"AUTHORIZED\",\"ERROR\",\"DENIED\",\"VOIDED_AT_RISK\",\"CANCELLED\",\"CAPTURE_IN_PROGRESS\",\"CAPTURED\",\"VOIDED\"]},\"voidInfo\":{\"$ref\":\"#/components/schemas/VoidInformation\"},\"houseAccount\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"otherPayment\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"createdDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"lastModifiedDevice\":{\"$ref\":\"#/components/schemas/Device\"},\"mcaRepaymentAmount\":{\"description\":\"The total currency amount withheld as repayment for a merchant\\ncash advance (MCA). The MCA repayment amount is set at the time\\nthe payment is captured, and then updated when settlement occurs.\\n\",\"type\":\"number\",\"format\":\"double\"}}}]},\"Customer\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"required\":[\"firstName\",\"lastName\",\"email\",\"phone\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"First name of the guest who placed the order.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name of the guest who placed the order.\"},\"phone\":{\"type\":\"string\",\"description\":\"The phone number corresponding to the guest who placed the order.\"},\"email\":{\"type\":\"string\",\"description\":\"The email address corresponding to the guest who placed the order. The email address is the key that identifies a unique restaurant guest, and all distinct guests should have distinct email addresses.\"}}}]},\"DeliveryInfo\":{\"type\":\"object\",\"description\":\"Required if the dining option behavior is DELIVERY\",\"required\":[\"address1\",\"city\",\"state\",\"zipCode\"],\"properties\":{\"address1\":{\"type\":\"string\",\"description\":\"The first line of the street address of the delivery destination.\\n\"},\"address2\":{\"type\":\"string\",\"description\":\"The second line of the street address of the delivery destination.\\n\"},\"city\":{\"type\":\"string\",\"description\":\"The name of the city or town of the delivery destination.\\n\"},\"state\":{\"type\":\"string\",\"format\":\"ISO 3166-2\",\"description\":\"The postal abbreviation of the state or province of the \\ndelivery destination. The abbreviation must be in ISO 3166-2 \\nformat (two capital letters).\\n\"},\"zipCode\":{\"type\":\"string\",\"description\":\"The postal or zip code of the delivery destination.\\n\"},\"latitude\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The north/south geographic coordinate of the delivery \\ndestination, in decimal format.\\n\"},\"longitude\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The east/west geographic coordinate of the delivery \\ndestination, in decimal format.\\n\"},\"notes\":{\"description\":\"Additional instructions or information about the delivery.\\n\",\"type\":\"string\"},\"deliveredDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the delivery employee indicated that \\nthe order was delivered in the Toast POS system. Response only. This \\nvalue is only set when the dining option for the order is \\n`DELIVERY`. For other dining options, the value is `null`. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"dispatchedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the restaurant indicated that the \\norder was available for delivery and assigned to a delivery \\nemployee in the Toast POS system. This value is only set when the \\ndining option for the order is `DELIVERY`. For other dining \\noptions, the value is `null`. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\"},\"deliveryEmployee\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}},\"AppliedServiceCharge\":{\"type\":\"object\",\"description\":\"A percentage/open/fixed service charge added to a check which can represent in general an upcharge like a gratuity or delivery fee. Whether the upcharge is taxable is defined in the restaurant-configured `serviceCharge`. The fields on the `AppliedServiceCharge` are computed based on the referenced `ServiceCharge` configuration.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"required\":[\"serviceCharge\"],\"properties\":{\"chargeAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The final applied amount excluding tax. This is required if amountType is OPEN.\"},\"serviceCharge\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"chargeType\":{\"description\":\"Derived from `serviceCharge`. An OPEN service charge can either be a dollar amount or a percentage.\",\"type\":\"string\",\"enum\":[\"FIXED\",\"PERCENT\",\"OPEN\"]},\"name\":{\"description\":\"Derived from `serviceCharge` - the configured human readable label for the service charge.\",\"type\":\"string\"},\"delivery\":{\"description\":\"Derived from `serviceCharge` - whether this service charge is a delivery charge.\",\"type\":\"boolean\"},\"gratuity\":{\"description\":\"Derived from `serviceCharge` - whether this service charge is a gratuity. Can be used to derive required tip amount on the check.\",\"type\":\"boolean\"},\"taxable\":{\"description\":\"Derived from `serviceCharge` - whether this service charge is taxable.\",\"type\":\"boolean\"},\"appliedTaxes\":{\"type\":\"array\",\"description\":\"Derived from `serviceCharge` - the taxes applied to the service\",\"items\":{\"$ref\":\"#/components/schemas/AppliedTaxRate\"}}}}]},\"AppliedTaxRate\":{\"type\":\"object\",\"description\":\"A tax rate applied to an `Item` or `ServiceCharge`.\",\"required\":[\"taxRate\"],\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"taxRate\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the tax rate.\"},\"rate\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The tax rate, which can be a fixed amount, a percentage, or null.\"},\"taxAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The tax amount that was actually applied.\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the tax rate. Default is percent if no tax rate config\",\"enum\":[\"PERCENT\",\"FIXED\",\"NONE\",\"TABLE\"]}}}]},\"AppliedDiscountTrigger\":{\"type\":\"object\",\"description\":\"The `Selection` which triggered the application of this discount.\",\"properties\":{\"selection\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"quantity\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the selection used to trigger the applied discount.\"}}},\"AppliedDiscount\":{\"type\":\"object\",\"description\":\"A discount applied to a check or item. The Toast POS system calculates\\nservice charges before applying discounts. The system calculates the tax\\nafter applying discounts. In a `POST` request, the type of the discount\\nmust be fixed amount or fixed percentage, and the discount must be applied\\nto a check. For more information, see [Applying discounts to an entire\\ncheck](https://doc.toasttab.com/doc/devguide/apiDiscountingOrders.html#apiApplyingDiscountsToACheck).\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the applied discount.\"},\"discountAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The discount amount in USD. This amount is subtracted from the check or item.\"},\"nonTaxDiscountAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount that a discount reduces a menu item price,\\nexcluding any discount amount applied to taxes. In most\\ncases, a discount only applies to the menu item price and\\nthe `nonTaxDiscountAmount` is the same as the `discountAmount`. \\nIf you apply a discount to a menu item that includes tax in \\nits price, the `nonTaxDiscountAmount` is less than the full \\ndiscount amount.\\n\"},\"discount\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"triggers\":{\"type\":\"array\",\"description\":\"Optional items which triggered this discount.\",\"items\":{\"$ref\":\"#/components/schemas/AppliedDiscountTrigger\"}},\"approver\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"processingState\":{\"type\":\"string\",\"description\":\"Applies to loyalty program discounts only. Loyalty\\nprogram reward discounts are validated and then applied,\\nor redeemed, by the third-party loyalty program service\\nprovider depending on the state of the Toast POS order.\\nThis value indicates the state of the discount in that\\nvalidation and application process. Response only. The\\n`processingState` may be one of the following enumerated\\nvalues.\\n<ul>\\n  <li><code>PENDING_APPLIED</code> - The loyalty program\\n  service provider has confirmed that the reward discount\\n  is valid for the order and customer. The reward has not\\n  been redeemed, or applied to the customer's loyalty\\n  account.</li>\\n  <li><code>APPLIED</code> - The reward discount has been\\n  redeemed. The reward is no longer available from the\\n  customer's loyalty program account.</li>\\n  <li><code>PENDING_VOID</code> - The reward discount has been\\n  removed from the Toast POS order. The reward is not\\n  available from the customer's loyalty program account\\n  until the loyalty program service provider processes\\n  the void operation.</li>\\n  <li><code>VOID</code> - The reward discount has been removed\\n  from the Toast POS order and the reward is available from\\n  the customer's loyalty program account again.</li>\\n</ul>\\n\",\"enum\":[\"PENDING_APPLIED\",\"APPLIED\",\"PENDING_VOID\",\"VOID\"]},\"loyaltyDetails\":{\"$ref\":\"#/components/schemas/LoyaltyDetails\"},\"comboItems\":{\"type\":\"array\",\"description\":\"A List of Menu Item Selections that this discount is applied to (empty for NonCombo Discounts).\",\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"appliedPromoCode\":{\"type\":\"string\",\"description\":\"The promo code that was applied for this discount.\"}}}]},\"LoyaltyDetails\":{\"type\":\"object\",\"description\":\"Information about the loyalty program discount applied to a check. The loyalty program account is identified in the <a href=\\\"#/definitions/AppliedLoyaltyInfo\\\">AppliedLoyaltyInfo</a> value for the check.\",\"required\":[\"vendor\",\"referenceId\"],\"properties\":{\"vendor\":{\"type\":\"string\",\"description\":\"The specific loyalty program service provider that supports the loyalty account.\",\"enum\":[\"TOAST\",\"PUNCHH\",\"PUNCHH2\",\"PAYTRONIX\",\"APPFRONT\",\"INTEGRATION\"]},\"referenceId\":{\"type\":\"string\",\"description\":\"The identifier of the loyalty program discount that is recognized by the loyalty program service provider. The Toast POS system transmits the discount identifier to the service provider to determine the validity and amount of the discount.\"}}},\"Refund\":{\"type\":\"object\",\"description\":\"A discount applied to a check or item.\",\"properties\":{\"refundAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the refund excluding the tip.\"},\"tipRefundAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the tip refund.\"},\"refundDate\":{\"description\":\"The date and time the refund was made. <a \\n    href=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\n    ISO 8601 date and time format for all Toast APIs.</a>\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"refundBusinessDate\":{\"description\":\"The business date (yyyyMMdd) on which this refund was \\ncreated.\\n\",\"type\":\"integer\"}}},\"Device\":{\"type\":\"object\",\"description\":\"The *Device ID* value that the Toast POS system assigns to a specific Toast POS device. The `id` value is a unique identifier for a device. To find the ID for a Toast POS device, do the following. From the overflow  menu (⋮) select *Device Status* and then select the *Device* tab.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"The physical ID of the device\"}}},\"VoidInformation\":{\"type\":\"object\",\"description\":\"Information about a void applied to a check or item.\",\"properties\":{\"voidUser\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"voidApprover\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"voidDate\":{\"description\":\"The date on which the refund was made. <a \\nhref=\\\"https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html\\\">Use \\nISO 8601 date and time format for all Toast APIs.</a>\\n\",\"type\":\"string\",\"format\":\"date-time\"},\"voidBusinessDate\":{\"description\":\"The business date (yyyyMMdd) on which this void was made.\\n\",\"type\":\"integer\"},\"voidReason\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}},\"ExternalReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"externalId\":{\"description\":\"External identifier string that is prefixed by the naming authority.\",\"type\":\"string\"}}}]},\"ToastReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID.\",\"required\":[\"guid\",\"entityType\"],\"properties\":{\"guid\":{\"description\":\"The GUID maintained by Toast.\",\"type\":\"string\"},\"entityType\":{\"description\":\"The type of object this is.\",\"type\":\"string\"}}}}}}},\"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-tender-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\":{}}}}}","permission":"guest","lastModified":"2024-09-05T12:56:37.000Z","redocInfoPageId":"tender.reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/toasttab/redocly-portal-configuration-prod/tender.reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"tender","isDefault":true,"id":"tender","title":"tender","link":null}]}]}}