Skip to main content
GET
List store product inventory

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ending_before
string

Return records that precede the record with this ID, in list order.

Pattern: ^[0-9]+$
limit
integer
default:20

Maximum number of records to return.

Required range: 1 <= x <= 100
starting_after
string

Return records that follow the record with this ID, in list order.

Pattern: ^[0-9]+$
store_department_id
string[]

The department the product belongs to. Repeat to match any of up to 20 values.

store_id
string[]

The store the product belongs to. Repeat to match any of up to 20 values.

updated_at
string<date-time>

When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset.

updated_at[gt]
string<date-time>

When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset.

updated_at[gte]
string<date-time>

When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset.

updated_at[lt]
string<date-time>

When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset.

updated_at[lte]
string<date-time>

When the on-hand quantity was last written. Pair a lower bound with a page size to poll for products counted since the previous request. UTC unless the value carries an offset.

Response

A page of store product inventory.

data
object[]
required
has_more
boolean
required

Whether more records follow this page.