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
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 |
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 clipboardRequest 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:
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. Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
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
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's Title
Translate the title of an item's listing from English to German.
Input
This sample translates an item's title from English to German.
POSThttps://api.ebay.com/commerce/translation/v1_beta/translate
Output
Upon success, the response includes the translated title, the original title, as well as the source and target languages.
Sample 2: Translate an Item's Description
Translate the description of an item from English to Chinese (Mandarin).
Input
This sample translates an item's description from English to Chinese (Mandarin).
POSThttps://apid.ebay.com/commerce/translation/v1/translate
Output
Upon success, the response includes the translated description, the original description, as well as the source and target languages.