getCustomerListDetails

Retrieves the details of a customer list with a valid ID

This method sends a POST request to the getCustomerListDetails endpoint of the Alokai Middleware. In turn, it exchanges data with the getCustomerListDetails endpoint exposed by the SAP OCC API Customer Controller.

Signature

export declare function getCustomerListDetails<Res extends CustomerList = CustomerList>(
	props: GetCustomerListDetailsProps,
	options?: MethodOptions
): Promise<Res>;

Parameters

Name	Required	Type	Description
`props`	Required	`GetCustomerListDetailsProps`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.
`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 customer list

Referenced Types

CustomerList
GetCustomerListDetailsProps
MethodOptions

Examples

Requesting customer list details

import { sdk } from '~/sdk';

const list = await sdk.commerce.getCustomerListDetails({ customerlist: 'asmInstoreCustomerList'});