Language Tutorials

While the Emporix e-commerce system is designed in English, you can specify languages in which your business communicates with suppliers and customers. Languages are used when generating the following resources:

  • Business reports

  • Emails

  • Invoices

  • Packlists

  • Picklists

  • Shipping notes

Supported languages

The Emporix e-commerce system supports all existing languages, including regional language variants such as American English or Swiss German. By default, both your Emporix tenant and its main site have their language set to English.

Language configurations

Languages are configured both tenant-wide and independently for particular sites.

Language codes defined in language configurations must be compliant with the IETF BCP-47 standard.

Your tenant's language configuration is stored under the project_lang key in the Emporix API Configuration Service. Check out the following language configuration example:

{
  "key": "project_lang",
  "value": "[{\"id\":\"en\",\"label\":\"English\",\"default\":false,\"required\":false},{\"id\":\"de\",\"label\":\"German\",\"default\":true,\"required\":true},{\"id\":\"fr\",\"label\":\"French\",\"default\":false,\"required\":false}]"
}

Site-specific language configuration is stored in the defaultLanguage and languages fields, inside the Site object.


{
  "defaultLanguage": "de",
  "languages": [
    "de",
    "en"
  ]
}

Managing language configurations through Emporix API

Check out the following tutorials to learn more about language configuration with Emporix API.

How to check which languages are configured for your tenant

To retrieve your tenant's language configuration, you need to send a request to the Retrieving a configuration endpoint.

API Reference
curl -L \
  --url 'https://api.emporix.io/configuration/{tenant}/configurations/{propertyKey}' \
  --header 'Accept: */*'

How to change your tenant's language configuration

To change your tenant's language configuration, you need to send a request to the Updating a configuration endpoint with updated language information in the request body.

API Reference
curl -L \
  --request PUT \
  --url 'https://api.emporix.io/configuration/{tenant}/configurations/{propertyKey}' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "project_country",
    "secured": false,
    "value": "AT",
    "version": 1
  }'

How to check which languages are configured for a particular site

To retrieve a particular site's language configuration, you need to send a request to the Retrieving a site endpoint. The language configuration will be returned in the the defaultLanguage and language fields in the response body.

API Reference
curl -L \
  --url 'https://api.emporix.io/site/{tenant}/sites/{siteCode}' \
  --header 'Accept: */*'

How to change a particular site's language configuration

To change a particular site's language configuration, you need to call the Partially updating a site endpoint with language configuration of your choice in the request body.

API Reference
curl -L \
  --request PATCH \
  --url 'https://api.emporix.io/site/{tenant}/sites/{siteCode}' \
  --header 'Content-Type: application/json' \
  --data '{
    "defaultLanguage": "en"
  }'

Last updated

Was this helpful?