updateProductVariants( )


Developer Preview

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

Updates variants of a specified product.

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 updateProductVariants(
  _id: string,
  variants: Array<VariantOverride>,
): Promise<UpdateVariantsResponse>;
Method Parameters
_idstringRequired

ID of the product with managed variants.


variantsArray<VariantOverride>Required

Variant info to update.

Returns
Return Type:Promise<UpdateVariantsResponse>
JavaScript
import { products } from "wix-stores.v2"; async function updateProductVariants(id, variants) { try { const result = await products.updateProductVariants(id, variants); 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?