translatableResource

query

Requires read_translations access scope.

A resource that can have localized values for different languages.

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 that has translatable fields.

Was this section helpful?

Retrieve existing French translations on a collection
Retrieve existing French translations specific to a market on a collection
Retrieve translatable content for a collection

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    translatableResource(resourceId: "gid://shopify/Collection/1007901140") {
7      resourceId
8      translations(locale: "fr") {
9        key
10        value
11      }
12    }
13  }`,
14);
15
16const data = await response.json();
17

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/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 } } }"
}'

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 data = await response.json();

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
      }
    }
  }`,
});

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)

Response

JSON

1{
2  "translatableResource": {
3    "resourceId": "gid://shopify/Collection/1007901140",
4    "translations": [
5      {
6        "key": "title",
7        "value": "la collection"
8      }
9    ]
10  }
11}