Reviews

3min

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 Home Depot - the product is specified using either the  item_id  or  url  parameter (where the  url  parameter contains a link to a Home Improvement product page). The parameters should be appended as querystring parameters to the Home Improvement Product Data API GET HTTP request.
Reviews are retrieved from the customer reviews page for a single product on Home Depot.
Customer Reviews Page
﻿
For example, to request reviews sorted by most helpful ( sort_by=most_helpful ), for the Item ID  317061059 , the request would be:
HTTP
Curl
Node.js
Python
PHP
https://api.backyardapi.com/request?api_key=demo&engine=homedepot&type=reviews&item_id=317061059&sort_by=most_helpful
https://api.backyardapi.com/request?api_key=demo&engine=homedepot&type=reviews&item_id=317061059&sort_by=most_helpful
﻿
﻿
Reviews Parameters
The following parameters are available for all requests made when  type=reviews  in addition to the Common Parameters.
Parameter
Required
Description
item_id
required
The Home Improvement Item ID to retrieve Reviews for.  
Note : If the item_id parameter is supplied then the url parameter is ignored.
gtin
optional
The GTIN/ISBN/UPC code to look up a matching product on Home Improvement for to retrieve reviews for. If the gtin parameter is supplied then the item_id parameter is ignored. GTIN-based requests work by looking up the GTIN/ISBN/UPC on Home Improvement first, then retrieving the reviews for the first matching item_id .
url
optional
The Home Improvement reviews-page URL to retrieve Reviews from.
sort_by
optional
Determines the sort order of reviews to return. Valid values are:
photo_reviews 
Returns reviews with photos first.
﻿
most_helpful 
Returns reviews with the most helpful reviews first.
﻿
newest_to_oldest 
Returns reviews ordered from newest to oldest.
﻿
oldest_to_newest 
Returns reviews ordered from oldest to newest.
﻿
high_to_low_rating 
Returns reviews ordered highest to lowest rating.
﻿
low_to_high_rating 
Returns reviews ordered lowest to highest rating.
﻿
﻿
﻿
search_term
optional
A search term to use to search reviews.
﻿
﻿
reviewer_type
optional
The type of reviewer to retrieve reviews from. Valid values are:
verified_purchase 
Include reviews by Verified Purchasers only.
﻿
all 
Include all reviews, regardless of whether they are from Verified Purchasers or not.
﻿
﻿
﻿
five_star
optional
﻿
﻿
Set to true to filter to only reviews that give the product a 5-star rating.
four_star
optional
Set to true to filter to only reviews that give the product a 4-star rating.
three_star
optional
Set to true to filter to only reviews that give the product a 3-star rating.
two_star
optional
Set to true to filter to only reviews that give the product a 2-star rating.
one_star
optional
Set to true to filter to only reviews that give the product a 1-star rating.
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 the maximum number of reviews per page is 10 (this is a Home Improvement limit).
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.
﻿
Next Steps
     Reviews Results﻿

Parameter	Required	Description
item_id	required	The Home Improvement Item ID to retrieve Reviews for. Note : If the item_id parameter is supplied then the url parameter is ignored.
gtin	optional	The GTIN/ISBN/UPC code to look up a matching product on Home Improvement for to retrieve reviews for. If the gtin parameter is supplied then the item_id parameter is ignored. GTIN-based requests work by looking up the GTIN/ISBN/UPC on Home Improvement first, then retrieving the reviews for the first matching item_id .
url	optional	The Home Improvement reviews-page URL to retrieve Reviews from.
sort_by	optional	Determines the sort order of reviews to return. Valid values are: photo_reviews Returns reviews with photos first. most_helpful Returns reviews with the most helpful reviews first. newest_to_oldest Returns reviews ordered from newest to oldest. oldest_to_newest Returns reviews ordered from oldest to newest. high_to_low_rating Returns reviews ordered highest to lowest rating. low_to_high_rating Returns reviews ordered lowest to highest rating.
search_term	optional	A search term to use to search reviews.
reviewer_type	optional	The type of reviewer to retrieve reviews from. Valid values are: verified_purchase Include reviews by Verified Purchasers only. all Include all reviews, regardless of whether they are from Verified Purchasers or not.
five_star	optional	Set to true to filter to only reviews that give the product a 5-star rating.
four_star	optional	Set to true to filter to only reviews that give the product a 4-star rating.
three_star	optional	Set to true to filter to only reviews that give the product a 3-star rating.
two_star	optional	Set to true to filter to only reviews that give the product a 2-star rating.
one_star	optional	Set to true to filter to only reviews that give the product a 1-star rating.
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 the maximum number of reviews per page is 10 (this is a Home Improvement limit).
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.

Updated 08 Aug 2024

Did this page help you?

Product