Get online ordering schedule

Get a restaurant location's online ordering schedule.

Securityoauth2

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
Java
Python

curl -i -X GET \
  https://toast-api-server/ordermgmt-config/v1/published/orderingSchedule \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -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": ["TAKE_OUT"
],
"businessDate": 0,
"timeRanges": [{"start": "14:15:22Z",
"end": "14:15:22Z"
}
]
}
],
"scheduledOrderMaxDays": 0,
"lastOrderConfiguration": "UNTIL_CLOSING_TIME",
"timeZoneId": "America/New_York"
}