Core APIs
...
Parameters
Core Requests

Offers

4min

Offers Parameters

GET /request

The Offers Parameters are applicable when making a request with type=offers to retrieve seller Offers for a single product on Amazon - the product is specified using either the asin and amazon_domain parameters or the url parameter (where the url parameter contains a link to an Amazon product offers page). The parameters should be appended as querystring parameters to the Product Data API GET HTTP request.

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

Offers Listing Page
Offers Listing Page


Lookup an ASIN by GTIN / ISBN / UPC / EAN Rainforest API can automatically convert GTIN/ISBN/UPC/EAN codes to ASINs and return Product Offers data for that GTIN. For details of how to lookup Amazon product details by GTIN/ISBN/UPC/EAN please see refer to the guide.

Note that Rainforest will cache the GTIN-to-ASIN 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).

For example, to request Prime-eligable Offers, for products in a New Condition, for the ASIN B073JYC4XM on amazon.com the request would be:

HTTP
Curl
Node.js
Python
PHP



Offers Parameters

The following parameters are available for all requests made when type=offers .

Parameter

Required

Description

amazon_domain

optional

The Amazon domain to retrieve Offers for the product specified in the asin parameter from. For a full list of supported Amazon domains see Supported Amazon Domains .

Note : If the amazon_domain and asin parameters are supplied then the url parameter is ignored.

asin

optional

The Amazon ASIN (product ID) to retrieve Offers for. Used in combination with the amazon_domain parameter.

Note : If the asin and amazon_domain parameters are supplied then the url parameter is ignored.

gtin

optional

A GTIN, ISBN, UPC or EAN code to retrieve results for. Internally Rainforest will first convert the GTIN/ISBN/UPC/EAN to an Amazon ASIN, then retrieve the results for that ASIN from Amazon. Used in combination with the amazon_domain parameter.

Note : If the gtin and amazon_domain parameters are supplied then the url parameter is ignored.

skip_gtin_cache

optional

By default Rainforest will cache the GTIN-to-ASIN 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 Amazon product-page URL to retrieve Offers from.

Note : If the url parameter is supplied then the amazon_domain and asin parameters are ignored.

offers_prime

optional

Limit the offers returned to just those that are Prime-eligible. Valid values are:

  1. true
  2. Only include offers that are Prime-eligible.



  1. false
  2. Include all offers, regardless of whether they are Prime-eligible or not.
  • 

    Document image
    

offers_free_shipping

optional

Limit the offers returned to just those that have Free Shipping. Valid values are:

  1. true
  2. Only include offers that have Free Shipping.



  1. false
  2. Include all offers, regardless of whether they have Free Shipping or not.
  • 

    Document image
    

offers_condition_new

optional

Limit the offers returned to just those that are of New Condition. Valid values are:

  1. true
  2. Only include offers that are New Condition.



  1. false
  2. Include all offers, regardless of their Condition.
  • 

    Document image
    

offers_condition_used_like_new

optional

Limit the offers returned to just those that are of Used-Like-New Condition. Valid values are:

  1. true
  2. Only include offers that are Used-Like-New Condition.



  1. false
  2. Include all offers, regardless of their Condition.
  • 

    Document image
    

offers_condition_used_very_good

optional

Limit the offers returned to just those that are of Used-Very-Good Condition. Valid values are:

  1. true
  2. Only include offers that are Used-Very-Good Condition.



  1. false
  2. Include all offers, regardless of their Condition.
  • 

    Document image
    

offers_condition_used_good

optional

Limit the offers returned to just those that are of Used-Good Condition. Valid values are:

  1. true
  2. Only include offers that are Used-Good Condition.



  1. false
  2. Include all offers, regardless of their Condition.
  • 

    Document image
    

offers_condition_used_acceptable

optional

Limit the offers returned to just those that are of Used-Acceptable Condition. Valid values are:

  1. true
  2. Only include offers that are Used-Acceptable Condition.



  1. false
  2. Include all offers, regardless of their Condition.
  • 

    Document image
    

show_different_asins

optional

Sometimes Amazon will return Offers from ASINs other than the ASIN supplied in the asin request parameter (for example, when the original ASIN is out of stock). show_different_asins controls whether you want these other-ASIN offer results returned, or not. Can be set to true to include offers from other ASINs, or false (the default) to hide offers from ASINs other than the ASIN supplied in the asin parameter. Note that if you supply a url instead of asin in your request this parameter is ignored.

page

optional

The current page of Offers to retrieve. Inspect the pagination.total_pages property in the Offers results to see how many pages of offers are available.

max_page

optional

Use the max_page parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response.

See the Pagination docs for more information.



Next Steps      Offers Results

Updated 11 Aug 2024
Did this page help you?