Internationalization - i18n
Attribute and masterdata objects can be translated into different languages. Translation is offered for the attributes name & description of:
- status
- type
- category
- classification
- documents
- products
Reading translated resources
The client should send the requested language in the HTTP Accept-Language header, which can be multiple languages with a quality factor. If no Accept-Language header is sent by the client, and no translation is available in any of the requested languages, the API will respond with the English translation.
We offer English and German translations for the objects listed above.
Identifier
The code property is used to identify the resource. By default, the code is the English name in lower snake-case. (e.g. name: ‘Out of Specification’, code: out_of_specification).
The only exception to this rule is for products, where the identifier is called product_code.
Writing translated resources
When creating a new resource, the submitted content is always saved as an English translation. The value of the Content-Language is ignored when creating a new resource. To add or change a translation, the client must patch the resource and specify the target language in the Content-Language header.
If the client sends multiple languages in the header, the first value is used. If no header is sent by the client, the value will be stored as the English translation.
Filtering and searching for translated resources
The client can send the requested language in the HTTP Accept-Language header. However, unlike the read methods, the filter will only search in the first preferred language sent by the client and then fall back on the in the English translations. It will not cascade through the second and third preferred languages.