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.
This section provides reference information about the endpoints and data types of the Toast order management configuration API. For general information about working with Toast APIs, see API overview.
Order Management Configuration API
Base URL: /ordermgmt-config/v1, Version: 1.0
Returns a restaurant location's online ordering schedule for takeout and/or delivery, including overrides, and the maximum number of days in the future a guest can place an online order.
Summary
| Path | Operation | Description |
|---|---|---|
| /published/orderingSchedule | GET | Get online ordering schedule |
Paths
GET /published/orderingSchedule
Get a restaurant location's online ordering schedule.
| Toast-Restaurant-External-ID | The identifier of the restaurant location whose online ordering schedule is to be retrieved. |
header | string |
application/json
- 200 OK
-
A
OrderingScheduleobject.
Schema definitions
An array of Overrides objects that indicate the specific days and times when the restaurant's online ordering schedule is different from its hours of operation.
- description: string
-
Description of the planned override.
- diningOptionBehavior: string
-
The
diningOptionBehaviorthe override applies to. Can be TAKE_OUT or DELIVERY or both. - businessDate: string
-
The day when the override applies in YYYYMMDD format.
- timeRanges: object[]
-
The time range when the override starts and ends.
Holds information about the specific day and time range when the restaurant location accepts online orders.
- day: string , x ∈ { MONDAY , TUESDAY , WEDNESDAY , THURSDAY , FRIDAY , SATURDAY , SUNDAY }
-
The day the online ordering schedule is returned for.
- timeRanges: object[]
-
Contains a key value pair detailing the start and end time for online ordering in HH:MM format.
A representation of an array of servicePeriods objects.
- servicePeriods: object[]
-
An array of
servicePeriodsobjects that contain information about the days and times when the restaurant location accepts online orders. - overrides: object[]
-
An array of
overrideobjects that contain information about planned overrides.Overridesonly affect online ordering. - scheduledOrderMaxDays: integer
-
Number of days an online order can be placed into the future.
The time range when the planned override starts and ends.
- start: string (time)
-
The local time in HH:MM format when the override starts.
- end: string (time)
-
The local time in HH:MM format when the override ends.
An array of servicePeriods objects that contain information about the days and times when the restaurant location accepts online orders.
- diningOptionBehavior: string , x ∈ { TAKE_OUT , DELIVERY }
-
The dining option behavior the online ordering schedule is returned for. Options are TAKE_OUT or DELIVERY. First-party delivery must be enabled to display DELIVERY hours.
- dayPeriods: object[]
-
An array of
DayPeriodsobjects that contain information about the specific day and time range when the restaurant accepts online orders.