Choose a version:

translatableResource

query

Requires read_translations access scope.

Retrieves a resource that has translatable fields. Returns the resource's Translation objects for different locales and markets, along with the original TranslatableContent and digest values needed to register new translations. Provides access to existing translations, translatable content with digest hashes for translation registration, and nested translatable resources like ProductVariant objects or Metafield objects.

Learn more about managing translated content.

Anchor to Arguments

Arguments

Anchor to resourceIdresourceId •ID! required: Find a translatable resource by ID.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to TranslatableResourceTranslatableResource

•TranslatableResource

A resource in Shopify that contains fields available for translation into different languages. Accesses the resource's translatable content, existing Translation objects, and any nested resources that can also be translated.

The TranslatableContent includes field keys, values, and digest hashes needed when registering translations.

You can retrieve translations for specific Locale and Market configurations. Each translation includes an outdated flag indicating whether the original content has changed since that translation was last updated.

Learn more about managing translated content.

Anchor to nestedTranslatableResourcesnestedTranslatableResources

•TranslatableResourceConnection!

non-null

Nested translatable resources under the current resource.

Arguments

Anchor to resourceTyperesourceType

•TranslatableResourceType

Return only resources of a type.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to resourceIdresourceId

•ID!

non-null

GID of the resource.

Anchor to translatableContenttranslatableContent

•[TranslatableContent!]!

non-null

Translatable content.

Anchor to marketIdmarketId •ID: Filters translatable content by market ID. Use this argument to retrieve translatable content specific to a market.

Anchor to translationstranslations

•[Translation!]!

non-null

Translatable content translations (includes unpublished locales).

Anchor to localelocale •String! required: Filters translations by locale.
Anchor to outdatedoutdated •Boolean: Filters by outdated translations.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Was this section helpful?

Examples

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

query {
  translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
    resourceId
    translations(locale: "fr") {
      key
      value
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") { resourceId translations(locale: \"fr\") { key value } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translations(locale: "fr") {
        key
        value
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translations(locale: "fr") {
        key
        value
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translations(locale: "fr") {
        key
        value
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
    resourceId
    translations(locale: "fr") {
      key
      value
    }
  }
}'

Response

{
  "translatableResource": {
    "resourceId": "gid://shopify/Collection/1007901140",
    "translations": [
      {
        "key": "title",
        "value": "la collection"
      }
    ]
  }
}

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

query {
  translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
    resourceId
    translations(locale: "fr", marketId: "gid://shopify/Market/128989799") {
      key
      value
      market {
        id
        name
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") { resourceId translations(locale: \"fr\", marketId: \"gid://shopify/Market/128989799\") { key value market { id name } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translations(locale: "fr", marketId: "gid://shopify/Market/128989799") {
        key
        value
        market {
          id
          name
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translations(locale: "fr", marketId: "gid://shopify/Market/128989799") {
        key
        value
        market {
          id
          name
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translations(locale: "fr", marketId: "gid://shopify/Market/128989799") {
        key
        value
        market {
          id
          name
        }
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
    resourceId
    translations(locale: "fr", marketId: "gid://shopify/Market/128989799") {
      key
      value
      market {
        id
        name
      }
    }
  }
}'

Response

{
  "translatableResource": {
    "resourceId": "gid://shopify/Collection/1007901140",
    "translations": [
      {
        "key": "title",
        "value": "la collection canadienne",
        "market": {
          "id": "gid://shopify/Market/128989799",
          "name": "Canada"
        }
      }
    ]
  }
}

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

query {
  translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
    resourceId
    translatableContent {
      key
      value
      digest
      locale
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") { resourceId translatableContent { key value digest locale } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translatableContent {
        key
        value
        digest
        locale
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translatableContent {
        key
        value
        digest
        locale
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translatableContent {
        key
        value
        digest
        locale
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
    resourceId
    translatableContent {
      key
      value
      digest
      locale
    }
  }
}'

Response

{
  "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"
      }
    ]
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

translatableResource(resourceId: "gid://shopify/Collection/1007901140") {

resourceId

translations(locale: "fr") {

key

value

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
    resourceId
    translations(locale: "fr") {
      key
      value
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { translatableResource(resourceId: \"gid://shopify/Collection/1007901140\") { resourceId translations(locale: \"fr\") { key value } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translations(locale: "fr") {
        key
        value
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translations(locale: "fr") {
        key
        value
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
      resourceId
      translations(locale: "fr") {
        key
        value
      }
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'query {
  translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
    resourceId
    translations(locale: "fr") {
      key
      value
    }
  }
}'

Response

JSON

{

"translatableResource": {

"resourceId": "gid://shopify/Collection/1007901140",

"translations": [

{

"key": "title",

"value": "la collection"

}

]

}