createWishlist
Create a wishlist
It receives data from the createWishlist endpoint exposed by the BigCommerce API
Signature
declare function createWishlist(
context: BigcommerceIntegrationContext,
params: CreateWishlistProps
): Promise<WishlistResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | BigcommerceIntegrationContext | |
params | Required | CreateWishlistProps |
Returns
Returns a response with the Wishlist object.
Referenced Types
Examples
Creating a new wishlist.
import { sdk } from '~/sdk.config.ts';
const createWishlistResponse = await sdk.bigcommerce.createWishlist({
{
"name": "My very own Wishlist!",
"is_public": true,
"items": []
}
});