Menus

Menus require menus scopes: reads use read_menus, writes use write_menus. A menu is a named, handle-addressed tree of items; each item links to a store resource (product, category, collection, page, blog post, vendor, brand, policy), a fixed destination (home, shop, cart, wishlist, account, the list pages), a custom URL, or is a non-navigable label heading a dropdown. Fetch /menus/limits first — the link-type vocabulary, per-type value requirements, and every tree cap (total items, children per parent, nesting depth) come from there, never hardcoded.

Item reads are built for scale: /menus/{menuId}/items pages one tree level at a time with per-node child counts, and /menus/{menuId}/items/search finds items anywhere in the tree with their ancestor paths. Writes are strict — cross-resource link targets are existence-validated in one batched pass, tree caps are enforced server-side, and reparenting is cycle- and depth-guarded. The atomic save (PUT /menus/{menuId}/save) applies name, handle, and item changes all-or-nothing: send the full items tree (existing item ids update in place so item-title translations survive) or a dirty ops buffer that stays O(changes) for very large menus. Item titles translate through the translations surface as the menu_item resource.

Endpoints#

Menu limits

GET read_menus

Fetch Menu limits, tree caps, and the link-type vocabulary.

Returns field maximum lengths, tree-shape caps (total items, children per parent, nesting depth), pagination caps, and the full link-type vocabulary with per-type value requirements. Build item forms from link_types — the set is server-owned.

Headers

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

curl https://api-store.tringify.com/api/2025-01/menus/limits \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/limits", {
  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/limits",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "bulk_max": 100,
    "custom_url_max_length": 2048,
    "handle_max_length": 255,
    "item_title_max_length": 255,
    "link_types": [
      {
        "label": "Home",
        "requires_value": false,
        "value": "home"
      },
      {
        "label": "Product",
        "requires_value": true,
        "search_resource": "product",
        "value": "product"
      },
      {
        "label": "Search",
        "requires_value": false,
        "value": "search"
      },
      {
        "label": "Custom URL",
        "requires_value": true,
        "value": "custom_url"
      }
    ],
    "list_max_limit": 100,
    "list_page_size": 20,
    "max_children_per_parent": 500,
    "max_items": 10000,
    "max_nesting_depth": 3,
    "max_per_store": 100,
    "name_max_length": 255,
    "page_size_options": [
      20,
      50,
      100
    ],
    "search_max_length": 100,
    "sort_columns": [
      "name",
      "created_at",
      "updated_at"
    ]
  },
  "success": true
}

List menus

GET read_menus

List menus for the store.

Returns paginated menus with item counts. Use search to filter by name or handle. Invalid sort parameters are rejected instead of silently defaulted.

Query parameters

Name	Type	Description
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size, capped by `list_max_limit`. Example: `20`
`search`	`string`	Search menus by name or handle. Example: `main`
`sort_by`	`string`	Sort column: name, created_at, or updated_at. Allowed values `namecreated_atupdated_at` Example: `created_at`
`sort_direction`	`string`	asc or desc. Allowed values `ascdesc` Example: `asc`

Headers

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

Errors

400 MENU_SEARCH_TOO_LONG
Search exceeds the Menu contract max length.
400 MENU_LIST_INVALID_SORT_BY
Sort column is not in the Menu sort vocabulary.
400 MENU_LIST_INVALID_SORT_DIRECTION
Sort direction is not asc or desc.

curl https://api-store.tringify.com/api/2025-01/menus?limit=20&page=1&search=main&sort_by=created_at&sort_direction=asc \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus?limit=20&page=1&search=main&sort_by=created_at&sort_direction=asc", {
  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?limit=20&page=1&search=main&sort_by=created_at&sort_direction=asc",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "limit": 20,
    "menus": [
      {
        "created_at": "2026-01-05T12:00:00+05:30",
        "handle": "main-menu",
        "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
        "item_count": 4,
        "name": "Main Menu",
        "updated_at": "2026-01-05T12:00:00+05:30"
      }
    ],
    "page": 1,
    "sort_by": "created_at",
    "sort_direction": "asc",
    "total": 1
  },
  "success": true
}

