getPageableCustomers

Gets paginated list of customers for Assisted Service Module

This method exchanges data with the getPageableCustomers endpoint exposed by the SAP OCC API Customers Controller.

Signature

export declare function getPageableCustomers(
	context: SapccIntegrationContext,
	props: GetPageableCustomersProps
): Promise<CustomerSearchPage>;

Parameters

Name	Required	Type	Description
`context`	Required	`SapccIntegrationContext`
`props`	Required	`GetPageableCustomersProps`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.

Returns

Returns page of customers

Referenced Types

SapccIntegrationContext
GetPageableCustomersProps
CustomerSearchPage

Examples

Requesting a customer page

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