AdminGetDiscountsParams

Parameters used to filter and configure the pagination of the retrieved discounts.

Properties

ruleAdminGetDiscountsDiscountRuleParams

Filter discounts by their associated rule.

qstring

Search terms to search discounts' code fields.

is_dynamicboolean

Filter discounts by whether they're dynamic.

is_disabledboolean

Filter discounts by whether they're disabled.

created_atDateComparisonOperator

Date filters to apply on the discounts' created_at date.

updated_atDateComparisonOperator

Date filters to apply on the discounts' updated_at date.

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 -.

expandstring

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

fieldsstring

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

Limit the number of items returned in the list.

Default: 20