getCustomerProductLists

Returns all customer product lists. Works for both registered and guest customers.

This method communicates with the getCustomerProductLists endpoint of the Vue Storefront API Middleware. In turn, it receives data from the getCustomerProductLists or the Get customer product lists endpoints exposed by SCAPI / OCAPI depending on the middleware configuration.

The following types of product lists are available: - wish_list - gift_registry - shopping_list - custom_1 - custom_2 - custom_3

Signature

export declare function getCustomerProductLists(
	
): Promise<CustomerProductListsResult>;

Returns

Returns a Product Lists result.

Referenced Types

• CustomerProductListsResult

Examples

Fetching the current customer's product lists.

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

const customer = await sdk.commerce.getCustomerProductLists();