Reviews

4min

Reviews Parameters
﻿GET  /request
The Reviews Parameters are applicable when making a request with  type=reviews  to retrieve customer Reviews for a single product on Amazon - the product is specified using either the  asin  and  amazon_domain  parameters or the  url  parameter (where the  url  parameter contains a link to an Amazon reviews page). The parameters should be appended as querystring parameters to the Product Data API GET HTTP request.
Reviews are retrieved from the customer reviews page for a single product on Amazon.
Customer Reviews Page
﻿
For example, to request all "critical" (i.e. negative) customer Reviews, sorted by "most recent", for the ASIN  B07WJJF8PB  on  amazon.com  the request would be:
HTTP
Curl
Node.js
Python
PHP
https://api.asindataapi.com/request?api_key=demo&type=reviews&amazon_domain=amazon.com&asin=B07WJJF8PB&review_stars=all_critical&sort_by=most_recent
https://api.asindataapi.com/request?api_key=demo&type=reviews&amazon_domain=amazon.com&asin=B07WJJF8PB&review_stars=all_critical&sort_by=most_recent
﻿
﻿
Reviews Parameters
The following parameters are available for all requests made when  type=reviews .
Parameter
Required
Description
amazon_domain
optional
The Amazon domain to retrieve Reviews for the product specified in the asin parameter from. For a full list of supported Amazon domains see Supported Amazon Domains .  
Note : If the amazon_domain and asin parameters are supplied then the url parameter is ignored.
asin
optional
The Amazon ASIN (product ID) to retrieve Reviews for. Used in combination with the amazon_domain parameter.  
Note : If the asin and amazon_domain parameters are supplied then the url parameter is ignored.
url
optional
The Amazon product-page URL to retrieve Reviews from.  
Note : If the url parameter is supplied then the amazon_domain and asin parameters are ignored.
reviewer_type
optional
The type of reviewer to retrieve reviews from. Valid values are:
verified_purchase 
Include reviews by Amazon Verified Purchasers only.
﻿
all 
Include all reviews, regardless of whether they are from Amazon Verified Purchasers or not.
﻿
﻿
review_stars
optional
The star rating of reviews to retrieve. Valid values are:
all_stars 
Include reviews with any star rating.
﻿
five_star 
Include reviews with a 5 star rating.
﻿
four_star 
Include reviews with a 4 star rating.
﻿
three_star 
Include reviews with a 3 star rating.
﻿
two_star 
Include reviews with a 2 star rating.
﻿
one_star 
Include reviews with a 1 star rating.
﻿
all_positive 
Include all positive reviews.
﻿
all_critical 
Include critical reviews.
﻿
﻿
review_formats
optional
The type of reviewer to retrieve reviews from. Valid values are:
all_formats 
Include reviews of any product format/variant.
﻿
current_format 
Include reviews relating specifically to the current format/variant.
﻿
﻿
review_media_type
optional
Filter the reviews to those containing a specific media type. Valid values are:
all_reviews 
Include reviews with text, images or video.
﻿
media_reviews_only 
Include only reviews containing images or video.
﻿
﻿
sort_by
optional
Determines the sort order of reviews to return. Valid values are:
most_helpful 
Returns reviews with the most helpful reviews first.
﻿
global_reviews
optional
Determines whether Global Reviews are included, or not Global Reviews are reviews from other Amazon domains outside of the Amazon domain specified in the request. Valid values are:
true 
The default, Global Reviews are included in the results.
﻿
false 
Global reviews are excluded from the results.
search_term
optional
A search term to use to search reviews.
﻿
﻿
show_different_asins
optional
Sometimes Amazon will return Reviews from ASINs other than the ASIN supplied in the asin request parameter (for example, when the original ASIN is out of stock). show_different_asins controls whether you want these other-ASIN review results returned, or not. Can be set to true (the default) to include reviews from other ASINs, or false to hide reviews from ASINs other than the ASIN supplied in the asin parameter. Note that if you supply a url instead of asin in your request this parameter is ignored.  
Note in the event of show_different_asins=false and the ASIN shown by Amazon being different from the requested ASIN, then all fields apart from product will be removed from the response.
page
optional
The current page of reviews to retrieve. Inspect the pagination.total_pages property in the Reviews results to see how many pages of reviews are available.  
Note that the maximum number of reviews pages served by Amazon is 500.
max_page
optional
Use the max_page parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response.  
See the Pagination docs for more information.
review_id
optional
A single Review ID, as returned by a prior type=reviews request, to retrieve. Useful if you wish to check for the presence of a single review. Use in combination with the amazon_domain parameter.
﻿
Next Steps
     Reviews Results﻿

