---
updatedAt: 2026-09-19T10:28:33.000Z
agentTools:
projectIndex: https://developers.deliverect.com/v3.0-ordering-experience/llms.txt
---
# Get Stores
## Purpose
Returns a list of all active stores within a specified account. A store represents a unique location, with its address, operating hours, currency, and live operating status, along with supported fulfillment types, each carrying its own availability, fees, preparation times and scheduling rules.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Commerce API",
"description": " Our Commerce API powers digital ordering via endpoints that provide store details, menu data, basket calculation and validation and provides a checkout flow to handle POS order injection.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.staging.deliverect.com"
}
],
"security": [
{
"oauth2ClientCredentials": []
}
],
"components": {
"securitySchemes": {
"oauth2ClientCredentials": {
"type": "oauth2",
"description": "Obtain an access token using the partner client ID and client secret. Send the returned token with each API request in the Authorization header as a Bearer token.",
"flows": {
"clientCredentials": {
"tokenUrl": "/oauth/token",
"scopes": {}
}
}
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true,
"oauth-options": {
"useInsecureClientAuthentication": true
}
},
"x-readme-fauxas": true,
"paths": {
"/commerce/{accountId}/stores": {
"get": {
"tags": [
"Endpoints"
],
"summary": "Get Stores",
"operationId": "commerce-channel-api-stores-get-stores",
"parameters": [
{
"name": "accountId",
"in": "path",
"schema": {
"type": "string",
"default": ""
},
"required": true
},
{
"name": "page",
"in": "query",
"description": "Page to be returned",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
},
"example": 1
},
{
"name": "size",
"in": "query",
"description": "Number of stores to be returned per page - Max: 100",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
},
"example": 20
},
{
"name": "latitude",
"in": "query",
"description": "Reference latitude coordinate to calculate store distance. Querying by `latitude` & `longitude` returns stores with a `distance` attribute representing, in metres, how far the store is from the given coordinates. To sort results by distance, add `&sort=distance`.",
"schema": {
"type": "number",
"format": "float"
},
"example": 30.4515
},
{
"name": "longitude",
"in": "query",
"description": "Reference longitude coordinate to calculate store distance. Querying by `latitude` & `longitude` returns stores with a `distance` attribute representing, in metres, how far the store is from the given coordinates. To sort results by distance, add `&sort=distance`.",
"schema": {
"type": "number",
"format": "float"
},
"example": -91.1871
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string",
"default": "distance",
"enum": [
"distance"
]
},
"description": "Attribute to sort results by (requires `latitude` & `longitude` to be supplied).",
"example": "distance"
},
{
"name": "fulfillmentType",
"in": "query",
"description": "Refines the stores returned to those supporting the specified fulfillment type(s). Combine multiple types (comma-separated) to match stores supporting any of the specified types.",
"schema": {
"type": "string",
"enum": [
"pickup",
"delivery",
"eatIn",
"curbside"
]
},
"example": "delivery"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": {
"total": 14,
"page": 1,
"size": 10,
"items": [
{
"id": "65eee6a9984a1bc1b9637c59",
"channelLinkId": "65eee6a9984a1bc1b9637c59",
"name": "Store Name",
"currency": "USD",
"address": {
"source": "350 5th Ave, New York, NY 10118",
"coordinates": [
-73.985428,
40.748817
],
"country": "US",
"city": "New York",
"stateOrProvince": "NY"
},
"openingHours": {
"timezone": "America/New_York",
"dayTimeRanges": [
{
"dayOfWeek": 1,
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": 2,
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": 3,
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": 4,
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": 5,
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": 6,
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": 7,
"startTime": "00:00:00",
"endTime": "23:59:00"
}
]
},
"distance": 1235,
"taxExclusive": false,
"status": "open",
"channelLocationId": "STORE0005",
"contact": {
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "+32411111111",
"email": "john.doe@acme.com"
},
"fulfillmentTypes": [
"pickup",
"delivery",
"eatIn"
]
},
{
"id": "65eee6a9984a1bc1b9637c60",
"channelLinkId": "65eee6a9984a1bc1b9637c60",
"name": "Store Name 2",
"currency": "USD",
"address": {
"source": "20 W 34th St, New York, NY 10001",
"coordinates": [
-73.9857,
40.7505
],
"country": "US",
"city": "New York",
"stateOrProvince": "NY"
},
"openingHours": {
"timezone": "America/New_York",
"dayTimeRanges": []
},
"distance": 890,
"taxExclusive": false,
"status": "closed",
"channelLocationId": "",
"fulfillmentTypes": []
}
]
}
}
},
"schema": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of stores returned by the query",
"example": 14,
"default": 0
},
"page": {
"type": "integer",
"description": "Current page number of the paginated response",
"example": 1,
"default": 0
},
"size": {
"type": "integer",
"description": "Number of store records returned per page",
"example": 10,
"default": 0
},
"items": {
"type": "array",
"description": "List of store objects. Each object contains details about one store location.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the Deliverect store, referred to as `channelLinkId` in basket and checkout processing",
"example": "65eee6a9984a1bc1b9637c59"
},
"channelLinkId": {
"type": "string",
"description": "Identifier linking the store to a sales channel (same value as `id`)",
"example": "65eee6a9984a1bc1b9637c59"
},
"channelLocationId": {
"type": "string",
"description": "A location identifier known to the channel platform (set within channel settings)",
"example": "STORE0005"
},
"channel": {
"type": "integer",
"description": "Global identifier of the ordering channel/platform",
"example": 19066
},
"name": {
"type": "string",
"description": "Assigned name for the specific store in Deliverect (not necessarily a customer facing store name)",
"example": "Store Name"
},
"currency": {
"type": "string",
"description": "Default currency used at this store for transactions. See list of currencies here.",
"example": "USD"
},
"address": {
"type": "object",
"description": "Store's address details, including source, coordinates, and location info (country, city, state)",
"properties": {
"source": {
"type": "string",
"description": "Full address as a single string",
"example": "1 Main street D13 R2P6 Ghent VOV"
},
"coordinates": {
"type": "array",
"description": "Longitude and Latitude of the store. Example: [25.276987, 55.296249]",
"items": {
"type": "number",
"example": 3.73398891371018
}
},
"country": {
"type": "string",
"description": "Country where the store is located",
"example": "BE"
},
"city": {
"type": "string",
"description": "City of the store",
"example": "Ghent"
},
"stateOrProvince": {
"type": "string",
"description": "State or province of the store",
"example": "VOV"
},
"postalCode": {
"type": "string",
"description": "Postal / ZIP code",
"example": "9000"
}
}
},
"openingHours": {
"type": "object",
"description": "Store's standard operating hours by day of week, including timezone. See more info on store opening hours here.",
"properties": {
"timezone": {
"type": "string",
"description": "Timezone identifier (IANA / TZ format)",
"example": "Europe/Brussels"
},
"dayTimeRanges": {
"type": "array",
"description": "Opening/closing intervals for each weekday",
"items": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "integer",
"description": "Day of the week (`1` = Monday, `7` = Sunday)",
"example": 1
},
"startTime": {
"type": "string",
"description": "Local opening time (`HH:mm:ss`)",
"example": "00:00:00"
},
"endTime": {
"type": "string",
"description": "Local closing time (`HH:mm:ss`)",
"example": "23:59:00"
}
}
}
},
"specialHours": {
"type": "array",
"description": "Exceptions to regular hours (holidays, special events)",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Label for the special-hours period",
"example": "4th July"
},
"start": {
"type": "string",
"description": "First date of the special-hours period (`YYYY-MM-DD`)",
"example": "2026-07-04"
},
"end": {
"type": "string",
"description": "Last date of the special-hours period (`YYYY-MM-DD`)",
"example": "2026-07-04"
},
"days": {
"type": "array",
"description": "Per-date detail within the special period",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The specific date the exception applies to",
"example": "2026-07-04"
},
"holiday": {
"type": "boolean",
"description": "Whether the store is fully closed (holiday) on this date",
"example": false
},
"openingHours": {
"type": "array",
"description": "Time ranges the store is open on this date",
"items": {
"type": "object",
"properties": {
"begin": {
"type": "string",
"description": "Local opening time on the special date",
"example": "09:00:00"
},
"end": {
"type": "string",
"description": "Local closing time on the special date",
"example": "12:00:00"
}
}
}
}
}
}
}
}
}
},
"scheduling": {
"type": "object",
"description": "Store-level order scheduling rules",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
},
"taxExclusive": {
"type": "boolean",
"description": "Indicates whether store prices are tax-exclusive (true) or tax-inclusive (false)",
"example": true
},
"status": {
"type": "string",
"description": "Current operating status of the store. See more info on statuses here.",
"enum": [
"open",
"busy",
"paused",
"closed"
],
"example": "open"
},
"preparationTimeDelay": {
"type": "integer",
"description": "Additional delay (in minutes) added to preparation time before an order is ready",
"example": 0
},
"contact": {
"type": "object",
"description": "Contact details of the person who is managing the store",
"properties": {
"firstName": {
"type": "string",
"description": "First name of contact person",
"example": "John"
},
"lastName": {
"type": "string",
"description": "Last name of contact person",
"example": "Doe"
},
"phoneNumber": {
"type": "string",
"description": "Contact phone number",
"example": "+32411111111"
},
"email": {
"type": "string",
"description": "Contact email address",
"example": "john.doe@acme.com"
}
}
},
"settings": {
"type": "object",
"description": "Configuration of each fulfillment type's fees, timing, and scheduling rules",
"properties": {
"pickup": {
"type": "object",
"description": "Settings for the `pickup` fulfillment type",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether this fulfillment type is active",
"example": true
},
"averagePreparationTime": {
"type": "integer",
"description": "Average preparation time in seconds",
"example": 900
},
"averagePreparationTimeMinutes": {
"type": "integer",
"description": "Average preparation time in minutes",
"example": 15
},
"serviceCharge": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
},
"type": {
"type": "string",
"enum": [
"fixed",
"percent"
],
"description": "How the fee is calculated",
"example": "percent"
}
},
"description": "Service charge details"
},
"bagFee": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
}
},
"description": "Packaging/bag fee"
},
"openingHours": {
"type": "array",
"description": "Channel-specific opening hours (empty = store hours apply). See more info on store opening hours here.",
"items": {
"type": "object",
"description": "Store's standard operating hours by day of week, including timezone",
"properties": {
"timezone": {
"type": "string",
"description": "Timezone identifier (IANA / TZ format)",
"example": "Europe/Brussels"
},
"dayTimeRanges": {
"type": "array",
"description": "Opening/closing intervals for each weekday",
"items": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "integer",
"description": "Day of the week (`1` = Monday, `7` = Sunday)",
"example": 1
},
"startTime": {
"type": "string",
"description": "Local opening time (`HH:mm:ss`)",
"example": "00:00:00"
},
"endTime": {
"type": "string",
"description": "Local closing time (`HH:mm:ss`)",
"example": "23:59:00"
}
}
}
},
"scheduling": {
"type": "object",
"description": "Store-level order scheduling rules",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
}
},
"scheduling": {
"type": "object",
"description": "Channel-specific scheduling rules (same fields as `openingHours.scheduling`)",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
},
"delivery": {
"type": "object",
"description": "Settings for the `delivery` fulfillment type",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether this fulfillment type is active",
"example": true
},
"averagePreparationTime": {
"type": "integer",
"description": "Average preparation time in seconds",
"example": 900
},
"averagePreparationTimeMinutes": {
"type": "integer",
"description": "Average preparation time in minutes",
"example": 15
},
"serviceCharge": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
},
"type": {
"type": "string",
"enum": [
"fixed",
"percent"
],
"description": "How the fee is calculated",
"example": "percent"
}
},
"description": "Service charge details"
},
"bagFee": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
}
},
"description": "Packaging/bag fee"
},
"openingHours": {
"type": "array",
"description": "Channel-specific opening hours (empty = store hours apply). See more info on store opening hours here.",
"items": {
"type": "object",
"description": "Store's standard operating hours by day of week, including timezone",
"properties": {
"timezone": {
"type": "string",
"description": "Timezone identifier (IANA / TZ format)",
"example": "Europe/Brussels"
},
"dayTimeRanges": {
"type": "array",
"description": "Opening/closing intervals for each weekday",
"items": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "integer",
"description": "Day of the week (`1` = Monday, `7` = Sunday)",
"example": 1
},
"startTime": {
"type": "string",
"description": "Local opening time (`HH:mm:ss`)",
"example": "00:00:00"
},
"endTime": {
"type": "string",
"description": "Local closing time (`HH:mm:ss`)",
"example": "23:59:00"
}
}
}
},
"scheduling": {
"type": "object",
"description": "Store-level order scheduling rules",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
}
},
"scheduling": {
"type": "object",
"description": "Channel-specific scheduling rules (same fields as `openingHours.scheduling`)",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
},
"averageDeliveryTime": {
"type": "integer",
"description": "Average delivery time in minutes",
"example": 900
},
"averageDeliveryTimeMinutes": {
"type": "integer",
"description": "Average delivery time in minutes (same value as above)",
"example": 15
},
"deliveryFee": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
}
},
"description": "Delivery fee details (value, taxRate)"
}
}
},
"eatIn": {
"type": "object",
"description": "Settings for the `eatIn` fulfillment type",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether this fulfillment type is active",
"example": true
},
"averagePreparationTime": {
"type": "integer",
"description": "Average preparation time in seconds",
"example": 900
},
"averagePreparationTimeMinutes": {
"type": "integer",
"description": "Average preparation time in minutes",
"example": 15
},
"serviceCharge": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
},
"type": {
"type": "string",
"enum": [
"fixed",
"percent"
],
"description": "How the fee is calculated",
"example": "percent"
}
},
"description": "Service charge details"
},
"bagFee": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
}
},
"description": "Packaging/bag fee"
},
"openingHours": {
"type": "array",
"description": "Channel-specific opening hours (empty = store hours apply). See more info on store opening hours here.",
"items": {
"type": "object",
"description": "Store's standard operating hours by day of week, including timezone",
"properties": {
"timezone": {
"type": "string",
"description": "Timezone identifier (IANA / TZ format)",
"example": "Europe/Brussels"
},
"dayTimeRanges": {
"type": "array",
"description": "Opening/closing intervals for each weekday",
"items": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "integer",
"description": "Day of the week (`1` = Monday, `7` = Sunday)",
"example": 1
},
"startTime": {
"type": "string",
"description": "Local opening time (`HH:mm:ss`)",
"example": "00:00:00"
},
"endTime": {
"type": "string",
"description": "Local closing time (`HH:mm:ss`)",
"example": "23:59:00"
}
}
}
},
"scheduling": {
"type": "object",
"description": "Store-level order scheduling rules",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
}
},
"scheduling": {
"type": "object",
"description": "Channel-specific scheduling rules (same fields as `openingHours.scheduling`)",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
},
"curbside": {
"type": "object",
"description": "Settings for the `curbside` fulfillment type",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether this fulfillment type is active",
"example": true
},
"averagePreparationTime": {
"type": "integer",
"description": "Average preparation time in seconds",
"example": 900
},
"averagePreparationTimeMinutes": {
"type": "integer",
"description": "Average preparation time in minutes",
"example": 15
},
"serviceCharge": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
},
"type": {
"type": "string",
"enum": [
"fixed",
"percent"
],
"description": "How the fee is calculated",
"example": "percent"
}
},
"description": "Service charge details"
},
"bagFee": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
}
},
"description": "Packaging/bag fee"
},
"openingHours": {
"type": "array",
"description": "Channel-specific opening hours (empty = store hours apply). See more info on store opening hours here.",
"items": {
"type": "object",
"description": "Store's standard operating hours by day of week, including timezone",
"properties": {
"timezone": {
"type": "string",
"description": "Timezone identifier (IANA / TZ format)",
"example": "Europe/Brussels"
},
"dayTimeRanges": {
"type": "array",
"description": "Opening/closing intervals for each weekday",
"items": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "integer",
"description": "Day of the week (`1` = Monday, `7` = Sunday)",
"example": 1
},
"startTime": {
"type": "string",
"description": "Local opening time (`HH:mm:ss`)",
"example": "00:00:00"
},
"endTime": {
"type": "string",
"description": "Local closing time (`HH:mm:ss`)",
"example": "23:59:00"
}
}
}
},
"scheduling": {
"type": "object",
"description": "Store-level order scheduling rules",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
}
},
"scheduling": {
"type": "object",
"description": "Channel-specific scheduling rules (same fields as `openingHours.scheduling`)",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
},
"driveThru": {
"type": "object",
"description": "Settings for the `driveThru` fulfillment type",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether this fulfillment type is active",
"example": true
},
"averagePreparationTime": {
"type": "integer",
"description": "Average preparation time in seconds",
"example": 900
},
"averagePreparationTimeMinutes": {
"type": "integer",
"description": "Average preparation time in minutes",
"example": 15
},
"serviceCharge": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
},
"type": {
"type": "string",
"enum": [
"fixed",
"percent"
],
"description": "How the fee is calculated",
"example": "percent"
}
},
"description": "Service charge details"
},
"bagFee": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100",
"example": 250
},
"taxRate": {
"type": "integer",
"description": "Tax rate applied to the fee (3 decimal digits, e.g. 5% = `5000`)",
"example": 0
}
},
"description": "Packaging/bag fee"
},
"openingHours": {
"type": "array",
"description": "Channel-specific opening hours (empty = store hours apply). See more info on store opening hours here.",
"items": {
"type": "object",
"description": "Store's standard operating hours by day of week, including timezone",
"properties": {
"timezone": {
"type": "string",
"description": "Timezone identifier (IANA / TZ format)",
"example": "Europe/Brussels"
},
"dayTimeRanges": {
"type": "array",
"description": "Opening/closing intervals for each weekday",
"items": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "integer",
"description": "Day of the week (`1` = Monday, `7` = Sunday)",
"example": 1
},
"startTime": {
"type": "string",
"description": "Local opening time (`HH:mm:ss`)",
"example": "00:00:00"
},
"endTime": {
"type": "string",
"description": "Local closing time (`HH:mm:ss`)",
"example": "23:59:00"
}
}
}
},
"scheduling": {
"type": "object",
"description": "Store-level order scheduling rules",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
}
},
"scheduling": {
"type": "object",
"description": "Channel-specific scheduling rules (same fields as `openingHours.scheduling`)",
"properties": {
"acceptsAsapOrders": {
"type": "boolean",
"description": "Whether \"as soon as possible\" orders are accepted",
"example": false
},
"acceptsPreOrders": {
"type": "boolean",
"description": "Whether orders can be scheduled for a future date",
"example": false
},
"acceptsSameDayPreOrders": {
"type": "boolean",
"description": "Whether pre-orders for later the same day are accepted",
"example": false
},
"minimumLeadTimeInMinutes": {
"type": "integer",
"description": "Minimum notice required before an order's fulfilment time",
"example": 30
},
"maximumDaysInAdvance": {
"type": "integer",
"description": "How far in the future orders can be scheduled (days)",
"example": 30
},
"slotLengthInMinutes": {
"type": "integer",
"description": "Length of each bookable time slot (minutes)",
"example": 30
}
}
}
}
}
}
},
"fulfillmentTypes": {
"type": "array",
"description": "Fulfillment types enabled for this store",
"items": {
"type": "string",
"enum": [
"pickup",
"delivery",
"eatIn",
"curbside",
"driveThru"
],
"example": "pickup"
}
},
"distance": {
"type": [
"integer",
"null"
],
"description": "Distance in meters from the reference coordinates, returned when `?latitude=` and `?longitude=` are supplied; `null` otherwise",
"example": 1235
}
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"examples": {
"Insufficient permissions": {
"summary": "Insufficient permissions",
"value": {
"code": "insufficient_permissions",
"description": ""
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"examples": {
"Account not found": {
"summary": "Account not found",
"value": {
"error": "account not found",
"http_code": 404,
"description": "account not found"
}
}
}
}
}
}
},
"deprecated": false
}
}
}
}
```