Cancel Return Request
POST /post-order/v2/return/{returnId}/cancel
This method cancels (closes) a return request on behalf of the buyer.
Output Samples Change History |
Input
See also Samples.
Resource URI (production)
POST https://api.ebay.com/post-order/v2/return/{returnId}/cancel
URI parameters
Parameter | Type | Required? | Meaning |
---|---|---|---|
returnId | string | Required | The unique eBay-assigned ID of the return request. This field is required to identify the return request that the buyer wishes to cancel (close). The return ID value is passed in as part of the call URI. |
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.
{ /* CloseReturnRequest */ "buyerCloseReason": string, "comments": { /* Text */ "content": string, "language": string, "translatedFromContent": string, "translatedFromLanguage": string } }
Request field descriptions
Input Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
buyerCloseReason | string | Optional |
The buyer passes a value into this field to indicate their reason for closing the return request. The value passed in this field must be defined in the BuyerCloseReturnReasonEnum type.
Applicable values are from BuyerCloseReturnReasonEnum:See buyerCloseReason. |
comments | Text | Optional | This container is used if the buyer wants to provide more information to the seller about why the return request is being closed. |
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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
Input Samples Change History |
Output
See also Samples.
Payload model
This call has no response payload.
nullInput Output Change History |
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.
This operation enables a buyer to cancel a return.
Description
The buyer cancels the specified return and provides an optional explanation.
Input
The returnId parameter identifies the return to be canceled, and the buyerCloseReason field indicates that the buyer received a replacement for the order line item.
URL format. See also the non-wrapped version of this URL. POST https://api.ebay.com/post-order/v2/return/5********9/cancel { "buyerCloseReason": "BUYER_RECEIVED_REPLACEMENT", "comments": { "content": "I have received a replacement for this item.", } }
Output
A successful call returns an HTTP code of 200
; there is no payload for the response.
JSON format.
Input Output Samples |
Change History
Change Date | Description |
---|