You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
getCustomerLists
Retrieves a list of all customer lists. This can only be done when logged in ASM.
This method sends a POST request to the getCustomerLists endpoint of the Alokai Middleware. In turn, it exchanges data with the getCustomerLists endpoint exposed by the SAP OCC API Customer Controller.
Signature
export declare function getCustomerLists<Res extends UserGroupList = UserGroupList>(
options?: MethodOptions
): Promise<Res>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
options | Optional | MethodOptions | Options that can be passed to additionally configure the request or customize the logic in a plugin. |
Returns
Returns representation of a User Group List
Referenced Types
Examples
Requesting a list of all customer lists
import { sdk } from '~/sdk';
const cutomerLists = await sdk.commerce.getCustomerLists();