Integration Module 2.0 for Medusa is outRead the announcement
Wishlist logo

Wishlist

Let guests and users set up wishlists

npm install @alphabite/medusa-wishlist
Category
Built by
Version
0.7.7
Last updated
1 month ago
Monthly downloads
Loading downloads

πŸ§žβ€β™‚οΈ Wishlist Plugin for Medusa

The Alphabite Wishlist Plugin is the most feature-complete wishlist system for MedusaJS. It supports both authenticated and guest users, multiple wishlists per user, and a full-featured SDK client for frontend integration.

This plugin ships with:

  • πŸ”Œ A fully typed JS SDK plugin
  • πŸ“­ A Postman collection
  • βœ… Support for guest & authenticated customers

⚠️ Version Compatibility

Please install the plugin version that matches your Medusa version:

Medusa VersionPlugin VersionInstall Command
and above
Below

is built and tested against Medusa .

Installing the latest version (Medusa 2.14.* and above)

Installing version 0.5.8 (Medusa 2.13.*)

Installing version 0.5.7 (Medusa versions below 2.13.0)

ℹ️ Using a mismatched version may result in compatibility issues. Make sure to check your Medusa version () before installing.


πŸ“š Table of Contents


✨ Features

  • βœ… Multiple wishlists per customer
  • βœ… Add/remove items to/from any wishlist
  • βœ… Guest wishlist supported + transfer when registered
  • βœ… Fully typed Medusa JS SDK integration with our SDK client
  • βœ… Pagination and filtering built-in
  • βœ… Admin page with Settings + Analytics tabs

πŸ“¦ Installation

Install the plugin via npm:

In your , register the plugin:


πŸ”§ Plugin Options

OptionTypeDefaultDescription
Selectively include Medusa product or product variant fields on wishlist list/retrieve endpoints that have wishlist items included
Selectively include Medusa product or product variant fields on wishlist items list/retrieve endpoints
Automatically populate wishlist items in
Limit number of items if is true
Enables wishlist creation & usage without authentication (cookie-based)

πŸ› οΈ Admin

The plugin adds a Wishlists page to the admin sidebar () with two tabs: Settings (guest / multiple-wishlist toggles) and Analytics (a read-only dashboard of KPIs, an activity trend, and the most-wishlisted products and variants).

See docs/admin-analytics.md for the analytics endpoint and response shape.


πŸ“¦ API Endpoints

All endpoints are available under .

MethodEndpointAuthDescription
GETβœ…List wishlists for the current customer
POSTβž– (optional)Create a new wishlist
GETβž– (optional)Retrieve a wishlist by ID
PUTβœ…Update wishlist metadata
DELETEβœ…Delete a wishlist
POSTβœ…Transfer guest wishlist to logged-in user
GETβž– (optional)Get items in a wishlist
POSTβž– (optional)Add an item to the wishlist
DELETEβž– (optional)Remove an item from the wishlist

πŸ§‘β€πŸ’» SDK Usage

❗❗❗Read more about our Medusa compatible SDK here


πŸ§ͺ Guest Wishlist Flow

Guest wishlists work like guest carts:

  1. Create a wishlist (no auth required)
  2. Save the in a cookie
  3. Use that ID for listing/adding/removing items
  4. When the user signs up or logs in, call the endpoint to associate it:

After that, the cookie is no longer needed.


🧩 Requirements

  • Medusa v2.14.0+
  • Works with both and

, and are provided by Medusa and don't need to be installed alongside the plugin.


πŸ“­ Postman Collection

You’ll find the ready-to-import Postman collection at:

alphabite-wishlist-postman.json

Use it to explore and test all endpoints interactively.


🀝 Contributing

We welcome issues, feedback, and PRs. Fork it, build it, improve it.

Let’s make commerce more personalized πŸ›οΈ