getAllWishlists

Gets all customers wishlists.

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

Signature

declare function getAllWishlists$1(
	props?: GetAllWishlistQuery,
	options?: MethodOptions
): Promise<WishlistResponse>;

Parameters

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

Returns

Returns a response containing the object with the created wishlist details.

Referenced Types

GetAllWishlistQuery
WishlistResponse

Examples

Getting customers wishlists

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

const getAllWishlistsResponse = await sdk.bigcommerce.getAllWishlists();