Jump to Content
API Reference
Guides
v2.0
v3.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Advanced Wishlist
API Reference
Guides
Search
Introduction
Swym Developer Documentation
Getting Started
SwymCallBacks
FAQs - Common implementation questions
Wishlist Plus Javascript SDK
List API
Create a List
Delete a List
Update List Attributes
Fetch Lists
Fetch List Details
Fetch List Contents
Fetch User Lists
Fetch Paginated List
Add to List
Delete From List
Update List Item
Add many products to a list
Remove many products from a list
Add product to many lists
Remove a product from many lists
Fetch Wishlist social count
List Share
Share via link and mark list public read-only
Email Wishlist
Share on social media
Lists Comments
Add a comment to a list
Fetch list comments
Add a comment to a product
Fetch comments in product
Delete a comment
Shopper Context API
Save shopper context
Disconnect shopper context
Render Default User Interfaces
Render the Shared Wishlist UI Container
Render a Wishlist Page / Modal in a container
Render an unsubscribe form
Triggered UI Events
Native storefront login Event
Added to Wishlist Event
Removed From Wishlist Event
Added to Cart From Wishlist Event
Added all to cart Event
Toast Notifications
APIs for Swym Powered buttons
Save For Later
JavaScript API
Getting Started
Initialize Save For Later
Add product
Remove products
Fetch all products
Update products
REST API [Beta]
Create a List [Beta]
Add Items [Beta]
Delete Items [Beta]
Fetch List [Beta]
Move to Cart [Beta]
Update Items [Beta]
Swym Back In Stock Alerts
JavaScript API
Subscribe for a product alert based on Topic
Fetch Subscriptions[DRAFT]
Request a Back In Stock Alert
Show "Email me when available" widget
Rest API
Subscribe to Back in Stock Alert
Fetch Subscriptions [BETA]
Lists - REst API
Getting Started
Authentication
Generate regid for a Shopper
Merge Guest and Logged in Sessions
Lists
Create a List
Delete List
Update List Attributes
Manage products in a list
Fetch all lists
Fetch list contents
Fetch User Lists
Fetch User List
Fetch Wishlist Social Count
List Share
Mark a List Public
Email a wishlist
Shopper
JavaScript API[Beta]
Fetch Recently Viewed Products [Beta]
Fetch Saved Cart Products [Beta]
REST API[Beta]
Fetch Recently Viewed Products [Beta]
Fetch Saved Cart Products [Beta]
Save Shopper Context [Beta]
API DEFINITIONS
List
List Config
List Update Input
Fields in list
List Contents
List Contents
Fields in List Item (Product)
Comments
List Comment Input
List Item Comment Input
List Comment Delete Input
Fields in List Comments Response
Fields in Product Comments Response
Errors
Overview
Parsing Bad Request error
Suggest
Creates a Save for Later List with the given name and attributes.
