Get online ordering availability

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.

Request
header Parameters
Toast-Restaurant-External-ID
required
string

The Toast platform GUID of the restaurant that is the context for this operation.

Example: 00000000-05f4-55a4-0000-0000020f4be3
Responses
200

Successful operation

get/availability
Request samples
curl -i -X GET \
  https://toast-api-server/restaurant-availability/v1/availability \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
{
  • "restaurantGuid": "string",
  • "status": "ONLINE",
  • "reasonKey": "AVAILABILITY_ONLINE",
  • "reason": "string"
}