deleteWishlist

Method to delete a wishlist

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

Signature

declare function deleteWishlist$1(
	props: DeleteWishlistSDKProps,
	options?: MethodOptions
): Promise<void>;

Parameters

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

Returns

Returns void

Referenced Types

DeleteWishlistSDKProps

Examples

Deleting a wishlist.

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

const deleteWishlistResponse = await sdk.bigcommerce.deleteWishlist({
  wishlistId: 30
});