Typical Response Elements Used
The promotion response groups provide a wealth of information about specific items. It is almost always a good idea to include one or both of the promotion response groups in requests that also ask for offers. Among all of the response elements returned by PromotionSummary, the following are typically used in the display of promotion information.
| Response Element | Description |
|---|---|
| BenefitDescription | Describes the benefit, which is the item(s) that the customer receives as a result of the promotion. This element will not be present if the item is not part of the promotional benefits. |
| EligibilityDescription | Describes the items the customer must purchase to qualify for the promotion. This element will not be present if the item does not qualify the customer to receive the promotional benefit. |
| TermsAndConditions | Specifies the terms and conditions of the promotion. |
The following response snippet shows the values for these elements.
<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>
These three elements are meant to be read by people. For that reason, they are returned in HTML.
The other response elements in PromotionDetails are really designed for further processing of the promotion. The following elements from PromotionDetails are helpful.
| Response Element | Description |
|---|---|
| ComponentType | Specifies what the promotion applies to, for example, Shipping, ItemPrice, Subtotal. |
| CouponCombinationType | Specifies the kinds of promotional coupons that can be combined, for example, Unrestricted, Preferential, and Exclusive, where: |
| 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 purchase to qualify for the promotion. |
The following response snippet shows the values for these elements.
<ComponentType>ItemPrice</ComponentType> <CouponCombinationType>Unrestricted</CouponCombinationType> <IsInBenefitSet>true</IsInBenefitSet> <IsInEligibilityRequirementSet>true</IsInEligibilityRequirementSet>
These values show that the promotion is based on discounting the price of the item ("ItemPrice"), that the promotion can be combined with any others ("Unrestricted"), and that the item is both what needs to be bought and what is awarded ("True").
For full responses, see: PromotionDetails and PromotionSummary response groups.
Related Topics