Core APIs
...
Results
Core Requests

Offers

4min

Offers Results

When making a request with the type parameter set to type=offers Rainforest API will return all Seller Offers for the product specified in either the asin and amazon_domain parameters or the url parameter.

Offers are retrieved from the offers listing popup window for a single product on Amazon.

Note that the buybox-winner offer is always pinned to the top of the offers listing popup window, above the 'other offers'. Rainforest will append the buybox winner offer to the top of the offers array when page=1 .

Stock Estimation To get stock estimation for a specific Offer pass that offers offer_id into a stock-estimation request.

Amazon Offers Listing Page
Amazon Offers Listing Page


An example of the JSON object returned from an Offers request is shown below:

JSON


Rainforest API returns the following properties for Offers requests:

Paginating Offers Results Amazon returns 10 offers per page. To request more offers issue additional requests incrementing the page parameter. The position property shows the position of the offer within the current page of results. For example, the first offer of page=2 would have position=1 .

Property

Type

Description

offers

array

An array of Offer objects, containing each of the Seller Offers shown on the Offers listing page. The Offer object has the following properties:

  • position
  • number
  • The position of the offer within the current page of offer results .



  • is_prime
  • boolean
  • Determines whether the Offer is Prime-eligible or not.



  • offer_id
  • string
  • The ID of the Offer. To get stock estimation for a specific Offer pass the offer_id into a stock-estimation request.



  • offer_asin
  • string
  • The ASIN the offer relates to. Normally the same as the ASIN supplied in the asin parameter unless the request specifies show_different_asins=true .



  • price_only_available_in_cart
  • string
  • True / false depending on whether the price for this Offer is only available in the Cart. If no price is shown then the price may only be visible once the ASIN is added to the cart. You could consider a stock-estimation request to retrieve the price when price_only_available_in_cart=true .



Price Object The price object contains details about the sellers pricing.

  • symbol
  • string
  • The currency symbol, i.e. $ for USD.



  • value
  • number
  • The price of the Offer.



  • currency
  • string
  • The currency of the Offer as a ISO 4217 currency code.



Minimum Order Quantity Object The minimum order quantity object contains details about the sellers minimum order quantity.

  • value
  • number
  • The minimum order quantity of the Offer.



Maximum Order Quantity Object The maximum order quantity object contains details about the sellers maximum order quantity.

  • value
  • number
  • The maximum order quantity of the Offer.



Promotion Object The promotion object contains details about any promotion associated with the seller offer.

  • raw
  • string
  • The raw text of the promotion.



Import Fee Object The Import Fee object contains details about any import fee payable on the offer.

  • symbol
  • string
  • The currency symbol, i.e. $ for USD.



  • value
  • number
  • The amount of the import fee.



  • currency
  • string
  • The currency of the import fee as a ISO 4217 currency code.



  • raw
  • string
  • The raw price as displayed on the import fee.



Condition Object The condition object contains details about the products condition.

  • is_new
  • boolean
  • Used to quickly determine whether the product being offered is new or used.



  • title
  • string
  • The main description of the product condition, i.e. "Used - Very Good".



  • comments
  • string
  • Any further comments about the product being offered, i.e. "Item will come repackaged."



