confirmInventory - Inventory Next Module Reference

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

This method confirms that a quantity is available of an inventory item in the specified locations.

Example

const isAvailable =
  await inventoryModuleService.confirmInventory(
    "iitem_123",
    ["loc_123", "loc_321"],
    10
  )

Parameters

inventoryItemIdstringRequired

The inventory item's ID.

locationIdsstring[]Required

The locations' IDs.

quantitynumberRequired

The quantity to confirm its availability.

contextContext

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

Returns

PromisePromise<boolean>Required

Whether the quantity is available.