listCustomerGroups - Customer Module Reference

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

This method retrieves a paginated list of customer groups based on optional filters and configuration.

Example

To retrieve a list of customer groups using their IDs:

const customerGroups =
  await customerModuleService.listCustomerGroups({
    id: ["cusgroup_123", "cusgroup_321"],
  })

To specify relations that should be retrieved within the customer groups:

const customerGroups =
  await customerModuleService.listCustomerGroups(
    {
      id: ["cusgroup_123", "cusgroup_321"],
    },
    {
      relations: ["customers"],
    }
  )

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const customerGroups =
  await customerModuleService.listCustomerGroups(
    {
      id: ["cusgroup_123", "cusgroup_321"],
    },
    {
      relations: ["customers"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterableCustomerGroupProps

The filters to apply on the retrieved customer groups.

configFindConfig<CustomerGroupDTO>

The configurations determining how the customer group is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a customer group.

sharedContextContext

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

Returns

PromisePromise<CustomerGroupDTO[]>Required

The list of customer groups.