Wishlist

3 min

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

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

{
  "wishlist_results": [
    {
      "position": 1,
      "title": "Giantex 20 Drawer Rolling Storage Cart Tools Scrapbook Paper Office School Organizer (25 x 15 x 35 Inch, Black)",
      "link": "https://www.amazon.com/dp/B07YBQTRZR/?coliid=I1LJPARJXZ1Y2T&colid=38B3V3AT7UH9B&psc=1&ref_=lv_vv_lig_dp_it",
      "asin": "B07YBQTRZR",
      "added_date": {
        "raw": "Item added July 30, 2022",
        "utc": "2022-07-29T23:00:00.000Z"
      },
      "rating": 4.4,
      "ratings_total": 1882,
      "image": "https://m.media-amazon.com/images/I/41nyMLAHnrL._SS135_.jpg",
      "price": {
        "symbol": "$",
        "value": 89.99,
        "currency": "USD",
        "raw": "$89.99"
      },
      "in_stock": true,
      "priority": "medium",
      "requested_count": 1,
      "purchased_count": 0
    },
    {
      "position": 2,
      "title": "Greeting Card Storage & Organizer Box with 6 Adjustable Dividers for Holiday Birthday Photos, Crafts, Scrapbook, Paper, Stickers, Envelopes and More, Plastic Box of Card (New Version)",
      "link": "https://www.amazon.com/dp/B096Y96QW4/?coliid=I341LNHYK5QFLS&colid=38B3V3AT7UH9B&psc=1&ref_=lv_vv_lig_dp_it",
      "asin": "B096Y96QW4",
      "added_date": {
        "raw": "Item added July 30, 2022",
        "utc": "2022-07-29T23:00:00.000Z"
      },
      "rating": 4.3,
      "ratings_total": 152,
      "image": "https://m.media-amazon.com/images/I/41PfBMObYxL._SS135_.jpg",
      "price": {
        "symbol": "$",
        "value": 26.99,
        "currency": "USD",
        "raw": "$26.99"
      },
      "in_stock": true,
      "priority": "medium",
      "requested_count": 1,
      "purchased_count": 0
    },
    {
      "position": 3,
      "title": "12-Pack Single-Color Chapter Book Library Bins™ with Dividers",
      "link": "https://www.amazon.com/dp/B07L3B1TQS/?coliid=I2SHLPK7XP7KAX&colid=38B3V3AT7UH9B&psc=1&ref_=lv_vv_lig_dp_it",
      "asin": "B07L3B1TQS",
      "added_date": {
        "raw": "Item added July 30, 2022",
        "utc": "2022-07-29T23:00:00.000Z"
      },
      "rating": 5,
      "ratings_total": 3,
      "image": "https://m.media-amazon.com/images/I/41rlb4nrhNL._SS135_.jpg",
      "price": {
        "symbol": "$",
        "value": 209.99,
        "currency": "USD",
        "raw": "$209.99"
      },
      "in_stock": false,
      "priority": "medium",
      "requested_count": 1,
      "purchased_count": 0
    },
    {
      "position": 4,
      "title": "Sterilite 16958612 Mini Crate, Clear, 12-Pack,Small",
      "link": "https://www.amazon.com/dp/B002BA5F16/?coliid=IIEYOU6SGU87A&colid=38B3V3AT7UH9B&psc=1&ref_=lv_vv_lig_dp_it",
      "asin": "B002BA5F16",
      "added_date": {
        "raw": "Item added July 30, 2022",
        "utc": "2022-07-29T23:00:00.000Z"
      },
      "rating": 4.7,
      "ratings_total": 593,
      "image": "https://m.media-amazon.com/images/I/51yulsQzXoL._SS135_.jpg",
      "price": {
        "symbol": "$",
        "value": 46.32,
        "currency": "USD",
        "raw": "$46.32"
      },
      "in_stock": true,
      "priority": "medium",
      "requested_count": 1,
      "purchased_count": 0
    },
    {
      "position": 5,
      "title": "Teacher Created Resources Blush Plastic Book Bin",
      "link": "https://www.amazon.com/dp/B09YBPKHGW/?coliid=I1NL291892SYZ7&colid=38B3V3AT7UH9B&psc=1&ref_=lv_vv_lig_dp_it",
      "asin": "B09YBPKHGW",
      "added_date": {
        "raw": "Item added July 30, 2022",
        "utc": "2022-07-29T23:00:00.000Z"
      },
      "image": "https://m.media-amazon.com/images/I/31z97-CWuSL._SS135_.jpg",
      "price": {
        "symbol": "$",
        "value": 7.79,
        "currency": "USD",
        "raw": "$7.79"
      },
      "in_stock": true,
      "priority": "medium",
      "requested_count": 1,
      "purchased_count": 0
    },
    {
      "position": 6,
      "title": "mDesign Large Modern Plastic Open Front Dip Storage Organizer Bin Basket for Home Office Organization - Shelf, Cubby, Cabinet, and Closet Organizing Decor - Ligne Collection - 4 Pack - Clear",
      "link": "https://www.amazon.com/dp/B09P48HBP2/?coliid=I1SHQ0MZ9GCXKL&colid=38B3V3AT7UH9B&psc=1&ref_=lv_vv_lig_dp_it",
      "asin": "B09P48HBP2",
      "added_date": {
        "raw": "Item added July 30, 2022",
        "utc": "2022-07-29T23:00:00.000Z"
      },
      "rating": 4.7,
      "ratings_total": 105,
      "image": "https://m.media-amazon.com/images/I/41LY2HtiKNL._SS135_.jpg",
      "price": {
        "symbol": "$",
        "value": 76.99,
        "currency": "USD",
        "raw": "$76.99"
      },
      "in_stock": true,
      "priority": "medium",
      "requested_count": 1,
      "purchased_count": 0
    },
    {
      "position": 7,
      "title": "mDesign Plastic Large Home Storage Organizer Bins with Open Front for Kitchen, Bedroom, Bathroom, Office, Craft or Playroom Organization - Holds Food, Toys, Books - Ligne Collection - 4 Pack - Clear",
      "link": "https://www.amazon.com/dp/B07KYW32FZ/?coliid=I3JX6IQ5PPZFV3&colid=38B3V3AT7UH9B&psc=1&ref_=lv_vv_lig_dp_it",
      "asin": "B07KYW32FZ",
      "added_date": {
        "raw": "Item added July 30, 2022",
        "utc": "2022-07-29T23:00:00.000Z"
      },
      "rating": 4.5,
      "ratings_total": 119,
      "image": "https://m.media-amazon.com/images/I/41jAQMqjhCL._SS135_.jpg",
      "price": {
        "symbol": "$",
        "value": 61.99,
        "currency": "USD",
        "raw": "$61.99"
      },
      "in_stock": true,
      "priority": "medium",
      "requested_count": 1,
      "purchased_count": 0
    },
    {
      "position": 8,
      "title": "AdirKids Book Shelf Organizer for Kids - 5 Tier Wooden Nursery Book Shelves Storage for Childrens Classroom Organization",
      "link": "https://www.amazon.com/dp/B09SRTQRQV/?coliid=I2CNBTFMUJU06E&colid=38B3V3AT7UH9B&psc=1&ref_=lv_vv_lig_dp_it",
      "asin": "B09SRTQRQV",
      "added_date": {
        "raw": "Item added July 30, 2022",
        "utc": "2022-07-29T23:00:00.000Z"
      },
      "rating": 2.9,
      "ratings_total": 3,
      "image": "https://m.media-amazon.com/images/I/51io0EbVg8L._SS135_.jpg",
      "price": {
        "symbol": "$",
        "value": 151.95,
        "currency": "USD",
        "raw": "$151.95"
      },
      "in_stock": true,
      "priority": "medium",
      "requested_count": 1,
      "purchased_count": 0
    },
    {
      "position": 9,
      "title": "3 Pack Clear Plastic Storage Bin with Handles, Book Bin Organizer, Transparent Organizer Bins for Kitchen, Cabinet, Pantry, School and Office",
      "link": "https://www.amazon.com/dp/B09LCGHBKB/?coliid=IDH84S1NCFT3C&colid=38B3V3AT7UH9B&psc=1&ref_=lv_vv_lig_dp_it",
      "asin": "B09LCGHBKB",
      "added_date": {
        "raw": "Item added July 30, 2022",
        "utc": "2022-07-29T23:00:00.000Z"
      },
      "rating": 4.5,
      "ratings_total": 2,
      "image": "https://m.media-amazon.com/images/I/51ann5iI4tL._SS135_.jpg",
      "price": {
        "symbol": "$",
        "value": 31.99,
        "currency": "USD",
        "raw": "$31.99"
      },
      "in_stock": true,
      "priority": "medium",
      "requested_count": 1,
      "purchased_count": 0
    },
    {
      "position": 10,
      "title": "Hedume 35 Pieces Travel Toothbrush Case, 7 Colors Portable Plastic Dust-proof Breathable Toothbrush Holder for Travel, Camping, Home, School, Business",
      "link": "https://www.amazon.com/dp/B09KLRTV9H/?coliid=I2NA37T5E2MKXX&colid=38B3V3AT7UH9B&psc=0&ref_=lv_vv_lig_dp_it",
      "asin": "B09KLRTV9H",
      "added_date": {
        "raw": "Item added July 16, 2022",
        "utc": "2022-07-15T23:00:00.000Z"
      },
      "rating": 4.3,
      "ratings_total": 7,
      "image": "https://m.media-amazon.com/images/I/41My6Y6ptnL._SS135_.jpg",
      "in_stock": false,
      "priority": "highest",
      "requested_count": 2,
      "purchased_count": 0
    }
  ],
  "pagination": {
    "next_page_token": "eyJGcm9tVVVJRCI6IjA4Y2IyYjdhLWIxOWUtNGU4Yy1hZjgwLWE1NGYzNTE2NDJmOCIsIlRvVVVJRCI6ImMyNDdkNjI0LWI1ZWYtNDgzZC04YWFmLWFlYmJjNzcxMTdmZiIsIkVkZ2VSYW5rIjo5Mjk2NTN9"
  }
}

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. symbol string The currency symbol, i.e. $ for USD. value number The price of the wishlist item. currency string The currency of the wishlist item as a ISO 4217 currency code. raw string 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