Skip to content

Wishlist

The Wishlist menu lets a signed-in customer save products for later. A client uses it to power the "save to wishlist" heart icon, the wishlist page, and the "move to cart" action.

When you use it

The wishlist is per-customer and scoped to the current channel. A customer can add a product (or toggle it on and off), list everything saved, view one item, move an item into the cart, remove an item, or clear the whole wishlist at once. The wishlist is a customer feature — it is not available to guests.

Operations in this menu

OperationGraphQL field
Get Wishlistswishlists query
Get Wishlist Itemwishlist(id:) query
Create WishlistcreateWishlist mutation
Toggle WishlisttoggleWishlist mutation
Delete WishlistdeleteWishlist mutation
Move to CartmoveWishlistToCart mutation
Delete All WishlistsdeleteAllWishlist mutation

All Wishlist operations require a customer Bearer token — see Authentication.

Released under the MIT License.