List API

The Swym Wishlist Plus Javascript List APIs enable shoppers to Create, Manage, and Share Wishlists.


Hey, The Docs are currently in Open Beta.

πŸ‘¨ πŸ‘© πŸ’»AI & Humans are scrambling...

πŸ“ πŸ’ΉMeetings are happening...

🏬 APIs are being added as you see this...

Please let us know if anything is unclear by mailing us at [email protected]


Build wishlists, back-in-stock alert forms, save for later lists, gift registries, plugins, and web apps. Leverage Swym's powerful List APIs to customise and extend the experience of any of our apps.


Pricing & Plans

The Lists API can be accessed through our Premium or higher-tier plans. For more information, visit our Pricing & Plans webpage.

What is a Wishlist?

A wishlist is a List of products that a shopper wishes to buy at a later date.

The shopper can create multiple List, each containing a unique selection of products. For example, they can create a "birthday gifts" List, a "holiday shopping" List, and a personal "wish" List.

Each List can have its own name, notes, properties, and sharing settings, allowing the customer to organize their products in the most convenient manner for them.

User Experience

sample wishlist flow

sample wishlist flow

Supported E-Commerce Platforms.

The Swym JavaScript SDK is compatible with numerous e-commerce platforms, such as Shopify, BigCommerce, Magento, WooCommerce, and many more.

You can use the Swym JavaScript SDK for all browser-based implementations. As long as you use Shopify Liquid or BigCommerce stencil based themes.

The table below shows the supported features for each platform and theme type.

Supportability Table

PlatformTheme TypeSupported
ShopifyAll liquid-based themesYes
BigCommerceAll Stencil ThemesYes

Please reach out to support if your e-commerce platform is not mentioned here.

Headless Store Front


Do you have a headless storefront?

The Swym JavaScript APIs are specifically designed for use with Liquid or Stencil-based themes. If you are using a headless storefront or Shopify Hydrogen, we recommend using our REST API instead


Please reach out to us at [email protected] if you have any inquiries, suggestions, or setup-related problems, and we will respond as soon as possible.