AdminGetCustomerGroupsParams
Parameters used to filter and configure the pagination of the retrieved customer groups.
Properties
order
stringThe field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with
-
.offset
numberThe number of items to skip when retrieving a list.
Default: 0
limit
numberLimit the number of items returned in the list.
Default: 10
expand
stringComma-separated relations that should be expanded in the returned data.
fields
string{@inheritDoc FindPaginationParams.fields}
id
string | string[] | StringComparisonOperatorIDs to filter customer groups by.
q
stringSearch term to search customer groups by their name.
name
string[]Names to filter customer groups by.
updated_at
DateComparisonOperatorDate filters to apply on the customer groups' update_at
date.
updated_at
DateComparisonOperatorupdate_at
date.created_at
DateComparisonOperatorDate filters to apply on the customer groups' created_at
date.
created_at
DateComparisonOperatorcreated_at
date.discount_condition_id
stringFilter customer groups by their associated discount condition's ID.
Was this section helpful?