VariationSummary

The VariationSummary resource provides the lowest price, highest price and variation dimensions for all variations in a response. A variation is a child ASIN. The parent ASIN is an abstraction of the children items. For example, a shirt is a parent ASIN and parent ASINs cannot be sold. A child ASIN would be a blue shirt, size 16, sold by MyApparelStore. This child ASIN is one of potentially many variations. The ways in which variations differ are called dimensions. In the preceding example, size and color are the dimensions. The resource is relevant for only GetVariations operation. Refer Organization of Items on Amazon and Variations Guide for more information.

Availability

All locales.

Response Elements

Name Description
PageCount The number of pages containing variation items with certain number of variations per page.
Price Container for showing the lowest and highest price of the child ASINs.
VariationCount The total number of child ASINs.
VariationDimensions List of all the dimensions i.e consistent theme over which the items varies and their values.

Price Response Element

The structure of Price container inside the high level VariationSummary Resource is as follows

{
  "VariationSummary": {
    "PageCount": "The number of pages containing variations",
    "Price": {
      "HighestPrice": "Highest Price among the child ASINs",
      "LowestPrice": "Lowest Price among the child ASINs"
    },
    "VariationCount": "The total number of child ASINs",
    "VariationDimension": [
      {
        "DisplayName": "Display Name of the Dimension",
        "Locale": "The locale in which Display Name is returned",
        "Name": "Name of the Dimension",
        "Values": "List of all possible values for the Dimension"
      }
    ]
  }
}

Refer following table for more information on each of the individual response elements of the Price response element:

ResponseElement Description
HighestPrice Highest Price among the child ASINs.
LowestPrice Lowest Price among the child ASINs.

VariationDimensions Response Element

The structure of Price container inside the high level VariationSummary Resource is as follows

{
  "VariationSummary": {
    "VariationDimension": [
      {
        "DisplayName": "Display Name of the Dimension",
        "Locale": "The locale in which Display Name is returned",
        "Name": "Name of the Dimension",
        "Values": "List of all possible values for the Dimension"
      }
    ]
  }
}
ResponseElement Description
DisplayName Display Name of the Dimension as visible on the Amazon retail website.
Locale The locale in which Display Name is returned.
Name Name of the Dimension.
Values List of all possible values for the Dimension.

Relevant Operations

Operations that can use these resources include:

Resources

Add the resource name in the request payload to get the corresponding data in the API response.

Name Description
VariationSummary.Price.HighestPrice Get the highest price among the child ASINs.
VariationSummary.Price.LowestPrice Get the lowest price among the child ASINs.
VariationSummary.VariationDimension Get the details about the dimensions like name, display-name and possible values on which the item varies.

VariationSummary.Price.HighestPrice

Requesting this resource returns the highest price among all the child ASINs.

Sample Response

{
  "VariationsResult": {
    "Items": [
      {
        "ASIN": "B00422MCVM",
        "DetailPageURL": "https://www.amazon.co.uk/dp/B00422MCVM?tag=xyz-20&linkCode=ogv&th=1&psc=1",
        "VariationAttributes": [
          {
            "Name": "size_name",
            "Value": "One Size"
          },
          {
            "Name": "color_name",
            "Value": "Tan"
          }
        ]
      },
      {
        "ASIN": "B00422MCW6",
        "DetailPageURL": "https://www.amazon.co.uk/dp/B00422MCW6?tag=xyz-20&linkCode=ogv&th=1&psc=1",
        "VariationAttributes": [
          {
            "Name": "size_name",
            "Value": "One Size"
          },
          {
            "Name": "color_name",
            "Value": "Black"
          }
        ]
      },
      {
        "ASIN": "B00422MCVW",
        "DetailPageURL": "https://www.amazon.co.uk/dp/B00422MCVW?tag=xyz-20&linkCode=ogv&th=1&psc=1",
        "VariationAttributes": [
          {
            "Name": "size_name",
            "Value": "One Size"
          },
          {
            "Name": "color_name",
            "Value": "Brown"
          }
        ]
      }
    ],
    "VariationSummary": {
      "PageCount": 2,
      "Price": {
        "HighestPrice": {
          "Amount": 30.87,
          "Currency": "GBP",
          "DisplayAmount": "£30.87"
        }
      },
      "VariationCount": 13
    }
  }
}

