eBay Trading APIVersion 1039

ReturnPolicyType

Type used to express the details of the return policy for an item.

Type that uses ReturnPolicyType:

Calls that use ReturnPolicyType:

Fields



Description ( string ) [0..1]
A detailed explanation of the seller's return policy.

eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML, and avoid character entity references (such as £ or £). If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. £).

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption = ReturnsAccepted) but does not specify this field when listing the item, GetItem returns this as an empty node

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.
See the Field Index to learn which calls use Description.

ExtendedHolidayReturns ( boolean ) [0..1]
When you list an item by using the Add/Revise/Relist families of calls, use this field to enable an Extended Holiday Returns policy for the item. A value of true indicates the seller is offering the item with an extended holiday returns period.

IMPORTANT: Extended Holiday Returns is a seasonally available feature, but it might not be made available every year. To ensure that the feature is enabled in any given year, check the Returns on eBay page of the eBay Seller Center before the holiday season starts. If the feature is not enabled for the season, this field is ignored. The extended holiday returns period is defined by three dates:
  • The start date - start of November.
  • The purchase cutoff date - end of the year.
  • The end date - end of January.
Note: These dates may vary by a few days each year. Sellers will be notified of the current dates on their eBay site before the holiday period starts. Sellers can specify Extended Holiday Returns (as well as their regular non-holiday returns period) for chosen listings at any time during the year. The Extended Holiday Returns offer is not visible in the listings until the current year's holiday returns period start date, at which point it overrides the non-holiday returns policy. Buyers will see and be subject to the Extended Holiday Returns offer in listings purchased through the purchase cutoff date, and will be able to return those purchases through the end date.

After the purchase cutoff date, the Extended Holiday Returns offer automatically disappears from listings, and the seller's non-holiday returns period reappears. Purchases made from that point on are subject to the non-holiday returns period, while purchases made before the cutoff date still have until the end date to be returned.

If the value of ExtendedHolidayReturns is false for an item, the returns period specified by the ReturnsWithinOption field applies, regardless of the purchase date. If the item is listed with a policy of no returns, ExtendedHolidayReturns is automatically reset to false.

For the AddItem family of calls, the value of ExtendedHolidayReturns is false by default.

For the ReviseItem family of calls, you can omit ExtendedHolidayReturns from the input if its value does not need to change. If the item being revised has bids or orders, you can add the extended holiday returns option to the listing, but you can't remove it. If the item does not have bids or orders, you can add or remove the extended holiday returns option; however, this is a significant revision, triggering a version change in the listing.

For the RelistItem family of calls, you can omit ExtendedHolidayReturns from the input if its value does not need to change.

For the GetItem call, ExtendedHolidayReturns is returned only if the site you sent the request to supports the seller's return policy. Typically, this is only when the request is sent to the listing site.

Note: Top-Rated Sellers offering Extended Holiday Returns on a listing will get an additional 5 percent discount on the Final Value Fees on top of the 20 percent discount they get for creating Top-Rated Plus qualifying listings. See the Becoming a Top Rated Seller and qualifying for Top Rated Plus help topic for more information on Top-Rated Seller, Top-Rated Plus requirements, and the 5 percent bonus discount for Extended Holiday Returns.
See the Field Index to learn which calls use ExtendedHolidayReturns.

Refund ( string ) [0..1]
Display string that buyer applications can use to present RefundOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the Refund.Description options returned by GeteBayDetails.

Not applicable as input to the Add/Revise/Relist family of calls. (Use RefundOption instead.)
See the Field Index to learn which calls use Refund.

RefundOption ( token ) [0..1]
Indicates how the seller will compensate the buyer for a returned item. Use the ReturnPolicy.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details.).

The RefundOption field is not supported by any of the European sites.

Applicable values: To get the applicable RefundOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.Refund.RefundOption fields in the response.

For Add/Revise/Relist/VerifyAdd API calls): If the seller accepts returns (ReturnsAcceptedOption = ReturnsAccepted) but you do not pass in this RefundOption field when listing the item, some eBay sites may set a default value (like MoneyBack), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For Revise calls only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

Note: The RefundOption values supported on the US site are MoneyBack and MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, MoneyBackOrReplacement can be used. A seller with limited inventory of an item should use the MoneyBack option.
See the Field Index to learn which calls use RefundOption.

RestockingFeeValue ( token ) [0..1]
Display string that indicates the restocking fee charged by the seller for returned items. This value is directly related to the RestockingFeeValueOption value, with the difference being that applications can use RestockingFeeValue to present the RestockingFeeValueOption value in a more user-friendly format when used in a GUI features such as option buttons or drop-down lists.
See the Field Index to learn which calls use RestockingFeeValue.

RestockingFeeValueOption ( token ) [0..1]
This enumeration value indicates the restocking fee percentage values that a seller can charge to a buyer who is returning an item due to buyer remorse and/or a purchasing mistake. A restocking fee is not applicable for an item that is being returned because it was not as described. Restocking fees are only applicable to the US and Canadian sellers who have opted into eBay Managed Returns.

In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value at listing time (either through the ReturnPolicy) or through a Return Business Policy that is applied to the listing.

To obtain the list of currently supported values, call GeteBayDetails with DetailName set to ReturnPolicyDetails. Then, look for the list of restocking fee percentage values in the ReturnPolicyDetails.RestockingFeeValue containers in the response.

For Get calls: The RestockingFeeValue field is directly related to RestockingFeeValueOption, and gives a user-friendly description of the restocking fee policy.
See the Field Index to learn which calls use RestockingFeeValueOption.

