updateVariantData( )

Updates the data (such as the price and the weight) of an existing product variant in the store.

The updateVariantData() function returns a Promise that resolves when a product's variant, with the specified choice and corresponding value, has been updated.

For example, if my product is a ring, I can update the price of the Gold value of the Metal choice, or the price of the Silver value of the Metal choice. In this example, "price" is the variant's data.

When passing parameters to updateVariantData(), if the combination of the product ID, choice, or choice value does not match any existing variants, an error is issued.

Only the properties passed in the VariantInfo object will be updated. All other properties remain the same.

Note: The Manage Variants field for the product must be set to true to update a variant's data.

Method Declaration
Copy
Method Parameters
productIdstringRequired

ID of the product to update.

variantInfoArray<VariantInfo>Required

The information to update for the variant.

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