Name | Type | Description | Notes |
---|---|---|---|
idCustomer | Integer | Limit to a single user | [optional] |
description | String | For your eyes only. This will never be displayed to the customer | [optional] |
priority | Integer | Rules are applied by priority. A rule with a priority of "1" will be processed before one with a priority of "2" | [optional] |
partialUse | Boolean | Allow to partial use this cart rule. If cart rule amount is greater than total customer order, a new cart rule will be created with the remainder amount. | [optional] |
code | String | Code used by customer to add it on his cart summary. Caution: rule will automatically be applied to everyone if you leave it blank | [optional] |
active | Boolean | Status of the cart rule | [optional] |
name | [I18nField] | This will be displayed in the cart summary, as well as on the invoice | |
dateFrom | String | Rule starts when this date is reached | [optional] |
dateTo | String | Rule ends when this date is reached | [optional] |
quantity | Integer | The cart rule will be applied to the first "X" orders only | [optional] |
quantityPerUser | Integer | A customer will only be able to use the cart rule "X" time(s) | [optional] |
minimumAmount | Integer | You can choose a minimum amount for the cart, either with taxes or not | [optional] |
minimumAmountTax | Integer | [optional] | |
minimumAmountCurrency | Integer | Currency ID | [optional] |
everyRecurringPayments | Boolean | If customer cart contains a subscription, select if cart rule will apply on recurring payments | [optional] |
reductionPercent | Number | Discount applied to cart when rule is added (in %). | [optional] |
reductionAmount | Number | Discount applied to cart when rule is added (in currency) | [optional] |
reductionCurrency | Integer | Currency ID for reduction amount | [optional] |
reductionTax | Integer | Tax application for currency discount | [optional] |
restrictionGroups | [CartRuleRestrictionGroup] | [optional] |