Tag translations

Read and write localized tag fields through the Store API.

Get tag translation

GET read_products + read_translations

Fetch one tag translation.

Returns stored translated Tag fields for one locale, including whether the translation is out of date.

Path parameters

Name	Type	Description
`id` required	`integer`	Tag id. Example: `7`
`locale` required	`string`	Enabled non-default store locale. Example: `fr`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 STORE_API_INVALID_TAG_ID
Tag id is invalid.
400 TRANSLATION_LOCALE_REQUIRED
locale is required.
400 TRANSLATION_LOCALE_NOT_ENABLED
Locale is not enabled for this store.
400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN
Translations cannot target the store's default locale.
400 TRANSLATION_FIELD_NOT_TRANSLATABLE
Field is not translatable for tags.
400 TRANSLATION_FIELDS_REQUIRED
At least one translated field is required.
400 TRANSLATION_FIELD_VALUE_TOO_LONG
A translated value exceeds its field limit.
400 TRANSLATION_INVALID_RESOURCE_ID
Tag id is invalid.
400 TRANSLATION_TOO_MANY_RESOURCES
The request exceeds the translation batch resource cap.
404 TRANSLATION_RESOURCE_NOT_FOUND
Tag does not exist in this store.
409 TRANSLATION_DUPLICATE_NAME_OR_SLUG
Translated name or slug conflicts with another tag.

curl https://api-store.tringify.com/api/2025-01/tags/7/translations/fr \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/tags/7/translations/fr", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/tags/7/translations/fr",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "fields": {
      "name": {
        "value": "Soldes ete",
        "is_outdated": false,
        "word_count": 2
      }
    }
  }
}

Set tag translation

PUT write_products + write_translations

Set one tag translation.

Writes translated Tag fields for one locale. Empty values clear the matching field translation.

Path parameters

Name	Type	Description
`id` required	`integer`	Tag id. Example: `7`
`locale` required	`string`	Enabled non-default store locale. Example: `fr`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`translations` required	`object`	Field-keyed translation values. Allowed fields come from `contract.translation.fields`. Example: `{"name": "Soldes ete"}`

Errors

400 STORE_API_INVALID_TAG_ID
Tag id is invalid.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 TRANSLATION_LOCALE_REQUIRED
locale is required.
400 TRANSLATION_LOCALE_NOT_ENABLED
Locale is not enabled for this store.
400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN
Translations cannot target the store's default locale.
400 TRANSLATION_FIELD_NOT_TRANSLATABLE
Field is not translatable for tags.
400 TRANSLATION_FIELDS_REQUIRED
At least one translated field is required.
400 TRANSLATION_FIELD_VALUE_TOO_LONG
A translated value exceeds its field limit.
400 TRANSLATION_INVALID_RESOURCE_ID
Tag id is invalid.
400 TRANSLATION_TOO_MANY_RESOURCES
The request exceeds the translation batch resource cap.
404 TRANSLATION_RESOURCE_NOT_FOUND
Tag does not exist in this store.
409 TRANSLATION_DUPLICATE_NAME_OR_SLUG
Translated name or slug conflicts with another tag.
400 TAG_NAME_REQUIRED
Name is required.
400 TAG_NAME_INVALID_CHARS
Name contains unsupported control characters.
400 TAG_NAME_TOO_LONG
Name exceeds the maximum length.
400 TAG_SLUG_INVALID_FORMAT
Slug is not valid for Tag URLs.
400 TAG_SLUG_TOO_LONG
Slug exceeds the maximum length.
409 TAG_DUPLICATE
Name or slug already exists in this store.

curl -X PUT https://api-store.tringify.com/api/2025-01/tags/7/translations/fr \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "translations": {
    "name": "Soldes ete"
  }
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/tags/7/translations/fr", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "translations": {
      "name": "Soldes ete"
    }
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/tags/7/translations/fr",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "translations": {
            "name": "Soldes ete",
        },
    },
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "resource_type": "tag",
    "resource_id": "7",
    "locale": "fr"
  }
}

Batch get tag translations

