retrieveInventoryItem - Inventory Next Module Reference

This documentation provides a reference to the retrieveInventoryItem 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 item by its ID.

Example#

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

Code
1const inventoryItem =2  await inventoryModuleService.retrieveInventoryItem("iitem_123")

To specify relations that should be retrieved:

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 inventoryItem = await inventoryModuleService.retrieveInventoryItem(2  "iitem_123",3  {4    relations: ["location_levels"],5  }6)

Parameters#

inventoryItemIdstring

The inventory item's ID.

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