fulfillmenttools
  • Welcome to the fulfillmenttools Platform Documentation
  • Getting Started
    • Setup your access to fulfillmenttools
    • Make your first API Calls
      • Add your first facility
      • Add your first listing
      • Place your first order
    • Core concepts & terminology
      • Order Flow
    • Postman Collection
    • Client SDKs
    • FAQ
  • Clients
    • Backoffice
      • First steps - Registration
      • Network view
        • Home
        • Orders
          • Unroutable orders
          • Pre-orders & Backorders
          • Order History
        • Inventory Management
          • Stock Overview
          • Channel Inventory
        • Facilities
        • Users
        • Returns
        • DOMS configuration
        • Settings
        • Analytics
          • DOMS Pages
          • Fulfillment Operations Pages
          • Inventory Pages
          • Downloads Page
      • Facility view
        • Home
        • Inbound
        • Tasks
        • Listings
        • Storage Locations
        • Facility
        • Users
    • Inventory app
      • Registration Inventory App
      • App sections
        • Inbound
        • Storage and relocation
    • Operations app
      • Android
        • Manual Registration
        • Android Enterprise Registration
        • Sections
          • Picking
            • Load Units (legacy)
            • Substitute items
            • Weighed or measured products
            • Scanning configuration
            • Picking Methods
              • Batch Picking
              • Multi Order Picking
          • Packing
          • Handover
          • Returns (legacy)
        • Printing
        • Notifications
      • Webapp
        • Packing
      • Overview features Android & Webapp
    • Technical requirements
      • Zebra Hardware Scanner Configuration
      • Honeywell Hardware Scanner Configuration
      • Supported barcodes for camera scanning
      • Requirements for fft applications
      • Zebra printer
    • Returns app
      • Handle unannounced returns
      • Handle announced returns
  • Products
    • Core Functionality
      • Process
        • External actions
      • Add and manage facilities
      • Notification Center
      • Checking on features
      • Tags and Stickers Concept
      • GDPR
      • Remote Configuration
      • Expiry
      • Target time
      • Time calculation for queries of future availabilities (LPS-calculation)
      • Interfacility Transfer
    • Carrier Management
      • Overview
        • Available Carriers
      • Concepts
        • Carrier Country Service Mapping (CCSM)
        • Non-delivery-days
        • Custom Carrier & Headless operation of Carriers
      • Providing needed data
    • Fulfillment Options
      • Fulfillability Check
      • Checkout Options
        • Available fulfillment options based on basket
        • Earliest possible delivery date
        • Available delivery dates within time-period
        • Availability for delivery date
      • Delivery Promise
    • Inventory Management
      • Configurations
      • Entities
        • Listing
        • Stock
          • Stock Properties
        • Storage Location
        • Zone
      • Global Inventory
        • Stock availability
        • Channel Inventory
        • Expected stock
        • Inbound Process
        • Reservations
        • Safety Stock
      • Inventory Control
        • Inventory Traits
        • Measurement Units
        • Outbound Inventory Tracking
        • Storage Location Recommendations
    • Order Fulfillment
      • Headless Order Fulfillment
      • Pick Jobs
      • Zone picking
      • Load Units
      • Custom Service
      • Handover Jobs
      • Add External Documents
      • Configurations
        • Picking Configuration
          • Picking methods
          • Short Pick Reasons
        • Packing Configuration
          • Packing Container Types
        • Print / Document Configuration
        • Tag Configurations
          • Parcel Tag Configuration
        • Handover Configuration
        • Operative Container Types
    • Order Routing
      • Entities
        • Ship-from-Store Orders
        • Click-and-Collect Orders
        • Locked Orders
        • Custom Services Orders
          • Simple Custom Service Order
          • Complex Custom Service Order
      • Fences
      • Ratings
      • Order Split
        • Order split - initial routing
        • Order split after shortpick
        • Item bundles
      • Reroute
      • Shape the routing with the DOMS Toolkit
      • Decision logs
    • Returns Management
      • Returns legacy
        • Available status
      • Returns 2.0
        • Return Reasons
        • Item Conditions
        • Integrating Returns with Events
    • Use Cases
      • Demand-Driven Replenishment
      • Expected stock in availability
      • Multi Order Picking
      • Interfacility transfer
      • Assigned Users
  • Connecting to fulfillmenttools
    • General Topics
      • Use external identity providers to authenticate to fulfillmenttools
        • Microsoft Entra ID / Azure Active Directory (AD)
      • Public Event Export
      • Available Regions
      • Backup Policies
    • GraphQL API
    • RESTful API
      • General Topics
        • API Release Life Cycle
        • Versioning
        • Authorization
        • Customization via Attributes
        • Update Guarantees
        • Rate Limits
        • Resource Timestamps
        • Pagination Interface
        • Localization
        • Custom Attributes
      • OpenAPI Specification
        • Swagger UI
        • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an Event
      • Available Events
      • Tutorial
    • commercetools Connect
    • Integration Tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout Options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
  • Incident Reporting
    • How to report incidents in fulfillmenttools
    • How to define incident priorities
  • Release Notes
    • Release Summary – May 2024
    • Release Summary – June 2024
    • Release Summary – July 2024
    • Release Summary – August 2024
    • Release Summary – September 2024
    • Release Summary – October 2024
