retrieveAvailableQuantity - Inventory Next Module Reference

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

This method retrieves the available quantity of an inventory item in the specified locations.

Example

const availableQuantity =
  await inventoryModuleService.retrieveAvailableQuantity(
    "iitem_123",
    ["loc_123", "loc_321"]
  )

Parameters

inventoryItemIdstringRequired

The inventory item's ID.

locationIdsstring[]Required

The locations' IDs.

contextContext

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

Returns

PromisePromise<number>Required

The available quantity of the item.