(46) Image translation completed

POST

This webhook is triggered when an image translation is completed or failed.

Applicable only for sellers that sell across EU. Prerequisite: The “Product Basic” API scope is enabled in Partner Center. For more information, refer to Access Scope.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

type

required

The ID of the webhook type.

integer

Allowed value: 46

tts_notification_id

The ID of this webhook notification.

string

shop_id

The shop ID.

string

timestamp

The time when this webhook is triggered. Unix timestamp.

integer format: int64

data

object

translation_task

The image translation task and the corresponding results. Each task corresponds to the translation of 1 image into 1 target language.

object

id

The ID to identify the image translation task.

string

status

The translation status. Possible values:

• PROCESSING: Translation is underway and has not yet completed.
• COMPLETED: Translation has completed and results are ready.
• FAILED: Translation did not complete due to an error.

string

Allowed values: PROCESSING COMPLETED FAILED

fail_reason

The reason why the translation task failed.

string

target_language

The target language to translate the image into. Possible values:

• de-DE
• en-IE
• es-ES
• fr-FR
• it-IT

string

Allowed values: de-DE en-IE es-ES fr-FR it-IT

original_image

The original image to be translated.

object

uri

The URI of the original image.

string

url

The URL of the original image.

string

translated_image

The translated image.

object

uri

The URI of the translated image.

string

url

The URL of the translated image.

string

Example

{
  "type": 46,
  "shop_id": "7494049642642441621",
  "tts_notification_id": "7327112393057371910",
  "timestamp": 1644412885,
  "data": {
    "translation_task": {
      "id": "764c6e87eedcea90399a0dafcd572b71",
      "status": "COMPLETED",
      "fail_reason": "",
      "target_lang": "it-IT",
      "original_image": {
        "uri": "tos-useast2a-i-tulkllf4y5-euttp/748e39ecff38453ab8396a36a53dbb92",
        "url": "https://p16-oec-sg.ibyteimg.com/tos-alisg-i-aphluv4xyz-sg/sample.jpeg"
      },
      "translated_image": {
        "uri": "tos-maliva-i-o3syd03w52-us/53b55d6e8cdf1f315affa7e70b45707d",
        "url": "https://p16-oec-sg.ibyteimg.com/tos-alisg-i-aphluv4xwc-sg/sample.jpeg"
      }
    }
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.