Вышел Модуль интеграций 2.0 для MedusaЧитать анонс
Wishlist logo

Wishlist

Позвольте гостям и пользователям создавать вишлисты

npm install @alphabite/medusa-wishlist
Категория
Создано
Версия
0.7.7
Последнее обновление
4 недели назад
Ежемесячные загрузки
Загрузка данных

🧞‍♂️ 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 🛍️