1. Home
  2. Amzpecty Documentation
  3. Amzpecty API Specifications
  4. Product Variations API

Product Variations API

ADD PARENT ASIN TO PRODUCT VARIATIONS QUERY QUEUE

The request to add a Parent ASIN to Product Variations query queue.

CREDIT DEDUCTION

1 (one) credit deduction for each variant after successful retrieval of data. Example: If there are 5 variants, 5 (five) credits will be deducted if all 5 variants information is successfully retrieved.

REQUEST
URI /api/query/requestvariants/ {PARENTASIN}?domain={domain}&secretKey={secretKey} {PARENTASIN } – required – the Parent ASIN to add to variant search queue {domain} – optional – defaults to www.amazon.com if unspecified. See Supported Amazon Domains for list.
Http Header (optional) AMZPECTY_CALLBACK_URL={Your callback URL}
Example /api/query/requestvariants/B01M5IK8M9?domain=www.amazon.com&secretKey= xxxxxxxxxx
RESPONSE
Headers
MediaType application/json
JSON Data
{
  status: "OK",
  allowed: 999,
  dailyAllowed: 100,
  messageId: null,
  message: null,
  data: null,
  rid: "5e70778ce4b09ae7cdd98243",
  dateProcessed: null
}

PRODUCT VARIATIONS QUERY CALLBACK

PRODUCT VARIATIONS QUERY CALLBACK REQUEST
URI Example: https://your.server.com/amzpecty_result {Please provide URL in Preferences Page} URL must be SSL enabled. AMZPECTY-API-SECRET-KEY (header name) – secret key header will be included for the call back server to validate the request origin
MediaType application/json
PRODUCT VARIATIONS QUERY CALLBACK JSON SAMPLE DATA
Headers
MediaType application/json
JSON Data
{
  "status":"OK",
  "responsefor": "productvariations",
  "allowed":142658,
  "dailyAllowed":9828,
  "messageId":null,
  "message":null,
  "data":{
    "parentAsin":"B077HN95T8",
    "itemName":"Pendleton Women’s Heritage Chelsea Slip-Resistant Rain Boot",
    "salesRank":31070,
    "options":[
      "Size",
      "Color"
],
   "totalVariations":86,
   "variants":[
{
  "asin":"B0772WW76G",
  "productUrl":"https://www.amazon.com/dp/B0772WW76G?th=1&psc=1",
  "option1":"Size",
  "option1Value":"6",
  "option2":"Color",
  "option2Value":"Rainier Red",
  "BBSellerName":"Fishbone Apparel",
  "BBPrice":109.95,
  "BBQuantity":2,
  "BBType":"FBA",
  "salesRank":31070,
  "totalOffers":1,
  "dimension":"3.8 x 9.5 x 11.7 inches",
  "imageUrl":"https://m.media-amazon.com/images/I/31wd4kuv6IL._SCLZZZZZZZ__SL80_.jpg",
  "weight":"3.351 pounds",
  "reviewPercentage":2.08,
  "reviewCount":2,
  "globalRatingsPositive": 4486,
  "globalRatingsCritical": 421,
  "globalReviewPositive": 1286,
  "globalReviewCritical": 271,
  "recentReview":"March 7, 2020","searchStatus":"completed" },
{
  "asin":"B07PJT8S6K",
  "productUrl":"https://www.amazon.com/dp/B07PJT8S6K?th=1&psc=1",
  "option1":"Size",
  "option1Value":"6",
  "option2":"Color",
  "option2Value":"Starwatchers Blue Print",
  "BBSellerName":"new pairs",
  "BBPrice":109.95,
  "BBQuantity":2,
  "BBType":"FBA",
  "salesRank":31070,
  "totalOffers":1,
  "dimension":"4.25 x 10.87 x 13.07 inches",
  "imageUrl":"https://m.media-amazon.com/images/I/41ooAxDOy5L._SCLZZZZZZZ__SL80_.jpg",
  "weight":"3.4502 pounds",
  "reviewPercentage":0.0,
  "reviewCount":0,
  "globalRatingsPositive": 0,
  "globalRatingsCritical": 0,
  "globalReviewPositive": 0,
  "globalReviewCritical": 0,
  "recentReview":"",
  "searchStatus":"completed"
}
]
},
  "rid":"5e70778ce4b09ae7cdd98243",
  "dateProcessed":1584429103564,
  "domain": "www.amazon.com"
}
PRODUCT VARIATIONS QUERY CALLBACK RESPONSE JSON ATTRIBUTES
Attribute NameDetails
statusThe status of the request.
responsefor“productvariations” value for Product Variations query result
allowedThe current allowed request count. Resets monthly.
dailyAllowedThe current allowed daily request count. Resets daily.
messageIdThe id of the message (if any) .
messageThe actual message (if any). Pls refer to Error Messages.
ridThe request id. This can be used to match this response to the original request.
dateProcessedThe date the request was processed in unix time format.
domainThe target Amazon domain.
data.parentAsinThe Parent ASIN of the product variants.
data. itemNameThe item name of the product.
data. salesRankThe Sales Rank of the Parent product.
data. options[]The list of options available. E.g. [ “Size”, “Color” ]
data.totalVariationsThe total number of variations for the Parent Asin.
data. variants[]The list of variants of the Parent Asin.
data.variants[n].asinThe Asin of this variant.
data.variants[n].productUrlThe product Url of this variant.
data.variants[n].option1The key for this first option as listed on data.options[]. E.g. “Size”
data.variants[n].option1ValueThe value for this first option. E.g. “9”
data.variants[n].option2The key for this second option as listed on data.options[]. E.g. “Color”
data.variants[n].option2ValueThe value for this second option. E.g. “Yellowstone Yellow”
data.variants[n].option*The key for this nth option as listed on data.options[].
data.variants[n].option*ValueThe value for this nth option.
data.variants[n].BBSellerNameThe buybox seller name of this variant.
data.variants[n].BBPriceThe buybox price of this variant excluding shipping.
data.variants[n].BBQuantityThe quantity available for the buybox seller of this variant.
data.variants[n].BBTypeThe seller type of this variant. “FBA” or “FBM”
data.variants[n].salesRankThe sales rank of this variant.
data.variants[n].totalOffersThe number of offers of this variant.
data.variants[n].dimensionThe dimension of this variant.
data.variants[n].imageUrlThe image URL of this variant.
data.variants[n].weightThe weight of this variant.
data.variants[n].reviewPercentageThis variant’s ( review count / all review count) X 100 .
data.variants[n].reviewCountDEPRECATED as of September 11, 2020. Use globalReviewPositive and globalReviewCritical instead.
data.variants[n].globalRatingsPositiveNEW. Added September 11, 2020. The total global positive ratings count of this variant.
data.variants[n].globalRatingsCriticalNEW. Added September 11, 2020. The total global critical ratings count of this variant.
data.variants[n].globalReviewPositiveNEW. Added September 11, 2020. The total global positive review count of this variant.
data.variants[n].globalReviewCriticalNEW. Added September 11, 2020. The total global critical review count of this variant.
data.variants[n].recentReviewThis variant’s most recent review date.
data.variants[n].searchStatusThe query status of this variant. “in-progress” or “completed”

