How to Retrieve Store Details

Retrieve storeId(s)

A storeId is the unique identifier for a store–channel (ordering platform) at a specific location. and may also be referenced as channelLinkId throughout the documentation. Baskets are created in association with a specific storeId.

In order to retrieve the stores existing on a specific location the GET STORES should be used.

Use the Get stores endpoint to retrieve the storeId for an account.

Store Opening hours

Ordering should only be possible within the store opening hours. 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

"openingHours": {
    "timezone": "Europe/Brussels",
    "dayTimeRanges": [
        {
            "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": 3,
            "endTime": "22:00",
            "startTime": "19:00"
        }
    ]
}

Store Status

An attribute "status" as shown in example below indicates whether a store is currently open or closed according to their configured operating hours. Additional statuses account for a temporary change in order acceptance, due to a function named 'Busy Mode' where the store is handling high demand by marking themselves as busy with delayed preparation times to be expected or not accepting any orders at present paused

Status	Use	Format
`open`	The store is open and accepting orders	str
`closed`	The store is closed at this time and not accepting orders	str
`busy`	The store is accepting orders, but with a delay in the preparation time marked in minutes as `preparationTimeDelay`. ASAP orders should not be possible and customer's made aware and expect delay	str
`paused`	the store is not currently accepting orders	str

"status": "busy",
"preparationTimeDelay": 30,

Testing busy mode & opening hours

From Locations > Select Opening hours / busy mode