Get a menu

GET read_menus

Fetch one menu with its full item tree.

Returns the menu and its nested item tree. For very large menus prefer the paginated items endpoint and page one level at a time.

Path parameters

Name	Type	Description
`id` required	`uuid`	Menu id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

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

Errors

400 STORE_API_INVALID_MENU_ID
Menu id is not a valid UUID.
404 NOT_FOUND
Menu (or item) does not exist in this store.

curl https://api-store.tringify.com/api/2025-01/menus/{menuId} \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/{menuId}", {
  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/{menuId}",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "created_at": "2026-01-05T12:00:00+05:30",
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "item_count": 1,
    "items": [
      {
        "children": [],
        "created_at": "2026-01-05T12:00:00+05:30",
        "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
        "link_type": "shop",
        "open_in_new_tab": false,
        "sort_order": 0,
        "title": "Shop"
      }
    ],
    "name": "Main Menu",
    "updated_at": "2026-01-05T12:00:00+05:30"
  },
  "success": true
}

List menu items

GET read_menus

List one level of a menu's item tree.

Returns one paginated level — root items, or the children of parent_id. Each node carries child_count so clients can render expand affordances without fetching children. This is how the admin editor scales to the max item cap.

Path parameters

Name	Type	Description
`id` required	`uuid`	Menu id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Query parameters

Name	Type	Description
`parent_id`	`uuid`	Parent item id. Omit for root items. Example: `1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0`
`page`	`integer`	Page number within the sibling level. Example: `1`
`limit`	`integer`	Page size, capped by `list_max_limit`. Example: `20`

Headers

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

Errors

400 STORE_API_INVALID_MENU_ID
Menu id is not a valid UUID.
404 NOT_FOUND
Menu (or item) does not exist in this store.

curl https://api-store.tringify.com/api/2025-01/menus/{menuId}/items?limit=20&page=1&parent_id=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/{menuId}/items?limit=20&page=1&parent_id=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/{menuId}/items?limit=20&page=1&parent_id=1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "has_more": false,
    "items": [
      {
        "child_count": 2,
        "created_at": "2026-01-05T12:00:00+05:30",
        "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
        "link_type": "shop",
        "open_in_new_tab": false,
        "sort_order": 0,
        "title": "Shop"
      }
    ],
    "total": 1
  },
  "success": true
}

Search menu items

GET read_menus

Search items across the whole menu.

Finds items by title or link label anywhere in the tree. Each hit includes its root-to-parent ancestor_ids and ancestor_titles so clients can expand-to-reveal without walking the tree.

Path parameters

Name	Type	Description
`id` required	`uuid`	Menu id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Query parameters

Name	Type	Description
`q` required	`string`	Search query over item titles and link labels. Example: `shop`
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size, capped by `list_max_limit`. Example: `20`

Headers

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

Errors

400 STORE_API_INVALID_MENU_ID
Menu id is not a valid UUID.
404 NOT_FOUND
Menu (or item) does not exist in this store.

curl https://api-store.tringify.com/api/2025-01/menus/{menuId}/items/search?limit=20&page=1&q=shop \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/{menuId}/items/search?limit=20&page=1&q=shop", {
  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/{menuId}/items/search?limit=20&page=1&q=shop",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "has_more": false,
    "items": [
      {
        "ancestor_ids": [],
        "ancestor_titles": [],
        "child_count": 0,
        "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
        "link_type": "shop",
        "open_in_new_tab": false,
        "sort_order": 0,
        "title": "Shop"
      }
    ],
    "total": 1
  },
  "success": true
}

Create a menu

POST write_menus

Create a menu (name + optional handle).

Creates an empty menu. handle is optional — when omitted it is generated from the name and auto-uniquified; a provided handle that collides is rejected. Fires menus/create.

Headers

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

Body parameters

Name	Type	Description
`name` required	`string`	Menu name. Example: `Main Menu`
`handle`	`string`	Optional handle. Omit to generate from the name (auto-uniquified). A provided duplicate is rejected. Example: `main-menu`

Errors