VariationSummary.Price.LowestPrice

Requesting this resource returns the lowest price among all the child ASINs.

Sample Response

{
  "VariationsResult": {
    "Items": [
      {
        "ASIN": "B00422MCVM",
        "DetailPageURL": "https://www.amazon.co.uk/dp/B00422MCVM?tag=xyz-20&linkCode=ogv&th=1&psc=1",
        "VariationAttributes": [
          {
            "Name": "size_name",
            "Value": "One Size"
          },
          {
            "Name": "color_name",
            "Value": "Tan"
          }
        ]
      },
      {
        "ASIN": "B00422MCW6",
        "DetailPageURL": "https://www.amazon.co.uk/dp/B00422MCW6?tag=xyz-20&linkCode=ogv&th=1&psc=1",
        "VariationAttributes": [
          {
            "Name": "size_name",
            "Value": "One Size"
          },
          {
            "Name": "color_name",
            "Value": "Black"
          }
        ]
      },
      {
        "ASIN": "B00422MCVW",
        "DetailPageURL": "https://www.amazon.co.uk/dp/B00422MCVW?tag=xyz-20&linkCode=ogv&th=1&psc=1",
        "VariationAttributes": [
          {
            "Name": "size_name",
            "Value": "One Size"
          },
          {
            "Name": "color_name",
            "Value": "Brown"
          }
        ]
      }
    ],
    "VariationSummary": {
      "PageCount": 2,
      "Price": {
        "LowestPrice": {
          "Amount": 17.03,
          "Currency": "GBP",
          "DisplayAmount": "£17.03"
        }
      },
      "VariationCount": 13
    }
  }
}

VariationSummary.VariationDimension

Requesting this resource returns the details about the dimensions like name, display-name and possible values.

Sample Response

{
  "VariationsResult": {
    "Items": [
      {
        "ASIN": "B00422MCVM",
        "DetailPageURL": "https://www.amazon.co.uk/dp/B00422MCVM?tag=xyz-20&linkCode=ogv&th=1&psc=1",
        "VariationAttributes": [
          {
            "Name": "size_name",
            "Value": "One Size"
          },
          {
            "Name": "color_name",
            "Value": "Tan"
          }
        ]
      },
      {
        "ASIN": "B00422MCW6",
        "DetailPageURL": "https://www.amazon.co.uk/dp/B00422MCW6?tag=xyz-20&linkCode=ogv&th=1&psc=1",
        "VariationAttributes": [
          {
            "Name": "size_name",
            "Value": "One Size"
          },
          {
            "Name": "color_name",
            "Value": "Black"
          }
        ]
      },
      {
        "ASIN": "B00422MCVW",
        "DetailPageURL": "https://www.amazon.co.uk/dp/B00422MCVW?tag=xyz-20&linkCode=ogv&th=1&psc=1",
        "VariationAttributes": [
          {
            "Name": "size_name",
            "Value": "One Size"
          },
          {
            "Name": "color_name",
            "Value": "Brown"
          }
        ]
      }
    ],
    "VariationSummary": {
      "PageCount": 2,
      "VariationCount": 13,
      "VariationDimensions": [
        {
          "DisplayName": "Size",
          "Name": "size_name",
          "Values": [
            "One Size"
          ]
        },
        {
          "DisplayName": "Colour",
          "Name": "color_name",
          "Values": [
            "Brown",
            "Navy",
            "Black",
            "Burgundy",
            "Cognac",
            "Gray",
            "Green",
            "Logan - Tan",
            "Navy/Black",
            "Red",
            "Rfid-black",
            "Rfid-navy",
            "Tan"
          ]
        }
      ]
    }
  }
}

results matching ""

    No results matching ""