account APIv1.4.0

getReturnPolicies

GET
/return_policy/
This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter.

Marketplaces and locales

Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: fr-BE. For details on header values, see HTTP request headers.

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/return_policy/?

URI parameters

ParameterTypeDescription
marketplace_idMarketplaceIdEnumThis query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one scope from the following list:

https://api.ebay.com/oauth/api_scope/sell.account

https://api.ebay.com/oauth/api_scope/sell.account.readonly

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
hrefstringReturns a URL link to the current result set.

Occurrence: Conditional

limitintegerReturns the maximum number of results that can be returned in result set.

Occurrence: Conditional

nextstringReturns a URL link to the next set of results.

Occurrence: Conditional

offsetintegerReturns how many result sets were skipped before the currently returned result set.

Occurrence: Conditional

prevstringReturns a URL link to the previous set of results.

Occurrence: Conditional

returnPoliciesarray of ReturnPolicyA list of the seller's return policies.

Occurrence: Conditional

returnPolicies.categoryTypesarray of CategoryTypeFor return policies, this field can be set to only ALL_EXCLUDING_MOTORS_VEHICLES (returns on motor vehicles are not processed through eBay flows)

Default: ALL_EXCLUDING_MOTORS_VEHICLES (for return policies only)

Occurrence: Always

returnPolicies.categoryTypes.defaultbooleanSellers can create multiple policies for any marketplaceId and categoryTypes.name combination. For example, you can create multiple fulfillment policies for one marketplace, where they all target the same category type name. However, only one policy can be the default for any marketplaceId and name combination, and eBay designates the first policy created for a combination as the default.

If set to true, this policy is the default policy for the associated categoryTypes.name and marketplaceId pair.

Note: eBay considers the status of this field only when you create listings through the Web flow. If you create listings using the APIs, you must specifically set the policies you want applied to a listing in the payload of the call you use to create the listing. If you use the Web flow to create item listings, eBay uses the default policy for the marketplace and category type specified, unless you override the default.

For more on default policies, see Changing the default policy for a category type.

Occurrence: Always

returnPolicies.categoryTypes.nameCategoryTypeEnumThe category type to which the policy applies (motor vehicles or non-motor vehicles).

Note for return policies: The 'MOTORS_VEHICLES' category type is not valid for return policies because eBay flows do not support the return of motor vehicles.

Occurrence: Always

returnPolicies.descriptionstringAn optional seller-defined description of the return policy for internal use (this value is not displayed to end users).

Max length: 250

Occurrence: Conditional

returnPolicies.extendedHolidayReturnsOfferedboolean

Important! This field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value supplied in this field is neither read nor returned.

If set to true, the seller offers an Extended Holiday Returns policy for their listings.

IMPORTANT: Extended Holiday Returns is a seasonally available feature that is offered on some eBay marketplaces. To see if the feature is enabled in any given year, check the Returns on eBay page before the holiday season begins. 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.

The above dates may vary by a few days each year. Sellers are notified of the current dates on their eBay marketplace 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 listings until the start date of current year's holiday returns period, at which point it overrides the non-holiday returns policy. Buyers can see the Extended Holiday Returns offer in listings displayed through the purchase cutoff date and are able to return those purchases until the end date of the period.

After the purchase cutoff date, the Extended Holiday Returns offer automatically disappears from the 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 of the period to return under the program.

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

Occurrence: Conditional

returnPolicies.internationalOverrideInternationalReturnOverrideTypeThis container, if populated, specifies the seller's policies for international returns (items that require postage via an international shipping service).

Buy default, the policies for international returns are inherited from the domestic return policy. This container allows the seller to customize their return policy for international returns.

Occurrence: Conditional

returnPolicies.internationalOverride.returnMethodReturnMethodEnumValid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns.

As of version 1.2.0, the only accepted value for this field is REPLACEMENT. This field is valid in only the US marketplace, any supplied value is ignored in other marketplaces.

Occurrence: Conditional

returnPolicies.internationalOverride.returnPeriodTimeDurationRequired if the internationalOverride.returnsAccepted field is set to true.

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.

You must set the value to one that's accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods.

For a definitive list of category return periods, call GeteBayDetails in the Trading API with DetailName set to ReturnPolicyDetails. In the response review the ReturnPolicyDetails.ReturnsWithin field to see the values supported in the different marketplace categories.

Note: In version 1.2.0, the options for this field were reduced. See the Release Notes for details.

Set this field using the TimeDuration complex type, where you set unit to DAY and value to either 30 or 60 (or other value, as appropriate).

Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours.

Occurrence: Conditional

returnPolicies.internationalOverride.returnPeriod.unitTimeDurationUnitEnumRequired in the TimeDuration container.

A time-measurement unit used to specify a period of time.

Time-measurement units can be years, months, days, hours, minutes, and other time units (see TimeDurationUnitEnum for a complete list of possible units). The unit is applied to the number in the value field to define a span of time. See the containing object for details and call GeteBayDetails in the Trading API to get the allowable values for the specific object you're configuring.

Occurrence: Conditional

returnPolicies.internationalOverride.returnPeriod.valueintegerRequired in the TimeDuration container.

An amount of time, as measured by the time-measurement units specified in the unit field.

Supported values for this field vary according to the object using the time duration. See the containing object for details and call GeteBayDetails in the Trading API to get the allowable values for the specific object you're configuring.

Occurrence: Conditional

returnPolicies.internationalOverride.returnsAcceptedbooleanRequired if the seller wants to set an international return policy that differs from their domestic return policy.

If set to true, the seller allows international returns. If set to false, the seller does not accept international returns.

Occurrence: Conditional

