Anchor to section titled 'undefined'shop
shop
mutation
2024-10latest
Requires write access scope.
Updates a locale for a shop.
Anchor to section titled 'Arguments'
Arguments
ISO code of the locale to update.
Specifies the input fields for a shop locale.
Was this section helpful?
Anchor to section titled 'ShopLocaleUpdatePayload returns'
ShopLocaleUpdatePayload returns
The locale that was updated.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: shopLocaleUpdate
Query Reference for MUTATION: shopLocaleUpdate
"mutation shopLocaleUpdate($locale: String!, $shopLocale: ShopLocaleInput!) {\n shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {\n shopLocale {\n # ShopLocale fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: shopLocaleUpdate
"{\n \"locale\": \"<your-locale>\",\n \"shopLocale\": {\n \"marketWebPresenceIds\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"published\": true\n }\n}"Schema Reference for MUTATION: shopLocaleUpdate
"input ShopLocaleInput {\n marketWebPresenceIds: [ID!]\n published: Boolean\n}\n"Display Examples for MUTATION: shopLocaleUpdate
[
{
"example": {
"type_name": "shoplocaleupdate",
"title": "Publish a locale",
"description": "Publishing a locale makes it available for translation. Make sure that you enable the locale before publishing it. A shop can have up to 20 alternate published locales.",
"query_string": "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}",
"query_arguments": {
"locale": "$locale",
"shopLocale": "$shopLocale"
},
"variables": {
"locale": "ko",
"shopLocale": {
"published": true
}
},
"response": {
"data": {
"shopLocaleUpdate": {
"userErrors": [],
"shopLocale": {
"name": "Korean",
"locale": "ko",
"primary": false,
"published": true
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/markets/store_localization/test/unit/graph_api/admin/mutations/shop_locale_update_test.rb",
"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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "locale",
"description": "ISO code of the locale to update.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "String!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "locale",
"argValue": " \"ko\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "shopLocale",
"description": "Specifies the input fields for a shop locale.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ShopLocaleInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ShopLocaleInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "shopLocale",
"argValue": " {\"published\":true}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "shoplocaleupdate",
"title": "Unpublish a locale",
"query_string": "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}",
"query_arguments": {
"locale": "$locale",
"shopLocale": "$shopLocale"
},
"variables": {
"locale": "ko",
"shopLocale": {
"published": false
}
},
"response": {
"data": {
"shopLocaleUpdate": {
"userErrors": [],
"shopLocale": {
"name": "Korean",
"locale": "ko",
"primary": false,
"published": false
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/markets/store_localization/test/unit/graph_api/admin/mutations/shop_locale_update_test.rb",
"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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "locale",
"description": "ISO code of the locale to update.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "String!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "locale",
"argValue": " \"ko\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "shopLocale",
"description": "Specifies the input fields for a shop locale.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ShopLocaleInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ShopLocaleInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "shopLocale",
"argValue": " {\"published\":false}",
"typeKind": "MUTATION"
}
]
}
]