updateInventoryVariants( )


Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.

The updateInventoryVariants() function is a Promise that resolves to the updated inventory variant data.

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 updateInventoryVariants(
  productId: string,
  inventoryItem: UpdateInventoryVariantsInventoryItem,
  options: UpdateInventoryVariantsOptions,
): Promise<void>;
Method Parameters
productIdstringRequired

Product ID.


inventoryItemUpdateInventoryVariantsInventoryItemRequired

Inventory item to update.


optionsUpdateInventoryVariantsOptions
JavaScript
import { inventory } from "wix-stores.v2"; async function updateInventoryVariants(productId, inventoryItem, options) { try { const result = await inventory.updateInventoryVariants( productId, inventoryItem, 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?