400 MENU_NAME_REQUIRED
Name is empty after normalization.
400 MENU_NAME_TOO_LONG
Name exceeds the Menu contract max length.
400 MENU_HANDLE_INVALID_FORMAT
Handle is not slug-shaped (lowercase words joined by hyphens).
400 MENU_HANDLE_TOO_LONG
Handle exceeds the Menu contract max length.
400 MENU_LIMIT_REACHED
The store is at its menu cap.
404 NOT_FOUND
Menu does not exist in this store.
409 MENU_HANDLE_DUPLICATE
Handle already exists in this store.

curl -X POST https://api-store.tringify.com/api/2025-01/menus \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "handle": "main-menu",
  "name": "Main Menu"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "handle": "main-menu",
    "name": "Main Menu"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/menus",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "handle": "main-menu",
        "name": "Main Menu",
    },
)
data = res.json()

Response

201

Sample response

{
  "data": {
    "created_at": "2026-01-05T12:00:00+05:30",
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "item_count": 0,
    "items": [],
    "name": "Main Menu",
    "updated_at": "2026-01-05T12:00:00+05:30"
  },
  "success": true
}

Update a menu

PUT write_menus

Rename a menu or change its handle.

Updates provided fields; omitted fields are unchanged. A handle change is validated and checked for uniqueness. Items are managed through the item endpoints or the atomic save. Fires menus/update.

Path parameters

Name	Type	Description
`id` required	`uuid`	Menu id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

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

Body parameters

Name	Type	Description
`name`	`string`	New menu name. Example: `Footer Menu`
`handle`	`string`	New handle. Must be unique and slug-shaped. Example: `footer-menu`

Errors

400 MENU_NAME_REQUIRED
Name is empty after normalization.
400 MENU_NAME_TOO_LONG
Name exceeds the Menu contract max length.
400 MENU_HANDLE_INVALID_FORMAT
Handle is not slug-shaped (lowercase words joined by hyphens).
400 MENU_HANDLE_TOO_LONG
Handle exceeds the Menu contract max length.
400 MENU_LIMIT_REACHED
The store is at its menu cap.
404 NOT_FOUND
Menu does not exist in this store.
409 MENU_HANDLE_DUPLICATE
Handle already exists in this store.

curl -X PUT https://api-store.tringify.com/api/2025-01/menus/{menuId} \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "handle": "footer-menu",
  "name": "Footer Menu"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/{menuId}", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "handle": "footer-menu",
    "name": "Footer Menu"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/menus/{menuId}",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "handle": "footer-menu",
        "name": "Footer Menu",
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "created_at": "2026-01-05T12:00:00+05:30",
    "handle": "footer-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "item_count": 4,
    "name": "Footer Menu",
    "updated_at": "2026-01-05T12:00:00+05:30"
  },
  "success": true
}

Save a menu atomically

PUT write_menus

Save name, handle, and item changes as one atomic batch.

The whole-menu save. Send items (the full tree — existing item ids are updated in place so item-title translations survive, missing ids are deleted, new items are created) OR ops (a dirty-ops buffer of create/update/delete/move operations, O(changes) instead of O(tree)). Cross-resource links (products, categories, collections, pages, blog posts, blog categories, vendors, brands, and policies) are existence-validated in one batched pass. Fires one compact menus/update.

Path parameters

Name	Type	Description
`id` required	`uuid`	Menu id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

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

Body parameters

Name	Type	Description
`name` required	`string`	Menu name. Example: `Main Menu`
`handle` required	`string`	Menu handle — required on save. Example: `main-menu`
`items`	`array<object>`	The FULL item tree. Each node: optional `id` (existing item), `title`, `link_type`, optional `link_value`/`link_label`, `open_in_new_tab`, `children`. Existing ids update in place; ids missing from the tree are deleted; nodes without ids are created. Example: `[{"title": "Shop", "link_type": "shop", "children": []}]`
`ops`	`array<object>`	Dirty-ops buffer instead of `items`. Each op: `kind` (create/update/delete/move), `id` or `temp_id`, placement (`parent_id`/`parent_temp_id`/`sort_order`), and fields. A create's `temp_id` can be another op's parent in the same batch. Example: `[{"kind": "create", "temp_id": "t1", "title": "Sale", "link_type": "shop"}]`

