Getting online ordering schedules

To retrieve a restaurant location's online ordering schedule, send a GET request to the /orderingSchedule endpoint of the order management configuration API. This endpoint returns a restaurant location’s online ordering hours for takeout, delivery, or both. The ordering schedule indicates the hours when a guest can place orders for immediate or future fulfillment.

Important

Retrieve a restaurant's online ordering schedule at least once per day at the end of the business day. This ensures that you have up-to-date information about when online ordering hours begin and end on the next business day. Future orders must fall within a restaurant's ordering hours. You are responsible for respecting the restaurant’s hours. The orders API will not validate against these hours.

Request for a restaurant's online ordering schedule

In the following example, you send a GET request to the /orderingSchedule endpoint with the Toast-Restaurant-External-ID to retrieve a restaurant location's online ordering schedule.

curl -X GET \
-H "Authorization: Bearer eyJzI1NiJ9hbGciOiJSU.eyJhd9yaXR5Ij
oiQ1JVTkNIVElNRSIsInJzR3VpZCI6IjE4YzQ5YWJlLWFlODItNGFlYy04ND
M1LWJhYTRjMjVlYTY2MiIsInNjb3BlIjpbImxWQiOlsidG9hc3QiXSwibmFt
aW5nQXV0aGhYm9yIiwib3JkZXJzIiwidXNlcm1nbXQiXSwiZXhwIjoxNDg0M
zg5ODUwLCJqdGkiOiJlMDYzZjJkMy1jNGYyLTRiZjItODJmNi01MTg1NWMzZ
DAxM2YiLCJjbGllbnRfaWQiOiJjcnVuY2h0aW1lIn0.X1_0y9Hzj5F9gdOw2
o6VSYTyZwooAJiFMDmNakbZrtiUdYwLzuLwLpCMQzX5pKYtOqDUz_cetGJL3
txKL1L-K2j1Enoq8An8hEM6e8J0KdAiwrYFO3W3CmWedaoz95K9ghNZVCs28
Td2Sp3Ix3fObxbrvanocx9_OT8S9uM8hdSXmBI_ykTWvOVgK4hO24V3DJy4b
9bz1FtgOvrClhELxCe8dJy7jiwAR60xczlCF5rna98RMLN6zY4ffjmljKFZ6
QV0KkVppWjEiJn7oFHiIylCX1sSg7sddrGatj0xJzts3GJ8u8_lryUNHaEvJ
dWq4Yzwo007AMgxjH9d241Y-g" 1\
-H "Toast-Restaurant-External-ID: 27d35c6a-7068-49f7-bee0-25e654e1227a" 2 \
"https://[toast-api-hostname]/ordermgmt-config/v1/published/orderingSchedule

1

Include an authentication token. For more information, see Authentication and restaurant access.

2

Specify the location GUID of the restaurant whose online ordering schedule you want to retrieve.


Response containing a restaurant's online ordering schedule

The following example shows a restaurant location's online ordering schedule for both DELIVERY and TAKEOUT dining option behaviors. The /orderingSchedule endpoint returns an array of values configured in the Online Ordering Hours section on the Takeout & delivery page in the Toast administration back-end. Restaurant operators must have first-party delivery enabled in the Toast administration back-end to display DELIVERY hours.

Note

Online ordering hours can extend past midnight as long as they are before the closeout hour. The closeout hour is the business day cutoff, which is the hour of the day that ends the current business day and starts the next. Allow at least 15 minutes between the end of the online ordering hour and the closeout hour. To configure your closeout hours, contact Toast support.

{
    "servicePeriods": [
        {
            "diningOptionBehavior": "DELIVERY" 1,
            "dayPeriods": [
                {
                    "day": "MONDAY",
                    "timeRanges": [
                        {
                            "start": "11:00" 2,
                            "end": "02:00"
                        }
                    ]
                },
                {
                    "day": "WEDNESDAY",
                    "timeRanges": [
                        {
                            "start": "11:00",
                            "end": "20:00"
                        }
                    ]
                },
                {
                    "day": "FRIDAY",
                    "timeRanges": [
                        {
                            "start": "11:00",
                            "end": "20:00"
                        }
                    ]
                },
                {
                    "day": "SATURDAY",
                    "timeRanges": [
                        {
                            "start": "12:00",
                            "end": "19:00"
                        }
                    ]
                }
            ]
        },
        {
            "diningOptionBehavior": "TAKE_OUT",
            "dayPeriods": [
                {
                    "day": "MONDAY",
                    "timeRanges": [
                        {
                            "start": "11:00",
                            "end": "02:00"
                        }
                    ]
                },
                {
                    "day": "WEDNESDAY",
                    "timeRanges": [
                        {
                            "start": "11:00",
                            "end": "20:00"
                        }
                    ]
                },
                {
                    "day": "FRIDAY",
                    "timeRanges": [
                        {
                            "start": "11:00",
                            "end": "20:00"
                        }
                    ]
                },
                {
                    "day": "SATURDAY",
                    "timeRanges": [
                        {
                            "start": "10:00",
                            "end": "19:00"
                        }
                    ]
                }
            ]
        }
    ],
    "overrides": 3 [
        {
            "description": "Staff meeting",
            "diningOptionBehavior": 4 [
                "DELIVERY",
                "TAKE_OUT"
            ],
            "businessDate": 20211004,
            "timeRanges": [
                {
                    "start": "12:00",
                    "end": "15:30"
                }
            ]
        }
    ],
    "scheduledOrderMaxDays": 21 5
}

1

The diningOptionBehavior the online ordering schedule is returned for.

2

The local time in HH:MM format.

3

Returns planned overrides. Scheduled overrides are customizable increments of 15 minutes when a restaurant can change their online ordering schedule independent of their standard hours of operation. Examples include holidays, staff meetings, and private parties. Overrides can be added to a restaurant’s standard hours of operation.

4

Indicates which diningOptionBehavior the override applies to.

5

The maximum number of days in the future a guest can schedule an online order. You should not place orders more than the scheduledOrderMaxDays. This value can be configured in the Online ordering section on the Takeout & delivery page in the Toast administration back-end.


The values returned are organized by diningOptionBehavior.

  • If the restaurants you work with manage their own delivery, use DELIVERY hours. For more information on how to configure self-delivery, see Setting Up Takeout & Delivery Using Your Own Drivers.

  • If you or the restaurants you work with offer third-party orders and pickup, use TAKE_OUT hours.

  • To display general restaurant availability, use TAKE_OUT hours.

Determining if a restaurant accepts online orders

In the following example, the response returns an empty array. This means the restaurant location has not configured their online ordering hours in the Toast administration back-end. We recommend you contact the restaurant location prior to going live to confirm online ordering hours have been configured.

{
    "servicePeriods": [],
    "overrides": [],
    "scheduledOrderMaxDays": 0
}