Skip to main content
Search stores or find nearby stores

Headers

If-None-Match
string

Strong entity tag from an earlier response.

If-Modified-Since
string

HTTP-date fallback validator. ETag takes precedence.

Query Parameters

q
string

Store name/number, address, or city search.

Required string length: 1 - 200
access_types
enum<string>[]
Maximum array length: 4
Available options:
consumer_state_store,
licensee_only,
package_agency,
unknown
lat
number<double>

WGS84 latitude; must be paired with lng.

Required range: -90 <= x <= 90
lng
number<double>

WGS84 longitude; must be paired with lat.

Required range: -180 <= x <= 180
radius_m
integer
default:50000

Radius in meters; valid only with coordinates.

Required range: 1 <= x <= 500000
sort
enum<string>
default:store_number

distance requires coordinates.

Available options:
distance,
name,
-name,
store_number,
-store_number
limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string

Signed opaque keyset cursor, valid for 15 minutes and only with the original query.

Maximum string length: 2048

Response

Store page.

data
object[]
required
meta
object
required