translation APIv1_beta.2.0

translate

POST

/translate

Translates input text into a given language.

Input

Resource URI (production)

POST https://api.ebay.com/commerce/translation/v1_beta/translate

URI parameters

This method has no URI parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

In addition, this method requires you to include the Content-Type header and its value should be set to "application/json". See HTTP request headers - opens rest request components page for details.

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to Clipboard

{ /* TranslateRequest */

"from" : "LanguageEnum : [en,zh,de...]",

"text" : [

"string"

"to" : "LanguageEnum : [en,zh,de...]",

"translationContext" : "TranslationContextEnum : [ITEM_TITLE,ITEM_DESCRIPTION]"

}

Request fields

Input container/field Type Description

from

LanguageEnum

The language of the input text to be translated.

Translations supported:

From	To	Context
(`en`) English	(`de`) German	ITEM_TITLE
(`en`) English	(`zh`) Chinese (Mandarin)	ITEM_TITLE ITEM_DESCRIPTION
(`ja`) Japanese	(`en`) English	ITEM_TITLE

Occurrence: Required

text

array of string

The input text to translate.

Note: Do not include markup (e.g., HTML, links, or JavaScript). All markup will be removed during translation.

Max string length: 80 characters

Max occurrence: One input string

Occurrence: Required

LanguageEnum

The target language for the translation of the input text.

Translations supported:

From	To	Context
(`en`) English	(`de`) German	ITEM_TITLE
(`en`) English	(`zh`) Chinese (Mandarin)	ITEM_TITLE ITEM_DESCRIPTION
(`ja`) Japanese	(`en`) English	ITEM_TITLE

Occurrence: Required

translationContext

TranslationContextEnum

The context of the translation. The context determines the rules that apply for the translation.

Valid Values: ITEM_TITLE and ITEM_DESCRIPTION

Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to Clipboard

{ /* TranslateResponse */

"from" : "LanguageEnum : [en,zh,de...]",

"to" : "LanguageEnum : [en,zh,de...]",

"translations" : [

{ /* Translation */

"originalText" : "string",

"translatedText" : "string"

}

]

}

Response fields

Output container/field	Type	Description
from	LanguageEnum	The language of the input text. Occurrence: Always
to	LanguageEnum	The language to use for the translation of the input text. Occurrence: Always
translations	array of Translation	A list of translations. Occurrence: Always
translations.originalText	string	The original text. Occurrence: Always
translations.translatedText	string	The translated text. Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
200	OK
400	Bad Request
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
110000	API_TRANSLATION	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
110001	API_TRANSLATION	REQUEST	From language is invalid, missing or not supported. For more information, see the API call reference documentation.
110002	API_TRANSLATION	REQUEST	To language is invalid, missing or not supported. For more information, see the API call reference documentation.
110003	API_TRANSLATION	REQUEST	Context is not supported. For more information, see the API call reference documentation.
110004	API_TRANSLATION	REQUEST	Maximum number of input text reached. For more information, see the API call reference documentation.
110005	API_TRANSLATION	REQUEST	Maximum length of input text reached. For more information, see the API call reference documentation.
110006	API_TRANSLATION	REQUEST	Unsupported from and to combination.
110007	API_TRANSLATION	REQUEST	Markups are not supported in input texts.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Translate an Item Title

Sample 2: Translate an Item Description

Sample 3: Translate a buyer query into the commerce site language

Sample 1: Translate an Item Title

Translate a title of an item listing from English to Chinese (Mandarin).

Input

The inputs are text (comma-separated array of strings to translate), translationContext (the translation rules to apply), from (the language of the source text), and to, (the language into which the text will be translated).

POST

https://api.ebay.com/commerce/translation/v1_beta/translate

Output

Upon success, the response includes a separate translation object for each string that was translated, including the original text, the source and target languages, and the translated text.

Sample 2: Translate an Item Description

Translate a description of an item from English to Chinese (Mandarin).

Input

The input fields for translating an item description are the same as those used for translating a title, but the translationContext sets the rules to apply to the translation (e.g., just one string, max string length is 2,000 characters, etc.).

POST

https://apid.ebay.com/commerce/translation/v1/translate

Output

Upon success, the response returns the translated item description.

Sample 3: Translate a buyer query into the commerce site language

Translates a Chinese query string from the foreign buyer in into English for use on the commerce site from which inventory is being surfaced.

Input

The input fields for translating a query are the same as those used for translating a title or description, but the to and from values are reversed. This lets you get a query from the foreign buyer translated into the language of the given marketplace or commerce site.

POST

https://apid.ebay.com/commerce/translation/v1/translate

Output

Upon success, the response includes an array of translated queries.