Errors

400 MENU_NAME_REQUIRED
Name is empty after normalization.
400 MENU_NAME_TOO_LONG
Name exceeds the Menu contract max length.
400 MENU_HANDLE_INVALID_FORMAT
Handle is not slug-shaped (lowercase words joined by hyphens).
400 MENU_HANDLE_TOO_LONG
Handle exceeds the Menu contract max length.
400 MENU_LIMIT_REACHED
The store is at its menu cap.
404 NOT_FOUND
Menu does not exist in this store.
409 MENU_HANDLE_DUPLICATE
Handle already exists in this store.
400 MENU_HANDLE_REQUIRED
Handle is required on the save path.
400 MENU_TOO_MANY_ITEMS
The tree exceeds the total item cap.
400 MENU_TOO_MANY_CHILDREN
A sibling group exceeds the children-per-parent cap.
400 MENU_ITEM_NESTING_DEPTH_REACHED
The tree exceeds the nesting-depth cap.
400 MENU_LINK_PRODUCT_NOT_FOUND
A product link references an id that does not exist (each linkable resource has matching *_ID_INVALID and *_NOT_FOUND codes: product, category, vendor, brand, collection, blog post, blog category, page).
400 MENU_LINK_POLICY_TYPE_INVALID
A policy link's value is not a valid policy type.

curl -X PUT https://api-store.tringify.com/api/2025-01/menus/{menuId}/save \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "handle": "main-menu",
  "items": [
    {
      "children": [],
      "link_type": "shop",
      "title": "Shop"
    }
  ],
  "name": "Main Menu",
  "ops": [
    {
      "kind": "create",
      "link_type": "shop",
      "temp_id": "t1",
      "title": "Sale"
    }
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/{menuId}/save", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "handle": "main-menu",
    "items": [
      {
        "children": [],
        "link_type": "shop",
        "title": "Shop"
      }
    ],
    "name": "Main Menu",
    "ops": [
      {
        "kind": "create",
        "link_type": "shop",
        "temp_id": "t1",
        "title": "Sale"
      }
    ]
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/menus/{menuId}/save",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "handle": "main-menu",
        "items": [{
            "children": [],
            "link_type": "shop",
            "title": "Shop",
        }],
        "name": "Main Menu",
        "ops": [{
            "kind": "create",
            "link_type": "shop",
            "temp_id": "t1",
            "title": "Sale",
        }],
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "created_at": "2026-01-05T12:00:00+05:30",
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "item_count": 1,
    "items": [
      {
        "children": [],
        "created_at": "2026-01-05T12:00:00+05:30",
        "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
        "link_type": "shop",
        "open_in_new_tab": false,
        "sort_order": 0,
        "title": "Shop"
      }
    ],
    "name": "Main Menu",
    "updated_at": "2026-01-05T12:00:00+05:30"
  },
  "success": true
}

Create a menu item

POST write_menus

Add one item to a menu.

Creates one item. link_type comes from the limits vocabulary; types with a target require link_value (ids are existence-validated). parent_id places it in the tree, subject to the nesting-depth cap. Fires menus/update.

Path parameters

Name	Type	Description
`id` required	`uuid`	Menu id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

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

Body parameters

Name	Type	Description
`title` required	`string`	Item title. Example: `Shop`
`link_type` required	`string`	Link type from the limits vocabulary. Example: `shop`
`link_value`	`string`	Target reference for types that require one — a resource id, policy type, or custom URL. Existence-validated. Example: `42`
`link_label`	`string`	Display label for the linked resource. Example: `Blue shirt`
`parent_id`	`uuid`	Parent item id. Omit for a root item. Subject to the nesting-depth cap. Example: `1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0`
`open_in_new_tab`	`boolean`	Open the link in a new tab. Example: `false`
`sort_order`	`integer`	Position within the sibling group. Omit to append. Example: `0`

Errors

