From 1771b5c6c91c8415a2285fca9555104927b74305 Mon Sep 17 00:00:00 2001 From: liufumingren Date: Sun, 20 Sep 2026 16:14:03 +0800 Subject: [PATCH] =?UTF-8?q?docs(api):=20=E5=90=8C=E6=AD=A5=20system=20?= =?UTF-8?q?=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3=E3=80=81=E5=8F=98=E6=9B=B4?= =?UTF-8?q?=E8=AE=B0=E5=BD=95=E4=B8=8E=E6=96=B9=E6=B3=95=E8=B7=AF=E7=94=B1?= =?UTF-8?q?=EF=BC=88=E7=A1=AE=E8=AE=A4=E6=89=93=E5=8D=B0=E7=9B=B8=E5=85=B3?= =?UTF-8?q?=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AI_METHOD_ROUTING.md | 4 +- methods/changes/system.json | 107 +++ methods/system.json | 1404 +++++++++++++++++++++++++++++++---- 3 files changed, 1367 insertions(+), 148 deletions(-) diff --git a/AI_METHOD_ROUTING.md b/AI_METHOD_ROUTING.md index 3567009..02b978f 100644 --- a/AI_METHOD_ROUTING.md +++ b/AI_METHOD_ROUTING.md @@ -304,7 +304,7 @@ rg "class .*Service|module.exports" app/service/qimenMethods - 临时清单输出:temp/tmp-service-method-inventory.md -自动生成时间: 2026-09-19T07:16:48.802Z +自动生成时间: 2026-09-19T19:08:16.992Z 扫描范围: app/service/**/*.js 文件数: 216 @@ -785,6 +785,8 @@ rg "class .*Service|module.exports" app/service/qimenMethods + + diff --git a/methods/changes/system.json b/methods/changes/system.json index f6d5aed..4537ca3 100644 --- a/methods/changes/system.json +++ b/methods/changes/system.json @@ -1,4 +1,111 @@ [ + { + "version": "2026.09.20-workbench-pack-backfill-confirm-print", + "date": "2026-09-20", + "type": "updated", + "summary": "打包链路(workbench.packOrder / workbench.finishPack)回写打包状态时同步补确认打印状态:扫描打包即视为面单已真实存在,confirm_print_status 未写入(none/null)时补 fin,团购按波次、散单按单,拦截订单跳过,并递增统计版本号驱动确认打印未领单长轮询。", + "methods": [ + "workbench.packOrder", + "workbench.finishPack" + ], + "notes": [ + "实现入口:systems/workbench.js _updateOrderPackStatus(覆盖开始打包/完成打包/关闭旧任务全部路径)", + "幂等:仅 confirm_print_status 为 none/null 时补 fin" + ] + }, + { + "version": "2026.09.20-wave-confirmPrintScan-need-right", + "date": "2026-09-20", + "type": "updated", + "summary": "order.wave.confirmPrintScan 改为需要接口权限(isNeedAuth=true),从免权限名单移除;confirmPrintUnclaimedWaveCount 保持免权限。", + "methods": [ + "order.wave.confirmPrintScan" + ], + "notes": [ + "运行时:wave.js _noNeedRight/_noNeedAuth 已移除 confirmPrintScan,checkAuth 走 checkApiPermission", + "权限记录由 permission:sync:system-api 从 system.json isNeedAuth=true 接口同步并授权角色 2" + ] + }, + { + "version": "2026.09.20-pendingOrder-list-confirm-print-claim-fields", + "date": "2026-09-20", + "type": "updated", + "summary": "order.pendingOrder.list 文档补充 confirm_print_status(确认打印)与 claim_status(领料)的 where 筛选说明与响应字段说明(功能已支持,本次仅同步文档)。", + "methods": [ + "order.pendingOrder.list" + ], + "notes": [ + "列表输出 ORDER_LIST_BASE_ATTRIBUTES 已包含 confirm_print_status/claim_status;where 无字段白名单,两列可直接透传筛选" + ] + }, + { + "version": "2026.09.20-wave-batchList-claim-status", + "date": "2026-09-20", + "type": "updated", + "summary": "order.wave.batchList 波次列表新增 claim_assignment_status 领料状态显示(含 claim_time/claim_operator)与 where.claim_assignment_status 筛选(波次表 claim_time 口径)。", + "methods": [ + "order.wave.batchList" + ], + "notes": [ + "领料状态以波次表 wms_wave_batch.claim_time 是否为空判定(二态:未领料/已领料),与 confirmPrintUnclaimedWaveCount 口径一致", + "where 新增 claim_assignment_status 筛选字段(仅 eq,unclaimed/claimed,兼容中文)" + ] + }, + { + "version": "2026.09.20-wave-confirm-print-count-fix", + "date": "2026-09-20", + "type": "updated", + "summary": "order.wave.confirmPrintUnclaimedWaveCount 统计口径修正:未领单由订单维度 claim_status 改为波次表维度 wms_wave_batch.claim_time IS NULL,避免历史领单(波次表加 claim_time 字段前)导致少算。", + "methods": [ + "order.wave.confirmPrintUnclaimedWaveCount" + ], + "notes": [ + "根因:B2026081500088/89 等波次订单 claim_status='fin'(历史领单)但 wave_batch.claim_time=null,订单维度口径误判为已领单导致 count 少算", + "新口径:wave_batch(wave_status 0/1、claim_time IS NULL)+ 波次下存在 confirm_print_status='fin' 的非取消订单" + ] + }, + { + "version": "2026.09.20-wave-confirm-print-scan-count", + "date": "2026-09-20", + "type": "added", + "summary": "order.wave 新增两个接口:confirmPrintScan(扫面单批量确认打印并写日志,与领单操作一致)与 confirmPrintUnclaimedWaveCount(快速查询已确认打印但未领单波次数量,支持 60s 长轮询,由确认打印/领单版本号驱动)。", + "methods": [ + "order.wave.confirmPrintScan", + "order.wave.confirmPrintUnclaimedWaveCount" + ], + "notes": [ + "confirmPrintScan 复用 print.confirmWavePrint 实现(同入参同返回)", + "confirmPrintUnclaimedWaveCount 长轮询:1s 间隔轮询 Redis 版本号(wave:confirm-print:unclaimed:version:{warehouseId}),60s 超时;Redis 不可用时降级为轮询 DB count", + "确认打印(print.confirmWavePrint)与领单(pick.waveClaimScan)成功后均递增统计版本号" + ] + }, + { + "version": "2026.09.20-wave-batchList-confirm-print", + "date": "2026-09-20", + "type": "updated", + "summary": "order.wave.batchList 波次列表新增 confirm_print_assignment_status 显示与筛选(确认打印状态:未确认打印/部分确认打印/已确认打印)。", + "methods": [ + "order.wave.batchList" + ], + "notes": [ + "where 新增 confirm_print_assignment_status 筛选字段(仅 eq,英文枚举 unconfirmed/partially_confirmed/confirmed)", + "list 每条新增 confirm_print_assignment_status 汇总状态字段" + ] + }, + { + "version": "2026.09.20-confirm-wave-print", + "date": "2026-09-20", + "type": "added", + "summary": "订单表新增 confirm_print_status(确认打印状态)字段,并新增 print.confirmWavePrint 波次确认打印接口:打印完成后扫描波次内任一订单面单,批量确认波次下已打印订单。", + "methods": [ + "print.confirmWavePrint" + ], + "notes": [ + "订单表 wms_order_delivery 及全部分表新增 confirm_print_status ENUM('none','fin'),默认 none;迁移 20260920100000-add-confirm-print-status-to-order-delivery", + "波次下存在未打印订单(print_status != 'fin',拦截订单除外)时阻断确认", + "拦截订单跳过(不确认、不阻断);全部已确认时重复扫描返回 already_confirmed" + ] + }, { "version": "2026.09.19-workbench-packOrder-server-side-verification", "date": "2026-09-19", diff --git a/methods/system.json b/methods/system.json index 64fd03b..9a90cc6 100644 --- a/methods/system.json +++ b/methods/system.json @@ -3193,7 +3193,7 @@ "type": "object", "required": false, "source": "body", - "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。where 无字段白名单,可直接传订单表列名。lock_status 锁定状态筛选(筛选值用数据库原始枚举 none/warehouse/store,不是响应中的 Y/N;ne 表示不等于;条件值为空自动忽略):未锁定 {\"lock_status\":\"none\"};已锁定(所有非 none){\"lock_status\":{\"operator\":\"ne\",\"value\":\"none\"}}。create_channel(订单来源渠道筛选,按订单表 create_channel 列过滤;枚举:MANUAL=手工单、API=接口、QM=奇门、STOCKOUT=出库转单)。支持简写与标准结构:{\"create_channel\":\"MANUAL\"} 单值精确、{\"create_channel\":[\"QM\",\"API\"]} 裸数组按 in 多选、{\"create_channel\":{\"operator\":\"in\",\"value\":[\"QM\",\"API\"]}} 标准结构多选、{\"create_channel\":{\"operator\":\"ne\",\"value\":\"MANUAL\"}} 排除指定渠道。注意:列表响应中的 create_channel 已格式化为中文标签(手工单/接口/奇门/出库转单),查询条件请传英文枚举值。" + "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。where 无字段白名单,可直接传订单表列名。lock_status 锁定状态筛选(筛选值用数据库原始枚举 none/warehouse/store,不是响应中的 Y/N;ne 表示不等于;条件值为空自动忽略):未锁定 {\"lock_status\":\"none\"};已锁定(所有非 none){\"lock_status\":{\"operator\":\"ne\",\"value\":\"none\"}}。create_channel(订单来源渠道筛选,按订单表 create_channel 列过滤;枚举:MANUAL=手工单、API=接口、QM=奇门、STOCKOUT=出库转单)。支持简写与标准结构:{\"create_channel\":\"MANUAL\"} 单值精确、{\"create_channel\":[\"QM\",\"API\"]} 裸数组按 in 多选、{\"create_channel\":{\"operator\":\"in\",\"value\":[\"QM\",\"API\"]}} 标准结构多选、{\"create_channel\":{\"operator\":\"ne\",\"value\":\"MANUAL\"}} 排除指定渠道。注意:列表响应中的 create_channel 已格式化为中文标签(手工单/接口/奇门/出库转单),查询条件请传英文枚举值。confirm_print_status(确认打印状态筛选,按订单表列过滤;枚举:none=未确认打印、fin=已确认打印)。支持简写与标准结构(同 create_channel 示例),如 {\"confirm_print_status\":\"fin\"} 只查已确认打印订单。claim_status(领料状态筛选,按订单表列过滤;枚举:none=未领料、padding=领料中、fin=已领料、error=异常)。支持简写与标准结构(同 create_channel 示例),如 {\"claim_status\":{\"operator\":\"ne\",\"value\":\"fin\"}} 查未完成领料的订单。" }, { "name": "sort", @@ -3208,7 +3208,7 @@ "name": "list", "type": "array", "required": true, - "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节),本次新增 store_remark(货主备注)字段;wave_index(波次内序号,联查 wms_order_wave_index,无记录时为 0)。lock_status 字段统一输出为 Y/N:none(含空值)→ 'N',其余值(如 warehouse/store)→ 'Y'。" + "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节),本次新增 store_remark(货主备注)字段;raw 行数据包含 confirm_print_status(确认打印状态,none/fin)与 claim_status(领料状态,none/padding/fin/error)字段;wave_index(波次内序号,联查 wms_order_wave_index,无记录时为 0)。lock_status 字段统一输出为 Y/N:none(含空值)→ 'N',其余值(如 warehouse/store)→ 'Y'。" }, { "name": "pagination", @@ -14066,6 +14066,111 @@ "message": "内部错误(OrderDeliveryFactory/OrderDeliveryModel 不可用或更新失败)" } ] + }, + { + "method": "print.confirmWavePrint", + "description": "波次确认打印:扫描波次内任一订单的面单号,将波次下全部已打印(print_status='fin')且非拦截的订单批量标记 confirm_print_status='fin',记录打印完成后真实扫描面单确认。拦截订单跳过(不确认、不阻断);波次下存在未打印订单(print_status != 'fin')时阻断;全部已确认时重复扫描返回 already_confirmed,不重复写日志。", + "isNeedAuth": false, + "isNeedLogin": true, + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "waybill_no", + "type": "string", + "required": true, + "source": "body", + "description": "面单号/运单号(必填,用于定位订单及所属波次)" + } + ], + "response": [ + { + "name": "waybill_no", + "type": "string", + "required": false, + "description": "扫描的面单号" + }, + { + "name": "matched_order_id", + "type": "number", + "required": false, + "description": "面单号匹配到的订单ID" + }, + { + "name": "wave_id", + "type": "number", + "required": false, + "description": "波次ID" + }, + { + "name": "wave_no", + "type": "string", + "required": false, + "description": "波次编码" + }, + { + "name": "total_order_count", + "type": "number", + "required": false, + "description": "波次下总订单数" + }, + { + "name": "intercepted_order_count", + "type": "number", + "required": false, + "description": "波次下拦截订单数(跳过确认)" + }, + { + "name": "confirmed_order_count", + "type": "number", + "required": false, + "description": "已确认打印订单数(confirm_print_status='fin')" + }, + { + "name": "newly_confirmed_order_count", + "type": "number", + "required": false, + "description": "本次新增确认订单数(仅 status=confirmed 时返回)" + }, + { + "name": "status", + "type": "string", + "required": false, + "description": "确认结果:confirmed=本次完成确认 / already_confirmed=已全部确认" + } + ], + "errors": [ + { + "code": 400, + "message": "waybill_no 必填(面单号/运单号)" + }, + { + "code": 400, + "message": "缺少当前用户仓库上下文 store_id" + }, + { + "code": 400, + "message": "运单对应订单未分配波次" + }, + { + "code": 400, + "message": "波次存在未打印订单,禁止确认打印(返回 unprinted_order_count)" + }, + { + "code": 404, + "message": "未查询到该面单号对应的订单,无记录" + }, + { + "code": 500, + "message": "内部错误(OrderDeliveryFactory/订单模型不可用或更新失败)" + } + ] } ] }, @@ -30746,7 +30851,7 @@ "list": [ { "method": "order.wave.batchList", - "description": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总(storage_assignment_status / express_assignment_status / print_assignment_status / pick_assignment_status / review_assignment_status / sync_assignment_status)。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。列表每条记录返回货主信息 store_name:当波次内所有订单均为同一货主(store_id)时返回货主名称,否则返回“混合”。货主名称优先取合约表 wms_store_warehouse.store_remask(货主备注名称),无合约或备注为空时回退 wms_store.company_name(公司全称)。where 中各字段支持裸值与 {operator,value,type} 标准结构(eq/ne/gt/lt/ge/le/in/notin/between/notbetween/like/contains/notlike/startswith/endswith/isnull/isnotnull;未显式传 operator 时保持历史默认语义:wave_no/creator/logistics_name/item_part/item_snapshot_key/item_detail_machine 默认模糊,其余默认等值),详见 where 参数说明。", + "description": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总(storage_assignment_status / express_assignment_status / print_assignment_status / confirm_print_assignment_status / claim_assignment_status / pick_assignment_status / review_assignment_status / sync_assignment_status)。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。列表每条记录返回货主信息 store_name:当波次内所有订单均为同一货主(store_id)时返回货主名称,否则返回“混合”。货主名称优先取合约表 wms_store_warehouse.store_remask(货主备注名称),无合约或备注为空时回退 wms_store.company_name(公司全称)。where 中各字段支持裸值与 {operator,value,type} 标准结构(eq/ne/gt/lt/ge/le/in/notin/between/notbetween/like/contains/notlike/startswith/endswith/isnull/isnotnull;未显式传 operator 时保持历史默认语义:wave_no/creator/logistics_name/item_part/item_snapshot_key/item_detail_machine 默认模糊,其余默认等值),详见 where 参数说明。", "isNeedAuth": false, "isNeedLogin": true, "headers": [ @@ -30777,7 +30882,7 @@ "type": "object", "required": false, "source": "body", - "description": "筛选白名单字段(object,可选)。仅支持下列字段过滤,且禁止传入 warehouse_id / warehouseId。\n【操作符传参】每个字段均支持「裸值」或「标准结构 {'operator':'eq','value':'...','type':'text'}」两种写法;未显式传 operator 时按该字段默认语义(见下方括号)。支持的操作符:eq、ne、gt、lt、ge、le、in、notin、between、notbetween、like、contains、notlike、startswith、endswith、isnull、isnotnull,按字段分组允许:\n- 数值类(wave_id、wave_type、wave_status、source、total_orders、processed_orders 及 total_orders_min/max、processed_orders_min/max):eq/ne/gt/lt/ge/le/in/notin/between/notbetween/isnull/isnotnull;\n- 文本类(wave_no、creator、logistics_name、item_part_type、item_part、item_snapshot_key、item_detail_machine):eq/ne/like/contains/notlike/startswith/endswith/in/notin/isnull/isnotnull;\n- 布尔类(distinguish_express):eq/ne/in/notin;\n- 分配/复核状态类(storage_assignment_status、express_assignment_status、print_assignment_status、review_assignment_status、sync_assignment_status):仅 eq;\n- 货主(store_id):eq/in/ne/notin。\nvalue 支持数组:like/contains/startswith/endswith 多值按 OR 展开,notlike 多值按 AND 展开;in/notin 要求 value 为非空数组;eq 传数组等价于 in;between/notbetween 要求 value 为长度 2 的数组(也接受 {start,end} / {from,to})。\n【字段清单】(括号内为未显式传 operator 时的默认语义)\n- wave_id(等值)\n- wave_no(模糊)\n- wave_type(等值)\n- wave_status(等值,接口固定叠加状态 0/1)\n- creator(模糊)\n- logistics_name(模糊)\n- item_part_type(等值)\n- item_part(模糊)\n- item_snapshot_key(模糊)\n- item_detail_machine(模糊)\n- distinguish_express(等值,value 兼容 true/false/1/0)\n- total_orders / processed_orders(等值,新增:波次订单总数/已处理数,可直接用 between 等操作符)\n- total_orders_min / total_orders_max(范围,等价于 total_orders 的 ge / le)\n- processed_orders_min / processed_orders_max(范围,等价于 processed_orders 的 ge / le)\n- express_assignment_status(等值,string,可选,英文枚举,取值:unassigned、partially_assigned、assigned;语义:按快递分配聚合判断,assigned 表示聚合后全部 fin,partially_assigned 表示部分已分配且不含 error,unassigned 表示全 none 或包含 error(异常并入未分配集合))。\n- print_assignment_status(等值,string,可选,英文枚举,取值:unprinted、partially_printed、printed;语义:按打印分配聚合判断,printed 表示聚合后全部已打印)。\n- storage_assignment_status(等值,string,可选,取值:未分配、部分分配、已分配;默认不传不做限制)。过滤语义:已分配=聚合后全部 fin;部分分配=不含 error,且既不是全 none,也不是全 fin;未分配=全 none 或包含 error(异常并入未分配筛选集合)。说明:返回字段 storage_assignment_status 的展示值保持不变,包含 error 时仍可显示“分配异常”;此处 where 的过滤语义会把异常计入“未分配”,以避免把过滤语义与展示值混淆。\n- source(可选,number)来源过滤:0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务;不传则不过滤。\n说明:express_assignment_status 与 print_assignment_status 要求使用英文枚举值;storage_assignment_status 仍向后兼容中文展示值。若传入的枚举值不在允许集合内,接口会返回 400(参数校验失败),并在 message 中说明错误字段与允许取值。\n- review_assignment_status(等值,string,可选,英文枚举:unreviewed、partially_reviewed、reviewed;分别表示未复核、部分复核、已复核)。\n- sync_assignment_status(等值,string,可选,英文枚举:unsynced、partially_synced、synced;分别表示未同步、部分同步、已同步;按订单 sync_status 聚合判断,synced 表示聚合后全部 fin,partially_synced 表示部分已同步且不含 error,unsynced 表示全未同步或包含 error(异常并入未同步集合))。\n- store_id(货主ID,可选,正整数,支持单值/数组/{operator,value} 结构,如 {\"operator\":\"\",\"value\":[1000281,1000000]};语义:默认 eq/in 返回包含任一筛选货主订单的波次,含混合货主波次;ne/notin 返回不包含所选货主订单的波次;不支持 like 等文本操作符)。" + "description": "筛选白名单字段(object,可选)。仅支持下列字段过滤,且禁止传入 warehouse_id / warehouseId。\n【操作符传参】每个字段均支持「裸值」或「标准结构 {'operator':'eq','value':'...','type':'text'}」两种写法;未显式传 operator 时按该字段默认语义(见下方括号)。支持的操作符:eq、ne、gt、lt、ge、le、in、notin、between、notbetween、like、contains、notlike、startswith、endswith、isnull、isnotnull,按字段分组允许:\n- 数值类(wave_id、wave_type、wave_status、source、total_orders、processed_orders 及 total_orders_min/max、processed_orders_min/max):eq/ne/gt/lt/ge/le/in/notin/between/notbetween/isnull/isnotnull;\n- 文本类(wave_no、creator、logistics_name、item_part_type、item_part、item_snapshot_key、item_detail_machine):eq/ne/like/contains/notlike/startswith/endswith/in/notin/isnull/isnotnull;\n- 布尔类(distinguish_express):eq/ne/in/notin;\n- 分配/复核状态类(storage_assignment_status、express_assignment_status、print_assignment_status、confirm_print_assignment_status、claim_assignment_status、review_assignment_status、sync_assignment_status):仅 eq;\n- 货主(store_id):eq/in/ne/notin。\nvalue 支持数组:like/contains/startswith/endswith 多值按 OR 展开,notlike 多值按 AND 展开;in/notin 要求 value 为非空数组;eq 传数组等价于 in;between/notbetween 要求 value 为长度 2 的数组(也接受 {start,end} / {from,to})。\n【字段清单】(括号内为未显式传 operator 时的默认语义)\n- wave_id(等值)\n- wave_no(模糊)\n- wave_type(等值)\n- wave_status(等值,接口固定叠加状态 0/1)\n- creator(模糊)\n- logistics_name(模糊)\n- item_part_type(等值)\n- item_part(模糊)\n- item_snapshot_key(模糊)\n- item_detail_machine(模糊)\n- distinguish_express(等值,value 兼容 true/false/1/0)\n- total_orders / processed_orders(等值,新增:波次订单总数/已处理数,可直接用 between 等操作符)\n- total_orders_min / total_orders_max(范围,等价于 total_orders 的 ge / le)\n- processed_orders_min / processed_orders_max(范围,等价于 processed_orders 的 ge / le)\n- express_assignment_status(等值,string,可选,英文枚举,取值:unassigned、partially_assigned、assigned;语义:按快递分配聚合判断,assigned 表示聚合后全部 fin,partially_assigned 表示部分已分配且不含 error,unassigned 表示全 none 或包含 error(异常并入未分配集合))。\n- print_assignment_status(等值,string,可选,英文枚举,取值:unprinted、partially_printed、printed;语义:按打印分配聚合判断,printed 表示聚合后全部已打印)。\n- confirm_print_assignment_status(等值,string,可选,英文枚举,取值:unconfirmed、partially_confirmed、confirmed;语义:按确认打印聚合判断,confirmed 表示聚合后全部已确认打印,unconfirmed 表示全部未确认,partially_confirmed 表示部分已确认)。\n- claim_assignment_status(等值,string,可选,取值:unclaimed / claimed,兼容中文 未领料 / 已领料;语义:以波次表 wms_wave_batch.claim_time 是否为空判定,二态无部分状态)。\n- storage_assignment_status(等值,string,可选,取值:未分配、部分分配、已分配;默认不传不做限制)。过滤语义:已分配=聚合后全部 fin;部分分配=不含 error,且既不是全 none,也不是全 fin;未分配=全 none 或包含 error(异常并入未分配筛选集合)。说明:返回字段 storage_assignment_status 的展示值保持不变,包含 error 时仍可显示“分配异常”;此处 where 的过滤语义会把异常计入“未分配”,以避免把过滤语义与展示值混淆。\n- source(可选,number)来源过滤:0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务;不传则不过滤。\n说明:express_assignment_status 与 print_assignment_status 要求使用英文枚举值;storage_assignment_status 仍向后兼容中文展示值。若传入的枚举值不在允许集合内,接口会返回 400(参数校验失败),并在 message 中说明错误字段与允许取值。\n- review_assignment_status(等值,string,可选,英文枚举:unreviewed、partially_reviewed、reviewed;分别表示未复核、部分复核、已复核)。\n- sync_assignment_status(等值,string,可选,英文枚举:unsynced、partially_synced、synced;分别表示未同步、部分同步、已同步;按订单 sync_status 聚合判断,synced 表示聚合后全部 fin,partially_synced 表示部分已同步且不含 error,unsynced 表示全未同步或包含 error(异常并入未同步集合))。\n- store_id(货主ID,可选,正整数,支持单值/数组/{operator,value} 结构,如 {\"operator\":\"\",\"value\":[1000281,1000000]};语义:默认 eq/in 返回包含任一筛选货主订单的波次,含混合货主波次;ne/notin 返回不包含所选货主订单的波次;不支持 like 等文本操作符)。" } ], "response": [ @@ -30785,7 +30890,7 @@ "name": "list", "type": "array", "required": true, - "description": "波次列表,包含波次基础信息与状态汇总(order_count / storage_assignment_status / express_assignment_status / print_assignment_status / pick_assignment_status / review_assignment_status / sync_assignment_status / unreviewed_order_count)。其中 pick_assignment_status 按订单 pick_status 聚合判定,取值:未拣货/部分拣货/已拣货/拣货异常。sync_assignment_status 按订单 sync_status 聚合判定,取值:未同步/部分同步/已同步/同步异常(error 并入未同步集合)。每条记录新增字段 source(number):来源标识,0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务。每条记录新增字段 store_name(string):货主信息,当波次内所有订单均为同一货主(store_id)时返回货主名称,否则返回“混合”;货主名称优先取合约表 wms_store_warehouse.store_remask(货主备注名称),无合约或备注为空时回退 wms_store.company_name(公司全称)。" + "description": "波次列表,包含波次基础信息与状态汇总(order_count / storage_assignment_status / express_assignment_status / print_assignment_status / confirm_print_assignment_status / claim_assignment_status / pick_assignment_status / review_assignment_status / sync_assignment_status / unreviewed_order_count)。其中 pick_assignment_status 按订单 pick_status 聚合判定,取值:未拣货/部分拣货/已拣货/拣货异常。sync_assignment_status 按订单 sync_status 聚合判定,取值:未同步/部分同步/已同步/同步异常(error 并入未同步集合)。confirm_print_assignment_status 按订单 confirm_print_status 聚合判定,取值:未确认打印/部分确认打印/已确认打印。claim_assignment_status 按波次表 wms_wave_batch.claim_time 判定(已领料/未领料,二态),并同步返回 claim_time 与 claim_operator。每条记录新增字段 source(number):来源标识,0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务。每条记录新增字段 store_name(string):货主信息,当波次内所有订单均为同一货主(store_id)时返回货主名称,否则返回“混合”;货主名称优先取合约表 wms_store_warehouse.store_remask(货主备注名称),无合约或备注为空时回退 wms_store.company_name(公司全称)。" }, { "name": "pagination", @@ -31232,6 +31337,164 @@ "message": "绑定包材失败" } ] + }, + { + "method": "order.wave.confirmPrintScan", + "description": "确认打印扫描(与领单 pick.waveClaimScan 操作一致):扫波次内任一订单的面单号,将波次下全部已打印(print_status='fin')且非拦截的订单批量标记 confirm_print_status='fin',并写订单操作日志(ORDER_CONFIRM_PRINT)。拦截订单跳过(不确认、不阻断);波次下存在未打印订单(print_status != 'fin')时阻断;全部已确认时重复扫描返回 already_confirmed。成功后递增确认打印未领单统计版本号,驱动 confirmPrintUnclaimedWaveCount 长轮询立即返回新值。", + "isNeedAuth": true, + "isNeedLogin": true, + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "waybill_no", + "type": "string", + "required": true, + "source": "body", + "description": "面单号/运单号(必填,用于定位订单及所属波次)" + } + ], + "response": [ + { + "name": "waybill_no", + "type": "string", + "required": false, + "description": "扫描的面单号" + }, + { + "name": "matched_order_id", + "type": "number", + "required": false, + "description": "面单号匹配到的订单ID" + }, + { + "name": "wave_id", + "type": "number", + "required": false, + "description": "波次ID" + }, + { + "name": "wave_no", + "type": "string", + "required": false, + "description": "波次编码" + }, + { + "name": "total_order_count", + "type": "number", + "required": false, + "description": "波次下总订单数" + }, + { + "name": "intercepted_order_count", + "type": "number", + "required": false, + "description": "波次下拦截订单数(跳过确认)" + }, + { + "name": "confirmed_order_count", + "type": "number", + "required": false, + "description": "已确认打印订单数(confirm_print_status='fin')" + }, + { + "name": "newly_confirmed_order_count", + "type": "number", + "required": false, + "description": "本次新增确认订单数(仅 status=confirmed 时返回)" + }, + { + "name": "status", + "type": "string", + "required": false, + "description": "确认结果:confirmed=本次完成确认 / already_confirmed=已全部确认" + } + ], + "errors": [ + { + "code": 400, + "message": "waybill_no 必填(面单号/运单号)" + }, + { + "code": 400, + "message": "缺少当前用户仓库上下文 store_id" + }, + { + "code": 400, + "message": "运单对应订单未分配波次" + }, + { + "code": 400, + "message": "波次存在未打印订单,禁止确认打印(返回 unprinted_order_count)" + }, + { + "code": 404, + "message": "未查询到该面单号对应的订单,无记录" + }, + { + "code": 500, + "message": "内部错误(OrderDeliveryFactory/订单模型不可用或更新失败)" + } + ] + }, + { + "method": "order.wave.confirmPrintUnclaimedWaveCount", + "description": "快速查询「已确认打印但未领单」的波次数量,使用当前登录操作者仓库上下文。口径(波次表驱动):未领单以 wms_wave_batch.claim_time IS NULL 为准(历史领单发生在波次表增加 claim_time 字段之前时,订单维度 claim_status 可能已是 fin 但波次表无记录,故不用订单 claim_status 判断),已确认打印以波次下存在 confirm_print_status='fin' 的非取消订单为准,仅统计 wave_status 0/1 的波次。支持长轮询(参考扫码登录):不传 last_count 立即返回当前值(status=current);传 last_count 且与当前值不同立即返回新值(status=changed);传 last_count 且与当前值相同则进入等待,每 1 秒检查统计版本号(确认打印/领单成功会递增版本号),最长等待 60 秒:期间变化立即返回新值(status=changed),超时未变化重查后返回当前值(status=timeout)。", + "isNeedAuth": false, + "isNeedLogin": true, + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "last_count", + "type": "number", + "required": false, + "source": "body", + "description": "上次调用返回的 count(可选基线);传入后进入最长 60s 长轮询等待变化,不传则立即返回当前值" + } + ], + "response": [ + { + "name": "count", + "type": "number", + "required": true, + "description": "已确认打印但未领单的波次数量" + }, + { + "name": "warehouse_id", + "type": "number", + "required": true, + "description": "当前仓库ID" + }, + { + "name": "status", + "type": "string", + "required": true, + "description": "返回状态:current=即时返回当前值 / changed=检测到变化返回新值 / timeout=等待 60s 未变化返回当前值" + } + ], + "errors": [ + { + "code": 400, + "message": "未识别到当前仓库上下文" + }, + { + "code": 500, + "message": "查询失败" + } + ] } ] }, @@ -34455,7 +34718,7 @@ }, { "method": "workbench.packOrder", - "description": "工作台打包上报(免登录、免权限、免鉴权,以工作台 token 鉴权):仓库与工作台均由服务端从 token 解析注入(body 传入 warehouse_id/workbench_id 一律忽略,禁止前端传值),入参发货单号、波次号、状态、打包时间、波次总订单数、SKU 品种数、商品总件数、打包人员(以上数量以服务端复查为准,设备上报仅交叉校验);按发货单号定位订单(current→dispatch 分表),同一工作台存在上一个未结束任务时先关闭(同步回写旧订单打包状态,并将工作台绑定摄像头 OSD 复位为「无任务」,新任务 OSD 在其后串行下发避免被复位覆盖),散单按 order_id、团购按 wave_no 去重后创建打包任务(wms_pack_task,缺失/非法 status 归一化为 1=打包中),写入打包人员(wms_pack_task_packer)与 operator_text、下发 OSD 到工作台绑定摄像头(散单显示运单号、团购显示波次号+订单总量,并写 Redis osd_{workbenchId} 缓存)、写操作日志;打包状态变更后主动失效对应工作台 token 缓存,保证 getWorkbenchInfo 尽快返回最新打包信息;团购单(isSandan=0)响应附 batch 波次信息(波次订单数为 current+dispatch 分表实时统计);拦截流程中的订单不允许打包(散单直接拒绝、团购波次静默跳过并视为完成);保留系统日志(systemInit 未声明免日志);成功返回 flag=success、code=200", + "description": "工作台打包上报(免登录、免权限、免鉴权,以工作台 token 鉴权):仓库与工作台均由服务端从 token 解析注入(body 传入 warehouse_id/workbench_id 一律忽略,禁止前端传值),入参发货单号、波次号、状态、打包时间、波次总订单数、SKU 品种数、商品总件数、打包人员(以上数量以服务端复查为准,设备上报仅交叉校验);按发货单号定位订单(current→dispatch 分表),同一工作台存在上一个未结束任务时先关闭(同步回写旧订单打包状态并补确认打印状态,并将工作台绑定摄像头 OSD 复位为「无任务」,新任务 OSD 在其后串行下发避免被复位覆盖),散单按 order_id、团购按 wave_no 去重后创建打包任务(wms_pack_task,缺失/非法 status 归一化为 1=打包中),写入打包人员(wms_pack_task_packer)与 operator_text、下发 OSD 到工作台绑定摄像头(散单显示运单号、团购显示波次号+订单总量,并写 Redis osd_{workbenchId} 缓存)、写操作日志;打包状态变更后主动失效对应工作台 token 缓存,保证 getWorkbenchInfo 尽快返回最新打包信息;团购单(isSandan=0)响应附 batch 波次信息(波次订单数为 current+dispatch 分表实时统计);拦截流程中的订单不允许打包(散单直接拒绝、团购波次静默跳过并视为完成);保留系统日志(systemInit 未声明免日志);成功返回 flag=success、code=200", "isNeedAuth": false, "isNeedLogin": false, "isNeedRight": false, @@ -34628,7 +34891,7 @@ }, { "method": "workbench.finishPack", - "description": "工作台打包完成(免登录、免权限、免鉴权,以工作台 token 鉴权):仓库与工作台均由服务端从 token 解析注入(body 传入 warehouse_id/workbench_id 一律忽略,禁止前端传值);查找该工作台最后一个未结束的打包任务(status<2,按 id 倒序取最新)并结束(写 end_time、status=2,结束时间按仓库配置的散单/团购打包最大时长上限截断),同步回写关联订单打包状态(散单更新单笔、团购批量更新波次下未拦截订单)并写完成操作日志,随后将工作台绑定摄像头 OSD 复位为「无任务」(回写 Redis osd_{workbenchId} 缓存并逐台摄像头下发「无任务」,失败仅告警不阻塞主流程);无未结束任务时返回 finished=false(data 仅 workbench_id/finished/message);打包任务结束后主动失效对应工作台 token 缓存,保证 getWorkbenchInfo 尽快返回最新打包信息;保留系统日志(systemInit 未声明免日志);成功返回 flag=success、code=200", + "description": "工作台打包完成(免登录、免权限、免鉴权,以工作台 token 鉴权):仓库与工作台均由服务端从 token 解析注入(body 传入 warehouse_id/workbench_id 一律忽略,禁止前端传值);查找该工作台最后一个未结束的打包任务(status<2,按 id 倒序取最新)并结束(写 end_time、status=2,结束时间按仓库配置的散单/团购打包最大时长上限截断),同步回写关联订单打包状态(散单更新单笔、团购批量更新波次下未拦截订单),并补确认打印状态(confirm_print_status 未写入时置 fin,团购按波次补、散单按单补)并写完成操作日志,随后将工作台绑定摄像头 OSD 复位为「无任务」(回写 Redis osd_{workbenchId} 缓存并逐台摄像头下发「无任务」,失败仅告警不阻塞主流程);无未结束任务时返回 finished=false(data 仅 workbench_id/finished/message);打包任务结束后主动失效对应工作台 token 缓存,保证 getWorkbenchInfo 尽快返回最新打包信息;保留系统日志(systemInit 未声明免日志);成功返回 flag=success、code=200", "isNeedAuth": false, "isNeedLogin": false, "isNeedRight": false, @@ -39742,197 +40005,718 @@ "description": "售后类型列表(系统级+本仓库自定义,分页);warehouseId 从登录上下文注入", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "isEnabled", "type": "number", "required": false, "source": "body", "description": "启用状态筛选:1/0" }, - { "name": "page", "type": "number", "required": false, "source": "body", "description": "页码,默认 1" }, - { "name": "pageSize", "type": "number", "required": false, "source": "body", "description": "每页数量,默认 20,最大 200" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "list", "type": "array", "required": true, "description": "类型列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }] + "params": [ + { + "name": "isEnabled", + "type": "number", + "required": false, + "source": "body", + "description": "启用状态筛选:1/0" + }, + { + "name": "page", + "type": "number", + "required": false, + "source": "body", + "description": "页码,默认 1" + }, + { + "name": "pageSize", + "type": "number", + "required": false, + "source": "body", + "description": "每页数量,默认 20,最大 200" + } + ], + "response": [ + { + "name": "list", + "type": "array", + "required": true, + "description": "类型列表" + }, + { + "name": "pagination", + "type": "object", + "required": true, + "description": "分页信息" + } + ] }, { "method": "inbox.v2.type.create", "description": "创建仓库自定义售后类型;系统级只读", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "type", "type": "string", "required": true, "source": "body", "description": "类型编码(≤20),仓库内唯一" }, - { "name": "name", "type": "string", "required": true, "source": "body", "description": "类型名称(≤50)" }, - { "name": "sortOrder", "type": "number", "required": false, "source": "body", "description": "排序值,默认 0" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "id", "type": "number", "required": true, "description": "新类型ID" }, { "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "type", + "type": "string", + "required": true, + "source": "body", + "description": "类型编码(≤20),仓库内唯一" + }, + { + "name": "name", + "type": "string", + "required": true, + "source": "body", + "description": "类型名称(≤50)" + }, + { + "name": "sortOrder", + "type": "number", + "required": false, + "source": "body", + "description": "排序值,默认 0" + } + ], + "response": [ + { + "name": "id", + "type": "number", + "required": true, + "description": "新类型ID" + }, + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.type.update", "description": "更新仓库自定义售后类型(name/isEnabled/sortOrder);系统预设类型拒绝修改", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "id", "type": "number", "required": true, "source": "body", "description": "类型ID" }, - { "name": "name", "type": "string", "required": false, "source": "body", "description": "新名称" }, - { "name": "isEnabled", "type": "number", "required": false, "source": "body", "description": "1 启用 0 停用" }, - { "name": "sortOrder", "type": "number", "required": false, "source": "body", "description": "排序值" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "id", + "type": "number", + "required": true, + "source": "body", + "description": "类型ID" + }, + { + "name": "name", + "type": "string", + "required": false, + "source": "body", + "description": "新名称" + }, + { + "name": "isEnabled", + "type": "number", + "required": false, + "source": "body", + "description": "1 启用 0 停用" + }, + { + "name": "sortOrder", + "type": "number", + "required": false, + "source": "body", + "description": "排序值" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.type.delete", "description": "删除仓库自定义售后类型(无子类型引用才可删);系统预设类型拒绝删除", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [{ "name": "id", "type": "number", "required": true, "source": "body", "description": "类型ID" }], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "id", + "type": "number", + "required": true, + "source": "body", + "description": "类型ID" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.subType.list", "description": "售后子类型列表(系统级+本仓库自定义,分页,可按类型/启用状态筛选)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "type", "type": "string", "required": false, "source": "body", "description": "类型编码筛选" }, - { "name": "isEnabled", "type": "number", "required": false, "source": "body", "description": "启用状态筛选:1/0" }, - { "name": "page", "type": "number", "required": false, "source": "body", "description": "页码" }, - { "name": "pageSize", "type": "number", "required": false, "source": "body", "description": "每页数量" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "list", "type": "array", "required": true, "description": "子类型列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }] + "params": [ + { + "name": "type", + "type": "string", + "required": false, + "source": "body", + "description": "类型编码筛选" + }, + { + "name": "isEnabled", + "type": "number", + "required": false, + "source": "body", + "description": "启用状态筛选:1/0" + }, + { + "name": "page", + "type": "number", + "required": false, + "source": "body", + "description": "页码" + }, + { + "name": "pageSize", + "type": "number", + "required": false, + "source": "body", + "description": "每页数量" + } + ], + "response": [ + { + "name": "list", + "type": "array", + "required": true, + "description": "子类型列表" + }, + { + "name": "pagination", + "type": "object", + "required": true, + "description": "分页信息" + } + ] }, { "method": "inbox.v2.subType.create", "description": "创建仓库自定义子类型(可挂在系统级类型或本仓库自定义类型下;子类型写入本仓库,后续关键词/函数/取号/白名单/回复均可写)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "type", "type": "string", "required": true, "source": "body", "description": "所属类型编码" }, - { "name": "subType", "type": "string", "required": true, "source": "body", "description": "子类型编码(≤50)" }, - { "name": "name", "type": "string", "required": true, "source": "body", "description": "子类型名称(≤50)" }, - { "name": "sortOrder", "type": "number", "required": false, "source": "body", "description": "排序值" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "id", "type": "number", "required": true, "description": "新子类型ID" }, { "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "type", + "type": "string", + "required": true, + "source": "body", + "description": "所属类型编码" + }, + { + "name": "subType", + "type": "string", + "required": true, + "source": "body", + "description": "子类型编码(≤50)" + }, + { + "name": "name", + "type": "string", + "required": true, + "source": "body", + "description": "子类型名称(≤50)" + }, + { + "name": "sortOrder", + "type": "number", + "required": false, + "source": "body", + "description": "排序值" + } + ], + "response": [ + { + "name": "id", + "type": "number", + "required": true, + "description": "新子类型ID" + }, + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.subType.update", "description": "更新仓库自定义子类型(name/isEnabled/sortOrder);系统预设拒绝修改", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "id", "type": "number", "required": true, "source": "body", "description": "子类型ID" }, - { "name": "name", "type": "string", "required": false, "source": "body", "description": "新名称" }, - { "name": "isEnabled", "type": "number", "required": false, "source": "body", "description": "1 启用 0 停用" }, - { "name": "sortOrder", "type": "number", "required": false, "source": "body", "description": "排序值" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "id", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + }, + { + "name": "name", + "type": "string", + "required": false, + "source": "body", + "description": "新名称" + }, + { + "name": "isEnabled", + "type": "number", + "required": false, + "source": "body", + "description": "1 启用 0 停用" + }, + { + "name": "sortOrder", + "type": "number", + "required": false, + "source": "body", + "description": "排序值" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.subType.delete", "description": "删除仓库自定义子类型,自动级联清理关联(关键词/函数关联/取号关联/群白名单/回复);系统预设拒绝删除", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [{ "name": "id", "type": "number", "required": true, "source": "body", "description": "子类型ID" }], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果(含级联清理统计)" }] + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "id", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果(含级联清理统计)" + } + ] }, { "method": "inbox.v2.keyword.list", "description": "关键词列表(系统级+本仓库自定义,分页,可按子类型/启用状态筛选)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "subTypeId", "type": "number", "required": false, "source": "body", "description": "子类型ID筛选" }, - { "name": "isEnabled", "type": "number", "required": false, "source": "body", "description": "启用状态筛选" }, - { "name": "page", "type": "number", "required": false, "source": "body", "description": "页码" }, - { "name": "pageSize", "type": "number", "required": false, "source": "body", "description": "每页数量" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "list", "type": "array", "required": true, "description": "关键词列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }] + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": false, + "source": "body", + "description": "子类型ID筛选" + }, + { + "name": "isEnabled", + "type": "number", + "required": false, + "source": "body", + "description": "启用状态筛选" + }, + { + "name": "page", + "type": "number", + "required": false, + "source": "body", + "description": "页码" + }, + { + "name": "pageSize", + "type": "number", + "required": false, + "source": "body", + "description": "每页数量" + } + ], + "response": [ + { + "name": "list", + "type": "array", + "required": true, + "description": "关键词列表" + }, + { + "name": "pagination", + "type": "object", + "required": true, + "description": "分页信息" + } + ] }, { "method": "inbox.v2.keyword.create", "description": "创建仓库自定义关键词(关键词为仓库级数据,可绑定系统级或本仓库自定义子类型;同一仓库内关键词唯一);系统预设关键词只读", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }, - { "name": "keyword", "type": "string", "required": true, "source": "body", "description": "关键词(≤100),仓库内唯一" }, - { "name": "sortOrder", "type": "number", "required": false, "source": "body", "description": "排序值" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "id", "type": "number", "required": true, "description": "新关键词ID" }, { "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + }, + { + "name": "keyword", + "type": "string", + "required": true, + "source": "body", + "description": "关键词(≤100),仓库内唯一" + }, + { + "name": "sortOrder", + "type": "number", + "required": false, + "source": "body", + "description": "排序值" + } + ], + "response": [ + { + "name": "id", + "type": "number", + "required": true, + "description": "新关键词ID" + }, + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.keyword.update", "description": "更新仓库自定义关键词(keyword/subTypeId/isEnabled/sortOrder);系统预设拒绝修改", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "id", "type": "number", "required": true, "source": "body", "description": "关键词ID" }, - { "name": "keyword", "type": "string", "required": false, "source": "body", "description": "新关键词" }, - { "name": "subTypeId", "type": "number", "required": false, "source": "body", "description": "新子类型ID" }, - { "name": "isEnabled", "type": "number", "required": false, "source": "body", "description": "1 启用 0 停用" }, - { "name": "sortOrder", "type": "number", "required": false, "source": "body", "description": "排序值" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "id", + "type": "number", + "required": true, + "source": "body", + "description": "关键词ID" + }, + { + "name": "keyword", + "type": "string", + "required": false, + "source": "body", + "description": "新关键词" + }, + { + "name": "subTypeId", + "type": "number", + "required": false, + "source": "body", + "description": "新子类型ID" + }, + { + "name": "isEnabled", + "type": "number", + "required": false, + "source": "body", + "description": "1 启用 0 停用" + }, + { + "name": "sortOrder", + "type": "number", + "required": false, + "source": "body", + "description": "排序值" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.keyword.delete", "description": "删除仓库自定义关键词;系统预设拒绝删除", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [{ "name": "id", "type": "number", "required": true, "source": "body", "description": "关键词ID" }], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "id", + "type": "number", + "required": true, + "source": "body", + "description": "关键词ID" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.numberRule.list", "description": "取号规则列表(全局资源只读,含 target/regexp/sort_order,供关联配置选择)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], "params": [], - "response": [{ "name": "list", "type": "array", "required": true, "description": "取号规则列表" }] + "response": [ + { + "name": "list", + "type": "array", + "required": true, + "description": "取号规则列表" + } + ] }, { "method": "inbox.v2.function.list", "description": "处理函数列表(代码同步权威,含 in_registry 标记与 isEnabled 开关;可按启用状态/关键词筛选)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "isEnabled", "type": "number", "required": false, "source": "body", "description": "启用状态筛选" }, - { "name": "keyword", "type": "string", "required": false, "source": "body", "description": "编码/名称模糊搜索" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "list", "type": "array", "required": true, "description": "函数列表(含 in_registry)" }] + "params": [ + { + "name": "isEnabled", + "type": "number", + "required": false, + "source": "body", + "description": "启用状态筛选" + }, + { + "name": "keyword", + "type": "string", + "required": false, + "source": "body", + "description": "编码/名称模糊搜索" + } + ], + "response": [ + { + "name": "list", + "type": "array", + "required": true, + "description": "函数列表(含 in_registry)" + } + ] }, { "method": "inbox.v2.function.update", "description": "更新函数排序(是否启用由代码硬编码,不做接口配置)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "id", "type": "number", "required": true, "source": "body", "description": "函数ID" }, - { "name": "sortOrder", "type": "number", "required": false, "source": "body", "description": "排序值" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "id", + "type": "number", + "required": true, + "source": "body", + "description": "函数ID" + }, + { + "name": "sortOrder", + "type": "number", + "required": false, + "source": "body", + "description": "排序值" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.reply.merged", "description": "回复配置合并后生效配置:以全部有效子类型(系统级+本仓库)为基底,每子类型一条、全量返回;本仓库有自定义则返回仓库级并标记 is_custom=1,否则返回系统级(is_custom=0,warehouse_id=null);无回复配置的子类型返回初始值(id=null,reply={back_text},is_reply=1,create_work_order=1);无启用状态字段,停用即回退系统级由 restore 承担", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], "params": [ - { "name": "subTypeId", "type": "number", "required": false, "source": "body", "description": "子类型ID筛选" } + { + "name": "subTypeId", + "type": "number", + "required": false, + "source": "body", + "description": "子类型ID筛选" + } ], "response": [ - { "name": "merged", "type": "array", "required": true, "description": "合并后生效配置全量列表;元素字段:id/sub_type_id/type/sub_type/sub_type_name/warehouse_id/is_custom(1仓库级 0系统级)/reply/is_reply/create_work_order/no_number_hint/created_at/updated_at" }, - { "name": "total", "type": "number", "required": true, "description": "总条数" } + { + "name": "merged", + "type": "array", + "required": true, + "description": "合并后生效配置全量列表;元素字段:id/sub_type_id/type/sub_type/sub_type_name/warehouse_id/is_custom(1仓库级 0系统级)/reply/is_reply/create_work_order/no_number_hint/created_at/updated_at" + }, + { + "name": "total", + "type": "number", + "required": true, + "description": "总条数" + } ] }, { @@ -39940,126 +40724,452 @@ "description": "创建仓库级回复配置(每子类型一条,仓库级覆盖系统级;isReply=0 表示命中后静默;createWorkOrder=0 表示函数照常执行但内部跳过工单登记)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }, - { "name": "reply", "type": "string", "required": true, "source": "body", "description": "回复文案(支持 {keyword}/{express}/{sub_type_name}/{back_text} 占位符)" }, - { "name": "isReply", "type": "number", "required": false, "source": "body", "description": "1 回复 0 静默,默认 1" }, - { "name": "createWorkOrder", "type": "number", "required": false, "source": "body", "description": "1 函数正常创建工单(默认) 0 函数照常执行但内部跳过工单登记" }, - { "name": "noNumberHint", "type": "string", "required": false, "source": "body", "description": "未取到单据号时的引导语(≤500)" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "id", "type": "number", "required": true, "description": "新回复ID" }, { "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + }, + { + "name": "reply", + "type": "string", + "required": true, + "source": "body", + "description": "回复文案(支持 {keyword}/{express}/{sub_type_name}/{back_text} 占位符)" + }, + { + "name": "isReply", + "type": "number", + "required": false, + "source": "body", + "description": "1 回复 0 静默,默认 1" + }, + { + "name": "createWorkOrder", + "type": "number", + "required": false, + "source": "body", + "description": "1 函数正常创建工单(默认) 0 函数照常执行但内部跳过工单登记" + }, + { + "name": "noNumberHint", + "type": "string", + "required": false, + "source": "body", + "description": "未取到单据号时的引导语(≤500)" + } + ], + "response": [ + { + "name": "id", + "type": "number", + "required": true, + "description": "新回复ID" + }, + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.reply.update", "description": "更新仓库级回复配置;系统级回复只读", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "id", "type": "number", "required": true, "source": "body", "description": "回复ID" }, - { "name": "reply", "type": "string", "required": false, "source": "body", "description": "新回复文案" }, - { "name": "isReply", "type": "number", "required": false, "source": "body", "description": "1 回复 0 静默" }, - { "name": "createWorkOrder", "type": "number", "required": false, "source": "body", "description": "1 函数正常创建工单 0 函数照常执行但内部跳过工单登记" }, - { "name": "noNumberHint", "type": "string", "required": false, "source": "body", "description": "取号失败引导语" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "id", + "type": "number", + "required": true, + "source": "body", + "description": "回复ID" + }, + { + "name": "reply", + "type": "string", + "required": false, + "source": "body", + "description": "新回复文案" + }, + { + "name": "isReply", + "type": "number", + "required": false, + "source": "body", + "description": "1 回复 0 静默" + }, + { + "name": "createWorkOrder", + "type": "number", + "required": false, + "source": "body", + "description": "1 函数正常创建工单 0 函数照常执行但内部跳过工单登记" + }, + { + "name": "noNumberHint", + "type": "string", + "required": false, + "source": "body", + "description": "取号失败引导语" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.reply.delete", "description": "删除仓库级回复配置;系统级回复只读", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [{ "name": "id", "type": "number", "required": true, "source": "body", "description": "回复ID" }], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "id", + "type": "number", + "required": true, + "source": "body", + "description": "回复ID" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.reply.save", "description": "保存仓库级回复配置(upsert,推荐接口):按传入字段保存,未传字段保持原值;无仓库级配置时按传入字段创建", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }, - { "name": "reply", "type": "string", "required": false, "source": "body", "description": "回复文案(≤2000)" }, - { "name": "isReply", "type": "number", "required": false, "source": "body", "description": "1 回复 0 静默,默认 1" }, - { "name": "createWorkOrder", "type": "number", "required": false, "source": "body", "description": "1 函数正常创建工单 0 函数照常执行但内部跳过工单登记" }, - { "name": "noNumberHint", "type": "string", "required": false, "source": "body", "description": "取号失败引导语(≤500)" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + }, + { + "name": "reply", + "type": "string", + "required": false, + "source": "body", + "description": "回复文案(≤2000)" + }, + { + "name": "isReply", + "type": "number", + "required": false, + "source": "body", + "description": "1 回复 0 静默,默认 1" + }, + { + "name": "createWorkOrder", + "type": "number", + "required": false, + "source": "body", + "description": "1 函数正常创建工单 0 函数照常执行但内部跳过工单登记" + }, + { + "name": "noNumberHint", + "type": "string", + "required": false, + "source": "body", + "description": "取号失败引导语(≤500)" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.reply.restore", "description": "还原仓库级回复配置:删除仓库级行,回退到系统级配置(幂等,无仓库级配置时返回已是系统级)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [{ "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.relation.function.list", "description": "查询子类型的处理函数关联列表(含函数编码/名称,按 sort_order)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [{ "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }], - "response": [{ "name": "list", "type": "array", "required": true, "description": "关联列表" }] + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + } + ], + "response": [ + { + "name": "list", + "type": "array", + "required": true, + "description": "关联列表" + } + ] }, { "method": "inbox.v2.relation.function.set", "description": "全量替换子类型的处理函数关联(items=[{functionId,sortOrder}]);仅本仓库自定义子类型可写,系统子类型关联只读", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }, - { "name": "items", "type": "array", "required": true, "source": "body", "description": "函数关联数组 [{functionId, sortOrder}]" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + }, + { + "name": "items", + "type": "array", + "required": true, + "source": "body", + "description": "函数关联数组 [{functionId, sortOrder}]" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.relation.rule.list", "description": "查询子类型的取号规则关联列表(含 target/规则名,按 sort_order)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [{ "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }], - "response": [{ "name": "list", "type": "array", "required": true, "description": "关联列表" }] + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + } + ], + "response": [ + { + "name": "list", + "type": "array", + "required": true, + "description": "关联列表" + } + ] }, { "method": "inbox.v2.relation.rule.set", "description": "全量替换子类型的取号规则关联(items=[{ruleId,sortOrder}]);仅本仓库自定义子类型可写", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }, - { "name": "items", "type": "array", "required": true, "source": "body", "description": "取号规则关联数组 [{ruleId, sortOrder}]" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + }, + { + "name": "items", + "type": "array", + "required": true, + "source": "body", + "description": "取号规则关联数组 [{ruleId, sortOrder}]" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] }, { "method": "inbox.v2.relation.group.list", "description": "查询子类型的群类型白名单关联列表(group_type + sub_group,含 is_system;sub_group='*' 表示主类型内所有子类型通配,group_type='*' 表示所有群)", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [{ "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }], - "response": [{ "name": "list", "type": "array", "required": true, "description": "白名单关联列表" }] + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } + ], + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + } + ], + "response": [ + { + "name": "list", + "type": "array", + "required": true, + "description": "白名单关联列表" + } + ] }, { "method": "inbox.v2.relation.group.set", "description": "替换子类型的群白名单关联(items=[{groupType,subGroup,sortOrder}],groupType∈store/warehouse/express/'*';subGroup 支持 '*' 通配主类型下所有子类型且覆盖该主类型其他具体行;groupType='*' 表示所有群且覆盖其他具体类型行(subGroup 忽略,归一化为空));系统预设行(is_system=1)保留不可删", "isNeedAuth": true, "isNeedLogin": true, - "headers": [{ "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" }], - "params": [ - { "name": "subTypeId", "type": "number", "required": true, "source": "body", "description": "子类型ID" }, - { "name": "items", "type": "array", "required": true, "source": "body", "description": "白名单数组 [{groupType, subGroup, sortOrder}];subGroup='*' 表示该主类型下所有子类型通配,groupType='*' 表示所有群" } + "headers": [ + { + "name": "Authorization", + "type": "string", + "required": true, + "description": "Bearer token" + } ], - "response": [{ "name": "message", "type": "string", "required": true, "description": "操作结果" }] + "params": [ + { + "name": "subTypeId", + "type": "number", + "required": true, + "source": "body", + "description": "子类型ID" + }, + { + "name": "items", + "type": "array", + "required": true, + "source": "body", + "description": "白名单数组 [{groupType, subGroup, sortOrder}];subGroup='*' 表示该主类型下所有子类型通配,groupType='*' 表示所有群" + } + ], + "response": [ + { + "name": "message", + "type": "string", + "required": true, + "description": "操作结果" + } + ] } ] },