Input
Resource URI (production)
URI parameters
HTTP request headers
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.
| Input container/field | Type | Description |
|---|---|---|
| from | LanguageEnum | The language of the input text to be translated. For the initial release, from must be set to "en" (English) for titles and descriptions and "zh" (Mandarin Chinese) for queries. Applicable values: en, zh Occurrence: Required |
| to | LanguageEnum | The target language for the translation of the input text. For the initial release, to must be set to "zh" (Mandarin Chinese) for titles and descriptions and "en" (English) for queries. Applicable values: en, zh Occurrence: Required |
| translationContext | TranslationContextEnum | The context of the translation. The context determines the rules that apply for the translation. For example, the allowed number of strings that can be submitted for titles differs from the number of strings that can be submitted for descriptions. Applicable values: ITEM_TITLE, ITEM_DESCRIPTION, ITEM_QUERY 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 (for titles and queries), 2,000 characters (descriptions) Max occurrence: 8 input strings for titles and queries, 1 input string for descriptions Occurrence: Required |
Output
| Output container/field | Type | Description |
|---|---|---|
| translations | array of Translation | The list of translations. Occurrence: Conditional |
| translations.from | LanguageEnum | The language of the input text. Occurrence: Conditional |
| translations.to | LanguageEnum | The language to use for the translation of th einput text. Occurrence: Conditional |
| translations.originalText | string | Original text. Occurrence: Conditional |
| translations.translatedText | string | Translated text. Occurrence: Conditional |
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 not supported. For more information, see the API call reference documentation. |
| 110002 | API_TRANSLATION | REQUEST | To language is 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 | To and from languages cannot be the same. |
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.