action ebay_create_return_policy { label: "createReturnPolicy" description: "This method creates a new return policy where the policy encapsulates seller's terms for returning items.

Each policy targets a specific marketplace, and you can create multiple policies for each marketplace. Return policies are not applicable to motor-vehicle listings.

A successful request returns the getReturnPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.

Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.

" provider: ebay method: POST path: "/return_policy" encoding: json input: { type: "object" description: "This root container defines a seller's return business policy for a specific marketplace and category group. This type is used when creating or updating a return business policy." 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 must be set to 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 type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers. " 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: "A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned." 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 return business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64" } refundMethod: { type: "string" description: "This value indicates the refund method that will be used by the seller for buyer returns.

Important! If this field is not included in a return business policy, it will default 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.

" } returnInstructions: { type: "string" description: "This text-based field provides more details on seller-specified return instructions.

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 can be used if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to eBay API documentation" } returnPeriod: { type: "object" additionalProperties: true } 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.

This field is conditionally required if returnsAccepted is set to true. For implementation help, refer to eBay API documentation" } returnsAccepted: { type: "boolean" description: "If set to 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.

" } } } output: { type: "object" description: "A complex type that is populated with a response containing a return policies." properties: { categoryTypes: { type: "array" description: "This field always returns ALL_EXCLUDING_MOTORS_VEHICLES for return business policies, since return business policies are not applicable to motor vehicle listings." 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. This field is returned if set for the policy.

Max length: 250" } extendedHolidayReturnsOffered: { type: "boolean" description: "

Important! This field is deprecated, since eBay no longer supports extended holiday returns. This field should no longer be returned.

" } internationalOverride: { type: "object" description: "This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers. " 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: "A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned." 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 return 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 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.

" } returnInstructions: { type: "string" description: "This text-based field provides more details on seller-specified return instructions.

Max length: 5000 (8000 for DE)" } returnMethod: { type: "string" description: "This field will be returned if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to eBay API documentation" } returnPeriod: { type: "object" additionalProperties: true } 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.

Note that the seller is always responsible for return shipping costs for SNAD-related issues.

This container will be returned unless the business policy states that the seller does not accept returns. For implementation help, refer to eBay API documentation" } returnsAccepted: { type: "boolean" description: "If set to true, the seller accepts returns. If set to false, this field indicates that the seller does not accept returns." } warnings: { type: "array" description: "An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty." items: { type: "object" description: "A container that defines the elements of error and warning messages." properties: { category: { type: "string" description: "The category type for this error or warning. It is a string that can have one of three values:

Application: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.
Business: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as \"Seller does not ship item to Antarctica\" or \"Buyer ineligible to purchase an alcoholic item\". Business errors are not syntactical input errors.
Request: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.

" } domain: { type: "string" description: "Name of the domain ,or primary system, of the service or application where the error occurred." } errorId: { type: "integer" format: "int32" description: "A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms." } inputRefIds: { type: "array" description: "Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation." items: { type: "string" } } longMessage: { type: "string" description: "A more detailed explanation of the error than given in the message error field." } message: { type: "string" description: "Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale." } outputRefIds: { type: "array" description: "Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId." items: { type: "string" } } parameters: { type: "array" description: "This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value." items: { type: "object" description: "A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error." properties: { name: { type: "string" description: "Name of the parameter that caused the error." } value: { type: "string" description: "The value of the parameter that caused the error." } } } } subdomain: { type: "string" description: "If present, indicates the subsystem in which the error occurred." } } } } } } }