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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function decrementInventory(decrementData: Array<DecrementData>): Promise<void>;
Method Parameters
decrementDataArray<DecrementData>Required

Item or product to decrement.

JavaScript
import { inventory } from "@wix/stores";

async function decrementInventory(decrementData, options) {
  const response = await inventory.decrementInventory(decrementData, options);
}
Errors

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

Did this help?