Update Product Variation

Modifies an existing product variation specified by its variation key. Typically used to change the price or inventory count of an existing product variation. Read-only options are ignored.<br><br>This current version of the Products API includes localizedContent to support <a href="/pages/catalog-structure#multi-locale-catalogs">multi-locale catalogs</a>, which was not present in the previous API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access product data that has not yet been rewritten to the new model by providing an x-api-version header set to "1".

PUT

commerce

catalog

admin

products

{productCode}

variations

{variationKey}

Error

A valid request URL is required to generate request examples

{
  "deltaPrice": {
    "creditValue": 123,
    "currencyCode": "<string>",
    "msrp": 123,
    "value": 123
  },
  "deltaWeight": 123,
  "fixedPrice": {
    "creditValue": 123,
    "currencyCode": "<string>",
    "listPrice": 123,
    "msrp": 123,
    "salePrice": 123
  },
  "fixedWeight": 123,
  "fulfillmentTypesSupported": [
    "<string>"
  ],
  "isActive": true,
  "isOrphan": true,
  "localizedDeltaPrice": [
    {
      "creditValue": 123,
      "currencyCode": "<string>",
      "msrp": 123,
      "value": 123
    }
  ],
  "localizedFixedPrice": [
    {
      "creditValue": 123,
      "currencyCode": "<string>",
      "listPrice": 123,
      "msrp": 123,
      "salePrice": 123
    }
  ],
  "options": [
    {
      "attributeFQN": "<string>",
      "content": {
        "localeCode": "<string>",
        "stringValue": "<string>"
      },
      "value": "<unknown>"
    }
  ],
  "properties": [
    {
      "attributeFQN": "<string>",
      "values": [
        {
          "attributeVocabularyValueDetail": {
            "content": {
              "localeCode": "<string>",
              "stringValue": "<string>"
            },
            "displayOrder": 123,
            "localizedContent": [
              {
                "localeCode": "<string>",
                "stringValue": "<string>"
              }
            ],
            "mappedGenericValues": [
              "<unknown>"
            ],
            "productName": "<string>",
            "value": "<string>",
            "valueSequence": 123
          },
          "content": {
            "localeCode": "<string>",
            "stringValue": "<string>"
          },
          "localizedContent": [
            {
              "localeCode": "<string>",
              "stringValue": "<string>"
            }
          ],
          "value": null
        }
      ]
    }
  ],
  "supplierInfo": {
    "cost": {
      "cost": 123,
      "isoCurrencyCode": "<string>"
    },
    "distPartNumber": "<string>",
    "mfgPartNumber": "<string>"
  },
  "upc": "<string>",
  "variationExists": true,
  "variationProductCode": "<string>",
  "variationkey": "<string>"
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Path Parameters

productCode

string

required

Merchant-created code associated with the product, for example, a SKU. Required.

variationKey

string

required

Unique identifier for a single variation. System-supplied and read-only.

Query Parameters

responseFields

string

limits which fields are returned in the response body

Body

application/json

Properties of the product variation that you are modifying. Required.

The ProductVariation resource helps merchants manage their products with configurable options. Using this resource, the system creates a matrix of all possible combinations of the product options and the merchant confirms which variations match products for sale. For example, a T-shirt with three color and three size options has nine possible product variations. The system keeps track of inventory for each variation.

deltaPrice

object

How much more a product variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted automatically.

Show child attributes

deltaWeight

number<double> | null

Weight of the product with this variation.

fixedPrice

object

Show child attributes

fixedWeight

number<double> | null

Fixed weight of the product with this variation.

fulfillmentTypesSupported

string[] | null

Indicates the fulfillment types the product supports.

isActive

boolean | null

If true, the merchant accepts the variation generated from the configurable options as a product offering. If IsActive is false then the product variation is not for sale--either because it was never a product offering or it was permanently dropped. IsActive is not intended for temporary unavailability. Default is false.

isOrphan

boolean | null

If true, the variation is no longer possible. The system sets IsOrphan to true when the merchant has changed something to make this variation impossible. For example, if the merchant stopped selling all "small" shirts, all product variations with the "small" option are set to IsOrphan. System-supplied and read-only.

localizedDeltaPrice

object[] | null

How much more the variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted accordingly. This collection allows for multiple currencies.

Show child attributes

localizedFixedPrice

object[] | null

Price of the variation using fixed per currency This collection allows for multiple currencies.

Show child attributes

options

object[] | null

List of values for this product variation: such as "small, "red.. these are read only here as the variationKey defines the values "

Show child attributes

properties

object[] | null

List of properties specific to this variation

Show child attributes

supplierInfo

object

Supplier info for the product

Show child attributes

upc

string | null

Price Lookup Unit code for the product

variationExists

boolean | null

If true, the product variation exists. When the merchant sets IsActive to true, the system sets VariationExists to true and creates a Variation Key as a unique identifier for this variation. System-supplied and read-only.

variationProductCode

string | null

Descriptive code to refer to a single variation. Typically this is a sequence appended to the base ProduceCode. A merchant can create this code to easily recognize a product variation. By default, the system creates this code by appending a number to the base product. After the merchant supplies this code, it becomes read-only.

variationkey

string | null

Unique identifier for a single variation ("small" + "red" + "short-sleeved"). System-supplied and read-only.

Response

deltaPrice

object

How much more a product variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted automatically.

Show child attributes

deltaWeight

number<double> | null

Weight of the product with this variation.

fixedPrice

object

Show child attributes

fixedWeight

number<double> | null

Fixed weight of the product with this variation.

fulfillmentTypesSupported

string[] | null

Indicates the fulfillment types the product supports.

isActive

boolean | null

isOrphan

boolean | null

localizedDeltaPrice

object[] | null

How much more the variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted accordingly. This collection allows for multiple currencies.

Show child attributes

localizedFixedPrice

object[] | null

Price of the variation using fixed per currency This collection allows for multiple currencies.

Show child attributes

options

object[] | null

List of values for this product variation: such as "small, "red.. these are read only here as the variationKey defines the values "

Show child attributes

properties

object[] | null

List of properties specific to this variation

Show child attributes

supplierInfo

object

Supplier info for the product

Show child attributes

upc

string | null

Price Lookup Unit code for the product

variationExists

boolean | null

variationProductCode

string | null

variationkey

string | null

Unique identifier for a single variation ("small" + "red" + "short-sleeved"). System-supplied and read-only.

Error

A valid request URL is required to generate request examples

{
  "deltaPrice": {
    "creditValue": 123,
    "currencyCode": "<string>",
    "msrp": 123,
    "value": 123
  },
  "deltaWeight": 123,
  "fixedPrice": {
    "creditValue": 123,
    "currencyCode": "<string>",
    "listPrice": 123,
    "msrp": 123,
    "salePrice": 123
  },
  "fixedWeight": 123,
  "fulfillmentTypesSupported": [
    "<string>"
  ],
  "isActive": true,
  "isOrphan": true,
  "localizedDeltaPrice": [
    {
      "creditValue": 123,
      "currencyCode": "<string>",
      "msrp": 123,
      "value": 123
    }
  ],
  "localizedFixedPrice": [
    {
      "creditValue": 123,
      "currencyCode": "<string>",
      "listPrice": 123,
      "msrp": 123,
      "salePrice": 123
    }
  ],
  "options": [
    {
      "attributeFQN": "<string>",
      "content": {
        "localeCode": "<string>",
        "stringValue": "<string>"
      },
      "value": "<unknown>"
    }
  ],
  "properties": [
    {
      "attributeFQN": "<string>",
      "values": [
        {
          "attributeVocabularyValueDetail": {
            "content": {
              "localeCode": "<string>",
              "stringValue": "<string>"
            },
            "displayOrder": 123,
            "localizedContent": [
              {
                "localeCode": "<string>",
                "stringValue": "<string>"
              }
            ],
            "mappedGenericValues": [
              "<unknown>"
            ],
            "productName": "<string>",
            "value": "<string>",
            "valueSequence": 123
          },
          "content": {
            "localeCode": "<string>",
            "stringValue": "<string>"
          },
          "localizedContent": [
            {
              "localeCode": "<string>",
              "stringValue": "<string>"
            }
          ],
          "value": null
        }
      ]
    }
  ],
  "supplierInfo": {
    "cost": {
      "cost": 123,
      "isoCurrencyCode": "<string>"
    },
    "distPartNumber": "<string>",
    "mfgPartNumber": "<string>"
  },
  "upc": "<string>",
  "variationExists": true,
  "variationProductCode": "<string>",
  "variationkey": "<string>"
}

Developers

API reference

AI Tools

Update Product Variation

Authorizations

Path Parameters

Query Parameters

Body

Response