Core API
...
Parameters
Customer Feedback

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 Ebay - the product is specified using either the epid and ebay_domain parameters or the url parameter (where the url parameter contains a link to an Ebay product page). The parameters should be appended as querystring parameters to the Ebay Product Data API GET HTTP request.

Reviews are retrieved from the customer reviews page for a single product on Ebay.

Customer Reviews Page
Customer Reviews Page


Lookup an EPID by GTIN / ISBN / UPC / EAN Countdown API can automatically convert GTIN/ISBN/UPC/EAN codes to EPIDs and return Reviews data for that GTIN. For details of how to lookup Ebay product details by GTIN/ISBN/UPC/EAN please see refer to the guide.

For example, to request customer reviews, sorted by "most recent", for the EPID 1522036563 on ebay.com the request would be:

HTTP
Curl
Node.js
Python
PHP



Reviews Parameters

The following parameters are available for all requests made when type=reviews .

Parameter

Required

Description

ebay_domain

optional

The Ebay domain to retrieve Reviews for the product specified in the epid parameter from. For a full list of supported Ebay domains see Supported Ebay Domains .

Note : If the ebay_domain and epid parameters are supplied then the url parameter is ignored.

epid

optional

The Ebay EPID (product ID) to retrieve Reviews for. Used in combination with the ebay_domain parameter.

Note : If the epid and ebay_domain parameters are supplied then the url parameter is ignored.

gtin

optional

A GTIN, ISBN, UPC or EAN code to retrieve results for. Internally Countdown API will first convert the GTIN/ISBN/UPC/EAN to an Ebay EPID, then retrieve the results for that EPID from Ebay. Used in combination with the ebay_domain parameter.

Note : If the gtin and ebay_domain parameters are supplied then the url parameter is ignored.

skip_gtin_cache

optional

By default Countdown API will cache the GTIN-to-EPID mapping for 2 months. To force a new GTIN lookup (for example, if you suspect the existing mapping is stale), use the skip_gtin_cache=true request parameter (note that using skip_gtin_cache=true decrements 2 credits from your balance, instead of 1).

url

optional

The Ebay product-page URL to retrieve Reviews from.

Note : If the url parameter is supplied then the ebay_domain and epid parameters are ignored.

condition

optional

Determines product condition reviews are filtered to. Valid values are:

  1. all
  2. Returns reviews of products in all conditions.



  1. new
  2. Returns reviews of new products.



  1. refurbished
  2. Returns reviews of refurbished products.



  1. preowned
  2. Returns reviews of pre-owned products.
  • 

    Document image
    

sort_by

optional

Determines the sort order of reviews to return.

Valid values are:

  1. most_relevant
  2. Returns reviews in order of relevancy to the search term .



  1. most_recent
  2. Returns reviews in date order, with the most recent first.



  1. rating_high_to_low
  2. Returns reviews ordered by rating, high to low.



  1. rating_low_to_high
  2. Returns reviews ordered by rating, low to high.



  • 

    Document image
    

search_term

optional

A search term to use to search reviews.

  • 

    Document image
    

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

Updated 09 Aug 2024
Did this page help you?