Wishlist
Let guests and users set up wishlists
π§ββοΈ 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 Version | Plugin Version | Install 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
- π¦ Installation
- π§ Plugin Options
- π οΈ Admin
- π¦ API Endpoints
- π§βπ» SDK Usage
- π§ͺ Guest Wishlist Flow
- π§© Requirements
- π Postman Collection
- π€ Contributing
β¨ 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
| Option | Type | Default | Description |
|---|---|---|---|
| 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 .
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| 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:
- Create a wishlist (no auth required)
- Save the in a cookie
- Use that ID for listing/adding/removing items
- 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.jsonUse 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 ποΈ

