updateProduct( )

Updates a product.

Each time the product is updated, revision increments by 1. The current revision must be passed when updating the product. This ensures you're working with the latest product and prevents unintended overwrites.

Notes:

  • To update array fields like options, modifiers, variantsInfo.variants, and any others, you must pass the entire existing array. Passing only the changed item overwrites the entire array, not just merge the single change.
  • To update variantsInfo.variants you must also pass options and vice versa. This is because variants and options are mutually dependent and must be aligned.
  • To update existing variantsInfo.variants, make sure to provide variantsInfo.variants.id. If no ID is passed, a variant is created with a new ID.
  • Updating media per variant isn't supported. Instead, assign media items to product option choices using the linkedMedia field. You must use preexisting product media.
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Product ID.

productUpdateProductRequired
optionsUpdateProductOptions
Returns
Return Type:Promise<V3Product>
Errors
400Invalid Argument

There are 13 errors with this status code.

404Not Found

There are 4 errors with this status code.

409Already Exists

There are 5 errors with this status code.

428Failed Precondition

There are 12 errors with this status code.

500Internal

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?