Escalate Return

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

This method is used to escalate a return request into a case. The escalation reason and an accompanying comment can be included in the request payload. If the return request is successfully escalated, a caseId value is returned in the response.

This method is not supported in the Sandbox environment.

Input

Resource URI (production)

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

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 user wishes to escalate. 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.

{ /* EscalateRequest */
"comments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    },
"reason": string
}

Request field descriptions

Input Container/Field	Type	Occurrence	Meaning
comments	Text	Optional	This container is used if the buyer or seller wants to add a note or explanation about why the return request is being escalated to a case.
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
reason	string	Optional	This field is used to specify the reason why the buyer or seller is escalating the specified return request into a case. One of the enumeration values defined in the EscalateReasonEnum type definition must be used here. Some values are only applicable to the buyer escalating the return request, some values are only applicable to the seller escalating the return request, and some values are relevant to either party. Although this field is not required, it is recommended that it is used by the buyer or seller. Applicable values: See EscalateReasonEnum

Output

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

{ /* EscalateResponse */
"caseId": string,
"caseUrl": string
}

Response field descriptions

Output Container/Field	Type	Occurrence	Meaning
caseId	string	Conditionally	This is unique eBay-assigned ID of the new case that was created after the return request was escalated to customer support. This field is only returned if the return request was successfully escalated to a return case.
caseUrl	string	Conditionally	This is the URL to the eBay page where more details on the case can be viewed. This field is only returned if the return request was successfully escalated to a return case.

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: Escalate a Return

Escalate an existing return request to a return case.

Description

This operation requests eBay customer support to escalate the specified return request to a return case.

Input

The returnId parameter is required to identify the return to be escalated. The reason field indicates that the buyer wants to escalate the return because the seller has not responded to the initial return request.

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

POST https://api.ebay.com/post-order/v2/return/5********9/escalate
{ 
  "reason": "SELLER_NO_RESPONSE",
  "comments":
  { 
    "content": "The seller did not respond to my return request."
  }
}

Output

The caseId field contains the identifier for the new return case.

JSON format.
{ 
  "caseId" :  "5********7"
}

Change History

Change Date	Description