Skip to main content
GET
List shelf locations

Authorizations

Authorization
string
header
required

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

Query Parameters

aisle
string

Only return shelf locations in this aisle. Matched exactly.

Maximum string length: 255
ending_before
string

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

is_primary
boolean

Whether the shelf location is the primary (home) location for its product. Omit to match both.

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.

store_id
string[]

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

store_product_id
string[]

The store product placed at this location. Repeat to match any of up to 20 values.

Response

A page of shelf locations.

data
object[]
required
has_more
boolean
required

Whether more records follow this page.