Initiates a translation task for one or more images. This asynchronous API queues the images for processing in the specified target language. Applicable only for sellers that sell across EU. Use the Image Translation Completed webhook to monitor the translation progress, or pass the task ID to the Get Image Translation Tasks API to retrieve the status and the translated images. Note:
- Please wait 5 minutes after task creation before calling the Get endpoint, and retry at intervals over 10 seconds to avoid rate limiting.
- Each task corresponds to the translation of 1 image into 1 target language.
- You can create up to 20 tasks per call and 500 tasks per day. Any tasks beyond the daily limit will be rejected.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
Request Bodyrequired
Section titled “Request Bodyrequired”object
The list of images to translate. Use the Upload Product Image API to upload the images first and obtain the corresponding image URIs.
Note: A request can contain at most 20 image URI and target language combinations in total. The recommendations to specify up to 5 images and up to 20 target languages are not independent limits that can be used together; the total number of combinations must remain 20 or fewer. For example, you can submit 10 images with 2 target languages each, but you can’t submit 10 images with 5 target languages each.
object
The URI of the image, retrieved from the Upload Product Image API
Recommendation: Specify up to 5 images to avoid exceeding the task limit per call.
The target languages to translate the image into. You can specify multiple target languages for each image. Possible values:
cs-CZda-DKde-ATde-BEde-DEel-GRen-GBen-IEes-ESfi-FIfr-FRfr-BEhu-HUit-ITnl-NLnl-BEpl-PLpt-PTsv-SERecommendation: Specify up to 20 languages to avoid exceeding the task limit per call.
Example
{ "images": [ { "image_uri": "tos-useast2a-i-tulkllf4y5-euttp/748e39ecff38453ab8396a36a53dbb92", "target_languages": [ "it-IT", "fr-FR" ] } ]}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
The list of translation tasks created for the requested images.
Each task corresponds to the translation of 1 image into 1 target language. So if you specified 2 target languages for an image, 2 tasks will be created.
object
The URI of the image to translate.
The target language for this translation task. This value corresponds to one of the target_languages submitted for the task’s image_uri.
The ID to identify the image translation task. Pass this ID to the Get Image Translation Tasks API to retrieve the task status and the translated image URIs.
Example
{ "code": 0, "data": { "translation_tasks": [ { "image_uri": "tos-useast2a-i-tulkllf4y5-euttp/748e39ecff38453ab8396a36a53dbb92", "target_language": "it-IT", "id": "764c6e87eedcea90399a0dafcd572b71" } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}