Home > @vsf-enterprise/sap-commerce-webservices-sdk > CustomerGroupsApi > getCustomerGroups

CustomerGroupsApi.getCustomerGroups() method

Returns all customer groups that are direct subgroups of a customergroup. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”. Get all subgroups of a customergroup.

Signature:

getCustomerGroups(baseSiteId: string, currentPage?: number, fields?: string, pageSize?: number, options?: any): Promise<import("axios").AxiosResponse<UserGroupList>>;

Parameters

Parameter	Type	Description
baseSiteId	string	Base site identifier
currentPage	number	Current page number (starts with 0).
fields	string	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
pageSize	number	Number of customer group returned in one page.
options	any	Override http request option.

Returns:

Promise<import("axios").AxiosResponse<UserGroupList>>

Exceptions

{RequiredError} CustomerGroupsApi