The PromotionDetails response group returns detailed information about promotions (if any) related to items in a response. Included is information about the merchant offering the promotion, claim codes for the promotion, allowed promotion combinations, the type of promotion, the promotion ID, elegibility requirements, and the terms and conditions of the promotion. Some of this information is also returned by the PromotionSummary response group.
Promotions are only associated with items that have offers. For that reason, a request that uses PromotionDetails must also include one of the following response groups:
Large
OfferFull
Offers
An error is returned if ProductDetails is not accompanied by one of these response groups in the request.
For more information, see Displaying Promotions.
There are many different kinds of promotion categories. The ones fully supported by ECS are:
FreeShipping--The item is shipped free of charge.
BuyQuantityXGetAmountOffX--If you buy at least the specified number of items, the cost of the next item is discounted. For example, if a customer buys three shirts, the fourth shirt is half off.
ForEachQuantityXGetAmountOffX--Each item is discounted by the specified amount. For example, all shirts are 30% off.
For all other promotion categories, only some of the promotional information is returned.
Operations that can use this response group are:
ItemLookup
ItemSearch
ListLookup
SimilarityLookup
The following table describes and shows the ancestry of the elements returned by PromotionDetails. The elements on the left side of a slash mark are the parents of the elements on the right side of the slash mark.
All of the elements in the following table, except Promotions, Promotion, and Details, are children of Promotions/Promotion/Details.
| Response Element | Ancestry | Definition |
|---|---|---|
| Amount |
EligibilityRequirements/EligibilityRequirement/CurrencyAmount Benefits/Benefit/FixedAmount/ |
Price expressed in the lowest currency denomination, for example, pennies. When Amount is part of EligibilityRequirementCurrency, the amount refers to the minimum purchase price necessary to be awarded the promotion, for example, "On purchases of $50 or more...." When Amount is part of Benefits, the amount is part of the benefit of the promotion, for example, $10 off. |
| ASIN | ItemApplicability/ | An alphanumeric token that uniquely identifies an item. |
| Benefit | Benefits/ | Container for information relating to a promotional benefit. Elements in the container include BenefitType and FixedAmount. |
| Benefits | Container for one or more Benefit elements. | |
| BenefitType | Benefits/Benefit/BenefitType/ | Specifies the type of promotion, for example, Free, FixedAmountOff, PercentOff, and TieredFixedAmountOff. |
| ComponentType | Benefits/Benefit/ | 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. | |
| CurrencyAmount | EligibilityRequirements/EligibilityRequirement/ | Price in terms of the lowest currency denomination, for example, pennies. This is the minimum price a customer must pay to qualify for the promotion. |
| CurrencyCode |
EligibilityRequirements/EligibilityRequirement/CurrencyAmount Benefits/Benefit/FixedAmount |
An abbreviation that specifies how to format the price. |
| Details | Container for elements that programmatically describe a promotion. | |
| EligibilityRequirement | EligibilityRequirements/ | Container for one or more EligibilityRequirementType elements. |
| EligibilityRequirementType | EligibilityRequirements/EligibilityRequirement/ | Specifies the eligibility requirements to qualify for the promotion, for example, MinPurchase, MinQuantity, or, ForEachQuantity. |
| EligibilityRequirements | Container for one or more EligibilityRequirement elements. | |
| FixedAmount | Benefits/Benefit/ | Specifies the price in terms of the lowest currency denomination. |
| FormattedPrice |
EligibilityRequirements/EligibilityRequirement/CurrencyAmount Benefits/Benefit/FixedAmount/ |
The price formatted for display. Specifies the money awarded as part of the promotion. |
| GroupClaimCode | An alphanumeric token to use to claim the promotional benefit. | |
| IsInBenefitSet | ItemApplicability/ | A boolean value. When "true," the associated ASIN is what the customer receives as part of the promotion. |
| IsInEligibilityRequirementSet | ItemApplicability/ | A boolean value. When "true," the associated ASIN is one of the items the customer must purchase to qualify for the promotion. |
| ItemApplicability | ItemApplicability/ItemApplicability/ItemApplicability | Container for ASIN, IsInBenefitSet, and IsInEligibilityRequirementSet. This group of values specifies whether the ASIN is what the customer receives as part of the promotion, whether the ASIN is what the customer needs to purchase to qualify for the promotion, or both. |
| MerchantId | The legacy merchant ID that is associated with the promotion. In contrast, the element, OwningMerchantId, is an updated ID for the same merchant. These IDs may or may not be the same. | |
| OwningMerchantId | The merchant ID that owns the promotion. OwningMerchantId is an updated ID for MerchantId. These IDs may or may not be the same. | |
| Promotion | Offers/Offer/Promotions | Container for one Details elements. |
| PromotionCategory | Offers/Offer/Promotions/Promotion/Summary | Specifies the kind of promotion. Valid values include FreeShipping, BuyAmountXGetAmountOffX, and ForEachAmountXGetAmountOffX. For more information, see Promotion Types. |
| PromotionId | Offers/OfferPromotions/Promotion/Summary | An alphanumeric token that uniquely identifies a promotion. |
| Promotions | Offers/Offer | A container for one or more Promotion elements. |
| TermsAndConditions | Offers/OfferPromotions/Promotion/Summary | HTML that specifies the terms and conditions of the promotion. |
PromotionDetails also returns the elements that all response groups return.
The following response groups are parent response groups of PromotionDetails.
None
The following response groups are children response groups of PromotionDetails.
None
The folllowing request was used to illustrate the XML response elements returned by PromotionDetails.
http://ecs.amazonaws.com/onca/xml?Service=AWSECommerceService& Operation=ItemLookup& ContentType=text/xml& AWSAccessKeyId=[Access Key ID]& ItemId=B000AQSMPO& IdType=ASIN& ResponseGroup=Offers,PromotionDetails& Version=2007-02-22
The following response snippet shows the elements returned by PromotionDetails.
<Promotions>
<Promotion>
<Details>
<MerchantId>ATVPDKIKX0DER</MerchantId>
<OwningMerchantId>ATVPDKIKX0DER</OwningMerchantId>
<PromotionId>A2QIQTNOFYRK5N</PromotionId>
<PromotionCategory>BuyAmountXGetAmountOffX</PromotionCategory>
<GroupClaimCode>AUGSAVER</GroupClaimCode>
<CouponCombinationType>Unrestricted</CouponCombinationType>
<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. <LI>At checkout, enter the promotional code and click the <STRONG>Apply</STRONG> button. <LI>The amount of the Best Value savings ($25) will be reflected on the final order checkout page. <LI>If you remove any of the participating promotion items from your Shopping Cart or violate any of the terms and conditions listed below, the promotion will be invalid, and the discount will be removed from the order. <LI>If you return any of the items involved in the promotion, the discount previously applied to the order will be subtracted from the return credit. </LI></OL><BR><STRONG>Terms and Conditions:</STRONG> <UL> <LI>Promotional offer valid for a limited time only. Items placed in Shopping Cart overnight may not be eligible for promotion at time of checkout. <LI>Promotion applies only to qualifying items displaying the offer message on their product information pages. Items that do not display the offer message do not qualify, regardless of the nature of the item. All All Clad, Calphalon, Capresso, Emerilware, Le Creuset, Orrefors, Kosta Boda, J.A. Henckels, Wusthof, Riedel, Marquis, Shun, Komachi, Waterford, Weber, Tassimo, Margaritaville, DKNY, Tommy Hilfiger, Nautica, Oscar by Oscar de Larenta, Cath Kidston, Raymond Waites, and KitchenAid Proline products are excluded from this offer <LI>All Furniture & Decor and Outdoor Living products are excluded from this offer. <LI>Applies only to products sold by the merchant indicated in the promotional offer message. Does not apply to items sold by other merchants on the Amazon.com Web site. For example, where the promotional offer applies to items offered by Amazon.com, items offered by other merchants on the Amazon.com Web site (e.g. Land's End, Target, etc.) do not qualify. <LI>Does not apply to any products purchased in Amazon.com's other sites, including Amazon.co.uk, Amazon.de, Amazon.fr, or Amazon.co.jp, or in Marketplace, zShops, or Auctions. <LI>Unless the offer message indicates otherwise, the promotional offer applies to the lowest priced qualifying item(s) <LI>Applies only when all qualifying and benefit products in the promotion are purchased in one order. <LI>Applies only to complete orders shipping to a single address that meet all other promotional requirements. <LI>Offer good while supplies last. <LI>No substitutions or rain checks. <LI>Offer must be redeemed through the Shopping Cart. Does not apply to orders placed with 1 Click. <LI>Shipping and handling charges apply to all products, including bonus items. <LI>Offer may not be combined with other offers, including promotional certificates. <LI>Void where prohibited. </LI></UL></TermsAndConditions>
<EligibilityRequirements>
<EligibilityRequirement>
<EligibilityRequirementType>MinPurchase</EligibilityRequirementType>
<CurrencyAmount>
<Amount>12500</Amount>
<CurrencyCode>USD</CurrencyCode>
<FormattedPrice>$125.00</FormattedPrice>
</CurrencyAmount>
</EligibilityRequirement>
</EligibilityRequirements>
<Benefits>
<Benefit>
<BenefitType>FixedAmountOff</BenefitType>
<ComponentType>ItemPrice</ComponentType>
<FixedAmount>
<Amount>2500</Amount>
<CurrencyCode>USD</CurrencyCode>
<FormattedPrice>$25.00</FormattedPrice>
</FixedAmount>
</Benefit>
</Benefits>
<ItemApplicability>
<ASIN>B000AQSMPO</ASIN>
<IsInBenefitSet>true</IsInBenefitSet>
<IsInEligibilityRequirementSet>true</IsInEligibilityRequirementSet>
</ItemApplicability>
</Details>
</Promotion>
</Promotions>