Stores - Glossary
Parameters | Meaning | Type |
|---|---|---|
| Total number of stores returned by the query | integer |
| Current page number of the paginated response | integer |
| umber of store records returned per page | integer |
items | List of store objects. Each object contains details about one store location | array of objects |
| Unique identifier of the Deliverect store, also referred to as | string |
| Human-readable name of the store location | string |
| Default currency used at this store for transactions | string |
| Identifier of the ordering channel/platform the store is linked to | integer |
| Store’s address details, including source, coordinates, and location info (country, city, state). | object |
address. | Raw address source string | string |
address. | Longitude and Latitude of the store Example: [25.276987, 55.296249] | array |
address. | Country where the store is located | string |
address. | City of the store | string |
address. | address.stateOrProvince | string |
| Store’s operating hours by day of week, including timezone | object |
openingHours.`timezone`` | Timezone identifier (IANA format) Example: "Asia/Calcutta" | string |
openingHours. | Opening/closing intervals for each weekday | array |
openingHours.dayTimeRanges. | Day of the week (1 = Monday, 7 = Sunday) | integer |
openingHours.dayTimeRanges. | Opening time (HH:mm:ss) | string |
openingHours.dayTimeRanges. | Closing time (HH:mm:ss). | string |
| ||
| Indicates whether store prices are tax-exclusive (true) or tax-inclusive (false). | boolean |
| current status of the store. Allowed values are
| enum |
| Additional delay (in minutes) added to preparation time before an order is ready | integer |
| Contact details of the person who is managing the store | object |
contact. | First name of contact person | string |
contact. | Last name of contact person | string |
contact. | Contact phone number | string |
contact. | Contact email address | string |
| 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 | |
| Whether this fulfillment type is active. | boolean |
| Average preparation time in minutes. | integer |
| Service charge details | object |
serviceCharge. | Fee amount | integer |
serviceCharge | 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 |
serviceCharge | Fee type | enum |
| Packaging/bag fee | object |
bagFee. | Fee amount | integer |
bagFee. | 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: | ||
| Average delivery time in minutes | integer |
| Delivery fee details (value, taxRate) | object |
fulfillmentTypes | ||
| List of fulfillment methods enabled for the store. Alowed values are
| enum |