1. Home
  2. Amzpecty Documentation
  3. Amzpecty API Specifications
  4. Products Review API

Products Review API

ADD ASIN/ISBN TO PRODUCT REVIEW API QUERY QUEUE

The request to add an ASIN/ISBN to Product Review query queue. Product Reviews API will query the product reviews with the ability to filter results based on user defined query parameters.

CREDIT DEDUCTION

1 (one) credit deduction (per page of Product Review) after successful retrieval of data. 5 pages of Product Review will consume 5 credits if retrieval is successful.

REQUEST
URI /api/query/reviews/{ASIN/ISBN}?domain={domain}&secretKey={secretKey} {ASIN/ISBN} – required – the ASIN or ISBN to add to tracking list {domain} – optional – defaults to www.amazon.com if unspecified valid values [ http://www.amazon.com,/www.amazon.com ] {location} – optional – filter reviews by location as shown in Amazon. E.g. (“United States”, “Mexico”, “United Kingdom” etc.) {datefrom} – optional – filters reviews posted since the given date (Valid pattern “yyyy-MM-dd”) {dateto} – optional – filters reviews posted up to the given date (Valid pattern “yyyy-MM-dd”) {verifiedpurchaseonly} – optional – filters only verified purchased reviews (Valid value: “true” or “false”) {rating} – optional – filters reviews by Star Rating (Valid values: “1”, “2”, “3”, “4”, “5”)
Example /api/query/reviews/B01M5IK8M9?domain=www.amazon.com&secretKey= xxxxxxxxxx&location=Mexico&datefrom=2021-01-01&dateto=2021-12-31&verifiedpurchaseonly=true&rating=5
RESPONSE
Headers
MediaType application/json
JSON Data
{
  "status": "OK",
  "allowed": 4971,
  "messageId": null,
  "message": null,
  "data": null,
  "rid": "58eb4fb8bfc2333894ce7dc7",
  "dateProcessed": null
}

Note: During callback, the rid can be used to link the callback data to the original request call.

PRODUCT REVIEWS QUERY CALLBACK

PRODUCT REVIEWS 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 REVIEWS QUERY CALLBACK JSON SAMPLE DATA
Headers
MediaType application/json
JSON Data
{
  status: "OK",
  responsefor: "productreviews",
  allowed: 108974,
  dailyAllowed: 9903,
  messageId: null,
  message: null,
  data: {
    asin: "B01M5IK8M9",
    searchStatus: "completed",
    reviewPagesScanned: 4,
  requestFilters: {
    location: "United States",
    verifiedPurchaseOnly: true,
    fromDate: "Jan 01, 2021",
    toDate: "Dec 31, 2021",
    starRating: "5"
},
  totalReviews: 21,
  totalVerifiedPurchase: 21,
  reviewLocations: [
{
  location: "United States",
  reviewCount: 21
}
],
  ratings: [
{
  rating: "5.0 out of 5 stars",
  reviewCount: 21
}
],
  reviews: [
{
  reviewId: "R5N2Q27S1WE1P",
  customerName: "Spirit_Child",
  customerProfileLink:"https://www.amazon.com/gp/profile/amzn1.account.AFE7FQ7FOLUVIUTTUKVF3MVMUPFQ/ref=cm_cr_getr_d_gw_btm?ie=UTF8",
  customerProfileAvatar: "https://images-na.ssl-images-amazon.com/images/G/01/x-locale/common/grey-pixel.gif",
  reviewTitle: "I love it!",
  reviewBody: "It delivered on time & it’s what I was expecting!!",
  reviewLocation: "United States",
  reviewDate: "Dec 22, 2021",
  verifiedPurchase: true,
  variant: "Size: Standard",
  starRating: 5,
  starRatingString: "5.0 out of 5 stars"
}
]
},
  rid: "628c4494e4b06e3bbeaa8b5b",
  dateProcessed: 1653359777214,
  domain: "www.amazon.com"
}
PRODUCT REVIEW 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.asinThe ASIN of the product.
data. searchStatusThe search status. [ “in-progress”, “completed”, “error”]
data. reviewPagesScannedThe number of reviews pages scanned
data. requestFiltersThe user specified filters for this query request
data. requestFilters. locationLocation filter. [“United States”, “Mexico” etc. as shown in Amazon]
data. requestFilters. verifiedPurchaseOnlytrue – return verified purchase only
data. requestFilters. fromDateReview Date from filter. [“yyyy-MM-dd” e.g. “2021-01-01”]
data. requestFilters. toDateReview Date to filter. [“yyyy-MM-dd” e.g. “2021-12-31”]
data. requestFilters. starRatingStar rating filter [“1”, “2”, “3”, “4”, “5”]
data.totalReviewsThe total reviews count.
data. totalVerifiedPurchaseThe total verified purchase review count.
data. reviewLocations[]The list of locations with their corresponding review count
data. reviewLocations[n].locationThe review location
data. reviewLocations[n].reviewCountThe review location count
data. ratings []The list of ratings with their corresponding rating count
data. ratings[n].ratingThe review rating
data. ratings[n].reviewCountThe review rating count
data. reviews[]The list of user reviews with their corresponding information details
data.reviews[n].reviewIdThe review Id
data.reviews[n].customerNameThe review customer name
data.reviews[n].customerProfileLinkThe review profile link
data.reviews[n].customerProfileAvatarThe review profile avatar link
data.reviews[n].reviewTitleThe review title
data.reviews[n].reviewBodyThe review body
data.reviews[n].reviewLocationThe review location
data.reviews[n].reviewDateThe review date
data.reviews[n].verifiedPurchaseThe review verified purchase flag (“true” if verified)
data.reviews[n].variantThe review product variant
data.reviews[n].starRatingThe review star rating
data.reviews[n].starRatingStringThe review star rating in string form

GET PRODUCT REVIEWS RESULT BY ASIN/ISBN

The request to get the latest Product Reviews result by ASIN/ISBN.

CREDIT DEDUCTION

0 (zero) credit deduction for the Get call.

REQUEST
URI /api/query/reviews/asin/{ASIN/ISBN}?domain={domain}&secretKey={secretKey} {ASIN/ISBN} – the ASIN to get most recent tracking list {domain} – optional – defaults to www.amazon.com if unspecified valid values [ http://www.amazon.com,/www.amazon.com ]
Example /api/query/reviews/asin/B01M5IK8M9?domain=www.amazon.com&secretKey= xxxxxxxxxx
RESPONSE

See Product Reviews Result Query Callback JSON Sample Data

GET PRODUCT REVIEWS RESULT BY RID

The request to get the latest Product Reviews result by RID.

CREDIT DEDUCTION

0 (zero) credit deduction for the Get call.

REQUEST
URI /api/query/reviews/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/reviews/rid/628c4494e4b06e3bbeaa8b5b?domain=www.amazon.com&secretKey= xxxxxxxxxx
RESPONSE

See Product Reviews Result Query Callback JSON Sample Data

Was this article helpful to you? Yes No

How can we help?