For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
          • MUTcreateAppExtension
          • MUTupdateAppExtension
          • MUTdeleteAppExtension
          • MUTcreateChannel
          • MUTremoveProductBasicInformationOverrides
          • MUTremoveProductSeoInformationOverrides
          • MUTremoveProductOptionsOverrides
          • MUTremoveProductStorefrontDetailsOverrides
          • MUTremoveProductPreOrderSettingsOverrides
          • MUTsetProductBasicInformation
          • MUTsetProductIsFeatured
          • MUTremoveProductIsFeaturedOverride
          • MUTsetProductSeoInformation
          • MUTsetProductStorefrontDetails
          • MUTsetProductPreOrderSettings
          • MUTsetProductOptionsInformation
          • MUTsetProductUrlPath
          • MUTremoveProductUrlPathOverride
          • MUTsetProductModifiersInformation
          • MUTremoveProductModifiersOverrides
          • MUTremoveProductCustomFieldsOverrides
          • MUTupdateProductCustomFields
          • MUTaddImagesToProduct
          • MUTremoveImagesFromProduct
          • MUTupdateProductImageProperties
          • MUTremoveProductImagePropertiesOverrides
          • MUTsetSharedProductModifiersInformation
          • MUTremoveSharedProductModifiersOverrides
          • MUTsetSharedProductOptionsInformation
          • MUTremoveSharedProductOptionsOverrides
          • MUTsettings
          • MUTupdateTranslations
          • MUTdeleteTranslations
          • MUTaddLocale
          • MUTdeleteLocale
          • MUTupdateLocale
          • MUTcreateEventBridgeWebhook
          • MUTcreatePubSubWebhook
          • MUTupdatePubSubWebhook
          • MUTupdateEventBridgeWebhook
          • MUTcreateHttpsWebhook
          • MUTdeleteWebhook
          • MUTupdateHttpsWebhook
          • MUTcreateMetafield
          • MUTupdateMetafield
          • MUTdeleteMetafield
          • MUTreassignMetafieldsOwner
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLAdminMutations

addLocale

Example Query
1mutation ExampleMutation($input: AddLocaleInput) {
2 addLocale(input: $input) {
3 locale {
4 code
5 status
6 isDefault
7 }
8 errors
9 }
10}
Variables
1{
2 "input": {
3 "channelId": "example",
4 "code": "example",
5 "status": "ACTIVE"
6 }
7}
Example response
1{
2 "data": {
3 "addLocale": {
4 "locale": {
5 "code": "example",
6 "status": "ACTIVE",
7 "isDefault": true
8 },
9 "errors": [
10 {
11 "id": "example",
12 "message": "example"
13 }
14 ]
15 }
16 }
17}
Adds a locale to a channel.
Was this page helpful?
Previous

deleteTranslations

Next

deleteLocale

Built with

Arguments

inputAddLocaleInputRequired

Returns

an optional AddLocaleResult
errorslist of AddLocaleErrors
The errors that occurred during the add locale mutation.
localeLocale
The locale that was added.