eBay Post-Order APIVersion 2.7.7

Set Return Preferences

POST /post-order/v2/return/preference

This method is used if the seller wants to indicate whether or not a Return Merchandise Authorization (RMA) number is required for returned items.

This method is not supported in the Sandbox environment.


See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/return/preference

This call has no path or query parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.


This call uses standard authorization tokens. See Making a Call for details.

Payload model

The following lists all fields that could be included in the request.

{ /* SetSellerReturnPreferenceRequest */
"rmaRequired": boolean

Request field descriptions

Input Container/Field Type Occurrence Meaning
rmaRequired boolean Required This field is included and set to true if the seller wishes to require that the buyer provide a Return Merchandise Authorization (RMA) when returning an item. This field is included and set to false if the seller wishes to turn off the RMA requirement when an item is returned. Since this is the only field in the request payload of the setReturnPreferences method, it is required when this method is used.


See also Samples.

Payload model

This call has no response payload.



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

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Set Return Preferences


This call sets Return Preferences for the seller's account


There are no path or query parameters for this method. In the request payload, the seller sets the rmaRequired boolean field to true, which means that a Return Merchandise Authorization (RMA) number will be associated with any item that is returned by a buyer.

URL format. See also the non-wrapped version of this URL.

POST https://api.ebay.com/post-order/v2/return/preference
	"rmaRequired": true


There is no response payload for this call, but only an HTTP status code that indicates success.

JSON format.
No response payload

Change History

Change Date Description