Menu item translations

Read and write translated navigation item titles through the Store API.

Only a menu item's title is translatable. Menu names, handles, link destinations, and tree positions stay unchanged. Use item IDs from a menu tree or item list. Reads require read_menus and read_translations; writes require write_menus and write_translations. The locale must be enabled and must not be the store's source language.

An empty title removes its translation. Batch reads return field maps keyed by menu_item:{id}; batch writes apply all rows or none. Source title edits mark translations as outdated without hiding them. Deleting an item removes its translations.

Get a menu item translation

GET read_menus + read_translations

Read a menu item's translated title.

Menu item IDs are store-scoped. Only title is translatable; destinations, menu names and handles stay unchanged. Missing translations return an empty fields object.

Path parameters

Name	Type	Description
`itemId` required	`uuid`	Menu item ID returned in a menu tree or item list. Example: `1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0`
`locale` required	`string`	Enabled non-default store locale. Example: `fr`

Headers

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

Errors

400 INVALID_INPUT
A menu item ID is not a valid UUID.
400 TRANSLATION_LOCALE_REQUIRED
A locale is required.
400 TRANSLATION_LOCALE_NOT_ENABLED
The language is not enabled for this store.
400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN
The source language cannot be a translation target.
400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE
An item does not exist in this store.
400 TRANSLATION_TOO_MANY_RESOURCES
The batch exceeds the translation resource limit.

curl 'https://api-store.tringify.com/api/2025-01/menus/items/1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0/translations/fr' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/items/1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0/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/menus/items/1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0/translations/fr",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "fields": {
      "title": {
        "is_outdated": false,
        "value": "Boutique",
        "word_count": 1
      }
    }
  },
  "success": true
}

Set a menu item translation

PUT write_menus + write_translations

Write or clear a menu item's translated title.

Supply title; an empty string clears its translation. A nonempty translation requires a nonempty source title. Saves validate ownership and source content and commit translation events atomically.

Path parameters

Name	Type	Description
`itemId` required	`uuid`	Menu item ID returned in a menu tree or item list. Example: `1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0`
`locale` required	`string`	Enabled non-default store locale. Example: `fr`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.
`Idempotency-Key`	`string`	Optional key for this translation write. Reuse it only with the same payload when repeating the request.

Body parameters

Name	Type	Description
`translations` required	`object`	Only title is supported. Example: `{"title":"Boutique"}`

Errors

400 INVALID_INPUT
A menu item ID is not a valid UUID.
400 TRANSLATION_LOCALE_REQUIRED
A locale is required.
400 TRANSLATION_LOCALE_NOT_ENABLED
The language is not enabled for this store.
400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN
The source language cannot be a translation target.
400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE
An item does not exist in this store.
400 TRANSLATION_TOO_MANY_RESOURCES
The batch exceeds the translation resource limit.
400 STORE_API_INVALID_REQUEST_BODY
The body is invalid or contains unknown fields.
400 TRANSLATION_FIELD_NOT_TRANSLATABLE
Only title can be translated.
400 TRANSLATION_FIELDS_REQUIRED
At least one translated field is required.
400 TRANSLATION_NO_SOURCE_TEXT
A nonempty translation requires a source title.
400 MENU_ITEM_TITLE_TOO_LONG
The translated title exceeds the menu item title limit.
409 TRANSLATION_MUTATION_CONFLICT
The idempotency key was already used for a different translation change.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/menus/items/1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0/translations/fr' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "translations": {
    "title": "Boutique"
  }
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/items/1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0/translations/fr", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "translations": {
      "title": "Boutique"
    }
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/menus/items/1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0/translations/fr",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "translations": {
            "title": "Boutique",
        },
    },
)
data = res.json()

Response

200

Sample response

{
  "code": "TRANSLATION_SAVED",
  "message": "Translation saved.",
  "success": true
}

Batch get menu item translations

GET read_menus + read_translations

Read translated titles for menu items.

Supply item IDs from this store. Each requested item appears in resources, including an empty field map when it has no translation.

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 menu item IDs. Example: `1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0`

Headers

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

Errors

400 INVALID_INPUT
A menu item ID is not a valid UUID.
400 TRANSLATION_LOCALE_REQUIRED
A locale is required.
400 TRANSLATION_LOCALE_NOT_ENABLED
The language is not enabled for this store.
400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN
The source language cannot be a translation target.
400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE
An item does not exist in this store.
400 TRANSLATION_TOO_MANY_RESOURCES
The batch exceeds the translation resource limit.

curl 'https://api-store.tringify.com/api/2025-01/menus/items/translations/fr?ids=1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/items/translations/fr?ids=1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0", {
  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/menus/items/translations/fr?ids=1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "resources": {
      "menu_item:1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0": {
        "title": {
          "is_outdated": false,
          "value": "Boutique",
          "word_count": 1
        }
      }
    }
  },
  "success": true
}

