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 Target - the product is specified using the  tcin ,  dpci  or  url  parameter (where the  url  parameter contains a link to an Target product page). The parameters should be appended as querystring parameters to the Target Product Data API GET HTTP request.
Reviews are retrieved from the customer reviews page for a single product on Target.
Customer Reviews Page
﻿
For example, to request reviews sorted by most recent ( sort_by=most_recent ), for the TCIN  78025470  the request would be:
HTTP
Curl
Node.js
Python
PHP
https://api.redcircleapi.com/request?api_key=demo&type=reviews&tcin=78025470&sort_by=most_recent
https://api.redcircleapi.com/request?api_key=demo&type=reviews&tcin=78025470&sort_by=most_recent
﻿
﻿
Reviews Parameters
The following parameters are available for all requests made when  type=reviews  in addition to the Common Parameters.
Parameter
Required
Description
tcin
optional
The Target TCIN (item ID) to retrieve Reviews for.
dpci
optional
The DPCI code to look up a matching product on Target for to retrieve reviews. DPCI-based requests work by searching for the DPCI on Target first, then retrieving the product details for the first matching tcin .
gtin
optional
The GTIN/ISBN/UPC code to look up a matching product on Target for to retrieve reviews. If the gtin parameter is supplied then the tcin and dpci parameters are ignored. GTIN-based requests work by searching for the GTIN/ISBN/UPC on Target first, then retrieving the product details for the first matching tcin .
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.
﻿
﻿
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.
﻿
﻿
review_media_type
optional
Filter the reviews to those containing a specific media type. Valid values are:
all_reviews 
Include all reviews, irrespective of whether they contain an image.
﻿
media_reviews_only 
Include only reviews containing images.
﻿
﻿
sort_by
optional
Determines the sort order of reviews to return. Valid values are:
most_recent 
Returns reviews with the most recent reviews first.
﻿
high_to_low_rating 
Returns reviews ordered highest to lowest rating.
﻿
low_to_high_rating 
Returns reviews ordered lowest to highest rating.
﻿
most_helpful 
Returns reviews with the most helpful reviews first.
﻿
﻿
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.
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.
url
optional
The Target product-page URL to retrieve reviews details from.  
Note : If the url parameter is supplied then the tcin , dpci and gtin parameters are ignored (the url overrides these parameters).
﻿
Next Steps
     Reviews Results﻿

Parameter	Required	Description
tcin	optional	The Target TCIN (item ID) to retrieve Reviews for.
dpci	optional	The DPCI code to look up a matching product on Target for to retrieve reviews. DPCI-based requests work by searching for the DPCI on Target first, then retrieving the product details for the first matching tcin .
gtin	optional	The GTIN/ISBN/UPC code to look up a matching product on Target for to retrieve reviews. If the gtin parameter is supplied then the tcin and dpci parameters are ignored. GTIN-based requests work by searching for the GTIN/ISBN/UPC on Target first, then retrieving the product details for the first matching tcin .
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.
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.
review_media_type	optional	Filter the reviews to those containing a specific media type. Valid values are: all_reviews Include all reviews, irrespective of whether they contain an image. media_reviews_only Include only reviews containing images.
sort_by	optional	Determines the sort order of reviews to return. Valid values are: most_recent Returns reviews with the most recent reviews first. high_to_low_rating Returns reviews ordered highest to lowest rating. low_to_high_rating Returns reviews ordered lowest to highest rating. most_helpful Returns reviews with the most helpful reviews first.
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.
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.
url	optional	The Target product-page URL to retrieve reviews details from. Note : If the url parameter is supplied then the tcin , dpci and gtin parameters are ignored (the url overrides these parameters).

Updated 08 Aug 2024

Did this page help you?

Product

Store Stock