Skip to main content
List a product's reported inventory across stores

Headers

If-None-Match
string

Strong entity tag from an earlier response.

If-Modified-Since
string

HTTP-date fallback validator. ETag takes precedence.

Path Parameters

product_id
string<uuid>
required

Stable API-owned product UUID.

Query Parameters

store_ids
string<uuid>[]

Comma-separated stable store UUIDs, mutually exclusive with coordinates.

Maximum array length: 25
inventory_store_codes
string[]

Comma-separated four-digit DABS inventory store codes, with leading zeros preserved. Mutually exclusive with store_ids and coordinates.

Maximum array length: 25
Pattern: ^[0-9]{4}$
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
observation_states
enum<string>[]
Maximum array length: 4
Available options:
reported_positive,
reported_zero,
row_absent,
unchecked
purchase_eligibility
enum<string>
default:any

Independent policy classification for ordinary consumer purchase.

Available options:
any,
eligible,
restricted,
unavailable,
unknown
inventory_age
enum<string>
default:within_policy

Whether inventory predicates require the current retrieval-age policy.

Available options:
within_policy,
any_age
sort
enum<string>
default:store_number

distance requires coordinates. Every sort ends with store UUID ascending.

Available options:
distance,
store_number,
quantity,
-quantity
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
include
enum<string>

Set to coverage_details to add pair-state accounting to the compact default coverage summary.

Available options:
coverage_details

Response

Inventory page from one immutable publication revision.

data
object[]
required
meta
object
required