400 STORE_API_INVALID_MENU_ID
Menu id is not a valid UUID.
400 MENU_ITEM_TITLE_REQUIRED
Item title is empty after normalization.
400 MENU_ITEM_TITLE_TOO_LONG
Item title exceeds the contract max length.
400 MENU_ITEM_LINK_TYPE_INVALID
Link type is not in the server vocabulary.
400 MENU_ITEM_LINK_VALUE_REQUIRED
The link type requires a link_value.
400 MENU_ITEM_LIMIT_REACHED
The menu is at its total item cap.
400 MENU_ITEM_PARENT_NOT_FOUND
parent_id does not exist in this menu.
400 MENU_ITEM_NESTING_DEPTH_REACHED
Placement exceeds the nesting-depth cap.
400 MENU_ITEM_DESCENDANT_PARENT
An item cannot be moved under itself or its own descendant.
400 MENU_TOO_MANY_CHILDREN
The sibling group exceeds the children-per-parent cap.
404 NOT_FOUND
Menu or item does not exist in this store.
400 MENU_LINK_PRODUCT_NOT_FOUND
A product link references an id that does not exist (each linkable resource has matching *_ID_INVALID and *_NOT_FOUND codes: product, category, vendor, brand, collection, blog post, blog category, page).
400 MENU_LINK_POLICY_TYPE_INVALID
A policy link's value is not a valid policy type.

curl -X POST https://api-store.tringify.com/api/2025-01/menus/{menuId}/items \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "link_label": "Blue shirt",
  "link_type": "shop",
  "link_value": "42",
  "open_in_new_tab": false,
  "parent_id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
  "sort_order": 0,
  "title": "Shop"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/{menuId}/items", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "link_label": "Blue shirt",
    "link_type": "shop",
    "link_value": "42",
    "open_in_new_tab": false,
    "parent_id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
    "sort_order": 0,
    "title": "Shop"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/menus/{menuId}/items",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "link_label": "Blue shirt",
        "link_type": "shop",
        "link_value": "42",
        "open_in_new_tab": False,
        "parent_id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
        "sort_order": 0,
        "title": "Shop",
    },
)
data = res.json()

Response

201

Sample response

{
  "data": {
    "children": [],
    "created_at": "2026-01-05T12:00:00+05:30",
    "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
    "link_type": "shop",
    "open_in_new_tab": false,
    "sort_order": 0,
    "title": "Shop"
  },
  "success": true
}

Update a menu item

PUT write_menus

Update one item's fields or placement.

Updates provided fields. Switching to a link type without a target clears link_value. parent_id reparents the item (cycle- and depth-guarded); an empty string moves it to the root. Fires menus/update.

Path parameters

Name	Type	Description
`id` required	`uuid`	Menu id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`
`itemId` required	`uuid`	Menu item id. Example: `1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0`

Headers

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

Body parameters

Name	Type	Description
`title`	`string`	New item title. Example: `Shop all`
`link_type`	`string`	New link type. Switching to a type without a target clears `link_value`. Example: `collection_list`
`link_value`	`string`	New target reference. Existence-validated.
`link_label`	`string`	New display label.
`parent_id`	`string`	New parent item id; empty string moves the item to the root. Cycle- and depth-guarded.
`open_in_new_tab`	`boolean`	Open the link in a new tab. Example: `true`

Errors

400 STORE_API_INVALID_MENU_ID
Menu id is not a valid UUID.
400 MENU_ITEM_TITLE_REQUIRED
Item title is empty after normalization.
400 MENU_ITEM_TITLE_TOO_LONG
Item title exceeds the contract max length.
400 MENU_ITEM_LINK_TYPE_INVALID
Link type is not in the server vocabulary.
400 MENU_ITEM_LINK_VALUE_REQUIRED
The link type requires a link_value.
400 MENU_ITEM_LIMIT_REACHED
The menu is at its total item cap.
400 MENU_ITEM_PARENT_NOT_FOUND
parent_id does not exist in this menu.
400 MENU_ITEM_NESTING_DEPTH_REACHED
Placement exceeds the nesting-depth cap.
400 MENU_ITEM_DESCENDANT_PARENT
An item cannot be moved under itself or its own descendant.
400 MENU_TOO_MANY_CHILDREN
The sibling group exceeds the children-per-parent cap.
404 NOT_FOUND
Menu or item does not exist in this store.
400 MENU_LINK_PRODUCT_NOT_FOUND
A product link references an id that does not exist (each linkable resource has matching *_ID_INVALID and *_NOT_FOUND codes: product, category, vendor, brand, collection, blog post, blog category, page).
400 MENU_LINK_POLICY_TYPE_INVALID
A policy link's value is not a valid policy type.

curl -X PUT https://api-store.tringify.com/api/2025-01/menus/{menuId}/items/1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "link_type": "collection_list",
  "open_in_new_tab": true,
  "title": "Shop all"
}'

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

import requests

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

Response

200

Sample response

{
  "data": {
    "children": [],
    "created_at": "2026-01-05T12:00:00+05:30",
    "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
    "link_type": "shop",
    "open_in_new_tab": false,
    "sort_order": 0,
    "title": "Shop"
  },
  "success": true
}

Delete a menu item

DELETE write_menus

Delete one item and its descendants.

Deletes the item and all of its children. Fires menus/update.

Path parameters

Name	Type	Description
`id` required	`uuid`	Menu id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`
`itemId` required	`uuid`	Menu item id. Example: `1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0`