Delivery Object The deliery object contains details about the products delivery options.

  • is_free
  • boolean
  • Used to quickly determine whether free delivery is offered.



  • fulfilled_by_amazon
  • boolean
  • Whether the delivery is via Amazon, or a third party seller.



  • shipped_from_outside_country
  • boolean
  • Whether the product is shipped from outside the home country for the given Amazon domain (e.g. if an item on Amazon.ca is shipped from the United States).



  • countdown
  • string
  • The countdown as displayed next to the offer, i.e. "20 hrs and 33 mins".



  • comments
  • string
  • Any delivery comments, i.e. "On back order - expected 30th June".



  • raw
  • string
  • The raw price as displayed for the delivery price (if present).



  • price
  • object
  • Delivery Price Object The delivery price object contains details about the delivery pricing for the Offer.
    • 
      1. symbol
      2. string
      3. The currency symbol, i.e. $ for USD.
    • 
      1. value
      2. number
      3. The price for delivery.
    • 
      1. currency
      2. string
      3. The currency as a ISO 4217 currency code.



  • upsell
  • object
  • Delivery Upsell Object The delivery upsell object contains details about the upsell messages (if shown) for the offer.
    • 
      1. name
      2. string
      3. The name of the upsell message, for example "Fastest delivery".
    • 
      1. value
      2. string
      3. The value of the upsell message, for example "Tomorrow" in the case of a "Fastest delivery" upsell message.



  • undeliverable
  • boolean
  • Present, and set to true , when the offer is not deliverable to the current customer_location . Absent if the product is deliverable.



  • undeliverable_message
  • string
  • When undeliverable=true , undeliverable_message contains the message shown indicating why the offer is undeliverable.



Seller Object The seller object contains details about the seller providing the Offer.

  • name
  • string
  • The name of the seller.



  • id
  • string
  • The ID of the seller. Can be specified as a request parameter to a type=seller_profile request to view this sellers profile page.



  • link
  • string
  • A link to the sellers shopfront on Amazon (for third party sellers).



  • rating
  • number
  • The third party sellers rating, out of 5.



  • ratings_total
  • number
  • The total number of ratings that the third party seller has received in the last 12 months.



  • ratings_total_percentage
  • number
  • The % of all ratings received by the third party seller in the last 12 months that Amazon determines where "positive".

product

object

An object containing details of the product (in so far as those details are shown on the Offers listing page). For full product details you should issue a request with type=product to retrieve details from the product page .

  • title
  • string
  • The product name.



  • categories
  • array
  • Categories Array An array containing details of the categories shown with this product as displayed next to the search bar at the top of the page. Note that Amazon products can exist in multiple categories. Each object in the array contains the following properties:
    • 
      1. name
      2. string
      3. The name of the category (i.e. "Toys & Games").



  • rating
  • number
  • The customer rating of the product, out of 5.



  • reviews_total
  • number
  • The total number of customer reviews the product has. To retrieve the reviews you should issue a request with type=reviews to retrieve details from the reviews page



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



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



  • sub_title
  • object
  • Subtitle Object The subtitle object contains details of the information shown in the subtitle directly underneath the product title.
    • 
      1. text
      2. string
      3. The text of the subtitle - typically the brand name of the product i.e. "Samsung".



  • attributes
  • array
  • Attributes Array The attributes array contains details of the product attributes as shown underneath the product title.
    • 
      1. name
      2. string
      3. The name of the product attribute i.e. "Capacity".
    • 
      1. value
      2. string
      3. The value of the product attribute i.e. "128 GB".

pagination

object

An object containing details of the current Offers page and the total number of Offers 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.

available_filters

object

An object containing details of which offer filters are shown by Amazon. Can be used to inform future type=offers requests.

  • offers_free_shipping
  • boolean
  • True/false depending on whether a offers_free_shipping filter is available.



  • offers_prime
  • boolean
  • True/false depending on whether a offers_prime filter is available.



  • offers_condition_new
  • boolean
  • True/false depending on whether a offers_condition_new filter is available.



  • offers_condition_used_like_new
  • boolean
  • True/false depending on whether a offers_condition_used_like_new filter is available.



  • offers_condition_used_very_good
  • boolean
  • True/false depending on whether a offers_condition_used_very_good filter is available.



  • offers_condition_used_good
  • boolean
  • True/false depending on whether a offers_condition_used_good filter is available.



  • offers_condition_used_acceptable
  • boolean
  • True/false depending on whether a offers_condition_used_acceptable filter is available.


Next Steps      Offers Parameters

Updated 11 Aug 2024
Did this page help you?