GET PRODUCT VARIATIONS QUERY RESULT DATA BY PARENT ASIN

0 (zero) credit deduction for the Get call.

The request to get the Product Variations query result data by Parent ASIN.

REQUEST
URI /api/query/getmatchasins/rid/{rid}?domain={domain}&secretKey={secretKey} { PARENTASIN } – the parent ASIN to get most recent variant list {domain} – optional – defaults to www.amazon.com if unspecified. See Supported Amazon Domains for list.
Example /api/query/getvariants/asin/B01M5IK8M9?domain=www.amazon.com&secretKey= xxxxxxxxxx
RESPONSE

See Product Variations Query Callback JSON Sample Data

GET PRODUCT VARIATIONS REQUEST RESULT DATA BY REQUEST ID

The request to get the product variations query result data by Request ID.

CREDIT DEDUCTION

0 (zero) credit deduction for the Get call.

REQUEST
URI /api/query/getvariants/rid/{ RID }?domain={domain}&secretKey={secretKey} { RID } – the Request ID to get most recent variant list {domain} – optional – defaults to www.amazon.com if unspecified. See Supported Amazon Domains for list.
Example /api/query/getvariants/rid/ 5e712345e4b04dd8c8b7e490?domain=www.amazon.com&secretKey= xxxxxxxxxx
RESPONSE

See Product Variations Query Callback JSON Sample Data

Was this article helpful to you? Yes No

How can we help?