Core APIs
...
Results
Deals & Bestsellers

Deals

2min

Deals Results

When making a request with the type parameter set to type=deals Rainforest API will return lightning deals / daily deals / 'goldbox' deals for the category_id and amazon_domain parameters specified.

Deals results are retrieved from the deals listing pages on Amazon.

Deals Page
Deals Page


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

JSON


Rainforest API returns the following properties for Deals requests:

Property

Type

Description

deals_results

array

An array of Deal Result objects, containing each of the deal results shown on the deals listing page. The Deal Result object has the following properties:

  • position
  • number
  • The position of the result on the deal listing page.



  • title
  • string
  • The product name.



  • asin
  • string
  • The Amazon product ID (ASIN) for the product.



  • link
  • string
  • The product page link.



  • deal_id
  • string
  • The ID of the deal.



  • deals_link
  • string
  • Link to the product variant page.



  • description
  • string
  • The description of the product.



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



  • deal_type
  • string
  • The deal-type (or category of deal) as described by Amazon themselves.



  • deal_price
  • object
  • The deal price of the product expressed as a price object with the following properties: value, the deal price offered, currency and symbol , the currency symbol.



  • list_price
  • object
  • The list price (RRP) of the product expressed as a price object with the following properties: value, the list price, currency and symbol , the currency symbol.



  • current_price
  • object
  • The current deal price of the product expressed as a price object with the following properties: value, the curent price, currency and symbol , the currency symbol.



  • starts_at
  • date
  • The ISO date/time stamp of the start of the deal.



  • ends_at
  • date
  • The ISO date/time stamp of the end of the deal.



  • percent_off
  • number
  • The percent off listed on the Deals page.



  • is_lightning_deal
  • boolean
  • True/false depending on whether Amazon flag this deal as a "lightning deal", or not.



  • deal_badge
  • string
  • The Amazon Deal badge presented on the deals page (if available). Examples are "Limited Time Deals", "With Prime","With Prime early access". Specific badges for Amazon Prime days or other promotional days will be added for limited times.



categories

array

An array containing details of the Deals categories shown on the deals page. Note that Deals categories can also be retrieved via the Categories API . Each object in the array contains the following properties:

  • name
  • string
  • The name of the category (i.e. "Toys & Games").



  • category_id
  • string
  • The ID of the Deals category. Can we used in a future type=deals requests category_id request parameter to retrieve deals from in this category.

pagination

object

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

  • current_page
  • number
  • The current page number.



  • total_pages
  • number
  • The total number of pages available.



  • total_deals
  • number
  • The total number of deals available.



Next Steps      Deals Parameters

Updated 25 Sep 2024
Did this page help you?
PREVIOUS
Question Answers
NEXT
Bestsellers
Docs powered by Archbee