Skip to main content
GET
List Inventory

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Query Parameters

limit
number
default:0

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

Example:

20

offset
number
default:0

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

Example:

0

altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required
Available options:
location

Search string for Variant Search

Example:

"Product Name"

trackInventory
boolean

Filter by track inventory status

Example:

true

allowOutOfStockPurchases
boolean

Filter by allow out of stock purchases status

Example:

true

isDigitalProduct
boolean

Filter by digital product status

Example:

false

availableQuantityFrom
number

Filter by minimum available quantity

Example:

10

availableQuantityTo
number

Filter by maximum available quantity

Example:

100

collectionIds
string

Filter by collection IDs (comma-separated)

Example:

"64a1b2c3d4e5f6789abcdef0,64a1b2c3d4e5f6789abcdef1"

Response

Successful response

inventory
object[]
required

List of inventory items

total
object
required

Total count of inventory items

Example:
Last modified on March 8, 2026