PATCH

Update Product


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.
  • Partial-update semantics: Update Product supports partial updates with the following rules:
    • At the request level, only product, product.id, and product.revision are required.
    • Other fields shown as required in the schema apply only when their parent field is provided.
    • Top-level fields you omit (for example, name, ribbon, brand, taxGroupId) are left unchanged.
    • The full-array overwrite rule applies only to repeated fields (options, modifiers, variantsInfo.variants); top-level scalar and object fields are partially updatable on their own.
    • To assign or change a brand without touching any other field, specify only id, revision, and brand.id. Supplying brand.name without brand.id is rejected with a BRAND_MISSING_ID validation error.
Authentication

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

Permissions
Product write in v3 catalog
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/stores/v3/products/{product.id}

Errors
400Invalid Argument

There are 16 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 11 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.

Event TriggersThis method triggers the following events:
Did this help?