Stores - Glossary


Parameters

Meaning

Type

total

Total number of stores returned by the query

integer

page

Current page number of the paginated response

integer

size

umber of store records returned per page

integer

items

List of store objects. Each object contains details about one store location

array of objects

id

Unique identifier of the Deliverect store, also referred to as channelLinkId

string

name

Human-readable name of the store location

string

currency

Default currency used at this store for transactions

string

channel

Identifier of the ordering channel/platform the store is linked to

integer

address

Store’s address details, including source, coordinates, and location info (country, city, state).

object

address.source

Raw address source 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

address.stateOrProvince

string

openingHours

Store’s operating hours by day of week, including timezone

object

openingHours.`timezone``

Timezone identifier (IANA format) Example: "Asia/Calcutta"

string

openingHours.dayTimeRanges

Opening/closing intervals for each weekday

array

openingHours.dayTimeRanges.dayOfWeek

Day of the week (1 = Monday, 7 = Sunday)

integer

openingHours.dayTimeRanges.startTime

Opening time (HH:mm:ss)

string

openingHours.dayTimeRanges.endTime

Closing time (HH:mm:ss).

string

distance

taxExclusive

Indicates whether store prices are tax-exclusive (true) or tax-inclusive (false).

boolean

status

current status of the store.

Allowed values are

open - The store is active

paused - The store is paused to receive orders

busy- The store is currently busy and the orders are delayes

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) and their respective fees/times.

object

pickup, delivery, eatIn

Seperate keys for "pickup", "delivery", "eatIn") exist, they share many attributes as listed below

enabled

Whether this fulfillment type is active.

boolean

averagePreparationTime

Average preparation time in minutes.

integer

serviceCharge

Service charge details

object

serviceCharge.value

Fee amount

integer

serviceChargetaxRate

Tax rate applied to the fee of service charge. Tax rates are always stored as an int with 3 decimal digits e.g. 5% would be sent as 5000

integer

serviceChargetype

Fee type fixedor percentage

enum

bagFee

Packaging/bag fee

object

bagFee.value

Fee amount

integer

bagFee.taxRate

Tax rate applied on bagfee Tax rates are always stored as an int with 3 decimal digits e.g. 5% would be sent as 5000

integer

delivery additionally includes:

averageDeliveryTime

Average delivery time in minutes

integer

deliveryFee

Delivery fee details (value, taxRate)

object

fulfillmentTypes

fulfillmentTypes

List of fulfillment methods enabled for the store.

Alowed values are

pickup, delivery, eatIn

enum