Headers

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

Errors

400 STORE_API_INVALID_MENU_ID
Menu id is not a valid UUID.
404 NOT_FOUND
Menu (or item) does not exist in this store.

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

import requests

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

Response

200

Sample response

{
  "success": true,
  "message": "Menu item deleted."
}

Delete a menu

DELETE write_menus

Delete a menu and all of its items.

Deletes the menu and all of its items. Fires menus/delete.

Path parameters

Name	Type	Description
`id` required	`uuid`	Menu id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

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

Errors

400 STORE_API_INVALID_MENU_ID
Menu id is not a valid UUID.
404 NOT_FOUND
Menu (or item) does not exist in this store.

curl -X DELETE https://api-store.tringify.com/api/2025-01/menus/{menuId} \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/menus/{menuId}", {
  method: "DELETE",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.delete(
    "https://api-store.tringify.com/api/2025-01/menus/{menuId}",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "message": "Menu deleted."
}

Fields#

Field	Kind	Create	Update	Required	Translatable
`name`	text	Yes	Yes	create	No
`handle`	slug	Yes	Yes		No
`item_count`	integer	No	No		No
`created_at`	datetime	No	No		No
`updated_at`	datetime	No	No		No

Webhook events#

Menu webhook events are declared by the Menu resource contract. The event cards below include the topic, subscription scope, store permission, payload schema, and sample payload.

Menu created

EVENT menus/create write_menus menus:write

Fired when a navigation menu is created.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Can be removed/added via the Payload builder
`menu.handle`	`string`	Can be removed/added via the Payload builder
`menu.item_count`	`integer`	Can be removed/added via the Payload builder
`menu.created_at`	`string`	Can be removed/added via the Payload builder
`menu.updated_at`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "menu": {
    "created_at": "2026-06-09T12:00:00Z",
    "handle": "...",
    "id": 7,
    "item_count": 0,
    "name": "Acme",
    "updated_at": "2026-06-09T12:00:00Z"
  }
}

Menu updated

EVENT menus/update write_menus menus:write

Fired when a navigation menu or one of its items is updated.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Can be removed/added via the Payload builder
`menu.handle`	`string`	Can be removed/added via the Payload builder
`menu.item_count`	`integer`	Can be removed/added via the Payload builder
`menu.created_at`	`string`	Can be removed/added via the Payload builder
`menu.updated_at`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "menu": {
    "created_at": "2026-06-09T12:00:00Z",
    "handle": "...",
    "id": 7,
    "item_count": 0,
    "name": "Acme",
    "updated_at": "2026-06-09T12:00:00Z"
  }
}

Menu deleted

EVENT menus/delete write_menus menus:write

Fired when a navigation menu is deleted.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Can be removed/added via the Payload builder
`menu.handle`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "menu": {
    "handle": "...",
    "id": 7,
    "name": "Acme"
  }
}