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. Nonempty queries must retain at least one character after normalization.

Required string length: 1 - 200
store_ids
string<uuid>[]

Comma-separated exact stable store UUIDs, mutually exclusive with inventory_store_codes.

Maximum array length: 25
inventory_store_codes
string[]

Comma-separated exact four-digit DABS inventory store codes, mutually exclusive with store_ids; leading zeros are preserved.

Maximum array length: 25
Pattern: ^[0-9]{4}$
access_types
enum<string>[]
Maximum array length: 4
Available options:
consumer_state_store,
licensee_only,
package_agency,
unknown
services
enum<string>[]

Comma-separated reviewed service attributes. A store must contain every requested service.

Maximum array length: 6
Available options:
refrigerated_beer,
wine_store,
high_end_product_room,
curbside_pickup,
accessible_entrance,
parking
operational_statuses
enum<string>[]

Comma-separated reviewed operational states; null/unknown source-only stores do not match.

Maximum array length: 4
Available options:
open,
temporarily_closed,
permanently_closed,
unknown
lat
number<double>

WGS84 latitude; must contain a numeric coordinate and be paired with lng. Empty values are invalid.

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

WGS84 longitude; must contain a numeric coordinate and be paired with lat. Empty values are invalid.

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

Radius in meters; requires both lat and lng. Supplying it without coordinates returns INVALID_PARAMETER.

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 resource endpoint, query, and sort. Reuse on another endpoint or with changed filters returns CURSOR_QUERY_MISMATCH. Follow links.next unchanged.

Maximum string length: 2048

Response

Store page.

data
object[]
required
meta
object
required