菜单树-列表
菜单 - 获取菜单列表
接口信息
- 接口地址:
{your-site-url}/api/skill/menu/list
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
GET
- 说明: 此接口用于获取店铺所有菜单树列表。每个菜单树是一个完整的菜单集合,包含该菜单的所有子项。注意返回的
item 仅包含一级菜单数据,二级及以上子菜单需通过获取菜单详情接口查看。
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数
无参数。
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/menu/list' \
--header 'skill-access-token: {your-skill-access-token}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": [
{
"id": 1,
"s_id": 1,
"shop_id": 15,
"name": "头部导航(不可删除)",
"can_delete": 2,
"created_at": "2022-06-25 09:12:19",
"updated_at": "2025-11-24 20:54:50",
"remote_id": 0,
"item": [
{
"id": 2250,
"shop_id": 15,
"menu_id": 1,
"name": "Home",
"parent_id": 0,
"url_type": 1,
"url_value": "/",
"object_id": 0,
"object_title": "",
"open_new": 2,
"is_hidden": 2,
"level": 1,
"position": 0,
"created_at": 1771938735,
"updated_at": 1771938735,
"remote_id": 0
},
{
"id": 123,
"shop_id": 15,
"menu_id": 1,
"name": "Products",
"parent_id": 0,
"url_type": 0,
"url_value": "",
"object_id": 0,
"object_title": "",
"open_new": 2,
"is_hidden": 2,
"level": 1,
"position": 2,
"created_at": 1667801752,
"updated_at": 1771938735,
"remote_id": 0
}
]
}
],
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Array[Object] |
菜单树列表 |
data 子项 - 菜单树字段
| 字段 |
类型 |
说明 |
id |
int |
菜单树 ID(数据库主键) |
s_id |
int |
店铺内部菜单 ID(头部导航固定为 1,尾部固定为 2,其余依次递增) |
shop_id |
int |
店铺 ID |
name |
string |
菜单名称 |
can_delete |
int |
是否可删除。1 = 可删除,2 = 不可删除(系统默认菜单树) |
remote_id |
int |
远程 ID,用于数据同步 |
created_at |
string |
创建时间 |
updated_at |
string |
最后更新时间 |
item |
Array[Object] |
该菜单树下的一级菜单子项列表。注意:列表接口仅返回一级数据,不包含二级、三级子菜单 |
item 子项 - 菜单子项字段
| 字段 |
类型 |
说明 |
id |
int |
菜单子项 ID |
shop_id |
int |
店铺 ID |
menu_id |
int |
所属菜单树 ID |
name |
string |
菜单子项名称 |
parent_id |
int |
父级 ID。0 表示一级菜单 |
url_type |
int |
菜单链接类型。code 值从 菜单-Url选择器 获取,对应关系见该文档的 url_type 类型枚举。url_type 决定了下拉框选择链接类型后需要进一步选择的具体实体(如选商品详情页后需再选具体商品) |
url_value |
string |
菜单链接值 |
object_id |
int |
链接类型对应的实体 ID(如商品 ID、页面 ID 等) |
object_title |
string |
对应实体的标题(如商品标题、页面标题等) |
open_new |
int |
是否新窗口打开。1 = 是,2 = 否 |
is_hidden |
int |
是否隐藏。1 = 是,2 = 否 |
level |
int |
菜单层级。1 = 一级 |
position |
int |
排序位置 |
created_at |
int |
创建时间戳 |
updated_at |
int |
更新时间戳 |
remote_id |
int |
远程 ID,用于数据同步 |
url_type 类型枚举
| 值 |
说明 |
0 |
无链接(占位/父级菜单) |
| 其他值 |
从 菜单-Url选择器 获取完整枚举,选择类型后还需根据类型选择对应实体(如选商品详情页后需选具体商品 ID) |
注意事项
- 每个菜单树是一个完整的菜单集合,包含一级、二级、三级等层级结构,但列表接口的
item 仅返回一级数据
s_id = 1 为头部导航菜单,s_id = 2 为尾部导航菜单,这两个系统默认菜单不可删除(can_delete = 2)
- 二级及以上子菜单需通过获取菜单详情接口查看