Product
GET /request
The Product Parameters are applicable when making a request with type=product to retrieve details of 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.
Product details are retrieved from the product page for a single product on Ebay.
Lookup an EPID by GTIN / ISBN / UPC / EAN Countdown API can automatically convert GTIN/ISBN/UPC/EAN codes to EPIDs and return product data. For details of how to lookup Ebay product details by GTIN/ISBN/UPC/EAN please see refer to the guide.
For example, to request details for the EPID 233599133856 on ebay.com the request would be:
The following parameters are available for all requests made when type=product .
Parameter | Required | Description |
|---|---|---|
ebay_domain | optional | The Ebay domain to retrieve product details from for the product specified in the epid parameter. 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 product details 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 product details from. Note : If the url parameter is supplied then the ebay_domain and epid parameters are ignored. |
include_html | optional | Determines whether raw HTML is included in the response (this can increase the size of the response). Can be set to true or false (the default). Note When adding requests with include_html=true to a Collection the maximum number of requests is lower (100) because including the HTML within the response makes the Collection Result Sets much larger. The limit is in place to ensure Result Set files are of a manageable size. If you have need to run a large number of requests all with include_html=true then simply split the requests across multiple 100-request Collections. |
include_parts_compatibility | optional | Determines whether Countdown returns the parts_compatibility property as part of the product request. The parts compatibility properties are typically shown in the descriptive section of the Ebay product listing page - for example, a compatibility table showing the vehicle a particular part is compatible with (screenshot shown below). Note : When include_parts_compatibility=true 2 credits are charged instead of 1 for the request (this is due to the increased number of internal requests required to retrieve parts compatibility attributes). Note : When include_parts_compatibility=true is only available on Ebay US or Ebay UK (i.e. when ebay_domain=ebay.com or ebay_domain=ebay.co.uk ). Note : When include_parts_compatibility=true the epid parameter must be supplied (as it is required for parts compatibility lookup). The url parameter cannot be used when include_parts_compatibility=true .
|
Next Steps Product Results