softDeleteCustomerGroups - Customer Module Reference

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

This method soft deletes customer groups by their IDs.

Example

await customerModuleService.softDeleteCustomerGroups([
  "cusgroup_123",
])

Parameters

groupIdsstring[]Required

The IDs of customer groups.

configSoftDeleteReturn<TReturnableLinkableKeys>

An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.

sharedContextContext

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

Returns

PromisePromise<void | Record<TReturnableLinkableKeys, string[]>>Required

An object that includes the IDs of related records that were also soft deleted. If there are no related records, the promise resolves to void.