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. readonlyAuth methods:
OAuthPrivate IntegrationToken types:
Sub-Account TokenAgency TokenRequest
Headers
Versionstringrequired
API Version
Available options
2021-07-28Query Parameters
limitnumber
The maximum number of items to be included in a single page of results
Default:
0Example:
20offsetnumber
The starting index of the page, indicating the position from which the results should be retrieved.
Default:
0Example:
0altIdstringrequired
Location Id or Agency Id
Example:
6578278e879ad2646715ba9caltTypestringrequired
Available options
locationsearchstring
Search string for Variant Search
Example:
Product NameResponse
Successful response
inventoryobject[]required
List of inventory items
totalobjectrequired
Total count of inventory items