Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

confirmInventory - Inventory Next Module Reference

This documentation provides a reference to the confirmInventory 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 confirms that a quantity is available of an inventory item in the specified locations.

Example#

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

Parameters#

inventoryItemIdstring
The inventory item's ID.
locationIdsstring[]
The locations' IDs.
quantityBigNumberInput
The quantity to confirm its availability.
contextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<boolean>
Whether the quantity is available.
Was this page helpful?