total | Total number of stores returned by the query | integer |
page | Current page number of the paginated response | integer |
size | Number of store records returned per page | integer |
items | List of store objects. Each object contains details about one store location. All fields below sit inside each item (i.e. id, address.source, …) | array of objects |
id | Unique identifier of the Deliverect store, referred to as channelLinkId in basket and checkout processing | string |
channelLinkId | Identifier linking the store to a sales channel (same value as id) | string |
channelLocationId | A location identifier known to the channel platform (set within channel settings) | string |
channel | Global identifier of the ordering channel/platform | integer |
name | Assigned name for the specific store in Deliverect (not necessarily a customer facing store name) | string |
currency | Default currency used at this store for transactions | string |
address | Store's address details, including source, coordinates, and location info (country, city, state) | object |
address.source | Full address as a single string | string |
address.coordinates | Longitude and Latitude of the store. Example: [25.276987, 55.296249] | array |
address.country | Country where the store is located | string |
address.city | City of the store | string |
address.stateOrProvince | State or province of the store | string |
address.postalCode | Postal / ZIP code | string |
openingHours | Store's standard operating hours by day of week, including timezone | object |
openingHours.timezone | Timezone identifier (IANA / TZ format) | string |
openingHours.dayTimeRanges | Opening/closing intervals for each weekday | array of objects |
openingHours.dayTimeRanges[].dayOfWeek | Day of the week (1 = Monday, 7 = Sunday) | integer |
openingHours.dayTimeRanges[].startTime | Local opening time (HH:mm:ss) | string |
openingHours.dayTimeRanges[].endTime | Local closing time (HH:mm:ss) | string |
openingHours.specialHours | Exceptions to regular hours (holidays, special events) | array of objects |
openingHours.specialHours[].name | Label for the special-hours period | string |
openingHours.specialHours[].start | First date of the special-hours period (YYYY-MM-DD) | string |
openingHours.specialHours[].end | Last date of the special-hours period (YYYY-MM-DD) | string |
openingHours.specialHours[].days | Per-date detail within the special period | array of objects |
openingHours.specialHours[].days[].date | The specific date the exception applies to | string |
openingHours.specialHours[].days[].holiday | Whether the store is fully closed (holiday) on this date | boolean |
openingHours.specialHours[].days[].openingHours | Time ranges the store is open on this date | array of objects |
openingHours.specialHours[].days[].openingHours[].begin | Local opening time on the special date | string |
openingHours.specialHours[].days[].openingHours[].end | Local closing time on the special date | string |
openingHours.scheduling | Store-level order scheduling rules | object |
openingHours.scheduling.acceptsAsapOrders | Whether "as soon as possible" orders are accepted | boolean |
openingHours.scheduling.acceptsPreOrders | Whether orders can be scheduled for a future date | boolean |
openingHours.scheduling.acceptsSameDayPreOrders | Whether pre-orders for later the same day are accepted | boolean |
openingHours.scheduling.minimumLeadTimeInMinutes | Minimum notice required before an order's fulfilment time | integer |
openingHours.scheduling.maximumDaysInAdvance | How far in the future orders can be scheduled (days) | integer |
openingHours.scheduling.slotLengthInMinutes | Length of each bookable time slot (minutes) | integer |
distance | Distance in meters returned where location filter is used ?latitude=30.4515&longitude=-91.1871 | — |
taxExclusive | Indicates whether store prices are tax-exclusive (true) or tax-inclusive (false) | boolean |
status | open — active
busy — open with delay (preparationTimeDelay in minutes);
paused — temporarily closed within normal hours, not accepting orders
closed — closed or outside opening hours; | enum |
preparationTimeDelay | Additional delay (in minutes) added to preparation time before an order is ready | integer |
contact | Contact details of the person who is managing the store | object |
contact.firstName | First name of contact person | string |
contact.lastName | Last name of contact person | string |
contact.phoneNumber | Contact phone number | string |
contact.email | Contact email address | string |
settings | Configuration of available fulfillment types (pickup, delivery, eatIn, curbside, driveThru) and their respective fees/times etc | object |
settings.<fulfillment type>
pickup|delivery|eatIn|curbside | Separate keys for "pickup", "delivery", "eatIn" exist; they share many attributes as listed below | object |
settings.<fulfillment type>.enabled | Whether this fulfillment type is active | boolean |
settings.<fulfillment type>.averagePreparationTime | Average preparation time in seconds | integer |
settings.<fulfillment type>.averagePreparationTimeMinutes | Average preparation time in minutes | integer |
settings.<fulfillment type>.serviceCharge | Service charge details | object |
settings.<fulfillment type>.serviceCharge.value | Fee amount | integer |
settings.<fulfillment type>.serviceCharge.taxRate | Tax rate applied to the fee of the service charge (3 decimal digits, e.g. 5% = 5000) | integer |
settings.<fulfillment type>.serviceCharge.type | Fee type: fixed or percent | enum |
settings.<fulfillment type>.bagFee | Packaging/bag fee | object |
settings.<fulfillment type>.bagFee.value | Fee amount expressed as integer with 2 decimal digits, e.g. $1 = 100 | integer |
settings.<fulfillment type>.bagFee.taxRate | Tax rate applied on bag fee (3 decimal digits, e.g. 5% = 5000) | integer |
settings.<fulfillment type>.scheduling | Channel-specific scheduling rules (same fields as openingHours.scheduling) | object |
settings.delivery | The delivery channel additionally includes the fields below | — |
settings.delivery.averageDeliveryTime | Average delivery time in minutes | integer |
settings.delivery.averageDeliveryTimeMinutes | Average delivery time in minutes (same value as above) | integer |
settings.delivery.deliveryFee | Delivery fee details (value, taxRate) | object |
settings.delivery.deliveryFee.value | Fee amount | integer |
settings.delivery.deliveryFee.taxRate | Tax rate applied on delivery fee (3 decimal digits, e.g. 5% = 5000) | integer |
fulfillmentTypes | Allowed values: pickup, delivery, eatIn, curbside | array of enum |
settings.<fulfillment type>.openingHours | Channel-specific opening hours (empty = store hours apply) | array |
