Get inventory data

Alternative to company_id. The brand's slug (lowercase, alphanumeric, spaces replaced with hyphens — derived from the brand name). When provided without company_id, the company_id is resolved server-side. Useful for cross-brand style lookups where the storefront doesn't track numeric company_ids.

The UPC code to retrieve stores and in-stock data for.

The brand's style identifier as stored in Locally (typically the style_number from the brand's product feed — often a model name or SKU root, not a partner's internal model ID). Resolves to a product within the company_id (or company_slug) scope. For cross-brand / reseller scenarios, the company must be the product owner, not the requesting partner — otherwise no product will match and inventory will come back empty. If you don't know the owner, use upc instead.

The distance unit for the geographical region.

Required if only_store_id is not specified. The latitude of the geographical region center.

Required if only_store_id is not specified. The longitude of the geographical region center.

Results are cached by default for stateful (session) requests. Set to 'true' to invalidate the cache.

Comma delimited list of statuses to filter by. Valid statuses are IN_STOCK, PTP_BOPIS, PTP_ROPIS, PTP_SDD and PTP_STS.

Locally API token must be passed in the header to authenticate the API consumer