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

Benefit and Eligible Items

Items returned in the promotion response group 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 buy 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's possible for an item to be the benefit item and the eligible item. For example, in a buy-two-shirts-get-the-third-shirt-half-off promotion, the shirt is the benefit item and the eligible item.

The promotion response groups use the IsInBenefitSet and IsInEligibilitySet elements to specify if an item is the benefit item or the eligible item.

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

The value for these elements is a boolean. For example, if IsInBenefitSet is true, the item is one of the benefits of the promotion, and the response will contain the BenefitDescription element, which describes the benefit item. The following example is a response 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>

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