| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| Disabled | date |
None. |
|
| Name |
Name for the discount |
string |
Required |
| Code |
Code for the coupon |
string |
Required String length: inclusive between 0 and 50 |
| Amount |
Fixed amount that will be discounted from the order ItemsBase |
decimal number |
None. |
| DiscountPercent |
Percentage that will be discounted from the order ItemsBase |
decimal number |
Range: inclusive between 0 and 1 |
| UsageLimit |
Maximum number of uses |
integer |
None. |
| UsagePerCustomerLimit |
Maximum number of uses per customer |
integer |
None. |
| MinimumOrderAmount |
The minimum required order amount of CouponableEntity to apply this coupon |
decimal number |
None. |
| MaximumOrderAmount |
The maximum order amount to apply this coupon (Normally used when DiscountRate is in place for Orders) |
decimal number |
None. |
| CouponsOff |
Excludes other coupons |
boolean |
None. |
| ValidFrom |
Validity start date |
date |
None. |
| Expiration |
Validity end date |
date |
None. |
| CouponableTypeID |
Defines the set of Amounts this coupon applies to: Variation.Amount (by Variation, Product, Classification, Provider or the whole Store ) or the Order.Amount |
integer |
None. |
| CouponableEntityID |
ID of Entity of Type defined by CouponableType |
integer |
None. |
| CustomerID | string |
String length: inclusive between 0 and 128 |
|
| CustomerTypeID | integer |
None. |
|
| Lang | string |
None. |
|
| StoreID | integer |
None. |
