Skip to main content
GET
Check store availability for a product

Authorizations

X-API-Key
string
header
required

Path Parameters

gtin
string
required

GTIN of the product to look up. Accepts GTIN-8, GTIN-12 (UPC-A), GTIN-13 (EAN-13), or GTIN-14; the service pads shorter forms to GTIN-14 internally before lookup.

Required string length: 8 - 14
Pattern: ^\d{8}$|^\d{12,14}$

Query Parameters

latitude
number
required

Latitude in decimal degrees (WGS84). Positive north / negative south. Required — the endpoint is location-anchored and has no default.

Required range: -90 <= x <= 90
longitude
number
required

Longitude in decimal degrees (WGS84). Positive east / negative west. Required — the endpoint is location-anchored and has no default.

Required range: -180 <= x <= 180
radius_km
number
default:10

Search radius in kilometers from the latitude/longitude pair. Stores beyond this distance are excluded. Capped at 100 km.

Required range: x <= 100

Response

OK

store
string
required

Store / branch name as the shopper would recognize it (e.g. 'Whole Foods Tribeca'). Sourced from Place.name.

address
string
required

Comma-joined street address ('line 1, city, region, postal_code'). Components missing on the underlying Place are omitted from the joined string.

distance_km
number
required

Great-circle distance from the user's location to this store, in kilometers, rounded to 2 decimals. Zero when the distance could not be computed.

Required range: x >= 0
stock_status
enum<string>
required

Customer-facing stock label derived from the underlying offer status. Use this when surfacing availability to a shopper. See stock_confidence for the machine-readable wire value.

Available options:
In Stock,
Discontinued,
Seasonal,
Out of Stock,
Unknown
stock_confidence
enum<string>
required

Wire value of the underlying InStoreOffer.status (apps.retailers.models.OfferStatus). Use this for programmatic decisions; see stock_status for the display label.

Available options:
active,
discontinued,
seasonal,
out_of_stock
price
string | null

Pre-formatted price string with currency symbol (e.g. '$4.99'). Null when no price is on file for this store.

last_verified
string | null

ISO 8601 timestamp of the last inventory verification on the underlying InStoreOffer.quantity_updated_at. Null when the offer has never had a quantity update.