Batch set menu item translations

PUT write_menus + write_translations

Write translated menu item titles in one batch.

Each row identifies a menu item from this store and supplies title in fields. The complete batch is validated before any translation is saved.

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.
`Idempotency-Key`	`string`	Optional key for this translation write. Reuse it only with the same payload when repeating the request.

Body parameters

Name	Type	Description
`translations` required	`array<object>`	Rows with an item id and title in fields. Example: `[{"id":"1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0","fields":{"title":"Boutique"}}]`

Errors

400 INVALID_INPUT
A menu item ID is not a valid UUID.
400 TRANSLATION_LOCALE_REQUIRED
A locale is required.
400 TRANSLATION_LOCALE_NOT_ENABLED
The language is not enabled for this store.
400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN
The source language cannot be a translation target.
400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE
An item does not exist in this store.
400 TRANSLATION_TOO_MANY_RESOURCES
The batch exceeds the translation resource limit.
400 STORE_API_INVALID_REQUEST_BODY
The body is invalid or contains unknown fields.
400 TRANSLATION_FIELD_NOT_TRANSLATABLE
Only title can be translated.
400 TRANSLATION_FIELDS_REQUIRED
At least one translated field is required.
400 TRANSLATION_NO_SOURCE_TEXT
A nonempty translation requires a source title.
400 MENU_ITEM_TITLE_TOO_LONG
The translated title exceeds the menu item title limit.
409 TRANSLATION_MUTATION_CONFLICT
The idempotency key was already used for a different translation change.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/menus/items/translations/fr' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "translations": [
    {
      "fields": {
        "title": "Boutique"
      },
      "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0"
    }
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/items/translations/fr", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "translations": [
      {
        "fields": {
          "title": "Boutique"
        },
        "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0"
      }
    ]
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/menus/items/translations/fr",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "translations": [{
            "fields": {
                "title": "Boutique",
            },
            "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
        }],
    },
)
data = res.json()

Response

200

Sample response

{
  "code": "TRANSLATION_SAVED",
  "message": "Translation saved.",
  "success": true
}

Webhook events#

Subscribe to these events when your integration mirrors localized menus. Update and clear events identify the locale and changed fields. One write can emit both events when it sets some fields and clears others.

Menu item translations updated

EVENT menu_items/translations/update App scope: read_menus Staff permission: menus:write

Fired when a menu item's title translation is added or updated for a locale.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Selectable in the Payload builder
`menu.handle`	`string`	Selectable in the Payload builder
`menu_item.id`	`string`	Always present
`menu_item.menu_id`	`string`	Selectable in the Payload builder
`menu_item.parent_id`	`string`	Selectable in the Payload builder
`menu_item.title`	`string`	Selectable in the Payload builder
`menu_item.link_type`	`string`	Selectable in the Payload builder
`menu_item.link_value`	`string`	Selectable in the Payload builder
`menu_item.link_label`	`string`	Selectable in the Payload builder
`menu_item.open_in_new_tab`	`boolean`	Selectable in the Payload builder
`menu_item.sort_order`	`integer`	Selectable in the Payload builder
`menu_item.created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "menu": {
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "name": "Main menu"
  },
  "menu_item": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
    "link_label": "Apparel",
    "link_type": "category",
    "link_value": "7",
    "menu_id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "open_in_new_tab": false,
    "parent_id": null,
    "sort_order": 0,
    "title": "Shop"
  },
  "translation": {
    "title": "Shop"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Menu item translations deleted

EVENT menu_items/translations/delete App scope: read_menus Staff permission: menus:write

Fired when a menu item's title translation is cleared for a locale.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Selectable in the Payload builder
`menu.handle`	`string`	Selectable in the Payload builder
`menu_item.id`	`string`	Always present
`menu_item.menu_id`	`string`	Selectable in the Payload builder
`menu_item.parent_id`	`string`	Selectable in the Payload builder
`menu_item.title`	`string`	Selectable in the Payload builder
`menu_item.link_type`	`string`	Selectable in the Payload builder
`menu_item.link_value`	`string`	Selectable in the Payload builder
`menu_item.link_label`	`string`	Selectable in the Payload builder
`menu_item.open_in_new_tab`	`boolean`	Selectable in the Payload builder
`menu_item.sort_order`	`integer`	Selectable in the Payload builder
`menu_item.created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "menu": {
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "name": "Main menu"
  },
  "menu_item": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
    "link_label": "Apparel",
    "link_type": "category",
    "link_value": "7",
    "menu_id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "open_in_new_tab": false,
    "parent_id": null,
    "sort_order": 0,
    "title": "Shop"
  },
  "translation": {
    "title": "Shop"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}