listAndCount - Inventory Next Module Reference

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

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

Example

To retrieve a list of inventory items using their IDs:

const [inventoryItems, count] =
  await inventoryModuleService.listAndCount({
    id: ["iitem_123", "iitem_321"],
  })

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

const [inventoryItems, count] =
  await inventoryModuleService.listAndCount(
    {
      id: ["iitem_123", "iitem_321"],
    },
    {
      relations: ["location_levels"],
    }
  )

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 [inventoryItems, count] =
  await inventoryModuleService.listAndCount(
    {
      id: ["iitem_123", "iitem_321"],
    },
    {
      relations: ["location_levels"],
      take: 20,
      skip: 2,
    }
  )

Parameters

selectorFilterableInventoryItemPropsRequired

The filters to apply on the retrieved inventory items.

configFindConfig<InventoryItemDTO>

The configurations determining how the inventory item is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a inventory item.

contextContext

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

Returns

PromisePromise<[InventoryItemDTO[], number]>Required

The list of inventory items along with their total count.