ReturnPolicyType

Type for the return policy details of an item.

Types that use ReturnPolicyType:

Calls that use one or more fields of ReturnPolicyType:

Fields

Description ( string )
EAN ( string )
Refund ( string )
RefundOption ( token )
RestockingFeeValue ( token )
RestockingFeeValueOption ( token )
ReturnsAccepted ( string )
ReturnsAcceptedOption ( token )
ReturnsWithin ( string )
ReturnsWithinOption ( token )
ShippingCostPaidBy ( string )
ShippingCostPaidByOption ( token )
WarrantyDuration ( string )
WarrantyDurationOption ( token )
WarrantyOffered ( string )
WarrantyOfferedOption ( token )
WarrantyType ( string )
WarrantyTypeOption ( token )

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.

EAN ( string ) [0..1]
The European Article Number (EAN) associated with the item, if any. To determine if your site supports this field, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for a 'true' value in the ReturnPolicyDetails.EAN field. Only returned if the seller has specified this value in their return policy.

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 EAN.

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 AddItem 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: As of version 771, listings created, revised, or relisted on the US site with deprecated RefundOption and/or ReturnsWithinOption values (using Add/Revise/Relist API calls) will be blocked.

For RefundOption, the deprecated values for the US site are MerchandiseCredit and Exchange. Instead of these deprecated values, the seller must offer a MoneyBack or a MoneyBackOrExchange refund option. Consider using the MoneyBackOrExchange option when you have the depth of inventory to support an exchange for a different size, color, or undamaged unit. Otherwise, use the MoneyBack option if you have limited inventory.
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 charged by the seller for returned items. In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy.

For Add/Revise/Relist calls: To obtain the list of applicable values, call GeteBayDetails with DetailName set to ReturnPolicyDetails. Then look for the list of restocking fee value options in the ReturnPolicyDetails.RestockingFeeValue container 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 may initially show the return policy as unspecified. In a future release, the View Item page will be updated to 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 one day (or zero days when same-day shipping becomes available in late May). The handling time is set through 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 changes to 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.

Note: As of version 771, listings created, revised, or relisted with deprecated RefundOption and/or ReturnsWithinOption values (using Add/Revise/Relist API calls) will be blocked.

For ReturnsWithinOption, the deprecated values are Days_3 and Days_7. Instead of these deprecated values, the seller must offer a 14-day, 30-day, or 60-day return window.

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.Description 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, 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 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.

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.
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 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.

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.