commerce/catalog/admin/products/variations

Use the product variations sub-resource to manage the variations of a product based on its attributes. For example, a t-shirt product could be offered in six variations: Small Black, Medium Black, Large Black, Small White, Medium White, and Large White.

Note:  You cannot create more than 5,000 product variations for a product. If you need to create more than 5,000 variations, Kibo eCommerce recommends creating a new base product and then creating more product variations off the new base product.

JSON Example

ProductVariation Properties

Property Description
deltaPrice

type: productVariationDeltaPrice

If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".

Refer to Product Variant Pricing and Weight in the Products guides topic for more information.

productVariationDeltaPrice.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

productVariationDeltaPrice.currencyCode

type: string

The localized currency code for the monetary amount.

productVariationDeltaPrice.msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

productVariationDeltaPrice.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

deltaWeight

type: decimal

The difference between the weight associated with this product, variation option, or extra and the base product. For example, if a product with a monogram weighs an extra 1/4 lb, the DeltaWeight value is "0.25". The amount of the delta is set by the weight type for the storefront.

fixedPrice

type: productVariationFixedPrice

If the product is in Explicit pricing mode, this is the price of the variation.

Refer to Product Variant Pricing and Weight in the Products guides topic for more information.

productVariationFixedPrice.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

productVariationFixedPrice.currencyCode

type: string

The localized currency code for the monetary amount.

productVariationFixedPrice.listPrice

type: decimal

If the product is in explicit pricing mode, this is the list price of the variation.

productVariationFixedPrice.msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

productVariationFixedPrice.salePrice

type: decimal

The set sale price for a product consisting of a price with a discount already applied.

For price list entries, this property is the product's sale price if the priceListEntryPrice.salePriceMode is set to Overridden.

fixedWeight

type: decimal

If the product is in explicit pricing mode, this is the fixed weight of the variation.

fulfillmentTypesSupported

type: list of string

List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both.

isActive

type: bool

Indicates if the object or feature is active.

isOrphan

type: bool

If true, the production variation is no longer available for sale. For example, if a client stops selling all "small" shirts, all product variations with the "small" option are set to IsOrphan. System-supplied and read only.

localizedDeltaPrice

type: list of productVariationDeltaPrice

The difference between associated prices for a product, variation option, or extra that is localized per the `localeCode`. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. Depending on the localeCode, the price may be converted such as from USD (US Dollar) to EUR (euro).

productVariationDeltaPrice.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

productVariationDeltaPrice.currencyCode

type: string

The localized currency code for the monetary amount.

productVariationDeltaPrice.msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

productVariationDeltaPrice.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

localizedFixedPrice

type: list of productVariationFixedPrice

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

productVariationFixedPrice.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

productVariationFixedPrice.currencyCode

type: string

The localized currency code for the monetary amount.

productVariationFixedPrice.listPrice

type: decimal

If the product is in explicit pricing mode, this is the list price of the variation.

productVariationFixedPrice.msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

productVariationFixedPrice.salePrice

type: decimal

The set sale price for a product consisting of a price with a discount already applied.

For price list entries, this property is the product's sale price if the priceListEntryPrice.salePriceMode is set to Overridden.

options

type: list of productVariationOption

List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types.

productVariationOption.attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

productVariationOption.content

type: attributeVocabularyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productVariationOption.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productVariationOption.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productVariationOption.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

supplierInfo

type: productSupplierInfo

Supplier-defined properties assigned for the product.

productSupplierInfo.cost

type: productCost

The cost of the product to the retailer, as specified through API or using the Cost field of the Product editor in Admin. This is not the price that the shopper sees on the storefront (which is usually higher).

For price lists entries, this property specifies the cost of the product if costMode is set to Overridden.

productSupplierInfo.productCost.cost

type: decimal

The cost of the product to the retailer, as specified through API or using the Cost field of the Product editor in Admin. This is not the price that the shopper sees on the storefront (which is usually higher).

For price lists entries, this property specifies the cost of the product if costMode is set to Overridden.

productSupplierInfo.productCost.isoCurrencyCode

type: string

The three character ISO currency code for the monetary amount. For example, USD is used for US Dollars.

productSupplierInfo.distPartNumber

type: string

The distributor part number associated with this product, defined by the product distributor.

productSupplierInfo.mfgPartNumber

type: string

The manufacturer's part number for the product.

upc

type: string

The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels.

variationExists

type: bool

If true, one or more product variations are configured for the specified product code.

variationkey

type: string

System-generated key that represents the attribute values that uniquely identify a specific product variation.

variationProductCode

type: string

Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code.

Operations

Operation Name Request URI Description
AddProductVariationLocalizedDeltaPrice POST %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedDeltaPrice%3fresponseFields%3d%7bresponseFields%7d

Adds the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

AddProductVariationLocalizedPrice POST %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedPrice%3fresponseFields%3d%7bresponseFields%7d

Adds the localized price value for a product variation and a specific localized currency.

DeleteProductVariation DELETE %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d

Deletes a variation, based on the supplied variation key, for the specified product code.

DeleteProductVariationLocalizedDeltaPrice DELETE %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedDeltaPrice%2f%7bcurrencyCode%7d

Deletes the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

DeleteProductVariationLocalizedPrice DELETE %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedPrice%2f%7bcurrencyCode%7d

Deletes the localized price value for a product variation and a specific localized currency.

GetProductVariation GET %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a product variation based on the supplied product code and variation key.

GetProductVariationLocalizedDeltaPrice GET %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedDeltaPrice%2f%7bcurrencyCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

GetProductVariationLocalizedDeltaPrices GET %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedDeltaPrice

Retrieves a collection of the localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

GetProductVariationLocalizedPrice GET %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedPrice%2f%7bcurrencyCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the localized price value for a product variation and a specific localized currency.

GetProductVariationLocalizedPrices GET %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedPrice

Retrieves a list of details of the localized price values for a product variation.

GetProductVariations GET %7bproductCode%7d%2fvariations%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of the product variations configured for the specified product code.

UpdateProductVariation PUT %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%3fresponseFields%3d%7bresponseFields%7d

Modifies the details of a variation, based on the supplied variation key, for the specified product code.

UpdateProductVariationLocalizedDeltaPrice PUT %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedDeltaPrice%2f%7bcurrencyCode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

UpdateProductVariationLocalizedDeltaPrices PUT %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedDeltaPrice

Updates all localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

UpdateProductVariationLocalizedPrice PUT %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedPrice%2f%7bcurrencyCode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the localized price value for a product variation and a specific localized currency.

UpdateProductVariationLocalizedPrices PUT %7bproductCode%7d%2fvariations%2f%7bvariationKey%7d%2flocalizedPrice

Updates a list of localized price values for a product variation.

UpdateProductVariations PUT %7bproductCode%7d%2fvariations%3fresponseFields%3d%7bresponseFields%7d

Modifies the collection of variations for the specified product code. Because this PUT replaces the existing resource, supply all information necessary to maintain for the product variation.