ReturnsAccepted ( string ) [0..1]
Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces.

If necessary, you can predict the choice of values based on the ReturnsAccepted.Description options returned by GeteBayDetails.
Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.)
See the Field Index to learn which calls use ReturnsAccepted.

ReturnsAcceptedOption ( token ) [0..1]
Indicates whether the seller allows the buyer to return the item. This field is required when ReturnPolicy is specified. If you specify ReturnsNotAccepted, the View Item page will indicate that returns are not accepted instead.)

All sites support the ability for a seller to not accept returns. If the seller doesn't accept returns, the item must specifically indicate ReturnsNotAccepted. (The return policy cannot be omitted from the item.)

On the eBay UK and Ireland sites, business sellers must accept returns for fixed-price items (including auction items with Buy It Now, and any other fixed price formats) when the category requires a return policy. On some European sites (such as eBay Germany (DE), registered business sellers are required to accept returns. Your application can call GetUser to determine a user's current business seller status.

Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for the item (ReturnsAcceptedOption = ReturnsAccepted) and handling time should be set to zero days (same-day shipping) or one day. The handling time is set through an integer value in the Item.DispatchTimeMax field.

Top-Rated listings qualify for the greatest average boost in Best Match and for the 20 percent Final Value Fee discount. For more information on eBay's Top-Rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page.

Applicable values: To get the applicable ReturnsAcceptedOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ReturnsAccepted.Description fields in the response. ReturnsAcceptedOptionsCodeType defines all the possible values.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.
See the Field Index to learn which calls use ReturnsAcceptedOption.

ReturnsWithin ( string ) [0..1]
Display string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces.

If necessary, you can predict the choice of values based on the ReturnsWithin.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use ReturnsWithinOption instead.)
See the Field Index to learn which calls use ReturnsWithin.

ReturnsWithinOption ( token ) [0..1]
The buyer can return the item within this period of time from the day they receive the item. Use the ReturnPolicy.Description field to explain the policy details.

Applicable values: To get the applicable ReturnsWithinOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption fields in the response. ReturnsWithinOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption = ReturnsAccepted) but you do not pass in this ReturnsWithinOption field when listing the item, some eBay sites may set a default value (like Days_14), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.
See the Field Index to learn which calls use ReturnsWithinOption.

ShippingCostPaidBy ( string ) [0..1]
Display string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces.

If necessary, you can predict the choice of values based on the ShippingCostPaidBy.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use ShippingCostPaidByOption instead.)
See the Field Index to learn which calls use ShippingCostPaidBy.

ShippingCostPaidByOption ( token ) [0..1]
The party who pays the shipping cost for a returned item. Use the ReturnPolicy.Descriptio field to explain any additional details.

Applicable values: To get the applicable ShippingCostPaidByOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ShippingCostPaidBy.ShippingCostPaidByOption fields in the response. ShippingCostPaidByOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption = ReturnsAccepted) but you do not pass in this ShippingCostPaidByOption field when listing the item, some eBay sites may set a default value (like Buyer), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.
See the Field Index to learn which calls use ShippingCostPaidByOption.

WarrantyDuration ( string ) [0..1]
Display string that buyer applications can use to present

WarrantyDurationOption in a more user-friendly format to buyers. For example, GetItem and related calls, this value is usually localized and can contain spaces.

If necessary, you can predict the choice of values based on the WarrantyDuration.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use WarrantyDurationOption instead.)
See the Field Index to learn which calls use WarrantyDuration.

WarrantyDurationOption ( token ) [0..1]
The warranty period.

Applicable values: To get the applicable WarrantyDurationOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyDuration.WarrantyDurationOption fields in the response. WarrantyDurationOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption = ReturnsAccepted) but you do not pass in this WarrantyDurationOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.
See the Field Index to learn which calls use WarrantyDurationOption.

WarrantyOffered ( string ) [0..1]
Display string that buyer applications can use to present WarrantyOfferedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces.

If necessary, you can predict the choice of values based on the WarrantyOffered.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use WarrantyOfferedOption instead.)
See the Field Index to learn which calls use WarrantyOffered.

WarrantyOfferedOption ( token ) [0..1]
Indicates whether a warranty is offered for the item.
Applicable values:
To get the applicable WarrantyOfferedOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyOffered.WarrantyOfferedOption fields in the response. WarrantyOfferedCodeType defines all the possible values.
Note: Only the eBay India site supports this field.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption = ReturnsAccepted) but you do not pass in this WarrantyOfferedOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

Note: For the US eBay Motors limited warranty (Short-Term Service Agreement) option, use Item.LimitedWarrantyEligible instead.

For the US eBay Motors "Is There an Existing Warranty?" option, use Item.AttributeSetArray instead.
For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.
See the Field Index to learn which calls use WarrantyOfferedOption.

WarrantyType ( string ) [0..1]
Display string that buyer applications can use to present WarrantyTypeOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces.

If necessary, you can predict the choice of values based on the WarrantyType.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use WarrantyTypeOption instead.)
See the Field Index to learn which calls use WarrantyType.

WarrantyTypeOption ( token ) [0..1]
Indicates the source or type of the warranty, if any. Note: Only the eBay India site supports this field.

Applicable values: To get the applicable WarrantyTypeOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyType.WarrantyTypeOption fields in the response. WarrantyTypeOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption = ReturnsAccepted) but you do not pass in this WarrantyTypeOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.
See the Field Index to learn which calls use WarrantyTypeOption.