eBay Post-Order APIVersion 2

Send Return Message

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

Buyers and sellers can use this call to upload a message related to a return.

Input

See also Samples.

Resource URI (production)

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

URI parameters

Parameter Type Required? Meaning
returnId string Required The unique identifier of the return. The returnId value is required to identify the return for which the message is intended.


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.

{ /* ret-ret:SendMessageRequest */
"message":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    }
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
message Text Optional !~~! Defines the properties of textual information. This includes the content itself, and the language in which it is presented. If the text has been translated, the original text and language are also included.
message.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.
message.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.
message.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.
message.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.

Output

See also Samples.

Payload model

This call has no response payload.



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: Send a Message

This operation enables the buyer and seller to communicate.

Description

In this operation, the seller sends a messge to the buyer regarding the specified return request.

Input

The returnId parameter is required to identify the return request associated with this message. The message.content field contains the message text.

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

POST https://api.ebay.com/post-order/v2/return/5000116809/send_message
{ 
  "message":
  { 
    "content": "I have received your return request, and you can expect a return shipping label shortly."
  }
}

Output

A successful call returns an HTTP code of 200; there is no payload for the response.

JSON format.



Change History

Change Date Description