2026-06-04 19:26:45 +08:00

322 lines
10 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"generatedAt": "2026-06-04 19:02:14",
"generatedAtLocal": "2026-06-04 19:02:14",
"source": "remote",
"filter": {
"platform": {
"value": "web",
"label": "网页端"
},
"project": {
"value": "all",
"label": "全部"
}
},
"module": {
"name": "快递接口管理模块",
"key": "setting.expressInterface",
"folder": "setting.expressinterface",
"interfaceCount": 6
},
"changes": {
"fromPreviousSnapshot": {
"moduleAdded": false,
"moduleRenamed": false,
"interfaceChanges": {
"addedMethods": [],
"deletedMethods": [],
"paramsUpdatedMethods": [],
"responseUpdatedMethods": []
}
}
},
"interfaces": [
{
"method": "setting.expressInterface.list",
"title": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。按 weight 升序、id 降序排序,优先按权重排序。",
"description": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。按 weight 升序、id 降序排序,优先按权重排序。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "pagination"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "支持按 shop_id 过滤"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "list,按 weight 升序、id 降序排序;优先按权重排序,权重相同再按 id 倒序"
},
{
"name": "total",
"type": "number",
"required": true,
"description": "total"
},
{
"name": "page",
"type": "number",
"required": true,
"description": "page"
},
{
"name": "page_size",
"type": "number",
"required": true,
"description": "page_size"
}
]
},
{
"method": "setting.expressInterface.listByWarehousePlatformCode",
"title": "按 warehouse_id + platform_code 查询快递接口全字段数组,支持缓存;返回结果按 weight 升序、必要时按 id 升序排序,每条记录显式包含 express_code 以及关联的 express 对象(如 express.id/express.code/express.name/express.platform)。该接口不分页,按 warehouse_id + platform_code 全量返回匹配记录。",
"description": "按 warehouse_id + platform_code 查询快递接口全字段数组,支持缓存;返回结果按 weight 升序、必要时按 id 升序排序,每条记录显式包含 express_code 以及关联的 express 对象(如 express.id/express.code/express.name/express.platform)。该接口不分页,按 warehouse_id + platform_code 全量返回匹配记录。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouse_id / warehouseId",
"type": "number",
"required": false,
"description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id),也支持显式传入以查询指定仓库,文档兼容 warehouse_id 与 warehouseId 两种写法。"
},
{
"name": "platform_code / platformCode",
"type": "string",
"required": true,
"description": "平台代码;作为缓存键的一部分,建议使用大写形式(服务端会标准化处理)。"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "快递接口记录数组(按 warehouse_id + platform_code 全量返回,不分页),每项包含以下字段:"
}
]
},
{
"method": "setting.expressInterface.create",
"title": "在当前仓库范围内创建快递接口,支持 shop_id/shopId 入参。",
"description": "在当前仓库范围内创建快递接口,支持 shop_id/shopId 入参。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "name",
"type": "string",
"required": true,
"description": "name"
},
{
"name": "express_code",
"type": "string",
"required": true,
"description": "express_code"
},
{
"name": "platform_code",
"type": "string",
"required": true,
"description": "platform_code"
},
{
"name": "shop_id",
"type": "number",
"required": false,
"description": "店铺 ID(支持 shopId),正整数,可空;未传或空值按 null 处理"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "新建记录 ID"
}
]
},
{
"method": "setting.expressInterface.update",
"title": "更新快递接口,支持 shop_id/shopId 入参(可空)。",
"description": "更新快递接口,支持 shop_id/shopId 入参(可空)。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id"
},
{
"name": "shop_id",
"type": "number",
"required": false,
"description": "shop_id"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id"
}
]
},
{
"method": "setting.expressInterface.delete",
"title": "删除快递接口,支持 id 别名 interface_id / interfaceId;返回被删除记录 id 与所属 warehouse_id。",
"description": "删除快递接口,支持 id 别名 interface_id / interfaceId;返回被删除记录 id 与所属 warehouse_id。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "快递接口ID;兼容 interface_id / interfaceId"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": false,
"description": "已删除记录 ID"
},
{
"name": "warehouse_id",
"type": "number",
"required": false,
"description": "记录所属仓库 ID"
},
{
"name": "deleted",
"type": "boolean",
"required": false,
"description": "是否已删除,成功时为 true"
}
]
},
{
"method": "index.getPrintPlatformList",
"title": "获取打印平台全量列表。供前端新增、修改快递接口时下拉选择使用;仅返回未删除且状态为 `ACTIVE` 的打印平台,不分页,按 `platform_name` 升序、`id` 升序返回。接口不校验额外鉴权或权限点,但需要登录态。",
"description": "获取打印平台全量列表。供前端新增、修改快递接口时下拉选择使用;仅返回未删除且状态为 `ACTIVE` 的打印平台,不分页,按 `platform_name` 升序、`id` 升序返回。接口不校验额外鉴权或权限点,但需要登录态。",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [],
"params": [],
"response": [
{
"name": "flag",
"type": "string",
"required": true,
"description": "全局调用结果标识,成功时为 `success`"
},
{
"name": "code",
"type": "number",
"required": true,
"description": "业务状态码,成功时返回 200"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "返回消息,成功时通常为 `ok`"
},
{
"name": "data",
"type": "array",
"required": true,
"description": "打印平台列表数组,不分页,仅包含未删除且状态为 `ACTIVE` 的平台;按 `platform_name` 升序、`id` 升序返回。每项字段如下:"
}
]
}
]
}