eBay Post-Order APIVersion 2.7.7

Get Return Preferences

GET /post-order/v2/return/preference

This method retrieves the return preferences currently active on the seller's account. This method does not have any path or query parameters, nor does it have a request payload.

This method is not supported in the Sandbox environment.


See also Samples.

Resource URI (production)

GET 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

This call has no request payload.


See also Samples.

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

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

Supported response formats: application/json, application/xml

For more information:
- See GetSellerReturnPreferenceResponse for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* GetSellerReturnPreferenceResponse */
"advanceRulesEnabled": boolean,
"rmaRequired": boolean,
"versionId": integer

Response field descriptions

Output Container/Field Type Occurrence Meaning
advanceRulesEnabled boolean Always This boolean field is returned as true if the seller's account is enabled to set up advanced return rules. Return Rules are set up and managed in My eBay.
rmaRequired boolean Always This boolean field is returned as true if the seller is requiring that an Return Merchandise Authorization (RMA) number be provided by the buyer when returning an item. This boolean field is returned as false if the seller is not requiring that an RMA number be provided for return items.
versionId integer Always The unique eBay-assigned ID of the seller's current set of return rules. This unique eBay-assigned ID will be updated each time the seller makes any type of update to return rules in My eBay.


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

Retrieve Return Preferences


This call retrieves Return Preferences set up for the seller's account


There are no path, query, or request payload parameters for this endpoint.

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

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


There are two boolean fields and a version ID values in the response.

JSON format.
"advanceRulesEnabled": true,
"rmaRequired": true,
"versionId": 4

Change History

Change Date Description