Order Management Configuration API (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.

Get online ordering schedule

Get a restaurant location's online ordering schedule.

Request

header Parameters

• Toast-Restaurant-External-ID required:
  string

  The identifier of the restaurant location whose online ordering schedule is to be retrieved.

  Example: 00000000-05f4-55a4-0000-0000020f4be3

Responses

200

A OrderingSchedule object.

get /published/orderingSchedule

Request samples

curl -i -X GET \
  https://toast-api-server/ordermgmt-config/v1/published/orderingSchedule \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

{
  "servicePeriods": [
    {
      "diningOptionBehavior": "TAKE_OUT",
      "dayPeriods": [
        {
          "day": "MONDAY",
          "timeRanges": [
            {
              "start": "14:15:22Z",
              "end": "14:15:22Z"
            }
          ]
        }
      ]
    }
  ],
  "overrides": [
    {
      "description": "string",
      "diningOptionBehavior": "string",
      "businessDate": "string",
      "timeRanges": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ]
    }
  ],
  "scheduledOrderMaxDays": 0
}