Offer

offerId

The unique identifier of the offer within the promotion.

ruleTemplateName

This enumeration value indicates the conditions of the discount, such as 'Buy N items, and get Y off total'. See the RuleTemplateNameEnum type description for more information on what each value indicates.

This value affects discountBenefit and discountSpecification.

discountBenefit

This enumeration value indicates the discount benefit as either a monetary amount or percentage of the item/order price. See the DiscountBenefitEnum type description for more information on what each value indicates.

discountSpecification

This enumeration value indicates the criteria for when the discount triggers. The discount is applied each time the specified criteria is met. See the DiscountSpecificationEnum type description for more information on what each value indicates.

criteria

The criteria used to define which items are eligible for this offer.

percentageOffItemValue

The percentage that is discounted off the sales price of the item (or items) when the discount criteria is met.

This field will only applicable if the discountBenefit value is PERCENTAGE_OFF_ITEM; it is returned as null otherwise.

percentageOffOrderValue

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 will only applicable if the discountBenefit value is PERCENTAGE_OFF_ORDER; it is returned as null otherwise.

amountOffItemValue

The monetary amount that is discounted off an item (or items) when the discount criteria is met.

This field will only applicable if the discountBenefit value is AMOUNT_OFF_ITEM; it is returned as null otherwise.

amountOffItemCurrency

The currency of the dollar value expressed in the amountOffItemValue field.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

This field will only applicable if the discountBenefit value is AMOUNT_OFF_ITEM; it is returned as null otherwise.

amountOffOrderValue

Used for threshold discounts, this is the monetary amount that is discounted off an order when the discount criteria is met.

This field will only applicable if the discountBenefit value is AMOUNT_OFF_ORDER; it is returned as null otherwise.

amountOffOrderCurrency

The currency of the dollar value expressed in the amountoffOrderValue field.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

This field will only applicable if the discountBenefit value is AMOUNT_OFF_ORDER; it is returned as null otherwise.

minAmountValue

Known as the threshold amount, this is the minimum dollar amount that needs to be spent on discounted items in order to qualify for the discount.

minAmountCurrency

The base currency applied to the value field of minAmountValue to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

forEachAmountValue

The monetary amount that must be spent on discounted items before the discount is applied, which applies for each multiple of this value on a repeating basis.

forEachAmountCurrency

The base currency applied to the value field of forEachAmountValue to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

minQuantity

The minimum quantity of discounted items that need to be bought in order to qualify for the discount.

forEachQuantity

The number of items that must be purchased in order to qualify for the discount, which applies for each multiple of this quantity on a repeating basis.

numberOfDiscountedItems

The number of items to be discounted when other criteria are met, such as forEachQuantity or minQuantity.

For example, when a buyer adds the number of items identified by these fields value to their cart, they can be eligible to receive the stated discount for an additional number of like items (specified by this field). To receive the discount, the buyer must purchase the number of items indicated by forEachQuantity or minQuantity, plus the number indicated by this field (for which they will get the discount).

maxDiscountAmountValue

The maximum monetary amount a buyer can save per discount.

maxDiscountAmountCurrency

The base currency applied to the value field of maxDiscountAmountValue to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.