NameDescriptionTypeAdditional information
id

Id of coupon, must be unique.

globally unique identifier

None.

Version

Coupon version. Default is 0. Use version 2 for the new html template engine.

byte

None.

PartnerId

Id of Link partner from Partner API.

integer

None.

Type

COUPON or COUPON_BOOK

string

None.

Username

Username from login.

string

None.

Name

Name of coupon.

string

None.

Description

Description of coupon.

string

None.

start

When the coupon should start being active.

date

None.

stop

When the coupon should stop being active.

date

None.

ReceiveOnce

If coupon codes should be limited to one pr user.

boolean

None.

UsageCount

How many times user has used coupon.

integer

None.

Usages

[Version 2 Only] Gets or sets the usages for a coupon. Valid values in the array are: * BulkSending or 1. Bulk sending. * OptInMessage or 2. Opt-in message.

Collection of CouponUsage

None.

validityPeriodMinutes

How many minutes the coupon is valid.

integer

None.

SiteTemplateId

Site template id for coupon.

globally unique identifier

None.

CodeGeneratorConfiguration

Type of codes generated.

CodeGeneratorConfiguration

None.

created

When the coupon was created.

date

None.

CouponIds

List of coupon ids if this is a coupon book.

Collection of globally unique identifier

None.

Site

[Version 1 Only] Coupon web site.

Site

None.

DynamicFields

[Version 1 Only] Dynamic fields for the site template.

Dictionary of string [key] and string [value]

None.

HeaderText

[Version 2 Only] Coupon header text.

string

None.

HeaderBackgroundColor

[Version 2 Only] Coupon header background color.

string

None.

ThumbnailButtonText

[Version 2 Only] Coupon or coupon book thumbnail button text.

string

None.

ThumbnailButtonTextColor

[Version 2 Only] Coupon book coupons button text color.

string

None.

ThumbnailButtonBackgroundColor

[Version 2 Only] Coupon book coupons button background color.

string

None.

MainText

[Version 2 Only] Coupon main text.

string

None.

ImageText

[Version 2 Only] Coupon image overlay text.

string

None.

ConditionsText

[Version 2 Only] Coupon conditions text.

string

None.

RedeemButtonText

[Version 2 Only] Coupon redeem button text.

string

None.

RedeemButtonTextColor

[Version 2 Only] Coupon redeem button text color.

string

None.

RedeemButtonBackgroundColor

[Version 2 Only] Coupon redeem button background color.

string

None.

RedeemWarningMessage

[Version 2 Only] Coupon redeem-popup warning message.

string

None.

RedeemOkButtonText

[Version 2 Only] Coupon redeem-popup ok button text.

string

None.

RedeemCancelButtonText

[Version 2 Only] Coupon redeem-popup cancel button text.

string

None.

RedeemOverlayText

[Version 2 Only] Coupon overlay text shown when coupon is redeemed.

string

None.

BackgroundColor

[Version 2 Only] Coupon/couponbook background color.

string

None.

ImageTextColor

[Version 2 Only] Coupon image text color

string

None.

ValidText

[Version 2 Only] Valid text

string

None.

ActiveSoonStatusText

[Version 2 Only] Active soon status text

string

None.

ActiveStatusText

[Version 2 Only] Active status text

string

None.

ActivationTimeText

[Version 2 Only] Activation time text

string

None.

ExpirationTimeText

[Version 2 Only] Expiration time text

string

None.

ExpiredStatusText

[Version 2 Only] Expired status text

string

None.

Images

[Version 2 Only] Coupon images.

Collection of CouponImageRequest

None.

BannerText

[Version 2 Only] Couponbook Banner text.

string

None.

BannerTextColor

[Version 2 Only] Couponbook Banner text color.

string

None.

Logo

[Version 2 Only] Coupon book logo image.

string

None.

CouponsButtonText

WARNING! This property is obsolete. Please use ThumbnailButtonText instead. This field will be removed in a future version of the API. [Version 2 Only] Coupon book coupons button text.

string

None.

ShowLikeButtons

[Version 2 Only] Couponbook Show like buttons.

boolean

None.

StoreName

[Version 2 Only] Gets or sets the store name that is sending this coupon.

string

None.

DiscountType

[Version 2 Only] Gets or sets the type of discount that the property represents. Valid values are: * Percentage or 1. The discount is given in percentages of the sales price. * Price or 2. The discount is given price discount subtracted from the sales price. * Other or 3. Some other type of discount (free, 3 for 2 and so on).

string

None.

DiscountValue

[Version 2 Only] Gets or sets the value of the discount, as described by .

decimal number

None.