Skip to main content

Retrieve Store Details

Updated over a week ago

Before basket creation, the ordering platform must retrieve storeIds and menuIds.

Retrieve a storeId

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.

Store opening hours

Ordering should only be possible during a store's opening hours. Each object in the array specifies a period of store availability. 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

Store status

An attribute "status" shows whether a store is currently open or closed in accordance with its configured operating hours. The busy and paused statuses are used when busy mode is active for the store.

Status

Use

Format

open

The store is open and accepting orders

string

closed

The store is closed at this time and is not accepting orders

string

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 customers are made aware to expect a delay.

string

paused

The store is currently not accepting orders.

string

Did this answer your question?