Anchor to section titled 'undefined'translatable
translatable
query
2024-10latest
Requires read access scope.
A resource that can have localized values for different languages.
Anchor to section titled 'Arguments'
Arguments
Find a translatable resource by ID.
Was this section helpful?
Anchor to section titled 'TranslatableResource possible returns'
TranslatableResource possible returns
A resource that has translatable fields.
Was this section helpful?
Code examples for QUERY: translatableResource
Query Reference for QUERY: translatableResource
"{\n translatableResource(resourceId) {\n # TranslatableResource fields\n }\n}"Input Reference for QUERY: translatableResource
Schema Reference for QUERY: translatableResource
Display Examples for QUERY: translatableResource
[
{
"example": {
"type_name": "translatableresource",
"title": "Retrieve existing French translations on a collection",
"description": "Query the `translations` field on the return field to check existing translations associated with a collection.",
"query_string": "query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\") {\n key\n value\n }\n }\n}",
"query_arguments": {
"resourceId": "gid://shopify/Collection/1007901140"
},
"response": {
"data": {
"translatableResource": {
"resourceId": "gid://shopify/Collection/1007901140",
"translations": [
{
"key": "title",
"value": "la collection"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/markets/store_localization/test/unit/graph_api/admin/translatable_resource_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\": \"query { translatableResource(resourceId: \\\"gid://shopify/Collection/1007901140\\\") { resourceId translations(locale: \\\"fr\\\") { key value } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\") {\n key\n value\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 query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\") {\n key\n value\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\") {\n key\n value\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 query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\") {\n key\n value\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": [
{
"arg": {
"name": "resourceId",
"description": "Find a translatable resource by ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null
},
"key": "resourceId",
"argValue": " \"gid://shopify/Collection/1007901140\"",
"typeKind": "QUERY"
}
]
},
{
"example": {
"type_name": "translatableresource",
"title": "Retrieve existing French translations specific to a market on a collection",
"description": "Make use of the optional `marketId` argument when querying the `translations` field to retrieve content specific to a market.",
"query_string": "query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\", marketId: \"gid://shopify/Market/128989799\") {\n key\n value\n market {\n id\n name\n }\n }\n }\n}",
"query_arguments": {
"resourceId": "gid://shopify/Collection/1007901140"
},
"response": {
"data": {
"translatableResource": {
"resourceId": "gid://shopify/Collection/1007901140",
"translations": [
{
"key": "title",
"value": "la collection canadienne",
"market": {
"id": "gid://shopify/Market/128989799",
"name": "Canada"
}
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/markets/store_localization/test/unit/graph_api/admin/translatable_resource_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\": \"query { translatableResource(resourceId: \\\"gid://shopify/Collection/1007901140\\\") { resourceId translations(locale: \\\"fr\\\", marketId: \\\"gid://shopify/Market/128989799\\\") { key value market { id name } } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\", marketId: \"gid://shopify/Market/128989799\") {\n key\n value\n market {\n id\n name\n }\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 query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\", marketId: \"gid://shopify/Market/128989799\") {\n key\n value\n market {\n id\n name\n }\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\", marketId: \"gid://shopify/Market/128989799\") {\n key\n value\n market {\n id\n name\n }\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 query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translations(locale: \"fr\", marketId: \"gid://shopify/Market/128989799\") {\n key\n value\n market {\n id\n name\n }\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": [
{
"arg": {
"name": "resourceId",
"description": "Find a translatable resource by ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null
},
"key": "resourceId",
"argValue": " \"gid://shopify/Collection/1007901140\"",
"typeKind": "QUERY"
}
]
},
{
"example": {
"type_name": "translatableresource",
"title": "Retrieve translatable content for a collection",
"description": "Use this query as part of preparing to register translations. The `digest` value is required as an input argument when registering a translation.",
"query_string": "query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translatableContent {\n key\n value\n digest\n locale\n }\n }\n}",
"query_arguments": {
"resourceId": "gid://shopify/Collection/1007901140"
},
"response": {
"data": {
"translatableResource": {
"resourceId": "gid://shopify/Collection/1007901140",
"translatableContent": [
{
"key": "title",
"value": "Featured items",
"digest": "a18b34037fda5b1afd720d4b85b86a8a75b5e389452f84f5b6d2b8e210869fd7",
"locale": "en"
},
{
"key": "body_html",
"value": "Collection description",
"digest": "e3fbf5a945f94e5ddbb6bef20f5e5e3a923b34bdf1eb170f770a8aa0fd163bfa",
"locale": "en"
},
{
"key": "handle",
"value": "featured",
"digest": "d562318e9c2d7e6d9c70de511fbf5d3081fae3d6699eed31c3a87c5a0bc6ca51",
"locale": "en"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/markets/store_localization/test/unit/graph_api/admin/translatable_resource_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\": \"query { translatableResource(resourceId: \\\"gid://shopify/Collection/1007901140\\\") { resourceId translatableContent { key value digest locale } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translatableContent {\n key\n value\n digest\n locale\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 query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translatableContent {\n key\n value\n digest\n locale\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translatableContent {\n key\n value\n digest\n locale\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 query {\n translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") {\n resourceId\n translatableContent {\n key\n value\n digest\n locale\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": [
{
"arg": {
"name": "resourceId",
"description": "Find a translatable resource by ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null
},
"key": "resourceId",
"argValue": " \"gid://shopify/Collection/1007901140\"",
"typeKind": "QUERY"
}
]
}
]