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.
The return data from a GET
request to the
/restaurants/{restaurantGUID}
endpoint of the restaurants API
includes an OnlineOrdering
object with the configuration for
the restaurant's Toast Online Ordering service. If the restaurant has the
Toast Online Ordering feature, restaurant employees configure these
settings on the Other Setup > Online Ordering page
on the Toast administration back-end.
The following example shows the online ordering configuration values
in the return data from a GET
request to the
/restaurants/{restaurantGUID}
endpoint of the restaurants
API.
Online Ordering Configuration in the Restaurants API
"onlineOrdering": { "enabled": true,"scheduling": true,
"specialRequests": true,
"specialRequestsMessage": "No substitutes. Additions may be charged extra.",
"paymentOptions": {
"delivery": {
"cash": true,
"ccSameDay": true,
"ccFuture": true
}, "takeout": {
"cash": true, "ccSameDay": true, "ccFuture": true, "ccInStore": true
}, "ccTip": true
} }
Indicates whether the restaurant accepts online orders from the Toast Online Ordering service. |
|
A value of |
|
Whether guests can add instructions to their online orders. |
|
If |
|
Information on the forms of payments that the restaurant accepts for delivery and takeout online orders. |
|
Information on the forms of payments that the restaurant accepts for online delivery orders. |
|
Whether cash is accepted as payment for the order. |
|
Whether the restaurant accepts online credit card payment for orders that are delivered on the same day. |
|
Whether the restaurant accepts online credit card payment for scheduled (future) orders. |
|
Information on the forms of payments that the restaurant
accepts for online takeout orders. The |
|
Whether the restaurant accepts credit card payment when the
guest picks up the takeout order in the restaurant. If
|
|
Whether guest who order online are allowed to add tips to the order when paying by credit card. |