translatableResource

query

Requires read_translation access scope.

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

Query a store's translation data.

Arguments

resourceId ● ID!non-null

The unique identifier for the resource.
For example, product ID 16057169190700063316363001.

Return

resourceId ● ID!non-null

The unique identifier for the resource.
For example, product ID 16057169190700063316363001.

translations ● [Translation]

Translatable content.

translatableContent ● [TranslatableContent!]!non-null

The resource content translation information.

Status and error codes

For detailed information about common codes, see Status and error codes.

Example

Query original and translated data for a specific resource, market, and language, where the translation data is outdated

Code

query MyQuery {
  translatableResource(resourceId: "gid://shopline/Product/12259794083525432746782293") {
    resourceId
    translatableContent {
      digest
      key
      locale
      type
      value
    }
    translations(locale: "en", outdated: true, marketId: "2805979406510623080534") {
      key
      locale
      market {
        id
      }
      outdated
      updatedAt
      value
    }
  }
}

Response

{
	"data": {
		"translatableResource": {
			"resourceId": "gid://shopline/Product/12259794083525432746782293",
			"translatableContent": [
				{
					"digest": "361af515d4e29f4a80ac9f8702ab703b",
					"key": "title",
					"locale": "DEFAULT",
					"type": "STRING",
					"value": "title"
				}
			],
			"translations": [
				{
					"key": "title",
					"locale": "en",
					"market": {
						"id": "2805979406510623080534"
					},
					"outdated": true,
					"type": "STRING",
					"updatedAt": "2025-01-05T00:00:00.492Z",
					"value": "desc"
				}
			]
		}
	}
}

Was this article helpful to you?

SHOPLINE

Legal