Create menu

POST 
/openapi/2026-01/menus

Create a custom menu for the store.

Request

application/json

Body

Bodyrequired

titlestringrequired

Menu title

categoryint32

Menu category. This endpoint creates custom menus only (3); built-in menus are maintained by the platform. Defaults to 3 when omitted

children object[]
Menu items tree
Array [
idint64
ID of an existing item in this menu. When updating, passing it updates that item in place and keeps its ID; otherwise a new item is created. Ignored when creating a menu
titlestring
Menu item title
targetstring
Link target, e.g. _blank opens in a new window
disabledint32
Whether the item is disabled: 1 disabled, 0 enabled
url_obj object
Link of the item; omitted means no link
typestring
Link type, e.g. home, product, collection, page, article, blog, web; unrecognized values are saved as no link (0)
source_idstring
ID of the linked resource (product, collection, page, etc.)
urlstring
Link URL
childrenundefined[]
Child items; can be nested to any depth
]

Example

json

{
  "title": "string",
  "category": 0,
  "children": [
    {
      "id": 0,
      "title": "string",
      "target": "string",
      "disabled": 0,
      "url_obj": {
        "type": "string",
        "source_id": "string",
        "url": "string"
      },
      "children": [
        null
      ]
    }
  ]
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

menu object

Created menu

idstring

Menu ID

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "menu": {
      "id": "string"
    }
  }
}