Help

Was this page helpful?

retrieveReservedQuantity - Inventory Next Module Reference - Medusa Documentation

retrieveReservedQuantity - Inventory Next Module Reference

This documentation provides a reference to the retrieveReservedQuantity 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 the reserved quantity of an inventory item in the specified location.

Example#

Code
1const reservedQuantity =2  await inventoryModuleService.retrieveReservedQuantity(3    "iitem_123",4    ["loc_123", "loc_321"]5  )

inventoryItemIdstring

The inventory item's ID.

locationIdsstring[]

The locations' IDs.

contextContextOptional

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

PromisePromise<IBigNumber>

The reserved quantity of the item.