listAndCountInventoryLevels - Inventory Next Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

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:

Code
1const [inventoryLevels, count] =2  await inventoryModuleService.listAndCountInventoryLevels(3    {4      inventory_item_id: ["iitem_123", "iitem_321"],5    },6    {7      relations: ["inventory_item"],8      take: 20,9      skip: 2,10    }11  )

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

Code
1const [inventoryLevels, count] =2  await inventoryModuleService.listAndCountInventoryLevels(3    {4      inventory_item_id: ["iitem_123", "iitem_321"],5    },6    {7      relations: ["inventory_item"],8    }9  )

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

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

Parameters#

selectorFilterableInventoryLevelProps

The filters to apply on the retrieved inventory levels.

configFindConfig<InventoryLevelDTO>Optional

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.

contextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<[InventoryLevelDTO[], number]>

The list of inventory levels along with their total count.

Was this page helpful?