Skip to main content

​
Method signature

client.inventory.getFilterValues(params)
Retrieves all available filter values for a specified product. This method is useful for discovering what part IDs, sizes, and colors are available before querying inventory levels.

​
Parameters

​
body.productId
string
required
The unique identifier for the product. This is the supplier’s product ID.

​
Return value

Returns a Promise that resolves to the available filter values for the product. The response format depends on the client’s configured format option (JSON or XML).
​
success
boolean
Indicates whether the request was successful.
​
filterValues
object
Object containing arrays of available filter values.

​
Code example

const filterValues = await client.inventory.getFilterValues({
  productId: 'item_id'
});

console.log(filterValues);
Use this method before calling getInventoryLevels() to discover what filters are available for a product. This helps you build dynamic filter interfaces and avoid querying for non-existent variations.

Get inventory levels

Retrieve current inventory levels with optional filtering

Build docs developers (and LLMs) love

Get started for freeTalk to us