Coupons
Lists all coupons.
Columns
Name
Type
Description
Id [KEY]
Integer
The coupons ID.
Name
String
The name of the coupon.
Type
String
Type of the coupon.
Amount
Decimal
The discount to apply to an order, as either an amount or a percentage.
MinPurchase
Decimal
Specifies a minimum value that an order must have before the coupon can be applied to it.
Expires
Datetime
Specifies when a coupon expires.
Enabled
Boolean
If the coupon is enabled, this fields value is true; otherwise, false.
Code
String
The coupon code that customers will use to receive their discounts.
AppliesToEntity
String
What the discount applies to. Can be products or categories.
AppliesToIds
String
ID of either the products or categories
NumUses
Integer
Number of times this coupon has been used.
MaxUses
Integer
Maximum number of times this coupon can be used.
MaxUsesPerCustomer
Integer
Maximum number of times each customer can use this coupon.
DateCreated
Datetime
Date Created
Last updated