restoreCustomerGroups - Customer Module Reference

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

This method restores a soft deleted customer group by its IDs.

Example

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

Parameters

groupIdsstring[]Required

The IDs of customer groups.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the customer groups. You can pass to its returnLinkableKeys property any of the customer group's relation attribute names, such as customers.

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 restored. If there are no related records restored, the promise resolves to void.