Discount Parameters

discount_quantity_amount

Accepts: A valid discount string.
Notes: Discounts by an amount, based on the quantity of to-be-discounted products. Abbreviated $/qty.

discount_quantity_percentage

Accepts: A valid discount string.
Notes: Discounts by a percentage, based on the quantity of to-be-discounted products. Abbreviated %/qty. Note that the value is based on the average of all applicable products, so applying this discount to differently priced items will result in an averaged discount.

discount_price_amount

Accepts: A valid discount string.
Notes: Discounts by an amount, based on the price of to-be-discounted products. Abbreviated $/$.

discount_price_percentage

Accepts: A valid discount string.
Notes: Discounts by a percentage, based on the price of to-be-discounted products. Abbreviated %/$. Note that the value is based on the average of all applicable products, so applying this discount to differently priced items will result in an averaged discount.

allunits

Also Called: All-Units Quantity Discounts

Description: Discounts the price of all of the products affected by the discount. Also referred to as “volume discounts” or “bulk order discounts.”
Notes: allunits is the default discount type for quantity discounts applied to products. If a discount type isn't specified, allunits is applied. Note that “single” is the default type for coupons.
Examples:

• Scenario: Buy two products, take $2 off of both.

  • Method: discount_quantity_amount

  • Logic: allunits|2-2
    

• Scenario: Orders of five or more get a 10% on every item ordered. Orders of 10 or more get a 20% discount on every item ordered.

  • Method: discount_quantity_percentage

  • Logic: allunits|5-10|10-20

incremental

Also Called: Incremental Quantity Discounts

Description: Discounts only the units above the tiers you set.
Notes: Most useful for individual products or many products with the same price. Not useful for $/$ discount methods.
Examples:

• Scenario: Buy two products, get additional products at $5 off. (The first two are not discounted.)

  • Method: discount_quantity_amount

  • Logic: incremental|3-5
    

• Scenario: With a quantity of 1-10, all products are at 100% (no discount). With a quantity of 150, 10 products would be at 100%, 40 would be at 90%, 50 would be at 85%, and 50 would be at 80%.

  • Method: discount_quantity_percentage

  • Logic: incremental|11-10|51-15|101-20

repeat

Also Called: Buy One, Get One (BOGO), or “Repeatable Incremental Quantity Discounts”
Description: Repeatable discounts are somewhat similar to incremental discounts, but only have a single tier that repeats. Using this method you can achieve “buy one get one free” types of discounts that repeat (buy 1 get 1, or buy 3 get 3). You can also do something like “buy 3 get the 4th at $5 off”, so buying 5 or 6 would only get a single $5 discount, but buying 8 would get a $10 discount.
Notes: Not useful for $/$ discount methods. Only accepts one tier.
Examples:

• Scenario: Buy one, get one free (100% off).

  • Method: discount_quantity_percentage

  • Logic: repeat|2-100
    

• Scenario: Buy 3, get the 4th at 50% off.

  • Method: discount_quantity_percentage

  • Logic: repeat|4-50

single

Also Called: Single Discount, One-Off Discount; or Coupon mode
Description: Unlike the other discount types, the single discount type applies one single discount and not a quantity discount across all products.
Notes: single is the default discount type for coupons, as it makes the most sense in that context. For %/qty and %/$ a single discount type will yield the same discount as allunits. Note that “allunits” is the default discount type for product and category discounts.
Examples:

• Scenario: Buy any 5 products, get $10 off your order.

  • Method: discount_quantity_amount

  • Logic: single|5-10

Example Discount Syntax

discount_method=Discount_Name{discount_type|X-A|Y-B|Z-C}

• discount_method: One of the Discount Methods above.

• Discount_Name: The text label applied to the discount and displayed to the customer in the cart. For example, “Summer Special” or “Local Coupon Discount”. A discount name is required for discounts to apply properly on cart pageloads.

• discount_type: A Discount Type from above. Optional. Will default to single if a coupon, or allunits otherwise.

• X, Y, Z: “Discount Tiers”. The threshold at which the Discount Amount will apply.

• A, B, C: “Discount Amounts”. The amount or percentage discount to apply.