# Swym API Documentation Documentation

> Build custom wishlists, back-in-stock alert forms, save for later lists, gift registries, plugins, and web apps for Shopify, Bigcommerce, WooCommerce, and many more.

## Guides
- [FAQs - Common implementation questions](https://developers.getswym.com/docs/faqs.md): Collection of frequently asked questions on the usage of our APIs. This is based on past conversations and issues we were able to help with our implementations.
- [Create a List](https://developers.getswym.com/docs/create-list.md): Create a list or Duplicate existing lists.
- [Update List Attributes](https://developers.getswym.com/docs/update-list-attributes.md): Update List level attributes such as note, name, and custom properties.
- [Fetch List Contents](https://developers.getswym.com/docs/fetch-list-contents.md): Fetch only the List Contents.
- [Add to List](https://developers.getswym.com/docs/add-to-list.md): Add a product to a List.
- [Update List Item](https://developers.getswym.com/docs/update-list-item.md): Update product attributes like cprops, note.
- [Fetch Wishlist social count](https://developers.getswym.com/docs/fetch-wishlist-social-count.md): Fetch the wishlist <<glossary:social-count>> of a product
- [Fetch Wishlist social count batch](https://developers.getswym.com/docs/fetch-wishlist-social-count-batch.md): Fetch batch of wishlist <<glossary:social-count>> of products
- [Add custom item to list](https://developers.getswym.com/docs/add-custom-item-to-list.md)
- [Share via link and mark list public read-only](https://developers.getswym.com/docs/share-via-link.md): Share a list can be achieved through generating a link to the default shared wishlist page. A list can also be made read-only for public access to support custom shared wishlist landing pages.
- [Removed From Wishlist Event](https://developers.getswym.com/docs/removed-from-wishlist-event.md): Event triggered when removing a product from wishlist.
- [Added to Cart From Swym UI](https://developers.getswym.com/docs/added-to-cart-from-wishlist-ui-event.md): Event triggered when adding an Item to cart from Swym UI.
- [Added all to cart Event](https://developers.getswym.com/docs/added-all-to-cart-event.md): Event triggered when adding all Items to cart from Swym UI.
- [Toast Notifications](https://developers.getswym.com/docs/toast-notifications.md): Trigger Default Swym Toast notifications
- [APIs for Swym Powered buttons](https://developers.getswym.com/docs/swym-powered-buttons.md): Add support for buttons to be powered by Swym features like Add to wishlist
- [Custom Wishlist Experience](https://developers.getswym.com/docs/custom-wishlist-experience-using-js-sdk.md): Build custom wishlist experiences using the Swym JS SDK without any default UI.
- [Wishlist Button (PDP)](https://developers.getswym.com/docs/wishlist-button-pdp.md): Add a wishlist toggle button to your product detail pages using the Swym JS SDK.
- [Wishlist Page](https://developers.getswym.com/docs/wishlist-page.md): Build a dedicated wishlist page with theme-native product cards, login nudge, conversion prompts, remove, add-to-cart, and wishlist sharing.
- [Collection Page Buttons](https://developers.getswym.com/docs/collection-page-buttons.md): Add wishlist buttons to product cards on collection and listing pages using the Swym JS SDK.
- [Header Icon](https://developers.getswym.com/docs/header-icon.md): Add a wishlist icon with live count badge to your store header using the Swym JS SDK.
- [Advanced Custom JSPatterns](https://developers.getswym.com/docs/advanced-custom-jspatterns.md): Multi-wishlist, event listening, and troubleshooting for SDK-only mode.
- [Initialize Save For Later](https://developers.getswym.com/docs/initialize-save-for-later-1.md): Create a new list of type 'save for later' for a user.
- [Fetch all products](https://developers.getswym.com/docs/fetch-all-products.md): Fetch the list of products added to the user's Save For Later list.
- [REST API [Beta]](https://developers.getswym.com/docs/rest-api.md)
- [Fetch List [Beta]](https://developers.getswym.com/docs/fetch-items.md): Fetch Save for Later list with items in the list.
- [Subscribe for a product alert based on Topic](https://developers.getswym.com/docs/subscribe-for-a-product-alert.md): Subscribe to Back In Stock Product Alert for a product on default storefronts
- [Fetch Subscriptions [Beta]](https://developers.getswym.com/docs/fetch-subscriptions-1.md): Fetch all subscriptions of a Shopper
- [Request a Back In Stock Alert](https://developers.getswym.com/docs/request-a-back-in-stock-alert.md): Request an Back in Stock alert for an out of stock product.
- [Show "Email me when available" widget](https://developers.getswym.com/docs/show-email-me-when-available-widget.md): This API shows the standard Swym Back In Stock Alerts Modal according to the optional topic.asdas
- [Subscribe to Back in Stock Alert](https://developers.getswym.com/docs/rest-api-subscribe-to-a-product-alert.md): Subscribe to Back In Stock Product Alert for a product using Create API
- [Fetch Subscriptions [BETA]](https://developers.getswym.com/docs/fetch-subscriptions.md): Fetch all subscriptions of a Shopper
- [Update List Attributes](https://developers.getswym.com/docs/update-list-attributes-1.md): Updates list level attributes like lnote, lprops.
- [Wishlist Exposed Feature Configurations](https://developers.getswym.com/docs/wishlist-exposed-feature-configurations.md): It enables headless clients to dynamically retrieve feature status exposed via APIs
- [JavaScript API[Beta]](https://developers.getswym.com/docs/javascript-api.md): JS APIs for Shopper Data
- [Fetch Recently Viewed Products [Beta]](https://developers.getswym.com/docs/fetch-recently-viewed-products-1.md): Fetch Products that have been recently viewed by a Shopper
- [Fetch Saved Cart Products [Beta]](https://developers.getswym.com/docs/fetch-saved-cart-products-1.md): Fetch Products that have been saved to cart by shopper
- [REST API[Beta]](https://developers.getswym.com/docs/rest-apibeta.md): REST API for Shopper Data
- [Fetch Recently Viewed Products [Beta]](https://developers.getswym.com/docs/fetch-recently-viewed-products.md): Fetch Products that have been recently viewed by a Shopper
- [Fetch Saved Cart Products [Beta]](https://developers.getswym.com/docs/fetch-saved-cart-products.md): Fetch Products that have been saved to cart by shopper
- [Save Shopper Context [Beta]](https://developers.getswym.com/docs/save-shopper-context-1.md): Save Shopper Preferences
- [List Update Input](https://developers.getswym.com/docs/list-update-input.md): Input to update your lists.
- [List Contents](https://developers.getswym.com/docs/list-contents.md): Contents inside a created list.
- [Fields in List Item (Product)](https://developers.getswym.com/docs/fields-in-list-item.md): Fields in List Item
- [Custom List Item](https://developers.getswym.com/docs/custom-list-item.md)
- [Bundle in Custom List Item](https://developers.getswym.com/docs/bundle-in-custom-item.md)
- [Wishlist Events](https://developers.getswym.com/docs/wishlist-events.md)
- [Wishlist Add[Beta]](https://developers.getswym.com/docs/wishlist-add.md): Fires when a shopper adds a product to a list/wishlist. When multiple lists are enabled, each addition generates its own event.
- [Wishlist Remove[Beta]](https://developers.getswym.com/docs/wishlist-remove.md): Fires when a shopper remove a product from a list/wishlist. When multiple lists are enabled, each remove generates its own event.
- [Wishlist Reminder[Beta]](https://developers.getswym.com/docs/wishlist-reminder.md): A scheduled event triggered to notify the shopper about a previously wishlisted product.
- [Wishlist Pricedrop[Beta]](https://developers.getswym.com/docs/wishlist-pricedrop.md): Triggers an event when the price of a wishlisted product reduces.
- [Wishlist Lowstock[Beta]](https://developers.getswym.com/docs/wishlist-lowstock.md): Triggers an event when inventory for a wishlisted product drops below a defined threshold.
- [Wishlist Backinstock[Beta]](https://developers.getswym.com/docs/wishlist-backinstock.md): Triggers an event when a wishlisted product is restocked above the set inventory threshold.
- [Wishlist Share[Beta]](https://developers.getswym.com/docs/wishlist-share.md): Triggers when a shopper shares their wishlist with others.
- [Backinstock Events](https://developers.getswym.com/docs/backinstock-events.md)
- [Remind Me[Beta]](https://developers.getswym.com/docs/remind-me.md): Fired when a shopper explicitly requests to be notified when a currently out-of-stock product or variant becomes available again.
- [Backinstock[Beta]](https://developers.getswym.com/docs/backinstock.md): Triggers an event when a product is restocked above the set inventory threshold.
- [Comingsoon[Beta]](https://developers.getswym.com/docs/comingsoonbeta.md): Fired when a shopper explicitly requests to be notified when a currently coming soon product or variant becomes available for again.
- [MCP](https://developers.getswym.com/docs/mcp.md)
- [Wishlist Social Count from Product Metafields (Beta)](https://developers.getswym.com/docs/wishlist-social-count-from-product-metafields.md): Load wishlist social count from liquid or Shopify Product metafield APIs

## API Reference
- [Wishlist Curations Page](https://developers.getswym.com/reference/wishlist-curation.md): Build a store-curated product page where tagged "creator" accounts publish named Swym lists as scrollable carousels — no custom coding required after initial setup.
- [Product Comparison Module](https://developers.getswym.com/reference/wishlist-comparison.md): Build a floating product comparison bar and modal by repurposing the Swym Wishlist list API as a per-customer comparison buffer — no custom backend required.
- [Prepare Server-side APIs, utilities and components.](https://developers.getswym.com/reference/prepare-your-serverjs-file-with-swym-rest-apis.md): This page covers adding APIs endpoints to your Headless store that cannot be used on the storefront and explicitly need to be called on a server. The guide also provides links to Swym utilities and some components that we recommend adding to your implementation.
- [Pepare Client-side APIs](https://developers.getswym.com/reference/pepare-client-apis.md): This page covers adding client side APIs that cover wishlist functionalities such as adding or removing a product to wishlist, implementing a wishlist page, etc.
- [Wishlist Button](https://developers.getswym.com/reference/wishlist-buttons.md): This guide covers building wishlist buttons on your headless storefront.
- [Multiple List Popup](https://developers.getswym.com/reference/multiple-list-popup.md): This guide covers building a list-selection pop-up for multiple wishlists.
- [Wishlist Page](https://developers.getswym.com/reference/wishlist-page-1.md): This guide covers building a wishlist page on headless storefronts.
- [Custom Wishlist Button](https://developers.getswym.com/reference/build-a-custom-wishlist-button-1.md): This guide provides steps to implement a custom wishlist button on your Shopify store. The button works on Product details pages as well as Collections pages.
- [Custom Header Icon](https://developers.getswym.com/reference/custom-header-icon.md): This guide covers building a custom wishlist header launch point using Swym APIs.
- [Custom Multiple-List Selection](https://developers.getswym.com/reference/custom-list-selection-popup.md): This guide will take you through the step-by-step process of creating and adding a custom list selection popup.
- [Variant Selector on Collections](https://developers.getswym.com/reference/variant-selector-on-collections.md): This guide provides steps to build a variant selector modal for the collections wishlist button. The solution automatically switches between single and multiple wishlists based on the Swym app settings.
- [Wishlist For Apparel - JS APIs](https://developers.getswym.com/reference/wishlist-apparel-page.md): Extend the standard wishlist page with a per-card variant selector so shoppers can pick size and colour before adding to cart.
- [Wishlist For B2B — JS APIs](https://developers.getswym.com/reference/wishlist-b2b-page.md): Extend the standard wishlist page with per-item quantity controls and buyer notes for B2B purchasing workflows.
- [Wishlist For Home & Furniture — JS APIs](https://developers.getswym.com/reference/wishlist-home-page.md): Extend the standard wishlist page with multi-list navigation, quantity controls, item notes, and a running total for home and furniture stores.