AdminGetCustomerGroupsParams

Parameters used to filter and configure the pagination of the retrieved customer groups.

constructor

---

Properties

created_atDateComparisonOperator

Date filters to apply on the customer groups' created_at date.

discount_condition_idstring

Filter customer groups by their associated discount condition's ID.

expandstring

Comma-separated relations that should be expanded in the returned data.

idstring | string[] | StringComparisonOperator

IDs to filter customer groups by.

limitnumber

Limit the number of items returned in the list.

Default: 10

namestring[]

Names to filter customer groups by.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

orderstring

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

qstring

Search term to search customer groups by their name.

updated_atDateComparisonOperator

Date filters to apply on the customer groups' update_at date.