Toast · JSON Structure

Restaurants Online Ordering Structure

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

Type: object Properties: 5
Food ServicePoint of SaleRestaurantsHospitality

OnlineOrdering is a JSON Structure definition published by Toast, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

enabled scheduling specialRequests specialRequestsMessage paymentOptions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-structure/restaurants-online-ordering-structure.json",
  "name": "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"
    }
  }
}