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 and their specific ordering options, menus and pricing.

Query Parameters

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

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

Store status

The store status shows the current status of availability, It can have the following values:

StatusMeaning
openStore is open and accepting orders.
closedStore is outside of opening hours.
busyStore is open, but with a delay in the preparation time which is shown as preparationTimeDelay in minutes
pausedStore is virtually closed (within the opening hours) and is not accepting orders.

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
int32
Defaults to 50
float
Defaults to 30.4515
float
Defaults to -91.1871
string
Defaults to distance
string
Responses

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