Core API
...
Results
Deals

Deals

2min

Deals Results

When making a request with the type parameter set to type=deals Countdown API will return deals results from the Ebay deals page specified in the url parameter.

Deals results are retrieved from the deals results page on Ebay.

Deals Results Page
Deals Results Page


An example of the JSON object returned from a Deals request is shown below:

JSON


Countdown API returns the following properties for Search requests:

Property

Type

Description

deals_results

array

An array of Deal Result objects, containing each of the product results shown on the Deals Results page. The Deal Result object has the following properties:

  • position
  • number
  • The position of the result on the deals page.



  • title
  • string
  • The product name.



  • epid
  • string
  • The Ebay product ID (EPID) for the listing.



  • link
  • string
  • The product page link.



  • image
  • string
  • A link to the image of the product.



  • hotness
  • string
  • The value of the 'hotness' entry shown next to the deal.



  • price
  • object
  • A price object representing the price of the deal. Contains raw , value and currency properties.



  • was_price
  • object
  • A was-price object representing the strikethrough was-price of the deal. Contains raw , value and currency properties.



  • type
  • string
  • The type of deal (showing the heading, if any, the deal is classified under on the deals page). Values are spotlight_deal , trending_deal , featured_deal , category_deal .



  • category_name
  • string
  • In the case of type=category_deal , category_name contains the name of the category.



  • category_link
  • string
  • In the case of type=category_deal , category_link contains the link of the deals category. Can be passed in a subsequent type=deals requests' url parameter to retrieve deals results from that category.

categories

array

An array of sub-categories shown on the deals page. Can be passed in a subsequent type=deals requests' url parameter to retrieve deals results from that category.

  • name
  • string
  • The name of the category.



  • link
  • string
  • The link to the category.

pagination

object

An object containing details of the current search results page and the total number of results that are available. To paginate you should specify the page number in your request's page parameter .

  • current_page
  • number
  • The current page number.



  • has_next_page
  • boolean
  • True / false as to whether a next page of search results is available.



  • next_page
  • number
  • The page number of the next page of results. Can be used in a subsequent type=deals requests' page parameter to request deals results from the next page.


Next Steps      Deals Parameters

Updated 16 Aug 2024
Did this page help you?