Product
When making a request with the type parameter set to type=product Countdown API will return product details for the product specified in either the epid and ebay_domain parameters or the url parameter. You can also request make a type=product by specifying a GTIN, EAN, ISBN or UPC code in the gtin parameter.
Master Pages vs. Individual Listing Pages There are two types of product pages that Countdown API can return data from. A Master Page shows a summary of all listings for a known product summerized in the top_picks array - i.e. "listings for the 'Nest Cam Indoor' product" and an Individual Listing Page will show detail for an individual listing.
Master Pages are denoted by is_master=true in the response and Individual Listing Pages are denoted by is_master=false in the response.
Countdown API will automatically detect the type of product page when the request is run, there is no difference in the request parameters required and no need to know what type of product page you're requesting ahead of running the request.
Master Pages and Individual Listing Pages have different results schemas, which are detailed below.
Master Pages (see example here) show multiple offers in the top_picks array for a single, known product.
Typically the offers shown will be for different conditions - i.e. new, used, preowned, auction etc and contain links to the Individual Listing Pages for the given listings. Master Pages can be identified by is_master=true in the response.
An example of the JSON object returned from an Product request referencing a Master Page is shown below:
Countdown API returns the following properties for Master Page Product requests (i.e. when is_master=true ):
Property | Type | Description |
is_master | boolean | A boolean set to true indicating that this is a Master Product page. |
sold_out | boolean | A boolean set to true when all selling channels for the product in this Master Product page are currently sold out. Corresponds to the "Currently Sold Out" message on the Master Product page.
|
top_picks | array | An array containing all of the Top Picks as shown on the Master Product page. The top_picks array will be populated with objects containing the same properties as shown on an Individual Listing page (see the Individual Listing page response schema below). Typically a Top Pick will be shown for each condition of listing shown on the Master Page - i.e. one for brand new, one for pre-owned, one for used, one for auction, etc. Inspect the top_picks.condition.name property to see the description of the Top Pick condition. |
Individual Listing Pages (see example here contain details of an individual listing. Individual Listing Pages can be identified by is_master=false in the response.
An example of the JSON object returned from an Product request referencing an Individual Listing Page is shown below:
Countdown API returns the following properties for Individual Listing Page Product requests (i.e. when is_master=false ):
Property | Type | Description |
is_master | boolean | A boolean set to false indicating that this is a Individual Listing page. |
is_auction | boolean | A boolean indicating whether the product listing is an auction or not. |
make_offer | boolean | A boolean set to true if the "Make Offer" button is visible on the listing, null if not. |
product | object | An object containing details of the primary product shown on the product page.
|
auction | object | Auction Object An object containing auction-specific information that is present when this is an auction listing (i.e when is_auction=true :
|
returns_policy | object | Return Policy Object An object showing details of the returns policy for the product, if available:
|
stock_status | object | Stock Status Object An object showing details of the stock status for the product, if available:
|
condition | object | Condition Object An object containing details of the condition for the product that's being offered for sale, if available:
|
offer | object | Offer Object An object showing details of the offer for the product, if available:
|
payment_methods | array | An array of strings with each entry in the array being a payment method that is accepted as payment for this product, for example PayPal . |
seller | object | Seller Object An object showing details of the seller for the product, if available:
|
shipping | object | Shipping Object An object showing details of the shipping for the product, if available:
|
reviews | array | Reviews Object An array of Review objects, containing each of the Customer Reviews shown on the Individual Listing product page. Note to see all reviews you should make a type=reviews request . The Review object has the following properties:
Date Object The date object contains details about the date of the review.
Profile Object The profile object contains details of the profile of the reviewer.
|
parts_compatibility | array | Parts Compatibility Array 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: The parts_compatibility property is only shown when the include_parts_compatibility=true request parameter is set.
|
Often times, when the specified epid is unavaialble Ebay will redirect the user to another, similar, listing. In these scenarios Countdown will return a response with the redirected=true property set, as-per the example below. The redirected EPID, and the link, are shown in the redirected_link and redirected_epid properties allowing you (should your use-case require it) to make a subsequent request for the redirected EPID.
An example of the JSON object returned from a redirected Product request is shown below:
Countdown API returns the following properties for Product requests that have been redirected:
Property | Type | Description |
redirected | boolean | A boolean set to true when the requested EPID has resulted in Ebay redirecting to another, similar EPID due to the request EPID no longer being avaialble. |
redirected_link | string | A URL to the product listing page of the EPID that has been redirected to. |
redirected_epid | string | The EPID that has been redirected to. |
Next Steps Product Parameters