returnPolicies.internationalOverride.returnShippingCostPayerReturnShippingCostPayerEnumRequired if the internationalOverride.returnsAccepted field is set to true.

This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Depending on the return policy and specifics of the 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.

Occurrence: Conditional

returnPolicies.marketplaceIdMarketplaceIdEnumThe ID of the eBay marketplace to which this return policy applies. If this value is not specified, value defaults to the seller's eBay registration site.

Occurrence: Required

returnPolicies.namestringA user-defined name for this return policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

Occurrence: Required

returnPolicies.refundMethodRefundMethodEnum

Important! this field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value other than MONEY_BACK will be treated as MONEY_BACK (although for a period of time, eBay will store and return the legacy values to preserve backwards compatibility).

Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns.

Each eBay marketplace may support different sets of refund methods and marketplaces can also have differing default values for this field. Sellers are obligated to honor the refund method displayed in their listings. Call GeteBayDetails in the Trading API to see the refund methods supported by the marketplaces you sell into.

We recommend you set this field to the value of your preferred refund method and that you use the description field to detail the seller's return policy (such as indicating how quickly the seller will process a refund, whether the seller must receive the item before processing a refund, and other similar useful details).

You cannot modify this value in a Revise item call if (1) the listing has bids or (2) the listing ends within 12 hours.

Occurrence: Always

returnPolicies.restockingFeePercentagestring

Important! This field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value supplied in this field is ignored, it is neither read nor returned.

Sellers who accept returns should include this field if they charge buyers a restocking fee when items are returned. A restocking fee comes into play only when an item is returned due to buyer remorse and/or a purchasing mistake, but sellers cannot charge a restocking fee for SNAD-related returns. The total amount returned to the buyer is reduced by the cost of the item multiplied by the percentage indicated by this field.

Allowable restocking fee values are:

  • 0.0: No restocking fee is charged to the buyer
  • 10.0: 10 percent of the item price is charged to the buyer
  • 15.0: 15 percent of the item price is charged to the buyer
  • 20.0: Up to 20 percent of the item price is charged to the buyer

Occurrence: Conditional

returnPolicies.returnInstructionsstring

Important! This field is being deprecated on many marketplaces. Once deprecated, this field will be ignored on marketplaces where it is not supported and it will neither be read nor returned.

This optional 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 £). To include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. £).

Max length: 5000 (8000 for DE)

Occurrence: Conditional

returnPolicies.returnMethodReturnMethodEnumValid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns.

As of version 1.2.0, the only accepted value for this field is REPLACEMENT. This field is valid in only the US marketplace, any supplied value is ignored in other marketplaces.

Occurrence: Always

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

You must set the value to one that's accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods; be sure the value you set in this field is applicable to the marketplace category where you use the return policy.

For a definitive list of category return periods, call GeteBayDetails in the Trading API with DetailName set to ReturnPolicyDetails. In the response review the ReturnPolicyDetails.ReturnsWithin field to see the values supported in the different marketplace categories.

Note: In version 1.2.0, the options for this field were reduced. See the Release Notes for details.

Set this field using the TimeDuration complex type, where you set unit to DAY and value to either 30 or 60 (or other value, as appropriate).

Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours.

Occurrence: Always

returnPolicies.returnPeriod.unitTimeDurationUnitEnumRequired in the TimeDuration container.

A time-measurement unit used to specify a period of time.

Time-measurement units can be years, months, days, hours, minutes, and other time units (see TimeDurationUnitEnum for a complete list of possible units). The unit is applied to the number in the value field to define a span of time. See the containing object for details and call GeteBayDetails in the Trading API to get the allowable values for the specific object you're configuring.

Occurrence: Conditional

returnPolicies.returnPeriod.valueintegerRequired in the TimeDuration container.

An amount of time, as measured by the time-measurement units specified in the unit field.

Supported values for this field vary according to the object using the time duration. See the containing object for details and call GeteBayDetails in the Trading API to get the allowable values for the specific object you're configuring.

Occurrence: Conditional

returnPolicies.returnPolicyIdstringA unique eBay-assigned ID for this policy. This ID value is appended to the end of the Location URI that is returned as a response header when you call createReturnPolicy).

Occurrence: Required

returnPolicies.returnsAcceptedbooleanIf set to true, the seller accepts returns.

Call the getReturnPolicies in the Metadata API to see what categories require returns to be offered for listings in each category. Also, note that some European marketplaces (for example, UK, IE, and DE) require sellers to accept returns for fixed-price items and auctions listed with Buy It Now. For details, see Returns and the Law (UK).

Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits.

Occurrence: Always

returnPolicies.returnShippingCostPayerReturnShippingCostPayerEnumThis field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Depending on the return policy and specifics of the 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.

Occurrence: Always

totalintegerReturns the total number of result sets in the paginated collection.

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
20401API_ACCOUNTREQUESTMissing field {fieldName}. {additionalInfo}
20403API_ACCOUNTREQUESTInvalid {fieldName}. {additionalInfo}
20404API_ACCOUNTREQUEST{fieldName} not found.
20500API_ACCOUNTAPPLICATIONSystem error.
20501API_ACCOUNTAPPLICATIONService unavailable. Please try again in next 24 hours.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get all Return Policies

Sellers can create one or more return policies for a particular marketplace. This call returns all the current policies for the specified marketplace.

Input

Specify the marketplace for the policies you want to retrieve using the marketplace_id query parameter.
GET
https://api.sandbox.ebay.com/sell/account/v1/return_policy?marketplace_id=EBAY_US

Output

If the call is successful, eBay returns an HTTP status code of 200 OK and a complete list of the return policies associated with the specified marketplace.