eBay Trading APIVersion 1061

ReturnPolicyType

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

To get the metadata on the values you can use for specific marketplaces, call GeteBayDetails with DetailName set to ReturnPolicyDetails, review the ReturnPolicyDetails fields in the response.

Note: In version 1061, the options for this field were reduced. eBay will throw an error if you attempt to list an item with this field set to a value that is not accepted by the target marketplace. See the Release Notes for details.

Type that uses ReturnPolicyType:

Calls that use ReturnPolicyType:

Fields



Description ( string ) [0..1]
This field contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored):
  • Germany (DE)
  • Spain (ES)
  • France (FR)
  • Italy (IT)
Where valid, sellers can use this field to add details about their return policies. 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: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.
See the Field Index to learn which calls use Description.

ExtendedHolidayReturns ( boolean ) [0..1]
Not used by any call.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports extended holiday returns.
See the Field Index to learn which calls use ExtendedHolidayReturns.

InternationalRefundOption ( token ) [0..1]
This field indicates how the seller compensates buyers for remorse returns. You must set this value to MoneyBack for all eBay marketplaces except for the US marketplace.

On EBAY_US: You can set this value to either MoneyBack or MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, you can set MoneyBackOrReplacement. Otherwise, eBay recommends you set this value to its default value, MoneyBack. For AddItem, VerifyAddItem, and RelistItem (and corresponding FixedPrice calls): If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not supply this field, some eBay sites may set a default value (like MoneyBack) and sellers are obligated to honor the policies set settings on their View Item pages.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.
See the Field Index to learn which calls use InternationalRefundOption.

InternationalReturnsAcceptedOption ( token ) [0..1]
This optional field indicates whether or not the seller accepts international returns (returns that need to be shipped via an international shipping service).

Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows international returns. If the seller does not accept international returns, they can specify ReturnsNotAccepted.

On the eBay DE, IE, and UK, registered 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. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.
See the Field Index to learn which calls use InternationalReturnsAcceptedOption.

InternationalReturnsWithinOption ( token ) [0..1]
A buyer can return an item that was shipped to an international location to the seller within the period of time specified by this field. The time period begins the day the buyer receives the item.

Applicable values: To get the applicable ReturnsWithinOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts international returns (InternationalReturnsAcceptedOption is set to ReturnsAccepted) but you do specify this field for a listing, eBay sets a default value (often Days_30) and the seller is obligated to honor this setting.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.
See the Field Index to learn which calls use InternationalReturnsWithinOption.

InternationalShippingCostPaidByOption ( token ) [0..1]
This option specifies either the buyer or the seller as the party who pays for international return shipping charges. Accepted values are Buyer or Seller. eBay sites often set Seller as the default value for this field, and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (InternationalReturnsAcceptedOption = ReturnsAccepted) but does not set this field when listing an item, some eBay sites may set a default value (like Buyer). Because sellers are obligated to honor the policies specified on their View Item pages, be sure this is set to the value desired by the seller.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.
See the Field Index to learn which calls use InternationalShippingCostPaidByOption.

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.

This field is applicable to only the US marketplace and is 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]
This field indicates how the seller compensates buyers for remorse returns. You must set this value to MoneyBack for all eBay marketplaces except for the US marketplace.

On EBAY_US: You can set this value to either MoneyBack or MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, you can set MoneyBackOrReplacement. Otherwise, eBay recommends you set this value to its default value, MoneyBack. For AddItem, VerifyAddItem, and RelistItem (and corresponding FixedPrice calls): If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not supply this field, some eBay sites may set a default value (like MoneyBack) and sellers are obligated to honor the policies set settings on their View Item pages.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.
See the Field Index to learn which calls use RefundOption.

RestockingFeeValue ( token ) [0..1]
Not used by any call.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer allows sellers to charge a restocking fee when returning items.
See the Field Index to learn which calls use RestockingFeeValue.

RestockingFeeValueOption ( token ) [0..1]
Not used by any call.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer allows sellers to charge a restocking fee when returning items.
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]
This required field indicates whether or not the seller accepts returns.

Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows items to be returned. Specify ReturnsNotAccepted for an item if the seller does not accept returns.

On the eBay DE, IE, and UK, registered 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. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response.

Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (ReturnsAcceptedOption = ReturnsAccepted) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using 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.



For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.
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]
Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

Applicable values: Retrieve the values supported by a marketplace by calling GeteBayDetails with DetailName set to ReturnPolicyDetails, then review ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption in the response.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: In version 1061, the options for this field were reduced. An error will be thrown if you attempt to list an item with this field set to a value that is not accepted by the target marketplace. See the Release Notes for details.
See the Field Index to learn which calls use ReturnsWithinOption.

ShippingCostPaidBy ( string ) [0..1]
This is a 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]
This option specifies either the buyer or the seller as the party who pays for return shipping charges. Accepted values are Buyer or Seller. eBay sites often set Seller as the default value for this field, and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.

Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and review the returned ReturnPolicyDetails.ShippingCostPaidBy values to see the values supported by a marketplace.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.
See the Field Index to learn which calls use ShippingCostPaidByOption.

WarrantyDuration ( string ) [0..1]
Not used by any call.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
See the Field Index to learn which calls use WarrantyDuration.

WarrantyDurationOption ( token ) [0..1]
Not used by any call.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
See the Field Index to learn which calls use WarrantyDurationOption.

WarrantyOffered ( string ) [0..1]
Not used by any call.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
See the Field Index to learn which calls use WarrantyOffered.

WarrantyOfferedOption ( token ) [0..1]
Not used by any call.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
See the Field Index to learn which calls use WarrantyOfferedOption.

WarrantyType ( string ) [0..1]
Not used by any call.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
See the Field Index to learn which calls use WarrantyType.

WarrantyTypeOption ( token ) [0..1]
Not used by any call.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns.
See the Field Index to learn which calls use WarrantyTypeOption.