removeCustomerFromGroup - Customer Module Reference

This documentation provides a reference to the removeCustomerFromGroup method. This belongs to the Customer Module.

removeCustomerFromGroup(groupCustomerPair, sharedContext?): Promise<void>

This method removes a customer from a group.

Example

await customerModuleService.removeCustomerFromGroup({
  customer_id: "cus_123",
  customer_group_id: "cus_321",
})

Parameters

groupCustomerPairGroupCustomerPairRequired

The details of the customer and the group it should be removed from.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<void>Required

Resolves when the customer is removed from the group successfully.

removeCustomerFromGroup(groupCustomerPairs, sharedContext?): Promise<void>

This method removes customers from groups.

Example

await customerModuleService.removeCustomerFromGroup([
  {
    customer_id: "cus_123",
    customer_group_id: "cus_321",
  },
])

Parameters

groupCustomerPairsGroupCustomerPair[]Required

A list of items, each being the details of a customer and the group it should be removed from.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<void>Required

Resolves when the customers are removed from the groups successfully.