removeWishlistItem

Remove an item from the wishlist. 🔐 This method requires authorization (or a guest context).

Description

This method removes a single product from the wishlist of the current context - an authorized user or a guest (resolved via the x-guest-id header, see Guest mode). It returns a Promise that resolves to the updated IWishlistResponse object.

Users.removeWishlistItem(

productId*

);

Parameters schema

Schema

productId(required): number
Product identifier.
example: 12345

Examples

Minimal example

const response = await Users.removeWishlistItem(12345);

Example response

{
  "items": [],
  "total": 0
}

Response schema

Schema: IWishlistResponse

items: IWishlistItem[]
Wishlist items.

items.productId: number
Product identifier.
example: 1

items.addedAt: string
ISO date when the item was added.
example: "2026-05-30T10:00:00.000Z"

total: number
Total number of items in the wishlist.
example: 3

---