{ "generatedAt": "2026-04-25 09:24:55", "generatedAtLocal": "2026-04-25 09:24:55", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "module": { "name": "快递接口管理模块", "key": "setting.expressInterface", "folder": "setting.expressinterface", "interfaceCount": 5 }, "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 }。每条记录字段见 children。", "description": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。每条记录字段见 children。", "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 条件对象;支持字段:id、name、express_code、platform_code、express_platform_id、sender_name、sender_tel、viewer、client_id、share_id、site_code、product_type、shop_name。支持 quickWhere 快速关键词。" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "快递接口记录数组(每项字段如下)" }, { "name": "total", "type": "number", "required": false, "description": "匹配的总记录数" }, { "name": "page", "type": "number", "required": false, "description": "当前页" }, { "name": "page_size", "type": "number", "required": false, "description": "每页数量" } ] }, { "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": "在当前仓库范围内创建快递接口,仅写入已实现字段(见 params),仓库由系统自动填充,禁止传入 warehouse_id/warehouseId。", "description": "在当前仓库范围内创建快递接口,仅写入已实现字段(见 params),仓库由系统自动填充,禁止传入 warehouse_id/warehouseId。", "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": "express_code", "type": "string", "required": true, "description": "快递编码(不区分大小写,会在服务端转为大写)" }, { "name": "platform_code", "type": "string", "required": true, "description": "平台代码(不区分大小写,会在服务端转为大写)" }, { "name": "express_platform_id", "type": "number", "required": true, "description": "平台接口 ID" }, { "name": "sender_name", "type": "string", "required": false, "description": "发件人姓名" }, { "name": "sender_tel", "type": "string", "required": false, "description": "发件人电话" }, { "name": "weight", "type": "number", "required": false, "description": "默认重量(可选)" }, { "name": "token", "type": "string", "required": false, "description": "接口密钥或 token" }, { "name": "viewer", "type": "string", "required": false, "description": "查看者标识" }, { "name": "client_id", "type": "string", "required": false, "description": "客户端 ID" }, { "name": "is_share", "type": "number", "required": false, "description": "是否共享(0/1)" }, { "name": "share_id", "type": "number", "required": false, "description": "共享记录 ID" }, { "name": "can_use_count", "type": "number", "required": false, "description": "可用次数/配额" }, { "name": "province_name", "type": "string", "required": false, "description": "省" }, { "name": "city_name", "type": "string", "required": false, "description": "市" }, { "name": "district_name", "type": "string", "required": false, "description": "区/县" }, { "name": "site_code", "type": "string", "required": false, "description": "站点编码" }, { "name": "product_type", "type": "string", "required": false, "description": "快递产品类型" }, { "name": "shop_name", "type": "string", "required": false, "description": "店铺名称/分组标识" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "新建记录 ID" } ] }, { "method": "setting.expressInterface.update", "title": "更新快递接口,支持局部字段更新;支持 id 别名 interface_id / interfaceId;禁止通过接口修改 warehouse_id。", "description": "更新快递接口,支持局部字段更新;支持 id 别名 interface_id / interfaceId;禁止通过接口修改 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" }, { "name": "name", "type": "string", "required": false, "description": "接口名称" }, { "name": "express_code", "type": "string", "required": false, "description": "快递编码(更新时会被转为大写)" }, { "name": "platform_code", "type": "string", "required": false, "description": "平台代码(更新时会被转为大写)" }, { "name": "express_platform_id", "type": "number", "required": false, "description": "平台接口 ID" }, { "name": "sender_name", "type": "string", "required": false, "description": "发件人姓名" }, { "name": "sender_tel", "type": "string", "required": false, "description": "发件人电话" }, { "name": "weight", "type": "number", "required": false, "description": "默认重量" }, { "name": "token", "type": "string", "required": false, "description": "接口密钥或 token" }, { "name": "viewer", "type": "string", "required": false, "description": "查看者标识" }, { "name": "client_id", "type": "string", "required": false, "description": "客户端 ID" }, { "name": "is_share", "type": "number", "required": false, "description": "是否共享(0/1)" }, { "name": "share_id", "type": "number", "required": false, "description": "共享记录 ID" }, { "name": "can_use_count", "type": "number", "required": false, "description": "可用次数/配额" }, { "name": "province_name", "type": "string", "required": false, "description": "省" }, { "name": "city_name", "type": "string", "required": false, "description": "市" }, { "name": "district_name", "type": "string", "required": false, "description": "区/县" }, { "name": "site_code", "type": "string", "required": false, "description": "站点编码" }, { "name": "product_type", "type": "string", "required": false, "description": "快递产品类型" }, { "name": "shop_name", "type": "string", "required": false, "description": "店铺名称/分组标识" } ], "response": [ { "name": "id", "type": "number", "required": false, "description": "首条更新记录 ID" }, { "name": "name", "type": "string", "required": false, "description": "更新后的接口名称" } ] }, { "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" } ] } ] }