retrieveInventoryLevel - Inventory Next Module Reference

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

This method retrieves an inventory level by its ID.

Example

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

const inventoryLevel =
  await inventoryModuleService.retrieveInventoryLevel(
    "iitem_123"
  )

To specify relations that should be retrieved:

const inventoryLevel =
  await inventoryModuleService.retrieveInventoryLevel(
    "iitem_123",
    {
      relations: ["inventory_item"],
    }
  )

Parameters

inventoryLevelIdstringRequired

The inventory level's ID.

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 retrieved inventory level.