decrementInventory( )


Subtracts a set number of items from inventory.

The decrementInventory() function returns a Promise that is resolved when the specified item's quantity has been updated in the inventory.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Stores - all permissions
Manage Products
Learn more about app permissions.
Method Declaration
Copy
function decrementInventory(
  decrementData: Array<DecrementData>,
  options: DecrementInventoryOptions,
): Promise<void>;
Method Parameters
decrementDataArray<DecrementData>Required

Item or product to decrement.


optionsDecrementInventoryOptions
JavaScript
import { inventory } from "wix-stores.v2"; async function decrementInventory(decrementData, options) { try { const result = await inventory.decrementInventory(decrementData, options); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?