Store Opening Times
A single entry of availabilities passed as an array in the menu payload looks like the code snippet below.
"availabilities": [
{
"dayOfWeek": 1,
"startTime": "13:00",
"endTime": "21:30"
}
Each object in the array will specify a period of store availability per day, multiple non-overlapping periods can be specified per day
Field | Use | Type |
---|---|---|
dayOfWeek | An integer value that indicates the day of the week for this availability (starting at 1 for Monday). | integer |
startTime | A 24-hour HH:MM format notation of the start time of availability expressed in the local time of the location. | string |
endTime | A 24-hour HH:MM format notation of the end time of availability expressed in the local time of the location. | string |
Menu Availability vs Busy Mode
The availabilities of a menu should be reflected in the opening hours set per store. This should work in conjunction with stores being closed temporarily i.e. ordering from a menu should not be possible when the store is set to a 'PAUSED' status via 'Busy Mode'..
It should be clear to customers where ordering isn't possible if this is due to being outside the store's opening hours or if the store has been temporarily closed.
Day of week | Integer value |
---|---|
Monday | 1 |
Tuesday | 2 |
Wednesday | 3 |
Thursday | 4 |
Friday | 5 |
Saturday | 6 |
Sunday | 7 |
See below an example entry of availabilities, note that Saturday's availability ("dayOfWeek": 6
) has two periods in the day where the store is opening;
"availabilities": [
{
"dayOfWeek": 1,
"endTime": "17:00",
"startTime": "09:00"
},
{
"dayOfWeek": 2,
"endTime": "17:00",
"startTime": "09:00"
},
{
"dayOfWeek": 3,
"endTime": "17:00",
"startTime": "09:00"
},
{
"dayOfWeek": 4,
"endTime": "17:00",
"startTime": "09:00"
},
{
"dayOfWeek": 5,
"endTime": "17:00",
"startTime": "09:00"
},
{
"dayOfWeek": 6,
"endTime": "17:00",
"startTime": "09:00"
},
{
"dayOfWeek": 6,
"endTime": "22:00",
"startTime": "19:00"
},
{
"dayOfWeek": 7,
"endTime": "17:00",
"startTime": "09:00"
}
],