v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB
Localization

Retrieves a list of all translatable fields and their translations.

Use the locale parameter to return translations for a specific locale. If a field doesn't have a translation for the requested locale, the value defaults to English, en.

If no locale is specified, all translations are returned, including the default English values.

get/v1/translations

Query parameters

localestring
Example:en-US

The locale code. Both ISO-639 language code and ISO-3166 country code formats are supported.

Headers

x-publisher-tokenstring required

The publisher token.

Response

Translations retrieved successfully.

Example response

{
  "dynamicTranslations": [
    {
      "type": "section",
      "externalId": "my-bundle-1",
      "field": "description",
      "locale": "es-ES",
      "value": "Hola!"
    }
  ],
  "staticTranslations": [
    {
      "key": "checkout.pay_button",
      "locale": "es-ES",
      "value": "Zapłać teraz"
    }
  ]
}