action api_get_return_policy_by_name {
label: "getReturnPolicyByName"
description: "This method retrieves the details of a specific return policy. Supply both the policy name and its associated marketplace_id in the request query parameters.
Marketplaces and locales
Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy 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: nl-BE. For details on header values, see HTTP request headers."
provider: api
method: GET
path: "/return_policy/get_by_policy_name"
encoding: json
input: {
type: "object"
properties: {
marketplace_id: {
type: "string"
}
name: {
type: "string"
}
}
required: ["marketplace_id", "name"]
additionalProperties: false
}
output: {
type: "object"
description: "This type is used by the returnPolicy response container, a container which defines a seller's return business policy for a specific marketplace."
properties: {
categoryTypes: {
type: "array"
description: "This container indicates which category group that the return policy applies to.
Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value will always be ALL_EXCLUDING_MOTORS_VEHICLES for return business policies."
items: {
type: "object"
description: "The category type discerns whether the policy applies to motor vehicle listings, or to any other items except motor vehicle listings.
Each business policy can be associated with either or both categories ('MOTORS_VEHICLES' and 'ALL_EXCLUDING_MOTORS_VEHICLES'); however, return business policies are not applicable for motor vehicle listings."
properties: {
default: {
type: "boolean"
description: "Note: This field has been deprecated and is no longer used.- Do not include this field in any create or update method.
- This field may be returned within the payload of a get method, but it can be ignored.
"
}
name: {
type: "string"
description: "The category type to which the policy applies (motor vehicles or non-motor vehicles).
The MOTORS_VEHICLES category type is not valid for return policies. eBay flows do not support the return of motor vehicles. For implementation help, refer to eBay API documentation"
}
}
}
}
description: {
type: "string"
description: "A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.
Max length: 250"
}
extendedHolidayReturnsOffered: {
type: "boolean"
description: "Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.
"
}
internationalOverride: {
type: "object"
description: "This container shows the seller's international return policy settings. This container is only returned if the seller has set a separate international return policy for the business policies. International return policies are optional, even if the seller ships to international locations. If a separate international return policy is not set, all of the domestic return policy settings also apply to international orders."
properties: {
returnMethod: {
type: "string"
description: "This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return. The buyer must be willing to accept a replacement item; otherwise, the seller will need to issue a refund for a return. For implementation help, refer to eBay API documentation"
}
returnPeriod: {
type: "object"
description: "This container indicates the number of calendar days that 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 return periods for one or more categories, call getReturnPolicies method of the Metadata API.
The TimeDuration type is used to set/indicate the return period, and you set the unit value to DAY and the value field 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.
This field is conditionally required if the internationalOverride.returnsAccepted field is set to true."
properties: {
unit: {
type: "string"
description: "These enum values represent the time measurement unit, such as DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.
See TimeDurationUnitEnum for a complete list of possible time-measurement units. For implementation help, refer to eBay API documentation"
}
value: {
type: "integer"
format: "int32"
description: "An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field."
}
}
}
returnShippingCostPayer: {
type: "string"
description: "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 'significantly not as described' (SNAD) issues.
This field is conditionally required if the internationalOverride.returnsAccepted field is set to true. For implementation help, refer to eBay API documentation"
}
returnsAccepted: {
type: "boolean"
description: "If set to true, the seller accepts international returns. If set to false, the seller does not accept international returns.
This field is conditionally required if the seller chooses to have a separate international return policy."
}
}
}
marketplaceId: {
type: "string"
description: "The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation"
}
name: {
type: "string"
description: "A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.
Max length: 64"
}
refundMethod: {
type: "string"
description: "If a seller indicates that they will accept buyer returns, this value will be set to MONEY_BACK. For implementation help, refer to eBay API documentation"
}
restockingFeePercentage: {
type: "string"
description: "Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored and it is no longer returned.
"
}
returnInstructions: {
type: "string"
description: "This text-based field provides more details on seller-specified return instructions. This field is only returned if set for the return business policy. Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.
Max length: 5000 (8000 for DE)"
}
returnMethod: {
type: "string"
description: "This field is only returned if the seller is willing to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to eBay API documentation"
}
returnPeriod: {
type: "object"
description: "This container indicates the number of calendar days that 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 categories support 30-day and 60-day return periods.
Note: Unless the seller has set a separate international return policy through the internationalOverride container, this return period will be valid for domestic and international returns (if the seller ships internationally)."
properties: {
unit: {
type: "string"
description: "These enum values represent the time measurement unit, such as DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.
See TimeDurationUnitEnum for a complete list of possible time-measurement units. For implementation help, refer to eBay API documentation"
}
value: {
type: "integer"
format: "int32"
description: "An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field."
}
}
}
returnPolicyId: {
type: "string"
description: "A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created."
}
returnShippingCostPayer: {
type: "string"
description: "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. For implementation help, refer to eBay API documentation"
}
returnsAccepted: {
type: "boolean"
description: "If this field is returned as true, the seller accepts returns.
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."
}
}
}
}