272 lines
7.3 KiB
JSON
272 lines
7.3 KiB
JSON
{
|
||
"generatedAt": "2026-05-08 17:47:16",
|
||
"generatedAtLocal": "2026-05-08 17:47:16",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "快递编码管理模块",
|
||
"key": "setting.express",
|
||
"folder": "setting.express",
|
||
"interfaceCount": 7
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "index.getExpressList",
|
||
"title": "合并后的快递列表",
|
||
"description": "合并后的快递列表",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.express.list",
|
||
"title": "查询当前仓库范围的快递映射列表,支持 where + pagination",
|
||
"description": "查询当前仓库范围的快递映射列表,支持 where + pagination",
|
||
"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": "分页参数,支持 page / pageSize,兼容 currentPage / page_size / size"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.express.listBase",
|
||
"title": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)",
|
||
"description": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.express.create",
|
||
"title": "创建快递映射,仅写入已实现字段(code、name、platform 等)",
|
||
"description": "创建快递映射,仅写入已实现字段(code、name、platform 等)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "快递编码"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "快递名称"
|
||
},
|
||
{
|
||
"name": "platform",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "平台标识(可选)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.express.checkCodeUnique",
|
||
"title": "校验快递编码在当前仓库/主体维度唯一性,仅支持 code 与可选 id 排除自身",
|
||
"description": "校验快递编码在当前仓库/主体维度唯一性,仅支持 code 与可选 id 排除自身",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "待校验的快递编码"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "排除自身 id(更新时使用)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.express.update",
|
||
"title": "更新快递映射,仅更新已实现字段(例如 name、platform)",
|
||
"description": "更新快递映射,仅更新已实现字段(例如 name、platform)",
|
||
"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": "name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "快递名称"
|
||
},
|
||
{
|
||
"name": "platform",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "平台标识(可选)"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.express.delete",
|
||
"title": "批量软删除快递映射;接受 ids 参数,已删除记录会在结果中标记。",
|
||
"description": "批量软删除快递映射;接受 ids 参数,已删除记录会在结果中标记。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "待删除的映射ID数组;支持数组、逗号字符串或单个ID。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "请求中的所有 id 列表(原样返回)"
|
||
},
|
||
{
|
||
"name": "deleted_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "本次实际被软删除的 ID 列表(即原本未被删除的 ID)"
|
||
},
|
||
{
|
||
"name": "already_deleted_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "请求中已处于已删除状态的 ID 列表"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "固定返回 'deleted'"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|