---
updatedAt: 2026-10-29T08:22:22.000Z
agentTools:
  projectIndex: https://docs.yotpo.com/llms.txt
---

# Update product variant

Updates a product variant within your product catalog.

> 👍 How to use this endpoint
>
> * Required parameters are listed below. For the full list of properties, see [About product variants](https://docs.yotpo.com/reference/product-variants).
> * To see example requests of full and minimal payload, click **Examples** in the payload on the right.
> * To skip a parameter, enter "null" or exclude it from the payload.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Yotpo API V3",
    "description": "Yotpo API V3 endpoints on api.yotpo.com. Webhook events are defined separately, in webhooks.json.",
    "version": "3.0"
  },
  "servers": [
    {
      "url": "https://api.yotpo.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "X-Yotpo-Token": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Yotpo-Token",
        "description": "Your Yotpo account access token. See [Authentication](https://core-api.yotpo.com/reference/yotpo-authentication) to learn how to generate your access token."
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Unauthorized. The access token in `X-Yotpo-Token` is invalid or expired, and the body is plain text. Generate a new token with [Generate access token](ref:yotpo-authentication). If the request also has an `Authorization: Bearer` header, the API checks that header instead of `X-Yotpo-Token` and returns `Bad token; invalid JSON` as JSON. Remove the `Authorization` header and send the token in `X-Yotpo-Token` only.",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "example": "unauthorized"
            }
          },
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "description": "Error message.",
                  "example": "Bad token; invalid JSON"
                }
              }
            },
            "examples": {
              "Authorization header sent": {
                "value": "{\n  \"message\": \"Bad token; invalid JSON\"\n}"
              }
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden. The request has no `X-Yotpo-Token` header.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "description": "Error message.",
                  "example": "Forbidden"
                }
              }
            },
            "examples": {
              "Missing token": {
                "value": "{\n  \"message\": \"Forbidden\"\n}"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "X-Yotpo-Token": []
    }
  ],
  "paths": {
    "/core/v3/stores/{store_id}/products/{yotpo_product_id}/variants/{yotpo_variant_id}": {
      "patch": {
        "summary": "Update product variant",
        "description": "Updates a product variant within your product catalog.",
        "operationId": "update-product-variant",
        "parameters": [
          {
            "name": "store_id",
            "in": "path",
            "description": "The store ID (app_key).",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "yotpo_product_id",
            "in": "path",
            "description": "The Yotpo ID for the product. This ID is created automatically upon creation of the product. You can find it by using the Retrieve endpoint.",
            "schema": {
              "type": "integer",
              "format": "int64"
            },
            "required": true
          },
          {
            "name": "yotpo_variant_id",
            "in": "path",
            "description": "The Yotpo ID for the product variant. This ID is created automatically upon creation of the variant. You can find it by using the Retrieve endpoint.",
            "schema": {
              "type": "integer",
              "format": "int64"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "variant"
                ],
                "properties": {
                  "variant": {
                    "type": "object",
                    "properties": {
                      "external_id": {
                        "type": "string",
                        "description": "The merchant's unique ID for the product variant. Max. length: 255 characters."
                      },
                      "name": {
                        "type": "string",
                        "description": "The name of the product variant. Max. length: 255 characters."
                      },
                      "description": {
                        "type": "string",
                        "description": "The description of the product variant."
                      },
                      "url": {
                        "type": "string",
                        "description": "The URL of the product variant on your store website. Max. length: 2048 characters."
                      },
                      "image_url": {
                        "type": "string",
                        "description": "The URL of the product variant image. Max. length: 2048 characters."
                      },
                      "price": {
                        "type": "number",
                        "format": "double",
                        "description": "The price of the product variant."
                      },
                      "compare_at_price": {
                        "type": "number",
                        "format": "double",
                        "description": "The original price of the product variant before any adjustments or sales."
                      },
                      "currency": {
                        "type": "string",
                        "description": "The currency of the product variant. Must be a valid 3-character ISO code. [See currency codes](https://www.iban.com/currency-codes)"
                      },
                      "inventory_quantity": {
                        "type": "integer",
                        "description": "The quantity of the product variant available for sale."
                      },
                      "is_discontinued": {
                        "type": "boolean",
                        "description": "Whether the product variant has been discontinued. Discontinued variants are excluded from product recommendations and other customer-facing widgets, and automatic review requests are not sent for them. [Learn more](https://support.yotpo.com/docs/adding-products-to-blocklist)"
                      },
                      "sku": {
                        "type": "string",
                        "description": "Stock-Keeping Unit. Cannot contain spaces or the \"/\" symbol. Max. length: 255 characters."
                      },
                      "gtins": {
                        "type": "array",
                        "description": "Global trade item numbers, often called barcodes. [See GTIN object description](https://core-api.yotpo.com/docs/gtin)",
                        "items": {
                          "type": "object",
                          "required": [
                            "value"
                          ],
                          "properties": {
                            "declared_type": {
                              "type": "string",
                              "description": "The GTIN standard.",
                              "enum": [
                                "EAN",
                                "UPC",
                                "ISBN"
                              ]
                            },
                            "value": {
                              "type": "string",
                              "description": "The GTIN value."
                            }
                          }
                        }
                      },
                      "options": {
                        "type": "array",
                        "description": "The variant's options, for example color or size. You can add up to 20 options for each variant.",
                        "maxItems": 20,
                        "items": {
                          "type": "object",
                          "required": [
                            "name",
                            "value"
                          ],
                          "properties": {
                            "name": {
                              "type": "string",
                              "description": "The option name, for example `color`, `size`, or `material`."
                            },
                            "value": {
                              "type": "string",
                              "description": "The option value, for example `blue` for the color option."
                            }
                          }
                        }
                      },
                      "custom_properties": {
                        "type": "object",
                        "description": "A key-value set of additional properties."
                      }
                    },
                    "description": "The variant fields to update. Send only the fields you want to change."
                  }
                }
              },
              "examples": {
                "Update Product Variant (minimal payload)": {
                  "value": {
                    "variant": {
                      "price": 120
                    }
                  }
                },
                "Update Product Variant (full payload)": {
                  "value": {
                    "variant": {
                      "name": "blue minimal surfboard",
                      "description": "A great surfboard!",
                      "url": "http://www.waverider.com/products/minimalsurfboard?variant=vr125f633d6h",
                      "image_url": "http://www.waverider.com/products/minimalsurfboard/images/blue2.jpg",
                      "price": 750,
                      "compare_at_price": 800,
                      "currency": "USD",
                      "inventory_quantity": 4,
                      "is_discontinued": false,
                      "sku": "xxxxx",
                      "gtins": [
                        {
                          "declared_type": "UPC",
                          "value": "742833102466"
                        }
                      ],
                      "options": [
                        {
                          "name": "color",
                          "value": "blue"
                        },
                        {
                          "name": "material",
                          "value": "epoxy"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK. The response has no body."
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"errors\": [\n    {\n      \"message\": \"price must be non-negative\"\n    }\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "message": {
                            "type": "string",
                            "example": "price must be non-negative",
                            "description": "What's wrong with the request, usually naming the missing or invalid field. Meant for logs; the wording can change, so don't parse it."
                          }
                        }
                      },
                      "description": "The validation errors. Usually one item."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"errors\": [\n    {\n      \"message\": \"variant not found\"\n    }\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "message": {
                            "type": "string",
                            "example": "variant not found",
                            "description": "Says which object wasn't found. Meant for logs; the wording can change, so don't parse it."
                          }
                        }
                      },
                      "description": "The errors. Usually one item."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "value": "application/json",
        "key": "Content-Type"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

# Sibling pages

* [About products](https://docs.yotpo.com/reference/products.md)
* [Create product](https://docs.yotpo.com/reference/create-product.md)
* [Update product](https://docs.yotpo.com/reference/update-product.md)
* [Retrieve products](https://docs.yotpo.com/reference/retrieve-products.md)
* [Retrieve product by ID](https://docs.yotpo.com/reference/retrieve-product-by-id.md)
* [About product variants](https://docs.yotpo.com/reference/product-variants.md)
* [Create product variant](https://docs.yotpo.com/reference/create-product-variant.md)
* [Retrieve product variants](https://docs.yotpo.com/reference/retrieve-product-variants.md)
* [Retrieve product variant by ID](https://docs.yotpo.com/reference/retrieve-product-variant-by-id.md)
* [About collections](https://docs.yotpo.com/reference/collections.md)
* [Create collection](https://docs.yotpo.com/reference/create-collection.md)
* [Update collection](https://docs.yotpo.com/reference/update-collection.md)
* [Retrieve collections](https://docs.yotpo.com/reference/retrieve-collections.md)
* [Add product to collection](https://docs.yotpo.com/reference/add-product-to-collection.md)
* [Retrieve products in collection](https://docs.yotpo.com/reference/retrieve-products-in-collection.md)
* [Remove product from collection](https://docs.yotpo.com/reference/remove-product-from-collection.md)
* [Retrieve list of collections for product](https://docs.yotpo.com/reference/retrieve-list-of-collections-for-product.md)