Toast · Schema

OnlineOrdering

Information about the web-based ordering configuration for the restaurant.

Food ServicePoint of SaleRestaurantsHospitality

Properties

Name	Type	Description
enabled	boolean	Indicates whether the restaurant has enabled the Toast online ordering module. This value is `true` if the module has ever been enabled. The value _does not_ indicate that a restaurant is accepting on
scheduling	boolean	Indicates whether the online ordering function for the restaurant allows guests to place orders that will be fulfilled in the future. If this value is `false`, orders will be fulfilled as soon as poss
specialRequests	boolean	Indicates whether the online ordering function for the restaurant allows guests to include written notes with additional instructions for their orders.
specialRequestsMessage	string	A written message that is shown to guests when they include additional instructions with an order. For example, the message might be "no substitutions."
paymentOptions	object	Information about the forms of payment that the restaurant accepts for online orders.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/restaurants-online-ordering-schema.json",
  "title": "OnlineOrdering",
  "description": "Information about the web-based ordering configuration for the\nrestaurant.\n",
  "type": "object",
  "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": "#/definitions/PaymentOptions",
      "description": "Information about the forms of payment that the restaurant\naccepts for online orders.\n"
    }
  }
}