Core APIs
...
Results
Specialist Pages

Wishlist

3min

Wishlist Results

When making a request with the type parameter set to type=wishlist Rainforest API will return data from the Wishlist page for the wishlist specified in either the wishlist_id and amazon_domain parameters or the url parameter.

Wishlist data is retrieved from the Wishlist popup.

Wishlist Page
Wishlist Page


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

JSON


Rainforest API returns the following properties for Wishlist requests:

Paginating Results Amazon returns 10 Wishlist per page. To request more wishlist results issue additional requests passing the next_page_token parameter from the previous request.

Note due to the infinate-scrolling behaviour of wishlist pages, you cannot reference a specific page directly. Pagination is achieved via the next_page_token request parameter.

Property

Type

Description

wishlist_results

array

An array of Wishlist objects, containing each of the Wishlist items shown on the Wishlist popup. The Wishlist object has the following properties:

  • position
  • number
  • The position (1-based) of the wishlist item on the current page.



  • title
  • string
  • The title of the wishlist item.



  • link
  • string
  • A link to the product page for the wishlist item ASIN.



  • asin
  • string
  • The ASIN of the wishlist item.



  • image
  • string
  • An image URL to the image of the wishlist item, if shown.



  • rating
  • number
  • An rating of the image of the wishlist item, if shown.



  • ratings_total
  • number
  • An total number of customer ratings the wishlist item has received, if shown.



  • in_stock
  • boolean
  • Set to true when the wishlist item is in stock, false otherwise.



  • priority
  • string
  • The priority of the wishlist item, as shown on the wishlist page - i.e. medium .



  • requested_count
  • number
  • The number of this wishlist item that has been requested by the wishlist owner.



  • purchased_count
  • number
  • The number of this wishlist item that have been purchased so far.



  • added_date
  • object
  • An date the wishlist item was added to the wishlist. Contains a raw and utc (timestamp) property.



  • price
  • object
  • Price Object The price object contains details about the wishlist items pricing.
    • 
      1. symbol
      2. string
      3. The currency symbol, i.e. $ for USD.
    • 
      1. value
      2. number
      3. The price of the wishlist item.
    • 
      1. currency
      2. string
      3. The currency of the wishlist item as a ISO 4217 currency code.
    • 
      1. raw
      2. string
      3. The raw price as displayed on the wishlist item.

pagination

object

An object containing details of the next_page_token required to request the next page of wishlist results in a subsequent requests' next_page_token parameter .

  • next_page_token
  • number
  • The next page token to pass into a subsequent type=wishlist requests' next_page_token request parameter .


Next Steps      Wishlist Parameters