Field |
Function |
PromoCode |
The promocode to be validated in the shopping cart. Can be manually applied in the cart page or passed via a redirect. |
PromoDescr |
For internal use only, used to identify the promocode. |
PromoCriteriaType |
Minimum Amount: A minimum merchandise total that must be met to allow the promocode to be applied to the order. InvtID Purchase: A product that must be purchased in the order to allow the promocode to be applied to the order. CustID: A customer specific promocode. This promocode can only be applied by the designated custID. |
MinAmt |
The minimum merchandise total that must be met to allow the promocode to be applied to the order. Required if PromoCriteriaType is "Minimum Amount" |
QualifyInvtID |
The invtID of the product that must be purchased in the order to allow the promocode to be applied to the order. Required if PromoCriteriaType is "InvtID Purchase" |
QualifyCustID |
The custID of the customer that is allowed to apply the promo code to the order. Required if PromoCriteriaType is "CustID" |
PromoOfferType |
Percentage Discount: Apply a percentage discount on the order. Only applies to merchandise total. Dollar Discount: Apply a straight dollar amount discount on the order. Merchandise: Add additional products to the order for free. Free Freight: Apply free shipping on the order. |
DiscPct |
Percentage discount off of the order. Required if PromoOfferType is "Percentage Discount". |
DiscAmt |
Dollar amount discount off of the order. Required if PromoOfferType is "Dollar Discount". |
GiveAwayInvtID |
The invtID to add to the order free. Required if PromoOfferType is "Merchandise". |
FrtTermsID |
The FrtTermsID to apply to the order to give away free shipping. Required if PromoOfferType is "Free Freight". |
PromoBeginDate |
The date this promo will be begin being accepted. (optional) |
PromoEndDate |
The date this promo will stop being accepted. (optional) |
One Time Use |
On/Off -- If checked (1) this promo code can only be used once per custID. |
Active |
On/Off -- If checked (1) this promo code will be treated as active and available for use. |