Powered by GitBook
On this page

Was this helpful?

  1. Connecting to fulfillmenttools
  2. RESTful API
  3. General Topics

Localization

PreviousPagination InterfaceNextCustom Attributes

Last updated 5 months ago

Was this helpful?

This page is outdated. Please go to our new documentation under .

The fulfillmenttools platform supports localization, enabling 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 Localization Features

  • User-specific locales: Determined by user settings in the authentication token.

  • Request-specific languages: Can be specified using a locale query parameter.

  • Localized entity fields: Store and retrieve localized field values.

Supported Languages

A list of currently supported languages can be found via the API. All supported languages are also available in the Backoffice and other fulfillmenttools applications.

Requesting Specific Languages

To request data in a specific language, add the locale query parameter followed by the language code, conforming to the ISO 639-1 standard.

Example request for a specific language

GET /api/endpoint?locale=de_DE

Fallback Language Mechanism

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

  1. Language specified in user settings.

  2. Default platform language.

  3. English (en_US).

  4. First available language for the entity.

  5. Non-localized field value of the entity.

Handling Localized Information in Entities

Each localizable entity schema contains fields and their corresponding localized versions, which are stored as objects with locale codes as keys.

Example of localized entity fields

{
  "title": "My Product",
  "titleLocalized": {
    "de_DE": "Mein Produkt",
    "fr_FR": "Mon produit",
    "nl_NL": "Mijn product"
  }
}
  • GET requests return localized values based on the user's locale.

  • POST, PUT, and PATCH requests must provide all localized values for the desired locales. Partial updates of localized values are not supported.

Using Entities Without Localization

The platform will prioritize returning localized values based on the user's locale. If a non-localized field is patched when a localizedObject is already present, the original field will always be overridden with the localized values in responses.

If localization is not required, omit the <fieldName>Localized object and provide the non-localized field directly.

Example of non-localized usage

{
  "title": "My Product"
}

Changing the 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 change, you must request a new authentication token to reflect the locale update.

Changing the Default Platform Locale

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

https://docs.fulfillmenttools.com/documentation

Get the list of supported locales

get
Authorizations
Responses
200
The supported locales can be found in the body.
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
get
GET / HTTP/1.1
Host: %%HOST%%
Accept: */*
[
  "de_DE"
]
  • Supported Localization Features
  • Supported Languages
  • GETGet the list of supported locales
  • Requesting Specific Languages
  • Fallback Language Mechanism
  • Handling Localized Information in Entities
  • Using Entities Without Localization
  • Changing the User Locale
  • PATCHPatch an existing user with the given ID
  • Changing the Default Platform Locale
  • PUTChange the tenant wide default locale configuration

Patch an existing user with the given ID

patch
Authorizations
Path parameters
userIdstringRequired

ID of the user you want to patch

Body
versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
Responses
200
The user is successfully modified.
application/json
Responseall of
400
Invalid input. See response for details
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
409
Facility version conflict
application/json
patch
PATCH / HTTP/1.1
Host: %%HOST%%
Content-Type: application/json
Accept: */*
Content-Length: 315

{
  "actions": [
    {
      "action": "ModifyUser",
      "firstname": "Alex",
      "lastname": "Schneider",
      "locale": "de_DE",
      "password": "fsdf6556",
      "roles": [
        {
          "facilities": [
            "0T1vKaEar0nuG58CxzA5"
          ],
          "name": "FULFILLER"
        }
      ],
      "assignedFacilities": [
        {
          "facilityRef": "0T1vKaEar0nuG58CxzA5",
          "assignedZones": [
            {
              "zoneRef": "LGMl2DuvPnfPoSHhYFOm"
            }
          ]
        }
      ]
    }
  ],
  "version": 42
}
{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "customClaims": {
    "roles": [
      {
        "facilities": [
          "0T1vKaEar0nuG58CxzA5"
        ],
        "name": "FULFILLER"
      }
    ]
  },
  "firstname": "Alex",
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "lastname": "Schneider",
  "locale": "de_DE",
  "username": "aschneider",
  "authenticationProvider": {
    "type": "EMAIL_PASSWORD",
    "id": "LGMl2DuvPnfPoSHhYFOm"
  },
  "assignedFacilities": [
    {
      "facilityRef": "0T1vKaEar0nuG58CxzA5",
      "assignedZones": [
        {
          "zoneRef": "LGMl2DuvPnfPoSHhYFOm"
        }
      ],
      "id": "LGMl2DuvPnfPoSHhYFOm"
    }
  ]
}

Change the tenant wide default locale configuration

put
Authorizations
Body
localestring · enumRequired

ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)

Example: de_DEPossible values:
idstringOptional
Responses
200
The locale Configuration was successfully set.
application/json
400
Invalid input. See response for details
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
put
PUT / HTTP/1.1
Host: %%HOST%%
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "locale": "de_DE",
  "countryLanguageMapping": {
    "DE": "de_DE",
    "US": "en_US",
    "RU": "ru_RU"
  },
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}
{
  "locale": "de_DE",
  "countryLanguageMapping": {
    "DE": "de_DE",
    "US": "en_US",
    "RU": "ru_RU"
  },
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}