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 Walmart USA ( walmart.com ) or Walmart Canada ( walmart.ca ) - the product is specified using either the  item_id  or  url  parameter (where the  url  parameter contains a link to a Walmart product page). The parameters should be appended as querystring parameters to the Walmart Product Data API GET HTTP request.
Reviews are retrieved from the customer reviews page for a single product on Walmart.
Customer Reviews Page
﻿
For example, to request reviews sorted by most helpful ( sort_by=most_helpful ), for the Item ID  782866746 , on  walmart.com  the request would be:
HTTP
Curl
Node.js
Python
PHP
https://api.bluecartapi.com/request?api_key=demo&type=reviews&item_id=782866746&sort_by=most_helpful
https://api.bluecartapi.com/request?api_key=demo&type=reviews&item_id=782866746&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
optional
The Walmart Item ID to retrieve Reviews for.  
Note : If the item_id parameter is supplied then the url parameter is ignored.
walmart_domain
optional
The Walmart domain to retrieve Reviews for. Can be set to walmart.com (the default), or walmart.ca .
url
optional
The Walmart reviews-page URL to retrieve Reviews from.
sort_by
optional
Determines the sort order of reviews to return. Valid values are:
most_relevant 
Returns reviews with the most relevant reviews 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.
﻿
﻿
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.
﻿
Next Steps
     Reviews Results﻿

Parameter	Required	Description
item_id	optional	The Walmart Item ID to retrieve Reviews for. Note : If the item_id parameter is supplied then the url parameter is ignored.
walmart_domain	optional	The Walmart domain to retrieve Reviews for. Can be set to walmart.com (the default), or walmart.ca .
url	optional	The Walmart reviews-page URL to retrieve Reviews from.
sort_by	optional	Determines the sort order of reviews to return. Valid values are: most_relevant Returns reviews with the most relevant reviews 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.
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.

Updated 08 Aug 2024

Did this page help you?

Product

Seller Profile