Parameter	Required	Description
amazon_domain	optional	The Amazon domain to retrieve Reviews for the product specified in the asin parameter from. For a full list of supported Amazon domains see Supported Amazon Domains . Note : If the amazon_domain and asin parameters are supplied then the url parameter is ignored.
asin	optional	The Amazon ASIN (product ID) to retrieve Reviews for. Used in combination with the amazon_domain parameter. Note : If the asin and amazon_domain parameters are supplied then the url parameter is ignored.
url	optional	The Amazon product-page URL to retrieve Reviews from. Note : If the url parameter is supplied then the amazon_domain and asin parameters are ignored.
reviewer_type	optional	The type of reviewer to retrieve reviews from. Valid values are: verified_purchase Include reviews by Amazon Verified Purchasers only. all Include all reviews, regardless of whether they are from Amazon Verified Purchasers or not.
review_stars	optional	The star rating of reviews to retrieve. Valid values are: all_stars Include reviews with any star rating. five_star Include reviews with a 5 star rating. four_star Include reviews with a 4 star rating. three_star Include reviews with a 3 star rating. two_star Include reviews with a 2 star rating. one_star Include reviews with a 1 star rating. all_positive Include all positive reviews. all_critical Include critical reviews.
review_formats	optional	The type of reviewer to retrieve reviews from. Valid values are: all_formats Include reviews of any product format/variant. current_format Include reviews relating specifically to the current format/variant.
review_media_type	optional	Filter the reviews to those containing a specific media type. Valid values are: all_reviews Include reviews with text, images or video. media_reviews_only Include only reviews containing images or video.
sort_by	optional	Determines the sort order of reviews to return. Valid values are: most_helpful Returns reviews with the most helpful reviews first.
global_reviews	optional	Determines whether Global Reviews are included, or not Global Reviews are reviews from other Amazon domains outside of the Amazon domain specified in the request. Valid values are: true The default, Global Reviews are included in the results. false Global reviews are excluded from the results.
search_term	optional	A search term to use to search reviews.
show_different_asins	optional	Sometimes Amazon will return Reviews from ASINs other than the ASIN supplied in the asin request parameter (for example, when the original ASIN is out of stock). show_different_asins controls whether you want these other-ASIN review results returned, or not. Can be set to true (the default) to include reviews from other ASINs, or false to hide reviews from ASINs other than the ASIN supplied in the asin parameter. Note that if you supply a url instead of asin in your request this parameter is ignored. Note in the event of show_different_asins=false and the ASIN shown by Amazon being different from the requested ASIN, then all fields apart from product will be removed from the response.
page	optional	The current page of reviews to retrieve. Inspect the pagination.total_pages property in the Reviews results to see how many pages of reviews are available. Note that the maximum number of reviews pages served by Amazon is 500.
max_page	optional	Use the max_page parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response. See the Pagination docs for more information.
review_id	optional	A single Review ID, as returned by a prior type=reviews request, to retrieve. Useful if you wish to check for the presence of a single review. Use in combination with the amazon_domain parameter.

Updated 15 Oct 2024

Did this page help you?

Offers

Product