This call allows the seller or buyer to perform an action against a return request.
Output Samples Change History |
See also Samples.
POST https://api.ebay.com/post-order/v2/return/{returnId}/decide
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. |
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.
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, "exchangeRate": string, "value": number }, "RMANumber": string, "rMAProvided": boolean }
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 |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. |
partialRefundAmount .convertedFromValue |
number | Optional |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
partialRefundAmount.currency | string | Optional |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. |
partialRefundAmount .exchangeRate |
string | Optional | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
partialRefundAmount.value | number | Optional | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
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
|
Input Samples Change History |
See also Samples.
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 }
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 |
Input Output Change History |
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.
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/5********9/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.
Input Output Samples |
Change Date | Description |
---|
Copyright © 2015–2021 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.