eBay Post-Order APIVersion 2.6

Process Return Request

POST /post-order/v2/return/{returnId}/decide

This call allows the seller or buyer to perform an action against a return request.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/return/{returnId}/decide

URI parameters

Parameter Type Required? Meaning
returnId string Required The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which an action is being performed against.


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.



Authorization

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.

{ /* DecideReturnRequest */
"comments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    },
"decision": token,
"keepOriginalItem": boolean,
"partialRefundAmount":
    { /* Amount */
    "convertedFromCurrency": string,
    "convertedFromValue": number,
    "currency": string,
    "value": number
    },
"RMANumber": string,
"rMAProvided": boolean
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
comments Text Optional Optional container that allows the seller or buyer to provide more information about the action that is being performed with the decide call.
comments.content string Conditional This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type.
comments.language string Conditional This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.

Applicable values are from LanguageEnum:See language.
comments.translatedFromContent string Conditional If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable.
comments
  .translatedFromLanguage
string Conditional If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.

Applicable values are from LanguageEnum:See translatedFromLanguage.
decision token Required When the seller calls calls this method, they can set the value of this field to offer a return option to the buyer, approve or decline a return request, offer a partial refund to the buyer, or provide a Return Merchandise Authorization (RMA) number to the buyer.

If the buyer is making the call, the only supported values are ACCEPT_PARTIAL_REFUND or DECLINE_PARTIAL_REFUND, which allows the buyer to accept or decline the partial refund amount offered by the seller.

Applicable values: See DecisionEnum
keepOriginalItem boolean Optional If set to true, the seller indicates that the buyer can keep the item they received instead of shipping it back to the seller when the refund request is accepted.

Default: false
partialRefundAmount Amount Conditional This field is conditionally required if the seller is using the decide call to offer a partial refund amount to the buyer in order to settle the return request. This amount is the dollar value that the seller is willing to offer the buyer as a partial refund. This field has no relevance if anything other than OFFER_PARTIAL_REFUND is passed in the decision field.
partialRefundAmount
  .convertedFromCurrency
string Optional Gets the original transaction currency, if the transaction involves a currency conversion. The currency is represented as a 3-letter currency code from ISO4217. See http://en.wikipedia.org/wiki/ISO_4217 If no conversion occurs, this should not be populated.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
partialRefundAmount
  .convertedFromValue
number Optional Gets the original transaction amount, if the transaction involves a currency conversion. If no conversion occurs, this should not be populated.
partialRefundAmount.currency string Optional Gets the transaction currency. This is the currency in which the transaction occurs: in the case of currency conversion, this is the post-conversion currency.

Applicable values are from CurrencyCodeEnum:See currency.
partialRefundAmount.value number Optional Gets the amount of the transaction, expressed in the specified request.
RMANumber string Conditional This field is conditionally required if the seller is using the POST /post-order/v2/return/{returnId}/decide call to provide a return merchandise authorization (RMA) to the buyer. The RMA value cannot be validated by eBay, so the seller should pay close attention to ensure that the RMA is accurate. If an RMA is provided in this field, the decision value should be PROVIDE_RMA.
rMAProvided boolean Optional If set to true, it indicates that the seller provided an RMA number to the buyer for the return processing.

Default: false

Output

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 DecideReturnResponse 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

{ /* DecideReturnResponse */
"refundStatus": token
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
refundStatus token Conditionally This field is only returned in the response if a refund has been requested or initiated. The value in this field indicates whether or not the refund operation was successful.

Applicable values: See Refund_MoneyMovementStatusEnum
null



Samples

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: Seller approves return.

The seller approves a return request generated by the buyer.

Description

The seller must approve all buyer-initiated return requests before they are allowed.

Input

Seller passes in the returnId as a path parameter in the URI of the call. In the request payload, the seller passes in APPROVE in the decision field, and also includes a comment.

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

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

{
  "decision": "APPROVE",
  "comments": 
  { 
    "content": "I approve your return request. Please ship the you want to return."
  }
}

Output

A successful call returns an HTTP status code of 200.

JSON format.



Change History

Change Date Description