Stock Estimation

4min

Stock Estimation Results
When making a request with the  type  parameter set to  type=stock_estimation  Rainforest API will return information about the stock level of the given  asin  from the shopping cart.
Stock Estimation Result
﻿
An example of the JSON object returned from a Stock Estimation request is shown below:
JSON
{
  "request_info": {
    "success": true,
    "credits_used": 1,
    "credits_remaining": 999
  },
  "request_metadata": {
    "id": "763fc1a4b3eb053f5c8f20f12655b09dfd36130d",
    "created_at": "2020-01-01T00:00:00.000Z",
    "processed_at": "2020-01-01T00:00:00.001Z",
    "total_time_taken": 0.1,
    "amazon_url": "https://www.amazon.com/dp/B073JYC4XM"
  },
  "request_parameters": {
    "type": "stock_estimation",
    "asin": "B073JYC4XM"
  },
  "stock_estimation": {
    "has_stock_estimation": true,
    "stock_level": 27,
    "asin": "B073JYC4XM",
    "offer_id": "ABCDEF12345",
    "min_quantity": 1,
    "price": {
      "value": 39.99,
      "currency": "USD",
      "raw": "39.99"
    },
    "is_prime": true,
    "in_stock": true,
    "message": "This seller has only 27 of these available. To see if more are available from another seller, go to the product detail page.",
    "availability_message": "Usually dispatched within 2 to 3 weeks.",
    "seller": {
      "name": "Sample Seller",
      "id": "ABCDEF12345",
      "link": "https://www.amazon.com/gp/help/seller/at-a-glance.html/ref=ox_sc_seller_act_1?seller=ABCDEF12345"
    }
  }
}{..."request_info":{..."success":true,
"credits_used":1,
"credits_remaining":999,
}
"request_metadata":{..."id":"763fc1a4b3eb053f5c8f20f12655b09dfd36130d",
"created_at":"2020-01-01T00:00:00.000Z",
"processed_at":"2020-01-01T00:00:00.001Z",
"total_time_taken":0.1,
"amazon_url":"https://www.amazon.com/dp/B073JYC4XM",
}
"request_parameters":{..."type":"stock_estimation",
"asin":"B073JYC4XM",
}
"stock_estimation":{..."has_stock_estimation":true,
"stock_level":27,
"asin":"B073JYC4XM",
"offer_id":"ABCDEF12345",
"min_quantity":1,
"price":{..."value":39.99,
"currency":"USD",
"raw":"39.99",
}
"is_prime":true,
"in_stock":true,
"message":"This seller has only 27 of these available. To see if more are available from another seller, go to the product detail page.",
"availability_message":"Usually dispatched within 2 to 3 weeks.",
"seller":{..."name":"Sample Seller",
"id":"ABCDEF12345",
"link":"https://www.amazon.com/gp/help/seller/at-a-glance.html/ref=ox_sc_seller_act_1?seller=ABCDEF12345",
}
}
}
﻿
Products that Require Login
For some ASINs Amazon will require the user to be logged in to their Amazon account to add the product to the cart.
In these instances Rainforest will be unable to provide stock estimation data. You can determine whether this is the case by inspecting the  stock_estimation.requires_login = true  property of the response.
Rainforest API returns the following properties for Stock Estimation requests:
Property
Type
Description
stock_level
number
The stock level of the product as shown on the shopping cart page. Note that this value could be influenced by a number of factors such as a maximum purchase quantity allowed by the seller or availability of the product at the seller. You should inspect the message property as this will show any alerts or messages shown on the shopping cart page also.
message
string
The message shown above the shopping cart - this could contain information about the stock level. For example, the message could indicate that the stock level shown is the maximum purchase quantity allowed by the seller, rather than the maximum number in stock.
availability_message
string
The availability message shown above the shopping cart (i.e. Ships in 2-3 weeks .
has_stock_estimation
boolean
Set to false when Rainforest cannot generate a stock estimation. Typically this property is set to false when the ASIN is shown as "Currently Unavailable" on the Product Detail Page and therefore a stock estimation cannot be generated as the product cannot be added to the Cart.
price
object
A price object showing price and currency information for the product.
min_quantity
number
The minimum purchase quantity for the product, as shown on the shopping cart page.
in_stock
boolean
Whether the product is indicated as being in-stock on the shopping cart page.
is_prime
boolean
Whether the product is indicated as being Prime-eligable as shown on the shopping cart page.
asin
string
The ASIN of the product as returned from the shopping cart page.
offer_id
string
The Offer ID of the product offer as returned from the shopping cart page.
requires_login
boolean
For some ASINs Amazon will require the user to be logged in to their Amazon account to add the product to the cart. In these instances Rainforest will be unable to provide stock estimation data. When this is the case requires_login will be set to true .
Seller Object
The seller object contains details about the seller providing the Offer for this stock estimation request. Only shown for third party marketplace sellers.
﻿
﻿
﻿
name
string
The name of the seller of the Offer.
id
string
The ID of the seller of the Offer.
link
string
A link to the sellers shopfront on Amazon (for third party sellers).
﻿
Next Steps
     Stock Estimation Parameters﻿

Property	Type	Description
stock_level	number	The stock level of the product as shown on the shopping cart page. Note that this value could be influenced by a number of factors such as a maximum purchase quantity allowed by the seller or availability of the product at the seller. You should inspect the message property as this will show any alerts or messages shown on the shopping cart page also.
message	string	The message shown above the shopping cart - this could contain information about the stock level. For example, the message could indicate that the stock level shown is the maximum purchase quantity allowed by the seller, rather than the maximum number in stock.
availability_message	string	The availability message shown above the shopping cart (i.e. Ships in 2-3 weeks .
has_stock_estimation	boolean	Set to false when Rainforest cannot generate a stock estimation. Typically this property is set to false when the ASIN is shown as "Currently Unavailable" on the Product Detail Page and therefore a stock estimation cannot be generated as the product cannot be added to the Cart.
price	object	A price object showing price and currency information for the product.
min_quantity	number	The minimum purchase quantity for the product, as shown on the shopping cart page.
in_stock	boolean	Whether the product is indicated as being in-stock on the shopping cart page.
is_prime	boolean	Whether the product is indicated as being Prime-eligable as shown on the shopping cart page.
asin	string	The ASIN of the product as returned from the shopping cart page.
offer_id	string	The Offer ID of the product offer as returned from the shopping cart page.
requires_login	boolean	For some ASINs Amazon will require the user to be logged in to their Amazon account to add the product to the cart. In these instances Rainforest will be unable to provide stock estimation data. When this is the case requires_login will be set to true .


name	string	The name of the seller of the Offer.
id	string	The ID of the seller of the Offer.
link	string	A link to the sellers shopfront on Amazon (for third party sellers).

Offers

Sales Estimation