Skip to main content

This container defines the discount as either a monetary amount or a percentage of the sales price.

Important!: You must populate one and only one of the fields in this container:

  • amountOffItem
  • amountOffOrder
  • percentageOffItem
  • percentageOffOrder

Tip: Refer to Configuring discounts for threshold discounts for information and examples on how to combine discountBenefit and discountSpecification values to create different types of discounts.

Types that use DiscountBenefit

DiscountRuleSelectedInventoryDiscount

Calls that use DiscountBenefit

POST
/item_price_markdown
GET
/item_price_markdown/{promotion_id}
PUT
/item_price_markdown/{promotion_id}
POST
/item_promotion
PUT
/item_promotion/{promotion_id}
GET
/item_promotion/{promotion_id}

Fields

Field
Type
Description
amountOffItem
Amount
The monetary amount that is discounted off an item (or items) when the discount criteria is met.

For threshold discounts, where the buyer triggers the discount, the valid values for this field are:
  5, 6, 7, 8, 9, 10, 15, 20, 25,
  30, 35, 40, 45, 50, 55, 60, 65,
  70, 75, 80, 85, 90, 95, 100, 110,
  120, 125, 150, 200, 250

For markdown discounts, the range is greater, as outlined below and detailed more precisely here:
  • $1 increments from $5 to $100
  • $5 increments from $105 to $1,000
  • $100 increments from $1,100 to $15,000
amountOffOrder
Amount
Used for threshold discounts, this is the monetary amount that is discounted off an order when the discount criteria is met. Because this field is valid only for orders, it's not a valid combination to use with markdown discounts.

Valid values for the associated amountOffOrder.value field:
  5, 6, 7, 8, 9, 10, 15, 20, 25,
  30, 35, 40, 45, 50, 55, 60, 65,
  70, 75, 80, 85, 90, 95, 100, 110,
  120, 125, 150, 200, 250
percentageOffItem
string
The percentage applied to the sales price that is discounted off the discounted item (or items) when the discount criteria is met.

Valid integer values for percentage off:   Min: 5   Max: 80
percentageOffOrder
string
Used for threshold discounts, this is the percentage of the order price that is discounted off the order when the discount criteria is met. This field is not value for markdown discounts.

Valid integer values for ORDER_DISCOUNT discounts:   Min: 5   Max: 80

For VOLUME_DISCOUNT discounts: Must be set to 0 for the first discount rule.