Manage app translations with the GraphQL Admin API
This guide explains how to use the GraphQL Admin API to create and retrieve translated content for Shopify resources. It also covers how to retrieve translated content using the Storefront API. For example, you might add translations of product information and email notification templates using the GraphQL Admin API so a merchant can send customers email notifications in multiple languages. Those translations can then be retrieved by either the GraphQL Admin API or the Storefront API.
GraphQL Admin API translation access scopes
To use the GraphQL Admin API to create or retrieve translated content, your app needs to request the
write_translations access scopes for a Shopify store. For more information on requesting access scopes when your app is installed, see OAuth.
Storefront API translation header
To use the Storefront API to retrieve translated content, your app needs to use the
Accept-Language HTTP request header when sending queries. The following example header enables Spanish translations to be returned using the Storefront API:
GraphQL Admin API translatable resource types
The following resource types and fields are translatable:
|Online store article||
|Online store blog||
|Online store page||
|Online store theme||
Retrieve a list of translatable resource types
TranslatableResourceType contains a list of the resource types that are translatable. You can use the following query to list each of those types:
Storefront API translation resources
The following resources include properties that can be retrieved using the Storefront API:
You can use the translateableResources connection to retrieve a list of translatable resources, their translatable content, and their existing translations in various languages. You can also retrieve all translations for a locale, regardless of resource type.
- Retrieve a list of translatable resource types
- Retrieve a list of translatable resources by their type
- Retrieve translations for a resource type and locale
- Retrieve a single translatable resource by its ID
- Retrieve translations from a resource object
Retrieve a list of translatable resources by their type
The following query retrieves a list of translatable resources that are products. For each product, the query retrieves the content that can be translated in the
The response shows that the White T-Shirt product with the ID
"gid://shopify/Product/1" has content that can be translated, including its title and body HTML.
key field associates translatable content with its translations. The
value field shows the translatable content itself. The
digest field is the translatable content's unique identifier. When you create a translation, the mutation needs to include the translatable content's digest value in the translatableContentDigest field.
Retrieve translations for a resource type and locale
Like the example above, this query retrieves a list of products and their translatable content. This query also includes the
translations field for each product, which retrieves any existing translations.
The field takes the argument
locale, which spec