Name | Type | Cardinality | Label | Required | Help |
applyDiscountTo |
PromotionCodeApplyDiscountTo |
0..1 |
Each Customer Can Use The Promotion |
F |
Set to apply discount to first sale only or to all sales. |
code |
string |
0..1 |
Coupon Code |
F |
Set the name of the promotion code.
Promotion codes can be assigned to lead, prospect, and customer records. |
codePattern |
string |
0..1 |
Code Pattern |
F |
You enter code patterns using the following components in any order you choose:
* [A.#] – This adds a number of random letters in the code.
* [N.#] – This adds a number of random numbers in the code.
* [AN.#] – This adds a number of random alphanumeric characters to the code.
* Hard-coded alphanumeric characters. Do not enclose these in square brackets.
* Dashes (-)
Note: The following letters and numbers cannot be used in coupon codes: 1, 0, I, L, O.
For example, the code ABC-[AN.3]-[A.3]-[N.3] would generate codes like:
* ABC-J3N-FLN-647
* ABC-45F-KPM-958
* ABC-5MP-PQA-874
When creating your code pattern, make sure that the pattern you give has enough variables to provide the number of unique codes you need for your promotion. |
currencyList |
PromotionCodeCurrencyList |
0..1 |
|
|
|
customFieldList |
CustomFieldList |
0..1 |
|
|
|
customForm |
RecordRef |
0..1 |
Custom Form |
F |
Select the custom form to use with this promotion. |
description |
string |
0..1 |
Description |
F |
Set the description for the promotion code. |
discount |
RecordRef |
0..1 |
Discount |
F |
Reference a value in a user defined discount list.
To create new values, click Lists > Accounting > Items > New > Discount. |
discountType |
boolean |
0..1 |
Discount Type |
F |
Define whether the value entered for Rate is calculated as a percentage or as an absolute discount value.
If the value entered is not a percent sign, the discount rate is applied as an absolute discount value. For example, 10% would result in a ten percent discount on the item whereas 10 would result in a ten dollar discount on the item. |
displayLineDiscounts |
boolean |
0..1 |
Display Line Discounts |
F |
Check this box if you want to show the promotion discount as line items in transactions. The discount will appear as a line beneath qualifying items on the transaction.
You must check this box and select a percentage discount in order to show strikeout pricing on Web store orders. A flat rate promotion applies to the total order.
If you clear this box, the promotion discount will be shown in the transaction total.
Note: If you use line discount promotions, when you apply the promotion to a transaction, you must click Calculate to create the discount line before saving the transaction. |
endDate |
dateTime |
0..1 |
End Date |
F |
Set the end date for this promotion code. |
excludeItems |
boolean |
0..1 |
|
F |
If set to true, then this promotion code applies to all items except those you add.
If set to false, the promotion code can only be used for the items added. |
freeShipMethod |
RecordRef |
0..1 |
Shipping Method |
F |
Select a shipping method from the list that will be offered for free on eligible transactions. |
implementation |
RecordRef |
0..1 |
|
F |
|
isInactive |
boolean |
0..1 |
Inactive |
F |
If true, inactivates the promotion code. |
isPublic |
boolean |
0..1 |
Available to all Clients |
F |
Check this box to be able to select this promotion on transactions for any customer.
If you do not check this box, only customers associated with the partners you select below are able to use this promotion. |
itemsList |
PromotionCodeItemsList |
0..1 |
|
|
|
locationList |
RecordRefList |
0..1 |
|
|
|
minimumOrderAmount |
double |
0..1 |
|
F |
Enter the amount that the customer must spend before the promotion code becomes valid.
If you use the Multiple Currencies feature, you can set a different minimum order amount for each currency in which you do business. |
name |
string |
0..1 |
Name |
F |
Enter the name for this promotion.
Note: This is the name used for internal and reporting use only. The coupon code you want customers to use on sales transactions is entered in the Coupon Code field on the Codes subtab. |
numberToGenerate |
long |
0..1 |
Codes to Generate |
F |
Enter the number of coupon codes you want to generate with your code pattern. |
partnersList |
PromotionCodePartnersList |
0..1 |
|
|
|
rate |
string |
0..1 |
Rate |
F |
Set the rate of discount for this item. |
startDate |
dateTime |
0..1 |
Start Date |
F |
Set the start date for the promotion code. |
useType |
PromotionCodeUseType |
0..1 |
Coupon Code Type |
F |
Choose whether you are entering a multiple-use coupon code that can be used any number of times by any number of customers, or single-use coupon codes that can only be used in one transaction by a single customer. |