Skip to main content
GET
Get inventory

Authorizations

Authorization
string
header
required

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

Query Parameters

pageIndex
integer
default:0
Required range: x >= 0
Example:

0

numResultsPerPage
integer
default:100
Required range: x >= 1
Example:

100

search
string | null
Example:

"organic apples"

ids
string | null
Example:

"pro_123,pro_456"

skus
string | null
Example:

"SKU-001,SKU-002"

semanticSearch
string | null
Example:

"fresh fruit for smoothies"

externalStoreLocationId
string | null
externalProductId
string | null

Response

OK

inventory
StoreInventoryOutputSerializer · object[]
required
totalResults
integer
required