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

CustomerGroupsApi class

CustomerGroupsApi - object-oriented interface CustomerGroupsApi {BaseAPI}

Signature:

export declare class CustomerGroupsApi extends BaseAPI 

Extends: BaseAPI

Methods

Method	Modifiers	Description
createCustomerGroup(baseSiteId, userGroup, options)		Creates a new customer group that is a direct subgroup of a customergroup. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”. Creates a new customer group.
getCustomerGroup(baseSiteId, groupId, fields, options)		Returns a customer group with a specific groupId. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”. Get a specific customer group.
getCustomerGroups(baseSiteId, currentPage, fields, pageSize, options)		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.
removeUsersFromCustomerGroup(baseSiteId, groupId, userId, options)		Deletes user from a customer group. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”. Deletes a user from a customer group.
replaceUsersForCustomerGroup(baseSiteId, groupId, members, options)		Sets members for a user group. The list of existing members is overwritten with a new one. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”. Sets members for a user group.
updateCustomerGroupWithUsers(baseSiteId, groupId, members, options)		Assigns user(s) to a customer group. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”. Assigns user(s) to a customer group.