translate: eBay Translation API | eBay Developers Program

POST/translate

This method translates listing title and listing description text from one language into another. For a full list of supported language translations, see the table in the API Overview page.

Input

Resource URI

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

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

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.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Header	Type	Description
Content-Type	string	This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required

Header

Type

Description

Content-Type

string

This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

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 : [de,en,es...]",

"text" : [

"string"

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

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

}

Request fields

Input container/field	Type	Description
from	LanguageEnum	The language of the input text to be translated. Not all LanguageEnum values are supported in this field. For a full list of supported language pairings, see the Supported languages table in the API Overview page. Occurrence: Required
text	array of string	The input text to translate. The maximum number of characters permitted is determined by the translationContext value: `ITEM_TITLE`: 1000 characters maximum `ITEM_DESCRIPTION`: 20,000 characters maximum. Note: When translating `ITEM_DESCRIPTION` text, HTML/CSS markup and links can be included and will not count toward this 20,000 character limit. Note: Currently, only one input string can be translated per API call. Support for multiple continuous text strings is expected in the future. Occurrence: Required
to	LanguageEnum	The target language for the translation of the input text. Not all LanguageEnum values are supported in this field. For a full list of supported language pairings, see the Supported languages table in the API Overview page. Occurrence: Required
translationContext	TranslationContextEnum	Input the listing entity to be translated. 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 : [de,en,es...]",

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

"translations" : [

{ /* Translation */

"originalText" : "string",

"translatedText" : "string"

}

]

}

Response fields

Output container/field	Type	Description
from	LanguageEnum	The enumeration value indicates the language of the input text. Occurrence: Always
to	LanguageEnum	The enumeration value indicates the language of the translated text. Occurrence: Always
translations	array of Translation	An array showing the input and translated text. Only one input string can be translated at this time. Support for multiple continuous text strings is expected in the future. Occurrence: Always
translations.originalText	string	The original text, in the language specified in the from field, that was input into the text field in the request. Occurrence: Always
translations.translatedText	string	The translation of the original text into the language specified in the to field. 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 for title translation context.
110008	API_TRANSLATION	REQUEST	Input text missing.

Warnings

This call has no warnings.

Samples

This call has no samples.