Get inventory levels

Retrieve current inventory levels for a product with optional filtering.

Method signature

client.inventory.getInventoryLevels(params)

Retrieves current inventory levels for a specified product. This method queries the supplier’s Inventory service to get real-time stock availability.

Parameters

body.productId · string · required

The unique identifier for the product. This is the supplier’s product ID.

body.productIDtype · string

The type of product identifier being used. Only applicable for version 1.2.1.

body.filters · object

Optional filters to narrow down inventory results by specific parts, sizes, or colors.

Show properties

body.filters.partIdArray · string[]

Array of part IDs to filter inventory results. Only inventory for these specific parts will be returned.

body.filters.LabelSizeArray · string[]

Array of label sizes to filter inventory results. Only inventory for these specific sizes will be returned.

body.filters.PartColorArray · string[]

Array of part colors to filter inventory results. Only inventory for these specific colors will be returned.

Return value

Returns a Promise that resolves to the inventory levels data. The response format depends on the client’s configured format option (JSON or XML).

success · boolean

Indicates whether the request was successful.

inventoryLevels · object[]

Array of inventory level records for the requested product.

Show properties

partId · string

The unique identifier for the product part.

quantity · number

Available quantity in stock.

attributeColor · string

Color attribute of the part.

labelSize · string

Size label for the part.

Code example

Basic usage

const inventoryData = await client.inventory.getInventoryLevels({
  productId: 'item_id'
});

console.log(inventoryData);

Related methods

Get filter values

Retrieve available filter values for a product