Product Advertising API
Developer Guide (API Version 2011-08-01)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

Benefit and Eligible Items

Items returned by one of the promotions response groups are related to the promotion in one of the following ways:

  • Benefit—The item is part of the promotional reward

    For example, in a buy one camera and get a camera case free promotion, the camera case is the benefit item

  • Eligible—The item is what the customer must purchase to qualify for the promotion

    For example, in a buy one camera and get a camera case free promotion, the camera is the eligible item

  • Both—It is possible for an item to be both the benefit and eligible item

    For example, in a buy two shirts get the third shirt half off promotion, the shirt is both the benefit and the eligible item

The promotions response groups specify whether an item is the benefit or eligible item by using the elements IsInBenefitSet and IsInEligibilitySet.

<IsInBenefitSet>true</IsInBenefitSet>
<IsInEligibilityRequirementSet>true</IsInEligibilityRequirementSet>

The value type for both of these elements is boolean. When "true," the item is part of that set. For example, if IsInBenefitSet is "true," the item is one of the benefits of the promotion.

If IsInBenefitSet is "true," the response also contains the element "BenefitDescription," which describes the benefit item, as shown.

<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>

If IsInEligibilitySet is "true," the response will contain the element, "EligibilityDescription," which describes the eligible item.