📥 Retrieving a Wishlist

This guide explains how to retrieve wishlists and optionally include their items in the response.

---

✅ Plugin Config to include Wishlisted Items

To automatically include wishlist items in the response when retrieving or listing wishlists, your plugin must be configured with:

{
  resolve: "@alphabite/medusa-wishlist",
  options: {
    includeWishlistItems: true,
    includeWishlistItemsTake: 5 // optional, default value is 5
  }
}

includeWishlistItemsTake option is optional, by default if includeWishlistItems is set to true, it will return up to 5 items, if you want more or less add the includeWishlistItemsTake option and set the desired amount

---

📘 Behavior

When includeWishlistItems is set to true:

• GET /store/wishlists/:id returns the wishlist and up to N items
• GET /store/wishlists returns all wishlists, each with up to N items

Where N is the value of includeWishlistItemsTake (default: 5)

---

🔍 Retrieve a Single Wishlist

Using SDK

const retrievedWishlist = await sdk.alphabite.wishlist.retrieve({
  id: "wl_...",
});

Using REST (Medusa SDK or fetch)

import { RetrieveWishlistInput, RetrieveWishlistOutput } from "@alphabite/medusa-sdk";

const retrievedWishlist = await sdk.client.fetch<RetrieveWishlistOutput>(`/store/wishlists/${wishlistId}`, {
  method: "GET",
  query: {
    items_fields: [],
  } as Omit<RetrieveWishlistInput, "id">,
});

API Reference

Learn more about our Medusa SDK Wrapper Alphabite Medusa SDK Wrapper 🔗

You can view the full endpoint documentation for Retrieve a Wishlist

---

🔍 List Wishlists

Using SDK

const retrievedWishlist = await sdk.alphabite.wishlist.list({});

Using REST (Medusa SDK or fetch)

import { RetrieveWishlistInput, RetrieveWishlistsOutput } from "@alphabite/medusa-sdk";

const retrievedWishlist = await sdk.client.fetch<RetrieveWishlistsOutput>(`/store/wishlists`, {
  method: "GET",
  query: {} as RetrieveWishlistsInput,
});

API Reference

Learn more about our Medusa SDK Wrapper Alphabite Medusa SDK Wrapper 🔗

You can view the full endpoint documentation for Retrieve a Wishlist

---

📝 Notes

• If includeWishlistItems is not enabled, the items field will not be included at all
• This behavior affects both single retrieval and list endpoints
• To get the full list of items beyond the includeWishlistItemsTake limit, call:

---

🔗 Related

• Retrieve a Wishlist - GET /store/wishlists/:id
• Docs: List Wishlists - GET /store/wishlists

---