retrieveInventoryLevel - Inventory Next Module Reference

This documentation provides a reference to the retrieveInventoryLevel 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 an inventory level by its ID.

Example#

A simple example that retrieves a inventory level by its ID:

Code
1const inventoryLevel =2  await inventoryModuleService.retrieveInventoryLevel(3    "iitem_123"4  )

To specify relations that should be retrieved:

Code
1const inventoryLevel =2  await inventoryModuleService.retrieveInventoryLevel(3    "iitem_123",4    {5      relations: ["inventory_item"],6    }7  )

Parameters#

inventoryLevelIdstring

The inventory level's ID.

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>

The retrieved inventory level.

Was this page helpful?