getPageableCustomers

Method that gets paginated list of customers for Assisted Service Module

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

Signature

export declare function getPageableCustomers<Res extends CustomerSearchPage = CustomerSearchPage>(
	props?: GetPageableCustomersProps,
	options?: MethodOptions
): Promise<Res>;

Parameters

Name	Required	Type	Description
`props`	Optional	`GetPageableCustomersProps`	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 page of customers

Referenced Types

CustomerSearchPage
GetPageableCustomersProps
MethodOptions

Examples

Requesting a customer page

const getPageableCustomers = await sdk.commerce.getPageableCustomers({
  currentPage: 1,
  customerListId: "asmInstoreCustomerList",
  pageSize: 5,
});