listInventoryLevels - Inventory Next Module Reference

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

This method retrieves a paginated list of inventory levels based on optional filters and configuration.

Example

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

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

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

const inventoryLevels =
  await inventoryModuleService.listInventoryLevels(
    {
      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 =
  await inventoryModuleService.listInventoryLevels(
    {
      inventory_item_id: ["iitem_123", "iitem_321"],
    },
    {
      relations: ["inventory_item"],
      take: 20,
      skip: 2,
    }
  )

Parameters

selectorFilterableInventoryLevelPropsRequired

The filters to apply on the retrieved inventory levels.

configFindConfig<InventoryLevelDTO>

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[]>Required

The list of inventory levels.