Wishlist

4min

Wishlist Parameters
﻿GET  /request
The Wishlist Parameters are applicable 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. The parameters should be appended as querystring parameters to the Product Data API GET HTTP request.
Wishlist data is retrieved from the Wishlist popup.
Wishlist Page
﻿
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.
For example, to request wishlist results for the wishlist ID  38B3V3AT7UH9B  on  amazon.com  the request would be:
HTTP
Curl
Node.js
Python
PHP
https://api.rainforestapi.com/request?api_key=demo&type=wishlist&amazon_domain=amazon.com&wishlist_id=38B3V3AT7UH9B
https://api.rainforestapi.com/request?api_key=demo&type=wishlist&amazon_domain=amazon.com&wishlist_id=38B3V3AT7UH9B
﻿
﻿
Wishlist Parameters
The following parameters are available for all requests made when  type=wishlist .
Parameter
Required
Description
amazon_domain
optional
The Amazon domain to retrieve Wishlist 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.
wishlist_id
optional
The Amazon wishlist ID to retrieve Wishlist results for. Used in combination with the amazon_domain parameter. The wishlist ID can be found in any Amazon wishlist URL after the /ls/ component of the wishlist URL.  
Note : If the wishlist_id and amazon_domain parameters are supplied then the url parameter is ignored.
url
optional
The Amazon wishlist-page URL to retrieve Wishlist results from.  
Note : If the url parameter is supplied then the amazon_domain and wishlist_url parameters are ignored.
sort_by
optional
Determines the sort order of wishlist items to return. Omit the sort_by parameter to return results in the default sort order. Valid values are:
price_high_to_low 
Returns highest priced wishlist items first.
﻿
price_low_to_high 
Returns lowest priced wishlist items first.
﻿
priority_high_to_low 
Returns highest priority wishlist items first.
﻿
﻿
next_page_token
optional
The current page of Wishlist results to retrieve. Inspect the pagination.next_page_token property in the Wishlist results to retrieve the next_page_token of the subsequent page.
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
     Wishlist Results﻿

Parameter	Required	Description
amazon_domain	optional	The Amazon domain to retrieve Wishlist 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.
wishlist_id	optional	The Amazon wishlist ID to retrieve Wishlist results for. Used in combination with the amazon_domain parameter. The wishlist ID can be found in any Amazon wishlist URL after the /ls/ component of the wishlist URL. Note : If the wishlist_id and amazon_domain parameters are supplied then the url parameter is ignored.
url	optional	The Amazon wishlist-page URL to retrieve Wishlist results from. Note : If the url parameter is supplied then the amazon_domain and wishlist_url parameters are ignored.
sort_by	optional	Determines the sort order of wishlist items to return. Omit the sort_by parameter to return results in the default sort order. Valid values are: price_high_to_low Returns highest priced wishlist items first. price_low_to_high Returns lowest priced wishlist items first. priority_high_to_low Returns highest priority wishlist items first.
next_page_token	optional	The current page of Wishlist results to retrieve. Inspect the pagination.next_page_token property in the Wishlist results to retrieve the next_page_token of the subsequent page.
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.

Updated 16 Aug 2024

Did this page help you?

Formats & Editions

Autocomplete