{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/rx.availability.service/operation/availabilityGet/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/rx.availability.service/operation/availabilityGet/","data":{"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\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/rx.availability.service/overview/","redocItemId":"tag/availability/operation/availabilityGet","redocHasInfoPage":false,"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"},"requestLogin":false,"lastModified":"2024-09-05T12:56:37.000Z"},"seo":{"title":"Get online ordering availability"}}},"pageContext":{"id":"5194d001-bbe0-59ea-8e0c-9a88fcb92ef4operation/availabilityGet__redocly content/rx.availability.service/operation/availabilityGet/","seo":{"title":"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","image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"rx.availability.service.reference.page.yaml#operation/availabilityGet","pageBaseUrl":"/rx.availability.service","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/rx.availability.service/operation/availabilityGet/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"restaurantAvailabilityService","id":"restaurantAvailabilityService","title":"restaurantAvailabilityService","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}