shopLocaleUpdate - admin-graphql - MUTATION

Version: 2024-10

Description:

Updates a locale for a shop.

Access Scopes

`write_locales` access scope.

Arguments

• locale: String! - ISO code of the locale to update.
• shopLocale: ShopLocaleInput! - Specifies the input fields for a shop locale.

Returns

• shopLocale: ShopLocale The locale that was updated.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Publish a locale

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) { shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) { userErrors { message field } shopLocale { name locale primary published } } }\",\n \"variables\": {\n    \"locale\": \"ko\",\n    \"shopLocale\": {\n      \"published\": true\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n      shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n        userErrors {\n          message\n          field\n        }\n        shopLocale {\n          name\n          locale\n          primary\n          published\n        }\n      }\n    }`,\n    \"variables\": {\n      \"locale\": \"ko\",\n      \"shopLocale\": {\n        \"published\": true\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n    shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n      userErrors {\n        message\n        field\n      }\n      shopLocale {\n        name\n        locale\n        primary\n        published\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"locale\": \"ko\",\n  \"shopLocale\": {\n    \"published\": true\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n    shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n      userErrors {\n        message\n        field\n      }\n      shopLocale {\n        name\n        locale\n        primary\n        published\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"locale\" => \"ko\",\n  \"shopLocale\" => [\n    \"published\" => true,\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n    shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n      userErrors {\n        message\n        field\n      }\n      shopLocale {\n        name\n        locale\n        primary\n        published\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"locale\": \"ko\",\n      \"shopLocale\": {\n        \"published\": true\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n  shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n    userErrors {\n      message\n      field\n    }\n    shopLocale {\n      name\n      locale\n      primary\n      published\n    }\n  }\n}"
        

  input: {
    "locale": "ko",
    "shopLocale": {
      "published": true
    }
  }

  response: {
    "data": {
      "shopLocaleUpdate": {
        "userErrors": [],
        "shopLocale": {
          "name": "Korean",
          "locale": "ko",
          "primary": false,
          "published": true
        }
      }
    }
  }

  Unpublish a locale

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) { shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) { userErrors { message field } shopLocale { name locale primary published } } }\",\n \"variables\": {\n    \"locale\": \"ko\",\n    \"shopLocale\": {\n      \"published\": false\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n      shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n        userErrors {\n          message\n          field\n        }\n        shopLocale {\n          name\n          locale\n          primary\n          published\n        }\n      }\n    }`,\n    \"variables\": {\n      \"locale\": \"ko\",\n      \"shopLocale\": {\n        \"published\": false\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n    shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n      userErrors {\n        message\n        field\n      }\n      shopLocale {\n        name\n        locale\n        primary\n        published\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"locale\": \"ko\",\n  \"shopLocale\": {\n    \"published\": false\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n    shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n      userErrors {\n        message\n        field\n      }\n      shopLocale {\n        name\n        locale\n        primary\n        published\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"locale\" => \"ko\",\n  \"shopLocale\" => [\n    \"published\" => false,\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n    shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n      userErrors {\n        message\n        field\n      }\n      shopLocale {\n        name\n        locale\n        primary\n        published\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"locale\": \"ko\",\n      \"shopLocale\": {\n        \"published\": false\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation updateLocale($locale: String!, $shopLocale: ShopLocaleInput!) {\n  shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n    userErrors {\n      message\n      field\n    }\n    shopLocale {\n      name\n      locale\n      primary\n      published\n    }\n  }\n}"
        

  input: {
    "locale": "ko",
    "shopLocale": {
      "published": false
    }
  }

  response: {
    "data": {
      "shopLocaleUpdate": {
        "userErrors": [],
        "shopLocale": {
          "name": "Korean",
          "locale": "ko",
          "primary": false,
          "published": false
        }
      }
    }
  }