API reference
- Getting Started with Your API
- SDKs and Toolkits
- Catalog Administration Overview
- GETGet Product Variations
- PUTUpdate Product Variations
- GETGet Product Variation
- PUTUpdate Product Variation
- DELDelete Product Variation
- GETGet Product Variation Localized Delta Prices
- PUTUpdate Product Variation Localized Delta Prices
- POSTAdd Product Variation Localized Delta Price
- GETGet Product Variation Localized Delta Price
- PUTUpdate Product Variation Localized Delta Price
- DELDelete Product Variation Localized Delta Price
- GETGet Product Variation Localized Prices
- PUTUpdate Product Variation Localized Prices
- POSTAdd Product Variation Localized Price
- GETGet Product Variation Localized Price by Currency
- PUTUpdate Product Variation Localized Price by Currency
- DELDelete Product Variation Localized Price by Currency
- GET
A valid request URL is required to generate request examples{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "<string>",
"variationProductCode": "<string>",
"deltaPrice": {
"currencyCode": "<string>",
"value": 123,
"msrp": 123,
"creditValue": 123
},
"localizedDeltaPrice": [
{
"currencyCode": "<string>",
"value": 123,
"msrp": 123,
"creditValue": 123
}
],
"fixedPrice": {
"currencyCode": "<string>",
"listPrice": 123,
"salePrice": 123,
"msrp": 123,
"creditValue": 123
},
"localizedFixedPrice": [
{
"currencyCode": "<string>",
"listPrice": 123,
"salePrice": 123,
"msrp": 123,
"creditValue": 123
}
],
"deltaWeight": 123,
"fixedWeight": 123,
"options": [
{
"attributeFQN": "<string>",
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
}
}
],
"properties": [
{
"attributeFQN": "<string>",
"values": [
{
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
]
}
],
"upc": "<string>",
"fulfillmentTypesSupported": [
"<string>"
],
"supplierInfo": {
"mfgPartNumber": "<string>",
"distPartNumber": "<string>",
"cost": {
"isoCurrencyCode": "<string>",
"cost": 123
}
}
}Update Product Variation
A valid request URL is required to generate request examples{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "<string>",
"variationProductCode": "<string>",
"deltaPrice": {
"currencyCode": "<string>",
"value": 123,
"msrp": 123,
"creditValue": 123
},
"localizedDeltaPrice": [
{
"currencyCode": "<string>",
"value": 123,
"msrp": 123,
"creditValue": 123
}
],
"fixedPrice": {
"currencyCode": "<string>",
"listPrice": 123,
"salePrice": 123,
"msrp": 123,
"creditValue": 123
},
"localizedFixedPrice": [
{
"currencyCode": "<string>",
"listPrice": 123,
"salePrice": 123,
"msrp": 123,
"creditValue": 123
}
],
"deltaWeight": 123,
"fixedWeight": 123,
"options": [
{
"attributeFQN": "<string>",
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
}
}
],
"properties": [
{
"attributeFQN": "<string>",
"values": [
{
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
]
}
],
"upc": "<string>",
"fulfillmentTypesSupported": [
"<string>"
],
"supplierInfo": {
"mfgPartNumber": "<string>",
"distPartNumber": "<string>",
"cost": {
"isoCurrencyCode": "<string>",
"cost": 123
}
}
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Merchant-created code associated with the product, for example, a SKU. Required.
Unique identifier for a single variation. System-supplied and read-only.
Query Parameters
limits which fields are returned in the response body
Body
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.
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.
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.
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.
Unique identifier for a single variation ("small" + "red" + "short-sleeved"). System-supplied and read-only.
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.
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
Show child attributes
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
Show child attributes
Show child attributes
Show child attributes
Price of the variation using fixed per currency This collection allows for multiple currencies.
Show child attributes
Show child attributes
Weight of the product with this variation.
Fixed weight of the product with this variation.
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
Show child attributes
List of properties specific to this variation
Show child attributes
Show child attributes
Price Lookup Unit code for the product
Indicates the fulfillment types the product supports.
Supplier info for the product
Show child attributes
Show child attributes
Response
Success
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.
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.
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.
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.
Unique identifier for a single variation ("small" + "red" + "short-sleeved"). System-supplied and read-only.
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.
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
Show child attributes
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
Show child attributes
Show child attributes
Show child attributes
Price of the variation using fixed per currency This collection allows for multiple currencies.
Show child attributes
Show child attributes
Weight of the product with this variation.
Fixed weight of the product with this variation.
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
Show child attributes
List of properties specific to this variation
Show child attributes
Show child attributes
Price Lookup Unit code for the product
Indicates the fulfillment types the product supports.
Supplier info for the product
Show child attributes
Show child attributes