Promotion

The object below is returned directly or within a successful response from the following API requests:

Create promotion

Update promotion

Retrieve a promotion

Search promotions

Promotion object

Parameter	Type / Description
CouponCodes	Array of strings Array of coupon/voucher codes when Coupon / Voucher type is Multiple. Otherwise, empty array.
ChannelType	String Possible values: ECOMMERCE CHANNEL_MANAGER ALL
CouponType	String Possible values: SINGLE MULTIPLE
DiscountType	String Possible values FIXED PERCENT
Type	String REGULAR GLOBAL SPECIAL_PRICE
PriceMatrix	Array of objects (only for SPECIAL_PRICE type of promotion) Is generated by the getPriceMatrix call and used to set promotion special prices.
ProductCode	String Code of the product that is used by promotion.
ProductTaxCategoryUUID	String or NULL The UUID of the tax category used for the product. Must be a category existent on your account. Required only for Cumulative promotions.
PricingConfigurationCode	String Code of pricing configuration used by promotion; must be related to the product.
OptionHash	String Unique identifier of one combination of price configuration options.
Options	Array of objects Describes price configuration options identified by OptionHash.
GroupName	String
OptionText	String
Prices	Array of objects Promotion prices by currency; the price for default currency is required.
Value	Required (int) Decimal
Currency	String ISO code
Discount	Int The value of the discount. Example: for a $30 USD discount 2Checkout returns the value 30 and for a 25% price cut, 2Checkout returns 25.
Products	Array Array of product codes for the products impacted by the promotion.
Name	String Promotion name.
Description	String Promotion description.
StartDate	String Starting date. The date when you set the promotion to start. Is NULL for promotions that start immediately after they're created.
EndDate	String Ending date. The date when you set the promotion to end. Is NULL for promotions that you want active indefinitely.
MaximumOrdersNumber	Int When the maximum number of orders is reached the promotion stops. Can be NULL if you want the promotion to apply to an unlimited number of orders.
MaximumQuantity	Int Discount only applies to a specific number of product, smaller than the maximum quantity you defined. Can be NULL if you want the promotion to apply to an unlimited number units. Any extra quantity added to the cart will be sold at full price.
InstantDiscount	Boolean Selecting the instant discount option will auto-apply the discount for ALL the selected products for all shoppers, without the need to enter the discount coupon.
Coupon	String The promotion/voucher for which you are extracting the information.
DiscountLabel	String Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency.
Enabled	Boolean Can be TRUE if promotion is enabled, or FALSE if otherwise.
Currency (fixed promotions)	String Currency code available for the default currency of FIXED promotions. Missing for PERCENT promotions.
DefaultCurrency	String Required for SPECIAL_PRICE promotions, represents the default currency of the promotion.
Code	String Unique, system-generated identifier 2Checkout associates with promotion campaigns.
PriceThreshold	Object Limits discount use only when total order value (taxes included) exceeds the threshold you configure.
PriceThreshold.Amount	Decimal The minimum threshold you defined for the default currency.
PriceThreshold.Currency	String Currency code available for the default currency of custom threshold settings.