Get Stores

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

Attribute

Function

Example

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

fulfillmentType

To refine stores returned by the fulfillment types supported, combine multiple types to meet any specified type
pickup|delivery|eatIn|curbside

?fulfillmentType=delivery

size

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

?size=20

page

Page 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
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!