Purchase condition XML definition

High level elements

1. The pattern that the catalog entries in the shopping cart must match before the promotion is applied to the order.
2. The reward that the customer receives when the required pattern is met.

PurchaseCondition element

The PurchaseCondition element is one of the primary elements inside the runtime promotion XML, and it defines the purchase condition. However, when creating a custom purchase condition, you are actually concerned with creating or customizing the elements inside the PurchaseCondition element, rather than the element itself.

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.condition.PurchaseCondition class.

The PurchaseCondition element contains one Pattern element and one Distribution element.

Pattern element

The Pattern element is one of the two primary elements inside the Purchase Condition element. The Pattern element contains the elements that define the things that a customer must have in their shopping cart to qualify for the promotion. This element is not very interesting, and serves to differentiate the elements from the reward elements.

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.condition.Pattern class.

A Pattern element contains one or more Constraint elements.

Constraint element

The Constraint element is the only element inside the Pattern element, though there may be multiple Constraint elements. The Constraint element contains elements that specify a list of items that make up one part of the pattern. There must be no cross-sections between constraints. Again, this element is not very interesting on it's own.

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.condition.Constraint class.

A Constraint element contains a WeightedRange element and a FilterChain element.

WeightedRange element

The WeightedRange element defines the quantity requirement of the Constraint.

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.condition.WeightedRange class.

<LowerBound>1</LowerBound>
<UpperBound>-1</UpperBound>
<Weight>1</Weight>

FilterChain element

The FilterChain element contains one or more filters that apply for the Constraint.

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.condition.FilterChain class.

<Filter impl="com.ibm.commerce.marketing.promotion.condition.DummyFilter"/>

Distribution element

The Distribution element is one of the two primary elements inside the Purchase Condition element. The Distribution element contains the elements that define the reward that a customer receives if they qualify for the promotion. This element is not very interesting, and serves to differentiate the elements from the pattern elements.

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.reward.Distribution class.

<Type>Volume</Type>
<Base>Cost</Base>
<Currency>CAD</Currency>

A Distribution element also contains a PatternFilter element and one or more Range elements.

PatternFilter element

The PatternFilter element determines the pattern of the reward.

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.condition.DummyFilter class.

Not all matched patterns are rewarded, for example, a combination of shirts and pants priced over $120 if a combination of shirts and pants which is priced at $100, it should be eliminated.

Range element

<UpperBound>200</UpperBound>
<LowerBound>100</LowerBound>

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.reward.DistributionRange class.

The Range element contains a Reward element.

Reward element

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.reward.DefaultReward class.

The Reward element contains an AdjustmentFunction element.

AdjustmentFunction element

This element has an impl parameter which in almost every case should be set to the default value, which refers to the com.ibm.commerce.marketing.promotion.reward.AdjustmentFunction class.

The AdjustmentFunction contains a FilterChain element and an Adjustment element.

Adjustment element

The Adjustment element defines the adjustment to the customer's order. This could be a price adjustment to an catalog entry, an adjustment to the order price, a free gift, or other such adjustment.

This element has an impl parameter which corresponds to the adjustment that is being applied to the order. The list of valid default adjustments, as well as any additional configuration XML they require can be found in the Example: Adjustment XML fragments topic.