Skip to main content
Skip to main content

listAndCountCustomerGroups - Customer Module Reference

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

This method retrieves a paginated list of customer groups along with the total count of available customer groups satisfying the provided filters.

Example

To retrieve a list of customer groups using their IDs:

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

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

const [customerGroups, count] =
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, count] =
await customerModuleService.listCustomerGroups(
{
id: ["cusgroup_123", "cusgroup_321"],
},
{
relations: ["customers"],
take: 20,
skip: 2,
}
)

Parameters

The filters to apply on the retrieved customer groups.
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[], number]>Required
The list of customer groups along with their total count.
Was this section helpful?