Skip to main content
Published: May 10 2007, 4:23:00 PMUpdated: November 28 2020, 3:40:32 PM

How can I use the promotional shipping feature when using the API?

Listing with the promotional shipping feature

Summary

Specify <PromotionalShippingDiscount>true</PromotionalShippingDiscount> in the Item.ShippingDetails container of the AddItem request to mark an item eligible for the promotional shipping discount.

<?xml version="1.0" encoding="utf-8"?>
<AddItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
 <ErrorLanguage>en_US</ErrorLanguage>
 <WarningLevel>High</WarningLevel>
 <Version>511</Version>
 <Item>
   <BuyItNowPrice>10.0</BuyItNowPrice>
   <Country>US</Country>
   <Currency>USD</Currency>
   <Description>Testing</Description>
   <ListingDuration>Days_7</ListingDuration>
   <Location>San Jose, CA</Location>
   <PaymentMethods>PaymentSeeDescription</PaymentMethods>
   <PrimaryCategory>
     <CategoryID>1463</CategoryID>
   </PrimaryCategory>
   <Quantity>1</Quantity>
   <ReservePrice>5.0</ReservePrice>
   <StartPrice>1.0</StartPrice>
   <Title>Testing</Title>
   <ShippingDetails>
     <PromotionalShippingDiscount>true</PromotionalShippingDiscount>
     ...
   </ShippingDetails>
   ...
 <Item>
</AddItemRequest>


Detailed Description

Sellers can specify a promotional shipping rule in their My eBay: Combined Payments and Shipping Discounts settings.
The rule can also be established through the SetShippingDiscoutProfiles call as in this example that sets a new promotional discount for the following rule.
  • Spend $50 on 2 or more items and shipping is Free
    <?xml version="1.0" encoding="utf-8"?>
    <SetShippingDiscountProfilesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
     <RequesterCredentials>
       <eBayAuthToken>token</eBayAuthToken>
     </RequesterCredentials>
     <Version>511</Version>
     <CombinedDuration>Days_14</CombinedDuration>
     <CurrencyID>USD</CurrencyID>
     <ModifyActionCode>Add</ModifyActionCode>
     <PromotionalShippingDiscountDetails>
       <DiscountName>ShippingCostXForAmountY</DiscountName>
       <OrderAmount currencyID="USD">50</OrderAmount>
       <ShippingCost>0</ShippingCost>
     </PromotionalShippingDiscountDetails>

     <ShippingInsurance>
       <InsuranceOption>NotOffered</InsuranceOption>
     </ShippingInsurance>
     <InternationalShippingInsurance>
       <InsuranceOption>NotOffered</InsuranceOption>
     </InternationalShippingInsurance>
    </SetShippingDiscountProfilesRequest>
For a promotional discount to be applied to an item in an order at Checkout time, the following criteria must be met:

  • The promotional discount must have been in effect when the item was listed.
  • The item must have been opted into that promotional discount when listed using <PromotionalShippingDiscount>true</PromotionalShippingDiscount>.
  • The promotional discount must have been in effect when the transaction was created for that item.
Keep in mind that this rule applies to combined payments only.



Additional Resources

How well did this answer your question?
Answers others found helpful