This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

availability_offline

The restaurant is offline and should not receive orders. Attributes in the availability_offline event’s payload include:

Value Description

restaurantGuid

A unique Toast POS identifier for the restaurant.

data type: string

format: uuid

status

OFFLINE

data type: string

format: uuid

reasonKey

AVAILABILITY_OFFLINE

The machine-readable reason why the restaurant is unavailable to accept online orders.

data type: string

reason

Restaurant cannot accept online orders

The human-readable reason why the restaurant is unavailable to accept online orders.

data type: string

Payload for an availability_offline event when a restaurant is unavailable to accept online orders

{
  "timestamp": "2021-08-23T16:40:00.063Z",
  "eventCategory": "restaurant_availability",
  "eventType": "availability_offline",
  "guid": "bf12cb0a-173a-4e66-bd3c-8121d4a5287f",
  "details": {
    "restaurantGuid": "fa1df5f1-407f-463b-aac2-f1c307fa5874",
    "status": "OFFLINE",
    "reasonKey": "AVAILABILITY_OFFLINE",
    "reason": "Restaurant cannot accept online orders"
  }
}