fulfillmenttools
API documentationIncident ManagementFeedback
Developer Docs
Developer Docs
  • Developer docs
  • Getting Started
    • Quickstart
    • Integration tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
    • Free trial
  • Technical Basics
    • Access to fulfillmenttools
    • Feature status
    • Available regions
    • Backup policies
  • Connecting to fulfillmenttools
    • Client SDKs
    • commercetools connect
    • OpenID connect
      • Configure Microsoft Entra ID / Azure Active Directory
      • Configure Keycloak
  • API
    • Core concepts
      • Authentication & authorization
      • API Versioning & lifecycle
      • Assign user to jobs
      • Localization
      • Resource timestamps
      • Custom attributes
      • Article attributes
      • Recordable attributes
      • Data update guarantees
      • Rate limits & scaling
      • Retries
      • Performance on test vs. production systems
      • Load testing
    • API calls
      • Postman
      • cURL
      • GraphQL Explorer
    • GraphQL API
    • RESTful API
      • Pagination interface
      • RapiDoc
      • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an event
      • Available events
        • Event flows
      • Eventing example
      • Event export
  • Integration Guides
    • Basics
      • Article categories
      • Audits
      • Facilities
      • Facility groups
      • GDPR configuration
      • Listings
      • Remote configuration
      • Receipts
      • Search
      • Subscribe to events
      • Sticker
      • Stocks
      • Storage locations
      • Tags
      • Users
    • Channel inventory
    • Facility discounts
    • Inbound process
    • Outbound stocks
    • Purchase order
    • Receipt
    • Routing strategy
    • Show sticker to clients
    • Stow jobs
  • More Integration Guides
    • Carrier management
      • Introduction to carrier configuration
      • Required data when operating carriers
      • Adding & connecting carriers to facilities
      • Custom carrier
    • Configurations for order fulfillment
      • Picking configuration
      • Packing configuration
      • Handover configuration
      • Printing and document configuration
      • Packing container types
      • Parcel tag configuration
      • Headless order fulfillment
      • Short-pick reasons
      • External documents in order fulfillment
      • Service jobs
      • Load units
      • Running sequence
    • DOMS - distributed order management system (routing)
    • External actions
    • Interfacility transfer
    • Notifications
    • Orders
      • Place your first order
      • Ship-from-store orders
      • Click-and-collect orders
      • Locked orders
      • Order with custom services
      • Bundled items in an order
      • Order process status
    • Availability & promising
    • Returns
Powered by GitBook
On this page
  • Supported languages
  • Usage
  • Request specific language
  • Fallback language
  • Change user locale
  • Change default platform locale
Edit on GitHub
  1. API
  2. Core concepts

Localization

The fulfillmenttools platform supports localization, which enables you to manage data in multiple languages. This document outlines how to change user and platform locales, request specific languages for your requests, and handle localized information in entities.

Supported languages

A list of currently supported languages can be obtained via the API:

GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/supportedlocaless

Usage

Many of our entities already have the localization feature, meaning the target language is already set for you in the result.

For example, we use the title in our articles (that is used, e.g. in the pick job line items). For creation, you have to define the different translations for the title, like in the following example:

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

If the title is requested by the REST API, the title field will be automatically filled with the corresponding translation. For example, if you use a user with German language, the result will look like this:

"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 specific language

To request a specific language, you have different possibilities:

  • User-specific language: Determined by the locale from the user object. This is automatically part of the Bearer token and will be used to select the language in the response.

  • Request-specific language: Use the query parameter locale, to get a specific language back.

  • Localized entity field: The *Localized field holds all translations every time.

Fallback language

If a requested language is unavailable, the platform uses the following fallback mechanism:

  1. Language specified in user settings

  2. Default platform language

  3. English

  4. The first available language for the entity

  5. Non-localized field value of the entity (only available on old entities)

Change user locale

To change the user locale, send a PATCH request to the user endpoint, including the new locale in the request body.

After the user locale changes, you must manually refresh the auth token to use the new language directly.

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

Change default platform locale

The default platform locale sets the standard language for the whole platform. Change it by sending a PUT request to the relevant configuration endpoint.

PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/locale
{
    "locale": "de_DE",
    ...
    "version": 42
}

Last updated 4 months ago

More Users-API information can be found here:

More Configurations-API information can be found here:

REST API documentation - Users
REST API documentation - Configurations