Localization API

The Localization API lets you translate rich HTML content into different languages on demand, while keeping the layout, formatting, and metadata intact. You can use it to localize catalog data, emails, and other HTML-based content.

It shares the same translation memory with all other channels, so your translations stay consistent everywhere.

Localize Content

post

Authorizations

Path parameters

store_idstringRequired

Body

one ofOptional

all ofOptional

Localization context is determined by selecting a localized site based on the provided country. If language and currency are also provided, the system attempts to match a specific site variation; otherwise, the default for the site / country is used.

or

all ofOptional

Localization context is determined by specifying a particular localized site. If language and currency are also provided, the system attempts to match a specific variation; otherwise, the site’s default settings are used.

Responses

200

Successful response

application/json

400

Request error

application/json

403

Authorization error

application/json

500

Error response

application/json

post

HTTPcURLJavaScriptPython

POST /v2/localization/{store_id}/localize HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "countryCode": "FR",
  "languageCode": "fr-FR",
  "currencyCode": "EUR",
  "platform": "email",
  "items": [
    {
      "format": "text",
      "content": "text"
    }
  ]
}

{
  "content": [
    "text"
  ]
}