Skip to main content
GET
List nearby stores
Returns stores that can serve a reference point — an ACTIVE store with at least one ACTIVE coverage zone covering the coordinates (RADIUS or POLYGON) — sorted nearest-first by store location. Use this for a map view or a “nearest location” picker after the customer shares GPS or a geocoded address.
Requires a Fire spark access token obtained through token exchange. For a full paginated catalog, use list stores.

Query parameters

Request

Response

The response wraps an array of store objects in data, ordered from nearest to farthest. Each object uses the same shape as list stores, including cms_template_id and cms when a CMS template is assigned. Only ACTIVE stores are included.

How matching and distance work

  1. Coverage filter — Only stores with an ACTIVE coverage zone that contains the point are returned. RADIUS zones use distance-to-center within radius (meters). POLYGON zones use point-in-polygon.
  2. Ranking — Matching stores are ordered by straight-line distance from the query coordinates to the store’s location (PostGIS geography on the store point).
Stores without a geocoded location or without covering zones are omitted.
Pair this endpoint with the device GPS or a geocoded address. Pass a low limit (for example 5) for compact pickers, or a higher value when rendering a map with more pins.

Store fields

See list stores for the full store schema.

Error responses

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

brand_id
string

Filter stores by brand. When omitted, all stores for the merchant are returned.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
latitude
number
required
Required range: -90 <= x <= 90
longitude
number
required
Required range: -180 <= x <= 180
limit
integer
Required range: x <= 50

Response

200 - application/json

Ok

data
object[]