---
title: "product.variant.update"
method: PUT
path: "/product.variant.update.json"
tags: ["product"]
---

# product.variant.update

`PUT /product.variant.update.json`

## Request

- Base URL: `https://api.api2cart.com/v1.1`
- URL: `https://api.api2cart.com/v1.1/product.variant.update.json`
- Auth: API key in header `x-api-key` and API key in header `x-store-key`

Update variant.

## Request body

- ProductVariantUpdate
  - `id` string: Defines variant update specified by variant id
  - `product_id` string: Defines product's id where the variant has to be updated
  - `store_id` string: Defines store id where the variant should be found
  - `lang_id` string: Language id
  - `options` object[]: Defines variant's options list
    - `option_name` string
    - `option_value` string
  - `name` string: Defines variant's name that has to be updated
  - `description` string: Specifies variant's description
  - `short_description` string: Defines short description
  - `model` string: Specifies variant's model that has to be added
  - `sku` string: Defines new product's variant sku
  - `visible` string: Set visibility status
  - `status` string: Defines product variant's status
  - `backorder_status` string: Set backorder status
  - `low_stock_threshold` number: Specify the quantity threshold below which the product is considered low in stock
  - `available_for_sale` boolean: Specifies the set of visible/invisible product's variants for sale
  - `avail` boolean: Defines category's visibility status
  - `is_default` boolean: Defines as a default variant
  - `is_free_shipping` boolean: Specifies variant's free shipping flag that has to be added
  - `taxable` boolean: Specifies whether a tax is charged
  - `tax_class_id` string: Defines tax classes where entity has to be added
  - `is_virtual` boolean: Defines whether the product is virtual
  - `manage_stock` boolean: Defines inventory tracking for product variant. When true, quantity sets the stock level and the stock status is derived from it; when false, quantity is ignored and in_stock sets the status directly.
  - `in_stock` boolean: Set stock status. Effective only when manage_stock is false — when stock is managed, the status is derived from quantity automatically and this parameter is ignored.
  - `warehouse_id` string: This parameter is used for selecting a warehouse where you need to set/modify a product quantity.
  - `reserve_quantity` number: This parameter allows to reserve/unreserve product variants quantity.
  - `quantity` number: Defines new products' variants quantity. Effective only when manage_stock is true — otherwise the value is ignored. To enable stock tracking and set a quantity in one call, pass manage_stock=true together with quantity.
  - `increase_quantity` number: Defines the incremental changes in product quantity. Effective only when manage_stock is true — otherwise the value is ignored.
  - `reduce_quantity` number: Defines the decrement changes in product quantity. Effective only when manage_stock is true.
  - `prices_inc_tax` boolean: Indicates whether prices include tax.
  - `price` number: Defines new product's variant price
  - `special_price` number: Defines new product's variant special price
  - `retail_price` number: Defines new product's retail price
  - `old_price` number: Defines product's old price
  - `cost_price` number: Defines new product's cost price
  - `fixed_cost_shipping_price` number: Specifies fixed cost shipping price
  - `sprice_create` string: Defines the date of special price creation
  - `sprice_expire` string: Defines the term of special price offer duration
  - `measure_unit` string: Unit for the price per unit. Must be in allowed list
  - `unit_price` number: Defines new product's unit price
  - `weight` number: Weight
  - `barcode` string: A barcode is a unique code composed of numbers used as a product identifier.
  - `width` number: Defines product's width
  - `weight_unit` string: Weight Unit
  - `height` number: Defines product's height
  - `length` number: Defines product's length
  - `gtin` string: Global Trade Item Number. An GTIN is an identifier for trade items.
  - `upc` string: Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products.
  - `mpn` string: Manufacturer Part Number. A MPN is an identifier of a particular part design or material used.
  - `ean` string: European Article Number. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products.
  - `isbn` string: International Standard Book Number. An ISBN is a unique identifier for books.
  - `harmonized_system_code` string: Harmonized System Code. An HSC is a 6-digit identifier that allows participating countries to classify traded goods on a common basis for customs purposes
  - `country_of_origin` string: The country where the inventory item was made
  - `meta_title` string: Defines unique meta title for each entity
  - `meta_description` string: Defines unique meta description of a entity
  - `meta_keywords` string: Defines unique meta keywords for each entity
  - `manufacturer` string: Specifies the product variant's manufacturer
  - `reindex` boolean: Is reindex required
  - `clear_cache` boolean: Is cache clear required
  - `processing_profile_id` integer: The numeric ID of the processing profile (readiness state) for physical products in Etsy. You can find possible values in the "cart.info" API method response, in the field processing_profiles[]->readiness_state_id.
  - `idempotency_key` string: A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

## Response `200`

successful operation

- object
  - `return_code` integer
  - `return_message` string
  - `result` object
    - `updated_items` integer

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)