Check store availability for a product
Returns nearby store availability for a known product. Provide the user’s location and search radius to find stores carrying this product, sorted by distance (closest first).
Authorizations
Path Parameters
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.
8 - 14^\d{8}$|^\d{12,14}$Query Parameters
Latitude in decimal degrees (WGS84). Positive north / negative south. Required — the endpoint is location-anchored and has no default.
-90 <= x <= 90Longitude in decimal degrees (WGS84). Positive east / negative west. Required — the endpoint is location-anchored and has no default.
-180 <= x <= 180Search radius in kilometers from the latitude/longitude pair. Stores beyond this distance are excluded. Capped at 100 km.
x <= 100Response
OK
Store / branch name as the shopper would recognize it (e.g. 'Whole Foods Tribeca'). Sourced from Place.name.
Comma-joined street address ('line 1, city, region, postal_code'). Components missing on the underlying Place are omitted from the joined string.
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.
x >= 0Customer-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.
In Stock, Discontinued, Seasonal, Out of Stock, Unknown Wire value of the underlying InStoreOffer.status (apps.retailers.models.OfferStatus). Use this for programmatic decisions; see stock_status for the display label.
active, discontinued, seasonal, out_of_stock Pre-formatted price string with currency symbol (e.g. '$4.99'). Null when no price is on file for this store.
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.