Skip to main content

An enumerated type that defines the condition of a promotion.

Types that use RuleTemplateNameEnum

Not used by any types.

Calls that use RuleTemplateNameEnum

Not used by any calls.

Enumerations

Value
Description
BUY_1_ITEMS_GET_Y_AMT_OFF_SUBTOTAL
Indicates that the buyer will receive a dollar value discount on their order when they buy an item.

The dollar value discount is shown in the corresponding amountOffOrderValue field.
BUY_1_ITEMS_GET_Y_PCT_OFF_SUBTOTAL
Indicates that the buyer will receive a percentage value discount on their order when they buy an item.

The percentage value discount is shown in the corresponding percentageOffOrderValue field.
BUY_N_ITEMS_GET_Y_AMT_OFF_SUBTOTAL
Indicates that for every N items purchased, the buyer will receive a dollar value discount on their the order.

The number of items that must be purchased is shown in the corresponding minQuantity field, and the dollar value discount is shown in the corresponding amountOffOrderValue field.
BUY_N_ITEMS_GET_Y_PCT_OFF_SUBTOTAL
Indicates that for every N items purchased, the buyer will receive a percentage value discount on their order.

The number of items that must be purchased is shown in the corresponding minQuantity field, and the percentage value discount is shown in the corresponding percentageOffOrderValue field.
FOR_EVERY_BUY_1_ITEMS_GET_Y_AMT_OFF_SUBTOTAL
Indicates that for each item purchased, the buyer will receive a dollar value discount on their order.

The dollar value discount for each item purchased is shown in the corresponding amountOffItemValue field.
FOR_EVERY_N_ITEMS_GET_Y_AMT_OFF_SUBTOTAL
Indicates that for every N items purchased, the buyer will receive a dollar value discount on their order.

The number of items that must be purchased is shown in the corresponding forEachQuantity field, and the dollar value discount is shown in the corresponding amountOffItemValue field.
FOR_EVERY_N_ITEMS_GET_M_ITEMS_AT_Y_PCT_OFF
Indicates that for every N items purchased, the buyer will receive a percentage value discount on M items.

The number of items that must be purchased is shown in the corresponding forEachQuantity field, the number of items being discounted is shown in the corresponding numberOfDiscountedItems field, and the percentage value discount for these items is shown in the percentageOffItemValue field.
FOR_EVERY_N_ITEMS_GET_M_ITEMS_FREE
Indicates that for every N items purchased, the buyer will receive M items free.

The number of items that must be purchased is shown in the corresponding forEachQuantity field, and the number of items being received for free is shown in the corresponding numberOfDiscountedItems field.
SPEND_X_AMT_GET_Y_AMT_OFF_SUBTOTAL
Indicates that if a buyer spends X amount, they will receive a dollar value discount on their order.

The required amount to spend is shown in the corresponding minAmountValue field, and the dollar value discount is shown in the corresponding amountOffOrderValue field.
SPEND_X_AMT_GET_Y_PCT_OFF_SUBTOTAL
Indicates that if a buyer spends X amount, they will receive a percentage value discount on their order.

The required amount to spend is shown in the corresponding minAmountValue field, and the percentage value discount is shown in the corresponding percentageOffOrderValue field.
FOR_EVERY_X_AMT_SPENT_GET_Y_AMT_OFF_SUBTOTAL
Indicates that the buyer will receive a dollar value discount on their order for every X dollar amount they spend.

The dollar value that must be spent is shown in the corresponding forEachAmountValue field, and the dollar value discount is shown in the corresponding amountOffItemValue field.
FOR_EVERY_X_AMT_SPENT_GET_Y_PCT_OFF_SUBTOTAL
Indicates that the buyer will receive a percentage value discount on their order for every X dollar amount they spend.

The dollar value that must be spent is shown in the corresponding forEachAmountValue field, and the percentage value discount is shown in the corresponding percentageOffItemValue field.