Skip to main content
PricesVersion: 2021-07-28

List Inventory

GET/products/inventory

The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters.

Authorizations

Authorizationstringheaderrequired

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

Scope:products/prices.readonly
Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available options2021-07-28

Query Parameters

limitnumber

The maximum number of items to be included in a single page of results

Default:0
Example:20
offsetnumber

The starting index of the page, indicating the position from which the results should be retrieved.

Default:0
Example:0
altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
searchstring

Search string for Variant Search

Example:Product Name

Response

Successful response

inventoryobject[]required

List of inventory items

totalobjectrequired

Total count of inventory items