API documentationIncident ManagementFeedback
Edit

Localization

The fulfillmenttools platform supports localization, enabling management of data in multiple languages. This page explains how to change user and platform locales, request specific languages, and handle localized entity fields.

Supported languages

The list of supported languages can be retrieved via the API:

GET https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/supportedlocales

Usage

Many entities already support localization. The system automatically applies the target language in responses.

For example, article titles require translations during creation:

"titleLocalized": {
    "de_DE": "Dies ist ein sehr schöner Titel",
    "en_US": "This is a very nice title"
}

Validation rules for localized objects:

  • Must contain at least one entry

  • Keys must be valid locale codes (e.g., en_US) adhering to the ISO 639 language code (e.g., en) and the ISO 3166-1 country code (e.g., US).

  • Values must have a minimum length of 1

When requested via the REST API, the title field is automatically filled with the appropriate translation. For a German user, the response is:

"title": "Dies ist ein sehr schöner Titel",
"titleLocalized": {
    "de_DE": "Dies ist ein sehr schöner Titel",
    "en_US": "This is a very nice title"
}

Request a specific language

Language selection can be controlled in three ways:

  • User locale: Defined in the user object and included in the Bearer token.

  • Request locale: Specified with the locale query parameter.

  • Localized field: The *Localized field always contains all translations.

Fallback language

If the requested language is unavailable, the system applies the following fallback order:

  1. Language defined in user settings

  2. Default platform language

  3. English

  4. First available language for the entity

  5. Non-localized field value (legacy entities only)

Change user locale

Refer to the Users API documentation for details.

To change a user’s locale, send a PATCH request with the new locale. After updating, refresh the authentication token to apply the change.

PATCH https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/users/{userId}
{
    "actions": [
        {
            "action": "ModifyUser",
            "locale": "de_DE"
        }
    ],
    "version": 2
}

Change default platform locale

Refer to the Configurations API documentation for details.

The default platform locale defines the standard language for the entire platform. Update it with a PUT request:

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/locale
{
    "locale": "de_DE",
    "version": 42,
    ...
}

Last updated