Skip to content

Locales

View as Markdown

A Locale is a language your catalog’s translatable content - product titles, option labels, supplier names - can be written in. Enable a locale here, then read or write translations in it with the Flowkiwi-Locale header.

Exactly one locale is the default at any time (its default is true): the one content is authored in and falls back to. You don’t change it here but through the Default locale resource.

A locale is identified by its code, in the ll or ll-CC format - such as fr, en-US or de-DE. There is no update: enable or delete a locale.

PropertyTypeRequiredDescription
codestringrequiredA locale identifier in the format ll or ll-CC, where ll is a two-letter lowercase language code (e.g., fr for French), and CC is an optional two-letter uppercase country code (e.g. FR for France).

Examples: fr, en-US, de-DE.
createdAtstring-The date and time when the resource was created (ISO 8601 format).
defaultboolean-Whether this locale is the default one. Exactly one locale is the default at any time. To change it, use PUT /api/default_locale.
updatedAtstring-The date and time when the resource was last modified (ISO 8601 format).
  • Sell in a new language. Create the locale, then write translations with Flowkiwi-Locale set to its code.
  • Switch the default. Set the default locale to another enabled locale.
  • Retire a language. Delete a non-default locale. Its translations are not deleted - they stay stored as orphans and are simply no longer reachable.

All requests require an OAuth 2.0 bearer token:

Authorization: Bearer <token>

Reading requires the instance_params:read scope; writing also requires instance_params:write.