Menu
Product Advertising API
Developer Guide (API Version 2013-08-01)

Common Response Elements

The following response elements are commonly used to display promotion information.

Response Element Description
BenefitDescription Describes the benefit, which is the item(s) the customer receives for the promotion. The element will not appear if the item is not part of the promotional benefit.
EligibilityRequirementDescription Describes the item(s) the customer must buy to qualify for the promotion. The element will not appear if the item does not qualify for the promotional benefit.
TermsAndConditions Specifies the terms and conditions of the promotion.

The following response snippet shows the values for BenefitDescription.

Copy
<BenefitDescription>Save $25.00 when you spend $125.00 or more on Kitchen & Housewares or Bed & Bath products offered by Amazon.com. Enter code AUGSAVER at checkout.</BenefitDescription> <TermsAndConditions><STRONG>To receive the Best Value discount:</STRONG> <OL> <LI>Add $125 of qualifying Kitchen & Housewares or Bed & Bath products to your Shopping Cart via the <STRONG>Add to Shopping Cart</STRONG> button on each respective product information page. … </TermsAndConditions>
Response Element Description
ComponentType Specifies what the promotion applies to, such as Shipping, ItemPrice, and Subtotal.
CouponCombinationType Specifies the type of promotional coupons that can be combined.
  • Unrestricted—Can be used with other promotions.

  • Preferential—Can be used with some promotions.

  • Exclusive—Cannot be used with other promotions.

FormattedPrice The price formatted for display.
IsInBenefitSet A boolean value. When true, the associated ASIN is what the customer receives as part of the promotion.
IsInEligibilityRequirementSet A boolean value. When true, the associated ASIN is what the customer must buy to qualify for the promotion.

The following response snippet shows the values for these elements.

Copy
<ComponentType>ItemPrice</ComponentType> <CouponCombinationType>Unrestricted</CouponCombinationType> <IsInBenefitSet>true</IsInBenefitSet> <IsInEligibilityRequirementSet>true</IsInEligibilityRequirementSet>

The response shows the promotion is a price discount. The promotion can be combined with other promotions. To qualify, the customer must buy the item. The same item is also given as part of the promotion.

For more information, see PromotionSummary Response Group.