Get Stores

get

https://api.staging.deliverect.com/commerce/{accountId}/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.

Path Params

accountId

string

required

Query Params

page

int32

Defaults to 1

Page to be returned

size

int32

Defaults to 50

Number of stores to be returned per page - Max: 100

latitude

float

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.

longitude

float

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.

sort

string

enum

Defaults to distance

Attribute to sort results by (requires latitude & longitude to be supplied).

Allowed:

fulfillmentType

string

enum

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.

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Purpose

200200

400400

403Forbidden

404Not Found