listInventoryItems - Inventory Next Module Reference

This documentation provides a reference to the listInventoryItems 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 items based on optional filters and configuration.

Example#

To retrieve a list of inventory items using their IDs:

Code
1const inventoryItems = await inventoryModuleService.listInventoryItems({2  id: ["iitem_123", "iitem_321"],3})

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

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const inventoryItems = await inventoryModuleService.listInventoryItems(2  {3    id: ["iitem_123", "iitem_321"],4  },5  {6    relations: ["location_levels"],7  }8)

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 inventoryItems = await inventoryModuleService.listInventoryItems(2  {3    id: ["iitem_123", "iitem_321"],4  },5  {6    relations: ["location_levels"],7    take: 20,8    skip: 2,9  }10)

Parameters#

selectorFilterableInventoryItemProps

The filters to apply on the retrieved inventory items.

configFindConfig<InventoryItemDTO>Optional

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.

contextContextOptional

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

Returns#

PromisePromise<InventoryItemDTO[]>

The list of inventory items.