GET read_products + read_translations

Fetch tag translations in batch.

Returns translated Tag fields for multiple tag ids in one locale.

Path parameters

Name	Type	Description
`locale` required	`string`	Enabled non-default store locale. Example: `fr`

Query parameters

Name	Type	Description
`ids` required	`string`	Comma-separated tag ids. Example: `1,2,3`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 TRANSLATION_LOCALE_REQUIRED
locale is required.
400 TRANSLATION_LOCALE_NOT_ENABLED
Locale is not enabled for this store.
400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN
Translations cannot target the store's default locale.
400 TRANSLATION_FIELD_NOT_TRANSLATABLE
Field is not translatable for tags.
400 TRANSLATION_FIELDS_REQUIRED
At least one translated field is required.
400 TRANSLATION_FIELD_VALUE_TOO_LONG
A translated value exceeds its field limit.
400 TRANSLATION_INVALID_RESOURCE_ID
Tag id is invalid.
400 TRANSLATION_TOO_MANY_RESOURCES
The request exceeds the translation batch resource cap.
404 TRANSLATION_RESOURCE_NOT_FOUND
Tag does not exist in this store.
409 TRANSLATION_DUPLICATE_NAME_OR_SLUG
Translated name or slug conflicts with another tag.

curl https://api-store.tringify.com/api/2025-01/tags/translations/fr?ids=1,2,3 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/tags/translations/fr?ids=1,2,3", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/tags/translations/fr?ids=1,2,3",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "resources": {
      "tag:7": {
        "fields": {
            "name": {
            "value": "Soldes ete",
            "is_outdated": false
          }
        }
      }
    }
  }
}

Batch set tag translations

PUT write_products + write_translations

Set tag translations in batch.

Writes translated Tag fields for multiple tag ids in one locale. Either every row is written or, if any row is invalid, none are.

Path parameters

Name	Type	Description
`locale` required	`string`	Enabled non-default store locale. Example: `fr`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`translations` required	`array<object>`	Rows with `id` and `fields`. Allowed field keys come from `contract.translation.fields`. Example: `[{"id": 7, "fields": {"name": "Soldes ete"}}]`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 TRANSLATION_LOCALE_REQUIRED
locale is required.
400 TRANSLATION_LOCALE_NOT_ENABLED
Locale is not enabled for this store.
400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN
Translations cannot target the store's default locale.
400 TRANSLATION_FIELD_NOT_TRANSLATABLE
Field is not translatable for tags.
400 TRANSLATION_FIELDS_REQUIRED
At least one translated field is required.
400 TRANSLATION_FIELD_VALUE_TOO_LONG
A translated value exceeds its field limit.
400 TRANSLATION_INVALID_RESOURCE_ID
Tag id is invalid.
400 TRANSLATION_TOO_MANY_RESOURCES
The request exceeds the translation batch resource cap.
404 TRANSLATION_RESOURCE_NOT_FOUND
Tag does not exist in this store.
409 TRANSLATION_DUPLICATE_NAME_OR_SLUG
Translated name or slug conflicts with another tag.
400 TAG_NAME_REQUIRED
Name is required.
400 TAG_NAME_INVALID_CHARS
Name contains unsupported control characters.
400 TAG_NAME_TOO_LONG
Name exceeds the maximum length.
400 TAG_SLUG_INVALID_FORMAT
Slug is not valid for Tag URLs.
400 TAG_SLUG_TOO_LONG
Slug exceeds the maximum length.
409 TAG_DUPLICATE
Name or slug already exists in this store.

curl -X PUT https://api-store.tringify.com/api/2025-01/tags/translations/fr \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "translations": [
    {
      "fields": {
        "name": "Soldes ete"
      },
      "id": 7
    }
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/tags/translations/fr", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "translations": [
      {
        "fields": {
          "name": "Soldes ete"
        },
        "id": 7
      }
    ]
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/tags/translations/fr",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "translations": [{
            "fields": {
                "name": "Soldes ete",
            },
            "id": 7,
        }],
    },
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "updated": 1
  }
}