Skip to content

Wishlist

The Wishlist menu lets a logged-in customer save products to come back to later. A customer can list their wishlist, add or toggle a product, remove a single item, clear the whole list, or move a saved item straight into the cart.

When a client uses this

The wishlist is per-customer and scoped to the current channel. Use toggle as a one-tap "heart" button — it adds the product if it isn't saved and removes it if it is. Move to cart transfers a saved item into the active cart so the customer can check out.

Operations in this menu

OperationMethod & PathDescription
Get Wishlist ItemsGET /api/shop/wishlistsList the customer's wishlist items.
Create Wishlist ItemPOST /api/shop/wishlistsAdd a product to the wishlist.
Toggle Wishlist ItemPOST /api/shop/wishlists/toggleAdd the product if absent, remove it if present.
Delete Wishlist ItemDELETE /api/shop/wishlists/{id}Remove one item.
Delete All Wishlist ItemsPOST /api/shop/delete-all-wishlistsClear the whole wishlist.
Move Wishlist Item to CartPOST /api/shop/move-wishlist-to-cartsMove a saved item into the cart.

All Wishlist endpoints require the storefront key and a customer Bearer token — see Authentication.

Released under the MIT License.