bulkDecrementInventoryItemsByVariantAndLocation( )

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 by variant and location.

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

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Inventory write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
decrementDataArray<DecrementDataByVariantAndLocation>Required

Variant and location IDs, as well as decrement data.

optionsBulkDecrementInventoryItemsByVariantAndLocationOptions
Returns
Return Type:Promise<BulkDecrementInventoryItemsByVariantAndLocationResponse>
Was this helpful?
Yes
No