removeWishlistItem

Removes items from the wishlist.

This method sends a POST request to the removeWishlistItem endpoint of the Vue Storefront API Middleware. In turn, it receives data from the removeWishlistItem endpoint exposed by the BigCommerce API

Signature

declare function removeWishlistItem(
	props: RemoveWishlistItemParams,
	options?: MethodOptions
): Promise<WishlistResponse>;

Parameters

Name	Required	Type	Description
`props`	Required	`RemoveWishlistItemParams`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.
`options`	Optional	`MethodOptions`

Returns

Returns updated Wishlist data

Referenced Types

RemoveWishlistItemParams
WishlistResponse

Examples

Removing an item from the wishlist

import { sdk } from '~/sdk.config.ts';

const removeWishlistItemResponse = await sdk.bigcommerce.removeWishlistItem({
   wishlistId: '7c3ab631-782c-4747-8ccc-873e87de5152',
   itemId: 132
  }
})