bulkDecrementInventoryItems( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Decrements quantities of multiple inventory items.

Notes::

  • trackQuantity must be true to allow for decrementing the quantity.
  • If you pass restrictInventory: true and the decrementData.decrementBy amount is greater than the current quantity in stock, the request will fail with an INSUFFICIENT_INVENTORY error.
  • Pass restrictInventory: false to allow for negative quantities.
  • If you pass preorderRequest: true and the item is available for preorder, the item's preorderCounter will increase and the item's quantity will stay the same.
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
Manage v3 catalog
Inventory write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
decrementDataArray<DecrementDataById>Required

Inventory item IDs and decrement data.

optionsBulkDecrementInventoryItemsOptions
Returns
Return Type:Promise<BulkDecrementInventoryItemsResponse>
JavaScript
Errors

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

Did this help?