Skip to main content
Skip to main content

listAndCountInventoryLevels - Inventory Next Module Reference

This documentation provides a reference to the listAndCountInventoryLevels method. This belongs to the Inventory Next Module.

This method retrieves a paginated list of inventory levels along with the total count of available inventory levels satisfying the provided filters.

Example

To retrieve a list of inventory levels using the IDs of their associated inventory items:

const [inventoryLevels, count] =
await inventoryModuleService.listAndCountInventoryLevels(
{
inventory_item_id: ["iitem_123", "iitem_321"],
},
{
relations: ["inventory_item"],
take: 20,
skip: 2,
}
)

To specify relations that should be retrieved within the inventory levels:

const [inventoryLevels, count] =
await inventoryModuleService.listAndCountInventoryLevels(
{
inventory_item_id: ["iitem_123", "iitem_321"],
},
{
relations: ["inventory_item"],
}
)

By default, only the first 10 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const [inventoryLevels, count] =
await inventoryModuleService.listAndCountInventoryLevels({
inventory_item_id: ["iitem_123", "iitem_321"],
})

Parameters

The filters to apply on the retrieved inventory levels.
The configurations determining how the inventory level is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a inventory level.
contextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<[InventoryLevelDTO[], number]>Required
The list of inventory levels along with their total count.
Was this section helpful?