Get Stores

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Purpose

Returns a list of stores, each store representing a unique location

Query Parameters

This endpoint returns all commerce stores for a given account, apply below query parameters to refine results;

AttributeFunctionExample
latitude / longitude

Querying by latitude & longitude , returns stores with a distance attribute representing in metres how far the store is from the given coordinates.

To sort by distance &sort=distance

?latitude=30.4515&longitude=-91.1871
fulfillmentTypeTo refine stores returned by the fulfillment types supported, combine multiple types to meet any specified type
pickup|delivery|eatIn|curbside
?fulfillmentType=delivery
sizeNumber of stores to be returned per page - Max: 100?size=20
pagePage to be returned?page=1

Glossary

For a full list of all store attributes and their definition, see the link below;

▶ View Store Model

Path Params
string
required
Query Params
int32
Defaults to 1

Page to be returned

int32
Defaults to 50

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

float
Defaults to 30.4515

Reference latitude coordinate to calculate store distance

float
Defaults to -91.1871

Reference longitude coordinate to calculate store distance

string
Defaults to distance
string

Fulfillment type(s) available on the channelLink. e.g: delivery,eatIn

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json