Skip to content

Create Locale

Adds a new locale so a storefront channel can offer that language. The new locale is returned with the server-assigned id / _id.

Operation

OperationTypePurpose
createAdminSettingsLocaleMutationCreate a locale

Input

FieldRequiredNotes
codeyesUnique locale code (lowercase letters, digits, underscore, hyphen — e.g. fr, pt-br).
nameyesHuman-readable display name.
directionyesText direction — ltr or rtl.

Notes

  • A logo image cannot be uploaded over GraphQL; new locales are created without a logo (logoPath / logoUrl are null).
  • A duplicate or malformed code is rejected with a validation error.

Permissions: settings.locales.create. See the Locales overview for behaviour.

Released under the MIT License.