createReturnPolicy

This field always returns ALL_EXCLUDING_MOTORS_VEHICLES for return business policies, since return business policies are not applicable to motor vehicle listings.

Occurrence: Always

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.

Occurrence: Conditional

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.

Occurrence: Always

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

Occurrence: Conditional

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

Occurrence: Conditional

This container is used by the seller to specify a separate international return policy, and will only be returned if the seller has set a separate return policy for international orders. If a separate international return policy is not defined by a seller, all of the domestic return policy settings will also apply to international orders.

Occurrence: Conditional

This field sets/indicates if the seller offers replacement or exchange items to the buyer in the case of an international return. The buyer must be willing to accept a replacement or exchange item; otherwise, the seller will need to issue a refund for a return.

Occurrence: Conditional

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.

Occurrence: Conditional

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.

Occurrence: Conditional

An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.

Occurrence: Conditional

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.

Occurrence: Conditional

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.

Occurrence: Conditional

The ID of the eBay marketplace to which this return business policy applies.

Occurrence: Always

A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

Occurrence: Always

This value indicates the refund method that will be used by the seller for buyer returns. In most cases, buyers will get their money back for returns, but for sellers who offer the 'Click and Collect' and 'Buy Online, Pick up in Store' option, the seller is able to offer a store/merchandise credit in addition to the 'money back' option. The buyer recieving money back for a return is always an option available to the buyer, even if this field is set to MERCHANDISE_CREDIT, or if this field is not returned at all.

Occurrence: Conditional

Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns.

Occurrence: Conditional

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.

Occurrence: Conditional

This field will be returned if the seller is willing and able to offer an alternative return method other than 'money back', such as an exchange or replacement item.

Occurrence: Conditional

This container specifies the amount of days that the buyer has to return the item after receiving it. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. This container will be returned unless the business policy states that the seller does not accept returns.

Occurrence: Conditional

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.

Occurrence: Conditional

An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.

Occurrence: Conditional

A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created.

Occurrence: Always

If set to true, the seller accepts returns. If set to false, this field indicates that the seller does not accept returns.

Occurrence: Always

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.

Occurrence: Always

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.

Occurrence: Always

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.

Occurrence: Conditional

Name of the domain ,or primary system, of the service or application where the error occurred.

Occurrence: Conditional

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.

Occurrence: Conditional

Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.

Occurrence: Conditional

A more detailed explanation of the error than given in the message error field.

Occurrence: Conditional

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.

Occurrence: Conditional

Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.

Occurrence: Conditional

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.

Occurrence: Conditional

Name of the parameter that caused the error.

Occurrence: Conditional

The value of the parameter that caused the error.

Occurrence: Conditional

If present, indicates the subsystem in which the error occurred.

Occurrence: Conditional