eBay Merchant Data APIVersion 1177

ReturnPolicyType

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

Historically, the GeteBayDetails call has been used to retrieve site-level return policy metadata. However, the GetCategoryFeatures call is now recommended instead because this call now returns category-level metadata for both domestic and international return policies.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. For more information on setting separate domestic and international return policies, see the International returns policy help topic.

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)
  • Austria (AT)
  • France (FR)
  • Italy (IT)
  • Spain (ES)
Where valid, sellers can use this field to add details about their return policies. eBay uses this text string as-is in the additional details 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 international buyers for returns. MoneyBack is the only supported value for all marketplaces except for the US. On the US marketplace, you can set this value to either MoneyBack or MoneyBackOrReplacement. MoneyBackOrReplacement can be used by sellers that have the depth of inventory to support an exchange for an identical item. However, ultimately, it is up to the buyer on whether they want money back or a replacement item.

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: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the refund option(s) for international returns will default to the value specified in the RefundOption field.
See the Field Index to learn which calls use InternationalRefundOption.

InternationalReturnsAcceptedOption ( token ) [0..1]
This field is conditionally required if a seller wants to use a separate return policy for international returns. The value in this field indicates whether or not the seller accepts returns from international buyers.

Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows international buyers to return items. Specify ReturnsNotAccepted for a listing if returns are not accepted from international buyers.

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.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the return accepted value for international returns will default to the value specified in the ReturnsAcceptedOption field.
See the Field Index to learn which calls use InternationalReturnsAcceptedOption.

InternationalReturnsWithinOption ( token ) [0..1]
This field is conditionally required if a seller is using a separate return policy for international returns, and is accepting international returns. The value in this field indicates the number of days that an international buyer has to return an item. The time period begins on the day that the buyer receives the item. 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.

Applicable values: Retrieve the values supported by a marketplace and category by calling GetCategoryFeatures with FeatureID set to InternationalReturnsDurationValues, then see the values returned under the Category.InternationalReturnsDurationValues container in the response.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts international returns (InternationalReturnsAcceptedOption is set to ReturnsAccepted) but does not 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.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the return period for international returns will default to the value specified in the ReturnsWithinOption field.
See the Field Index to learn which calls use InternationalReturnsWithinOption.

InternationalShippingCostPaidByOption ( token ) [0..1]
This field is conditionally required if a seller is using a separate return policy for international returns, and is accepting international returns. The value in this field specifies whether the buyer or the seller 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.

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 or for late shipments.

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: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, return shipping cost payee for international returns will default to the value specified in the ShippingCostPaidByOption field.
See the Field Index to learn which calls use InternationalShippingCostPaidByOption.

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

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 returns. MoneyBack is the only supported value for all marketplaces except for the US. On the US marketplace, you can set this value to either MoneyBack or MoneyBackOrReplacement. MoneyBackOrReplacement can be used by sellers that have the depth of inventory to support an exchange for an identical item. However, ultimately, it is up to the buyer on whether they want money back or a replacement item.

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: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalRefundOption field.
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]
Not used by any call.

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 a listing if returns are not accepted.

On the eBay DE, IE, and UK marketplaces, 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 Seller levels and performance standards 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.

Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalReturnsAcceptedOption field.
See the Field Index to learn which calls use ReturnsAcceptedOption.

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

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 and category by calling GetCategoryFeatures with FeatureID set to DomesticReturnsDurationValues, then see the values returned under the Category.DomesticReturnsDurationValues container 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: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalReturnsWithinOption field.
See the Field Index to learn which calls use ReturnsWithinOption.

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

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 whether the buyer or the seller 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 or for late shipments.

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: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalShippingCostPaidByOption field.
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.