Find the answer to your question
Advanced Search
How to send Return Policy AddItem calls family?
Summary
Starting in October 2008, seller is required to clearly specify if returns are accepted, and the restriction applies to most categories. To include Return Policy in a listing, you need to first find out if the category of interest requires return policy, which return policies are supported for the category and then specify Return Policy in Item.ReturnPolicy node.
Detailed Description
1. make GetCategoryFeatures api call and check ReturnPolicyEnabled flag to determine if ReturnPolicy is required for the category of interest, let's take the US CategoryID 2312 as an example.
<?xml version="1.0" encoding="utf-8"?>
<GetCategoryFeaturesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<Version>1219</Version>
<ViewAllNodes>true</ViewAllNodes>
<DetailLevel>ReturnAll</DetailLevel>
<RequesterCredentials>
<eBayAuthToken>xxxx</eBayAuthToken>
</RequesterCredentials>
<FeatureID>ReturnPolicyEnabled</FeatureID>
<CategoryID>2312</CategoryID>
</GetCategoryFeaturesRequest>
<?xml version="1.0" encoding="utf-8"?>
<GetCategoryFeaturesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2022-08-25T08:33:30.828Z</Timestamp>
<Ack>Success</Ack>
<Version>1219</Version>
<Build>E1219_CORE_APICATALOG_19146446_R1</Build>
<CategoryVersion>9795</CategoryVersion>
<UpdateTime>2022-08-25T00:26:56.000Z</UpdateTime>
<Category>
<CategoryID>2312</CategoryID>
<ReturnPolicyEnabled>true</ReturnPolicyEnabled>
</Category>
<SiteDefaults>
<ReturnPolicyEnabled>true</ReturnPolicyEnabled>
</SiteDefaults>
<FeatureDefinitions>
<ReturnPolicyEnabled/>
</FeatureDefinitions>
</GetCategoryFeaturesResponse>
2. As shows in the GetCategoryFeaturesResponse payload, the category takes the ReturnPolicyEnabled=true the site default, we then use GeteBayDetails API to determine the available Return Policy values:
<?xml version="1.0" encoding="utf-8"?>
<GeteBayDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<Version>585</Version>
<RequesterCredentials>
<eBayAuthToken>xxxx</eBayAuthToken>
</RequesterCredentials>
<DetailName>ReturnPolicyDetails</DetailName>
</GeteBayDetailsRequest>
<?xml version="1.0" encoding="utf-8"?>
<GeteBayDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2022-08-25T08:38:18.550Z</Timestamp>
<Ack>Success</Ack>
<Version>1201</Version>
<Build>E1201_CORE_API6_19110890_R1</Build>
<ReturnPolicyDetails>
<Refund>
<RefundOption>MoneyBack</RefundOption>
<Description>Money Back</Description>
</Refund>
<Refund>
<RefundOption>MoneyBackOrReplacement</RefundOption>
<Description>Money back or replacement (buyer's choice)</Description>
</Refund>
<Refund>
<RefundOption>MoneyBackOrExchange</RefundOption>
<Description>Money back or exchange (buyer's choice)</Description>
</Refund>
<ReturnsWithin>
<ReturnsWithinOption>Days_14</ReturnsWithinOption>
<Description>14 Days</Description>
</ReturnsWithin>
<ReturnsWithin>
<ReturnsWithinOption>Days_30</ReturnsWithinOption>
<Description>30 Days</Description>
</ReturnsWithin>
<ReturnsWithin>
<ReturnsWithinOption>Days_60</ReturnsWithinOption>
<Description>60 Days</Description>
</ReturnsWithin>
<ReturnsAccepted>
<ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
<Description>Returns Accepted</Description>
</ReturnsAccepted>
<ReturnsAccepted>
<ReturnsAcceptedOption>ReturnsNotAccepted</ReturnsAcceptedOption>
<Description>No returns accepted</Description>
</ReturnsAccepted>
<Description>true</Description>
<ShippingCostPaidBy>
<ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
<Description>Buyer</Description>
</ShippingCostPaidBy>
<ShippingCostPaidBy>
<ShippingCostPaidByOption>Seller</ShippingCostPaidByOption>
<Description>Seller</Description>
</ShippingCostPaidBy>
<RestockingFeeValue>
<RestockingFeeValueOption>NoRestockingFee</RestockingFeeValueOption>
<Description>No</Description>
</RestockingFeeValue>
<RestockingFeeValue>
<RestockingFeeValueOption>Percent_10</RestockingFeeValueOption>
<Description>10%</Description>
</RestockingFeeValue>
<RestockingFeeValue>
<RestockingFeeValueOption>Percent_15</RestockingFeeValueOption>
<Description>15%</Description>
</RestockingFeeValue>
<RestockingFeeValue>
<RestockingFeeValueOption>Percent_20</RestockingFeeValueOption>
<Description>20%</Description>
</RestockingFeeValue>
<DetailVersion>6</DetailVersion>
<UpdateTime>2022-05-05T09:01:00.000Z</UpdateTime>
</ReturnPolicyDetails>
<UpdateTime>2022-05-05T09:01:00.000Z</UpdateTime>
</GeteBayDetailsResponse>
3. Send the ReturnPolicy options in Item.ReturnPolicy container in AddItem call as below:
<?xml version="1.0" encoding="utf-8"?>
<AddItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<Version>1271</Version>
<ErrorLanguage>en_US</ErrorLanguage>
<WarningLevel>High</WarningLevel>
<Item>
<Country>US</Country>
<Currency>USD</Currency>
<Description>TEST - FlatSimple</Description>
<DispatchTimeMax>3</DispatchTimeMax>
<ListingDuration>Days_7</ListingDuration>
<Location>San Jose, CA</Location>
<PaymentMethods>PaymentSeeDescription</PaymentMethods>
<PaymentMethods>PayPal</PaymentMethods>
<PayPalEmailAddress>ve2@aol.com</PayPalEmailAddress>
<PrimaryCategory>
<CategoryID>2312</CategoryID>
</PrimaryCategory>
<Quantity>1</Quantity>
<StartPrice>1</StartPrice>
<BuyItNowPrice>10</BuyItNowPrice>
<Title>ISDA TEST - FlatSimple</Title>
<ShippingDetails>
<ShippingType>Flat</ShippingType>
<ShippingServiceOptions>
<ShippingServicePriority>1</ShippingServicePriority>
<ShippingService>UPS2ndDay</ShippingService>
<ShippingServiceCost>5</ShippingServiceCost>
<ShippingServiceAdditionalCost>1</ShippingServiceAdditionalCost>
<ShippingSurcharge>1</ShippingSurcharge>
</ShippingServiceOptions>
</ShippingDetails>
<ReturnPolicy>
<ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
<RefundOption>MoneyBack</RefundOption>
<ReturnsWithinOption>Days_30</ReturnsWithinOption>
<Description>Text description of return policy details</Description>
<ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
</ReturnPolicy>
</Item>
<RequesterCredentials>
<eBayAuthToken>XXXXXXXXXXX</eBayAuthToken>
</RequesterCredentials>
</AddItemRequest>