Getting Started

What does this JS API do ?

This API allows you full control on how and when to display the wishlist items, adding and deleting items from customer wishlist and more.

You can use this API to fully implement your own wishlist experience

What are the prerequisites ?

You need to be on Silver plan or higher to use the JS API

JS API loading

Wishlist Hero JS loads asynchronously to ensure it does not fall in the site's critical loading path.

To ensure all calls to WishList Hero APIs are made only once WishList Hero is loaded and ready, please wrap all calls to the API in a event listener as shown below.

Listening for the API ready event
                
document.addEventListener("wishlist-hero-wishlist-sdk-ready", async function (e) {
    // your API calls go here                            
});

This document lists and explains various front-end javascript APIs exposed by Wishlist Hero.

One can refer this documentation to get the formal knowledge on how to manipulate front-end behavior of Wishlist Hero’s application according to the respective needs.

In case of any incorrect or incomplete information, please reach out to the developers’ team at Wishlist Hero.

In this documentation, we have covered following topics for an individual API: