Skip to main content
Skip to main content

AdminGetDiscountsParams

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

constructor

Parameters

argsunknown[]Required

Properties

expandstring
Comma-separated relations that should be expanded in the returned data.
fieldsstring
Comma-separated fields that should be included in the returned data.
is_disabledboolean
Filter discounts by whether they're disabled.
is_dynamicboolean
Filter discounts by whether they're dynamic.
limitnumber
Limit the number of items returned in the list.

Default: 20

offsetnumber
The number of items to skip when retrieving a list.

Default: 0

qstring
Search terms to search discounts' code fields.
Filter discounts by their associated rule.
Was this section helpful?