{ "generatedAt": "2026-06-18 17:45:21", "generatedAtLocal": "2026-06-18 17:45:21", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "totalInterfaceCount": 322, "changes": { "summary": { "moduleAdded": 0, "moduleDeleted": 0, "moduleUpdated": 2, "interfaceAdded": 1, "interfaceDeleted": 0, "interfaceParamsUpdated": 0, "interfaceResponseUpdated": 2 }, "moduleUpdates": { "added": [], "deleted": [], "updated": [ { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "folder": "storage_receiving", "previousModuleName": "收货单模块", "previousModuleKey": "storage_receiving", "interfaceChanges": { "addedMethods": [], "deletedMethods": [], "paramsUpdatedMethods": [], "responseUpdatedMethods": [ "storage.receiving.getAvailableInboundQuantity" ] } }, { "moduleName": "入库单模块", "moduleKey": "storage.entry", "folder": "storage.entry", "previousModuleName": "入库单模块", "previousModuleKey": "storage.entry", "interfaceChanges": { "addedMethods": [ "storage.entry.unbindReceivingDetails" ], "deletedMethods": [], "paramsUpdatedMethods": [], "responseUpdatedMethods": [ "storage.entry.get" ] } } ] }, "interfaceUpdates": { "added": [ { "moduleName": "入库单模块", "moduleKey": "storage.entry", "folder": "storage.entry", "method": "storage.entry.unbindReceivingDetails" } ], "deleted": [], "paramsUpdated": [], "responseUpdated": [ { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "folder": "storage_receiving", "method": "storage.receiving.getAvailableInboundQuantity" }, { "moduleName": "入库单模块", "moduleKey": "storage.entry", "folder": "storage.entry", "method": "storage.entry.get" } ] } }, "interfaces": [ { "moduleName": "配置模块", "moduleKey": "config", "moduleFolder": "config", "method": "config.list", "title": "config.list 接口", "description": "config.list 接口", "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 数组(stock_warehouse.id)" }, { "name": "method", "type": "string", "required": true, "description": "要修改的字段名,可选值:brand_name、prohibited_id、gross_weight、packing_requirements、managementFlags、stock_unit" }, { "name": "value", "type": "string|number|object", "required": true, "description": "修改值,类型依 method 而定:brand_name/packing_requirements/stock_unit 为 string(<=255 字符);prohibited_id 为 number(整数);gross_weight 为 number(正数,可含小数);managementFlags 为 object,必须包含 is_sn_mgmt/is_shelf_life_mgmt/is_batch_mgmt,值为 'Y' 或 'N'" }, { "name": "values", "type": "any", "required": false, "description": "兼容字段:当前实现以 `value` 为准,不使用 `values`。若客户端历史使用 `values`,请切换为 `value`。" } ], "response": [ { "name": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功;405 表示参数/权限校验不通过;500 表示服务器错误" }, { "name": "message", "type": "string", "required": false, "description": "业务提示信息" }, { "name": "data", "type": "object", "required": false, "description": "成功时返回的结果对象" } ] }, { "moduleName": "看板模块", "moduleKey": "dashboard", "moduleFolder": "dashboard", "method": "dashboard.express_ratio", "title": "dashboard.express_ratio 接口", "description": "dashboard.express_ratio 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "看板模块", "moduleKey": "dashboard", "moduleFolder": "dashboard", "method": "dashboard.hot_order_rank", "title": "dashboard.hot_order_rank 接口", "description": "dashboard.hot_order_rank 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "看板模块", "moduleKey": "dashboard", "moduleFolder": "dashboard", "method": "dashboard.order_trend", "title": "订单趋势统计:按小时统计当日订单数与发货数,包含汇总信息(订单总数、发货总数、发货率、峰值时段)。数据来源于真实数据库查询,已废弃旧版 mock 数据。", "description": "订单趋势统计:按小时统计当日订单数与发货数,包含汇总信息(订单总数、发货总数、发货率、峰值时段)。数据来源于真实数据库查询,已废弃旧版 mock 数据。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token,从中解析 warehouseId(仓库上下文)" } ], "params": [], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码,200 表示成功" }, { "name": "message", "type": "string", "required": true, "description": "业务提示信息" }, { "name": "data", "type": "object", "required": true, "description": "成功时返回的趋势数据对象" } ] }, { "moduleName": "看板模块", "moduleKey": "dashboard", "moduleFolder": "dashboard", "method": "dashboard.platform_distribution", "title": "dashboard.platform_distribution 接口", "description": "dashboard.platform_distribution 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "看板模块", "moduleKey": "dashboard", "moduleFolder": "dashboard", "method": "dashboard.storeStats", "title": "dashboard.storeStats 接口", "description": "dashboard.storeStats 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "看板模块", "moduleKey": "dashboard", "moduleFolder": "dashboard", "method": "dashboard.warehouseStats", "title": "dashboard.warehouseStats 接口", "description": "dashboard.warehouseStats 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.fastWhereTree", "title": "index.fastWhereTree 接口", "description": "index.fastWhereTree 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "type", "type": "string", "required": false, "description": "type 参数" } ], "response": [] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getCainiaoStfTemplates", "title": "公共无参查询淘宝菜鸟标准模板列表;服务端调用淘宝开放平台 cainiao.cloudprint.stdtemplates.get,请求地址为 https://eco.taobao.com/router/rest,使用 TOP 公共签名参数。不需要用户授权,不下发 session,不依赖登录态、当前仓库或店铺授权。成功返回 data.platform_code='TB' 与标准模板数组,模板项统一字段为 template_id/template_name/template_url/cp_code/wp_code。", "description": "公共无参查询淘宝菜鸟标准模板列表;服务端调用淘宝开放平台 cainiao.cloudprint.stdtemplates.get,请求地址为 https://eco.taobao.com/router/rest,使用 TOP 公共签名参数。不需要用户授权,不下发 session,不依赖登录态、当前仓库或店铺授权。成功返回 data.platform_code='TB' 与标准模板数组,模板项统一字段为 template_id/template_name/template_url/cp_code/wp_code。", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码,成功时返回 200。" }, { "name": "message", "type": "string", "required": true, "description": "业务提示信息,成功时返回 ok。" }, { "name": "data.platform_code", "type": "string", "required": true, "description": "平台编码,固定返回 TB。" }, { "name": "data.list", "type": "array", "required": true, "description": "菜鸟标准模板列表;来源于 cainiao_cloudprint_stdtemplates_get_response.result.datas[*].standard_templates[*] 的宽松兼容解析结果,按统一字段 template_id/template_name/template_url/cp_code/wp_code 返回。" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getCOSUploadConfig", "title": "index.getCOSUploadConfig 接口", "description": "index.getCOSUploadConfig 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "data", "type": "object", "required": false, "description": "data 参数" } ], "response": [] }, { "moduleName": "快递编码管理模块", "moduleKey": "setting.express", "moduleFolder": "setting.express", "method": "index.getExpressList", "title": "获取快递列表。默认返回系统基础快递与当前登录仓库自定义快递编码的合并结果:系统快递在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础快递列表。仅接受 `express_code` 入参,服务端会先 trim 再转为大写:`systemOnly=true` 时按系统快递编码过滤系统基础快递列表;`systemOnly=false` 时按自定义编码映射记录中的系统快递编码字段 `express_code` 过滤,仅返回当前登录仓库下匹配该系统快递编码的自定义编码列表,不再回传系统基础项。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义编码列表为空。接口优先读取缓存,未命中时回源 `wms_express` 与 `wms_express_setting`。", "description": "获取快递列表。默认返回系统基础快递与当前登录仓库自定义快递编码的合并结果:系统快递在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础快递列表。仅接受 `express_code` 入参,服务端会先 trim 再转为大写:`systemOnly=true` 时按系统快递编码过滤系统基础快递列表;`systemOnly=false` 时按自定义编码映射记录中的系统快递编码字段 `express_code` 过滤,仅返回当前登录仓库下匹配该系统快递编码的自定义编码列表,不再回传系统基础项。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义编码列表为空。接口优先读取缓存,未命中时回源 `wms_express` 与 `wms_express_setting`。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "systemOnly", "type": "boolean|number|string", "required": false, "description": "是否仅返回系统基础快递列表;仅 `true`、`1`、`'1'`、`'true'` 会被识别为 true,其余值按 false 处理" }, { "name": "express_code", "type": "string", "required": false, "description": "系统快递编码;服务端会去首尾空格并转为大写。`systemOnly=true` 时按该系统快递编码过滤系统基础快递列表;`systemOnly=false` 时按自定义映射记录中的系统快递编码字段 `express_code` 过滤当前仓库的自定义编码列表,而不是按自定义 `code` 过滤" } ], "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": "快递列表数组。默认模式下先返回系统基础快递,再追加当前仓库自定义编码;当传入 `express_code` 且 `systemOnly=false` 时,仅返回当前仓库下系统快递编码等于该 `express_code` 的自定义映射记录,不返回系统基础项。每项字段如下:" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getI18nMessage", "title": "index.getI18nMessage 接口", "description": "index.getI18nMessage 接口", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "language", "type": "string", "required": false, "description": "language 参数" } ], "response": [] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getImages", "title": "index.getImages 接口", "description": "index.getImages 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getLocationTypeList", "title": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存", "description": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [ { "name": "list", "type": "array", "required": false, "description": "库位类型列表" }, { "name": "total", "type": "number", "required": false, "description": "返回总数" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getMessageDetail", "title": "index.getMessageDetail 接口", "description": "index.getMessageDetail 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "平台编码管理模块", "moduleKey": "setting.platform", "moduleFolder": "setting.platform", "method": "index.getPlatformList", "title": "获取平台列表。默认返回系统基础平台与当前登录仓库自定义平台设置的合并结果:系统平台在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础平台列表。`full` 为真值时返回全量字段(包含 wms_platform 全部表字段、route_platform_code、platid 等)。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义设置列表为空。接口优先读取缓存,未命中时回源 `wms_platform` 与 `wms_platfrom_setting`。", "description": "获取平台列表。默认返回系统基础平台与当前登录仓库自定义平台设置的合并结果:系统平台在前,仓库自定义编码在后,同一 `code` 仅保留首条(系统同码优先保留系统记录)。当 `systemOnly` 为真值(支持 `true`、`1`、`'1'`、`'true'`)时,仅返回系统基础平台列表。`full` 为真值时返回全量字段(包含 wms_platform 全部表字段、route_platform_code、platid 等)。仓库范围来自当前登录用户 `ctx.user.store_id`;未识别到仓库时,自定义设置列表为空。接口优先读取缓存,未命中时回源 `wms_platform` 与 `wms_platfrom_setting`。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "systemOnly", "type": "boolean|number|string", "required": false, "description": "是否仅返回系统基础平台列表;仅 `true`、`1`、`'1'`、`'true'` 会被识别为 true,其余值按 false 处理。也支持 `is_system` 别名(若请求体中同时存在 `is_system` 和 `systemOnly`,优先使用 `is_system`)" }, { "name": "full", "type": "boolean|number|string", "required": false, "description": "是否返回全量字段;仅 `true`、`1`、`'1'`、`'true'` 会被识别为 true,其余值按 false 处理。为 true 时返回 wms_platform 全部表字段、route_platform_code、platid 等扩展信息" } ], "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": "平台列表数组。默认模式下先返回系统基础平台,再追加当前仓库自定义设置;`systemOnly=true` 时仅返回系统基础平台。每项字段如下:" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getPlatformOauthLink", "title": "获取平台授权链接。入参支持 code / platform_code / platformCode,服务端按首个非空值标准化为大写平台编码;会从当前登录上下文读取仓库 ID(ctx.user.store_id),再从 wms_platform.auth_base_url 读取授权基础地址。接口会优先复用当前仓库与平台下 status=0 的未授权记录;若历史 auth_random_code 带有当前配置前缀,则会先去前缀后以裸码回写,当前数据库最终保存的 auth_random_code 为裸码。若无可复用记录则生成新的裸码并写入 wms_shops。返回的 oauth_link 会从配置 platformOauthReservationCodePrefix 读取前缀(本地示例为 xxxxx_),按“前缀 + 平台编码 + '_' + 裸码”生成 state,并将 URL 编码后的 state 直接拼接到平台基础授权链接后,例如 xxxxx_PDD_。当前仅支持已按上述模式配置好的基础授权链接。", "description": "获取平台授权链接。入参支持 code / platform_code / platformCode,服务端按首个非空值标准化为大写平台编码;会从当前登录上下文读取仓库 ID(ctx.user.store_id),再从 wms_platform.auth_base_url 读取授权基础地址。接口会优先复用当前仓库与平台下 status=0 的未授权记录;若历史 auth_random_code 带有当前配置前缀,则会先去前缀后以裸码回写,当前数据库最终保存的 auth_random_code 为裸码。若无可复用记录则生成新的裸码并写入 wms_shops。返回的 oauth_link 会从配置 platformOauthReservationCodePrefix 读取前缀(本地示例为 xxxxx_),按“前缀 + 平台编码 + '_' + 裸码”生成 state,并将 URL 编码后的 state 直接拼接到平台基础授权链接后,例如 xxxxx_PDD_。当前仅支持已按上述模式配置好的基础授权链接。", "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": false, "description": "平台编码主字段;与 platform_code / platformCode 三选一即可,服务端按 code -> platform_code -> platformCode 顺序取首个非空值并转为大写" }, { "name": "platform_code", "type": "string", "required": false, "description": "平台编码下划线别名" }, { "name": "platformCode", "type": "string", "required": false, "description": "平台编码驼峰别名" } ], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码,成功时返回 200" }, { "name": "data.platform_code", "type": "string", "required": true, "description": "标准化后的平台编码" }, { "name": "data.oauth_link", "type": "string", "required": true, "description": "基于 wms_platform.auth_base_url 构造的授权链接;实际拼接值为 encodeURIComponent(prefix + platform_code + '_' + rawCode),其中 prefix 来自 platformOauthReservationCodePrefix,rawCode 为数据库 auth_random_code 中保存的裸码。基础授权链接需预先配置为可直接追加 state 值的模式。" } ] }, { "moduleName": "快递接口管理模块", "moduleKey": "setting.expressInterface", "moduleFolder": "setting.expressinterface", "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` 升序返回。每项字段如下:" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getPrintPlatformTemplateList", "title": "按打印平台与快递编码查询模板列表。express_code 为必填;接口会先按 platform_code(默认 CAINIAO)定位 wms_express 对应打印平台字段,再以 express_code 过滤可用模板后返回。", "description": "按打印平台与快递编码查询模板列表。express_code 为必填;接口会先按 platform_code(默认 CAINIAO)定位 wms_express 对应打印平台字段,再以 express_code 过滤可用模板后返回。", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "platform_code", "type": "string", "required": false, "description": "打印平台编码(如 CAINIAO);不传默认 CAINIAO,服务端会转为大写。" }, { "name": "express_code", "type": "string", "required": true, "description": "快递编码(必填);服务端会转为大写,并用于按 wms_express 中对应打印平台字段筛选模板。" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "全局结果标识;成功为 success,失败为 failure。" }, { "name": "code", "type": "number", "required": true, "description": "业务状态码;成功时为 200。" }, { "name": "message", "type": "string", "required": true, "description": "提示信息;成功时为 ok。" }, { "name": "data", "type": "object", "required": true, "description": "返回数据对象。" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getShopExpressList", "title": "获取指定店铺的快递签约/电子面单可用列表。接口依赖当前登录仓库上下文 ctx.user.store_id 校验店铺归属;服务端会按店铺所属平台拉取并收敛可用快递列表,统一返回前端消费结构;未接入的平台当前返回空列表。", "description": "获取指定店铺的快递签约/电子面单可用列表。接口依赖当前登录仓库上下文 ctx.user.store_id 校验店铺归属;服务端会按店铺所属平台拉取并收敛可用快递列表,统一返回前端消费结构;未接入的平台当前返回空列表。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "shop_id", "type": "string|number", "required": false, "description": "店铺 ID;与 shopId 兼容,二选一至少传一个。服务端按 shop_id、shopId 的顺序读取首个非空值。" }, { "name": "shopId", "type": "string|number", "required": false, "description": "店铺 ID 的驼峰兼容字段;当 shop_id 为空时读取该值。" } ], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码,成功时返回 200。" }, { "name": "message", "type": "string", "required": true, "description": "业务提示信息,成功时返回 ok。" }, { "name": "data.shop_id", "type": "number", "required": true, "description": "当前店铺 ID。" }, { "name": "data.platform_code", "type": "string", "required": true, "description": "店铺所属平台编码,返回值按服务端实现转为大写。" }, { "name": "data.list", "type": "array", "required": true, "description": "服务端按店铺所属平台拉取并统一收敛后的快递签约/电子面单可用列表;未接入的平台返回空数组。" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.getShopList", "title": "获取当前登录仓库下的已授权店铺列表,支持按平台编码可选过滤。仓库上下文来自 ctx.user.store_id;服务端兼容读取 body.platform_code 与 body.platformCode,按该顺序取首个 trim 后非空值作为平台过滤条件。未传平台参数时返回当前登录仓库下全部已授权店铺;传入非空平台编码时仅返回该平台的已授权店铺。结果按 status DESC、updated_at DESC、id DESC 排序,并对敏感字段完成脱敏后返回 data.list。", "description": "获取当前登录仓库下的已授权店铺列表,支持按平台编码可选过滤。仓库上下文来自 ctx.user.store_id;服务端兼容读取 body.platform_code 与 body.platformCode,按该顺序取首个 trim 后非空值作为平台过滤条件。未传平台参数时返回当前登录仓库下全部已授权店铺;传入非空平台编码时仅返回该平台的已授权店铺。结果按 status DESC、updated_at DESC、id DESC 排序,并对敏感字段完成脱敏后返回 data.list。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "platform_code", "type": "string", "required": false, "description": "平台编码过滤条件;兼容 platformCode。服务端按 platform_code、platformCode 的顺序读取首个值,trim 后非空时仅返回该平台的已授权店铺;未传或为空时返回当前登录仓库下全部已授权店铺。" } ], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码,成功时返回 200" }, { "name": "message", "type": "string", "required": true, "description": "业务提示信息,成功时返回 ok" }, { "name": "data.list", "type": "array", "required": true, "description": "当前登录仓库下按条件过滤后的已授权店铺列表数组;未传平台参数时返回当前仓库全部已授权店铺,传入非空 platform_code/platformCode 时仅返回对应平台店铺。结果按 status DESC、updated_at DESC、id DESC 排序,且 owner_id、access_token、refresh_token、auth_random_code 已按实现规则脱敏。" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.listInterfaceTypes", "title": "查询可用的接口类型列表(如奇门仓储、开放接口等)", "description": "查询可用的接口类型列表(如奇门仓储、开放接口等)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [], "response": [] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.loadStores", "title": "index.loadStores 接口", "description": "index.loadStores 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.polyapiAuthorizeUrl", "title": "生成菠萝派授权链接。该接口不接收请求参数,服务端会固定调用 Differ.JH.BuildeAuthorizeUrl,并以内置配置 this.app.config.poloApi.appKey / this.app.config.poloApi.secret 以及当前代码中写死的 callbackUrl=http://39.100.57.68/、state=123456、itemcode=test001 作为上游请求参数,最终将菠萝派接口原始响应包裹后返回。", "description": "生成菠萝派授权链接。该接口不接收请求参数,服务端会固定调用 Differ.JH.BuildeAuthorizeUrl,并以内置配置 this.app.config.poloApi.appKey / this.app.config.poloApi.secret 以及当前代码中写死的 callbackUrl=http://39.100.57.68/、state=123456、itemcode=test001 作为上游请求参数,最终将菠萝派接口原始响应包裹后返回。", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码,成功时返回 200。" }, { "name": "message", "type": "string", "required": true, "description": "业务提示信息,成功时返回 ok。" }, { "name": "data.respone", "type": "object", "required": true, "description": "菠萝派接口 Differ.JH.BuildeAuthorizeUrl 的原始响应对象。字段名按当前实现保持为 respone。" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.putI18nCollect", "title": "index.putI18nCollect 接口", "description": "index.putI18nCollect 接口", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "keys", "type": "array", "required": false, "description": "keys 参数" }, { "name": "locale", "type": "string", "required": false, "description": "locale 参数" }, { "name": "project", "type": "string", "required": false, "description": "project 参数" }, { "name": "source", "type": "string", "required": false, "description": "source 参数" } ], "response": [] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.recognizeLicensePlate", "title": "识别车牌号码(通过 base64 图片)", "description": "识别车牌号码(通过 base64 图片)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "base64", "type": "string", "required": true, "description": "base64 图片,支持 data URL 前缀(data:image/...;base64,)或纯 base64 字符串" }, { "name": "imageBase64", "type": "string", "required": false, "description": "兼容字段(同 base64)" }, { "name": "image_base64", "type": "string", "required": false, "description": "兼容字段(同 base64)" } ], "response": [ { "name": "licensePlate", "type": "string", "required": false, "description": "识别到的车牌号(对外契约,仅返回该字段)" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.ReferenceFile", "title": "index.ReferenceFile 接口", "description": "index.ReferenceFile 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.searchSpace", "title": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)", "description": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "keyword", "type": "string", "required": false, "description": "搜索关键字,对 space_code 和 custom_barcode 做模糊匹配(%keyword%);为空时返回当前仓库下前 50 条" } ], "response": [ { "name": "flag", "type": "string", "required": false, "description": "全局调用结果标识,成功时为 success" }, { "name": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功" }, { "name": "message", "type": "string", "required": false, "description": "返回信息" }, { "name": "data", "type": "array", "required": false, "description": "库位数组(最多 50 条),每项包含以下字段" }, { "name": "total", "type": "number", "required": false, "description": "本次返回的记录条数(等于 data.length,≤50)" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.test", "title": "后台专用的拼多多开放平台测试接口,用于传入请求参数并发起真实请求,返回签名后的请求体和接口响应", "description": "后台专用的拼多多开放平台测试接口,用于传入请求参数并发起真实请求,返回签名后的请求体和接口响应", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "type", "type": "string", "required": true, "description": "拼多多接口名,例如 pdd.order.number.list.get" }, { "name": "bizParams", "type": "object", "required": false, "description": "业务参数对象,会参与签名和请求" }, { "name": "request", "type": "object", "required": false, "description": "bizParams 兼容字段" }, { "name": "accessToken", "type": "string", "required": false, "description": "用户授权令牌" }, { "name": "access_token", "type": "string", "required": false, "description": "accessToken 的下划线命名兼容字段" }, { "name": "dataType", "type": "string", "required": false, "description": "返回格式,默认 JSON" }, { "name": "version", "type": "string", "required": false, "description": "API 版本" }, { "name": "timestamp", "type": "string|number", "required": false, "description": "时间戳,不传则使用当前秒级时间戳" }, { "name": "clientId", "type": "string", "required": false, "description": "覆盖配置中的 client_id" }, { "name": "clientSecret", "type": "string", "required": false, "description": "覆盖配置中的 client_secret" }, { "name": "baseUrl", "type": "string", "required": false, "description": "请求地址,默认拼多多开放平台网关" }, { "name": "headers", "type": "object", "required": false, "description": "额外请求头" }, { "name": "timeout", "type": "number", "required": false, "description": "请求超时时间(毫秒)" } ], "response": [ { "name": "requestBody", "type": "object", "required": false, "description": "实际发送到 PDD 网关的请求体,已包含 sign" }, { "name": "response", "type": "any", "required": false, "description": "拼多多接口返回内容" }, { "name": "baseUrl", "type": "string", "required": false, "description": "实际请求地址" } ] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.tryAutoTranslateNewKeys", "title": "index.tryAutoTranslateNewKeys 接口", "description": "index.tryAutoTranslateNewKeys 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "基础模块", "moduleKey": "index", "moduleFolder": "index", "method": "index.uploadSuccessNotify", "title": "index.uploadSuccessNotify 接口", "description": "index.uploadSuccessNotify 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "订单归档模块", "moduleKey": "order.archiveOrder", "moduleFolder": "order.archiveorder", "method": "order.archiveOrder.detail", "title": "查询单个订单详情,返回订单头、商品明细和运单信息", "description": "查询单个订单详情,返回订单头、商品明细和运单信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / id / order_id / orderId", "type": "array|string|number", "required": true, "description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项" }, { "name": "tableType / tablePosition / type / moduleName", "type": "string", "required": false, "description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等" } ], "response": [ { "name": "order", "type": "object", "required": false, "description": "订单头对象(raw 行数据)" }, { "name": "detail", "type": "object", "required": false, "description": "等同于 order" }, { "name": "orderItems / items", "type": "array", "required": false, "description": "商品明细数组" }, { "name": "expresses", "type": "array", "required": false, "description": "运单信息数组" }, { "name": "waybill_codes", "type": "array", "required": false, "description": "去重后的运单号字符串数组" } ] }, { "moduleName": "订单归档模块", "moduleKey": "order.archiveOrder", "moduleFolder": "order.archiveorder", "method": "order.archiveOrder.list", "title": "归档订单列表,使用 history 模型。", "description": "归档订单列表,使用 history 模型。", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "订单列表(raw 行数据)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }, { "name": "recheck_status", "type": "string", "required": false, "description": "复核状态:none=未复核,fin=已复核" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.badgeCount", "title": "订单工作台各标签页角标计数,基于当前仓库上下文返回。配送、配送异常与归档标签固定返回 99+。", "description": "订单工作台各标签页角标计数,基于当前仓库上下文返回。配送、配送异常与归档标签固定返回 99+。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [ { "name": "reviewOrder", "type": "number|string", "required": true, "description": "待审核角标" }, { "name": "pendingOrder", "type": "number|string", "required": true, "description": "待处理角标" }, { "name": "outboundOrder", "type": "number|string", "required": true, "description": "待出库角标" }, { "name": "expectionOrder", "type": "number|string", "required": true, "description": "待处理异常角标" }, { "name": "entrustOrder", "type": "number|string", "required": true, "description": "委托外仓角标" }, { "name": "deliveryOrder", "type": "string", "required": true, "description": "配送角标,固定返回 99+" }, { "name": "deliveryExpectionOrder", "type": "string", "required": true, "description": "配送异常角标,固定返回 99+" }, { "name": "archiveOrder", "type": "string", "required": true, "description": "归档角标,固定返回 99+" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.bindExpressPackageMaterial", "title": "按订单ID+运单号匹配 wms_order_express,按包材编码匹配包材,并将 package_material_id 与 package_material_name_snapshot 绑定到订单运单记录。", "description": "按订单ID+运单号匹配 wms_order_express,按包材编码匹配包材,并将 package_material_id 与 package_material_name_snapshot 绑定到订单运单记录。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_id", "type": "number|string", "required": true, "description": "订单ID,必填。" }, { "name": "waybill_code", "type": "string", "required": true, "description": "运单号,必填。" }, { "name": "package_material_code", "type": "string", "required": true, "description": "包材编码,必填。" } ], "response": [ { "name": "order_id", "type": "number", "required": true, "description": "订单ID(成功时返回于 data 对象中)。" }, { "name": "waybill_code", "type": "string", "required": true, "description": "运单号(成功时返回于 data 对象中)。" }, { "name": "package_material_id", "type": "number", "required": true, "description": "绑定后的包材ID(成功时返回于 data 对象中)。" }, { "name": "package_material_name_snapshot", "type": "string", "required": true, "description": "绑定时写入的包材名称快照(成功时返回于 data 对象中)。" }, { "name": "package_material_code", "type": "string", "required": true, "description": "绑定成功的包材编码(成功时返回于 data 对象中)。" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.bindExpressPackageMaterialByWaybill", "title": "按运单号绑定包材。仅需传入运单号与包材编码,系统自动根据运单号反查对应订单运单记录并绑定包材,无需传入订单ID。", "description": "按运单号绑定包材。仅需传入运单号与包材编码,系统自动根据运单号反查对应订单运单记录并绑定包材,无需传入订单ID。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "waybill_code", "type": "string", "required": true, "description": "运单号,必填。" }, { "name": "package_material_code", "type": "string", "required": true, "description": "包材编码,必填。" } ], "response": [ { "name": "order_id", "type": "number", "required": true, "description": "运单号对应的订单ID(成功时返回于 data 对象中)。" }, { "name": "waybill_code", "type": "string", "required": true, "description": "运单号(成功时返回于 data 对象中)。" }, { "name": "package_material_id", "type": "number", "required": true, "description": "绑定后的包材ID(成功时返回于 data 对象中)。" }, { "name": "package_material_name_snapshot", "type": "string", "required": true, "description": "绑定时写入的包材名称快照(成功时返回于 data 对象中)。" }, { "name": "package_material_code", "type": "string", "required": true, "description": "绑定成功的包材编码(成功时返回于 data 对象中)。" } ] }, { "moduleName": "订单配送异常模块", "moduleKey": "order.deliveryExpectionOrder", "moduleFolder": "order.deliveryexpectionorder", "method": "order.deliveryExpectionOrder.detail", "title": "查询单个订单详情,返回订单头、商品明细和运单信息", "description": "查询单个订单详情,返回订单头、商品明细和运单信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / id / order_id / orderId", "type": "array|string|number", "required": true, "description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项" }, { "name": "tableType / tablePosition / type / moduleName", "type": "string", "required": false, "description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等" } ], "response": [ { "name": "order", "type": "object", "required": false, "description": "订单头对象(raw 行数据)" }, { "name": "detail", "type": "object", "required": false, "description": "等同于 order" }, { "name": "orderItems / items", "type": "array", "required": false, "description": "商品明细数组" }, { "name": "expresses", "type": "array", "required": false, "description": "运单信息数组" }, { "name": "waybill_codes", "type": "array", "required": false, "description": "去重后的运单号字符串数组" } ] }, { "moduleName": "订单配送异常模块", "moduleKey": "order.deliveryExpectionOrder", "moduleFolder": "order.deliveryexpectionorder", "method": "order.deliveryExpectionOrder.list", "title": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。", "description": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }, { "name": "recheck_status", "type": "string", "required": false, "description": "复核状态:none=未复核,fin=已复核" } ] }, { "moduleName": "订单配送模块", "moduleKey": "order.deliveryOrder", "moduleFolder": "order.deliveryorder", "method": "order.deliveryOrder.detail", "title": "查询单个订单详情,返回订单头、商品明细和运单信息", "description": "查询单个订单详情,返回订单头、商品明细和运单信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / id / order_id / orderId", "type": "array|string|number", "required": true, "description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项" }, { "name": "tableType / tablePosition / type / moduleName", "type": "string", "required": false, "description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等" } ], "response": [ { "name": "order", "type": "object", "required": true, "description": "订单头对象(raw 行数据)" }, { "name": "detail", "type": "object", "required": true, "description": "等同于 order" }, { "name": "orderItems / items", "type": "array", "required": true, "description": "商品明细数组" }, { "name": "expresses", "type": "array", "required": true, "description": "运单信息数组,每个元素包含以下字段:waybill_code(运单号,string)、weighing_weight(称重重量,number|null)、sys_logistics_code(系统物流公司编码,string)、sys_logistics_name(系统物流公司名称,string)、logistics_code(实际物流公司编码,string)、logistics_name(实际物流公司名称,string)、logistics_interface_id(物流接口ID,number|null)、business_key(业务标识,string)、created_at(创建时间戳毫秒,number|null)、package_material_id(包材ID,number|null)、package_material_name_snapshot(包材名称快照,string|null)" }, { "name": "waybill_codes", "type": "array", "required": true, "description": "去重后的运单号字符串数组" } ] }, { "moduleName": "订单配送模块", "moduleKey": "order.deliveryOrder", "moduleFolder": "order.deliveryorder", "method": "order.deliveryOrder.list", "title": "配送订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m4。", "description": "配送订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m4。", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }, { "name": "recheck_status", "type": "string", "required": false, "description": "复核状态:none=未复核,fin=已复核" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.detail", "title": "查询单个订单详情,返回订单头、商品明细和运单信息", "description": "查询单个订单详情,返回订单头、商品明细和运单信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / id / order_id / orderId", "type": "array|string|number", "required": true, "description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项" }, { "name": "tableType / tablePosition / type / moduleName", "type": "string", "required": false, "description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等" } ], "response": [ { "name": "order", "type": "object", "required": true, "description": "订单头对象(raw 行数据)" }, { "name": "detail", "type": "object", "required": true, "description": "等同于 order" }, { "name": "orderItems / items", "type": "array", "required": true, "description": "商品明细数组" }, { "name": "expresses", "type": "array", "required": true, "description": "运单信息数组,每个元素包含以下字段:waybill_code(运单号,string)、weighing_weight(称重重量,number|null)、sys_logistics_code(系统物流公司编码,string)、sys_logistics_name(系统物流公司名称,string)、logistics_code(实际物流公司编码,string)、logistics_name(实际物流公司名称,string)、logistics_interface_id(物流接口ID,number|null)、business_key(业务标识,string)、created_at(创建时间戳毫秒,number|null)、package_material_id(包材ID,number|null)、package_material_name_snapshot(包材名称快照,string|null)" }, { "name": "waybill_codes", "type": "array", "required": true, "description": "去重后的运单号字符串数组" } ] }, { "moduleName": "订单委托外仓模块", "moduleKey": "order.entrustOrder", "moduleFolder": "order.entrustorder", "method": "order.entrustOrder.detail", "title": "查询单个订单详情,返回订单头、商品明细和运单信息", "description": "查询单个订单详情,返回订单头、商品明细和运单信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / id / order_id / orderId", "type": "array|string|number", "required": true, "description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项" }, { "name": "tableType / tablePosition / type / moduleName", "type": "string", "required": false, "description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等" } ], "response": [ { "name": "order", "type": "object", "required": false, "description": "订单头对象(raw 行数据)" }, { "name": "detail", "type": "object", "required": false, "description": "等同于 order" }, { "name": "orderItems / items", "type": "array", "required": false, "description": "商品明细数组" }, { "name": "expresses", "type": "array", "required": false, "description": "运单信息数组" }, { "name": "waybill_codes", "type": "array", "required": false, "description": "去重后的运单号字符串数组" } ] }, { "moduleName": "订单委托外仓模块", "moduleKey": "order.entrustOrder", "moduleFolder": "order.entrustorder", "method": "order.entrustOrder.list", "title": "委托外仓订单列表,使用 outsourced 模型。", "description": "委托外仓订单列表,使用 outsourced 模型。", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }, { "name": "recheck_status", "type": "string", "required": false, "description": "复核状态:none=未复核,fin=已复核" } ] }, { "moduleName": "订单异常模块", "moduleKey": "order.expectionOrder", "moduleFolder": "order.expectionorder", "method": "order.expectionOrder.detail", "title": "查询单个订单详情,返回订单头、商品明细和运单信息", "description": "查询单个订单详情,返回订单头、商品明细和运单信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / id / order_id / orderId", "type": "array|string|number", "required": true, "description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项" }, { "name": "tableType / tablePosition / type / moduleName", "type": "string", "required": false, "description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等" } ], "response": [ { "name": "order", "type": "object", "required": false, "description": "订单头对象(raw 行数据)" }, { "name": "detail", "type": "object", "required": false, "description": "等同于 order" }, { "name": "orderItems / items", "type": "array", "required": false, "description": "商品明细数组" }, { "name": "expresses", "type": "array", "required": false, "description": "运单信息数组" }, { "name": "waybill_codes", "type": "array", "required": false, "description": "去重后的运单号字符串数组" } ] }, { "moduleName": "订单异常模块", "moduleKey": "order.expectionOrder", "moduleFolder": "order.expectionorder", "method": "order.expectionOrder.list", "title": "待处理异常订单列表,默认仅查询 step=3 的订单。", "description": "待处理异常订单列表,默认仅查询 step=3 的订单。", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }, { "name": "recheck_status", "type": "string", "required": false, "description": "复核状态:none=未复核,fin=已复核" } ] }, { "moduleName": "订单异常模块", "moduleKey": "order.expectionOrder", "moduleFolder": "order.expectionorder", "method": "order.expectionOrder.resolveException", "title": "将待处理异常订单转回正常待处理状态(step 3 → 2)。只操作当前仓库的当前订单表,且仅对 step=3 的订单生效。", "description": "将待处理异常订单转回正常待处理状态(step 3 → 2)。只操作当前仓库的当前订单表,且仅对 step=3 的订单生效。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids", "type": "number[]", "required": true, "description": "订单ID 正整数数组,不能为空" } ], "response": [ { "name": "updated_count", "type": "number", "required": true, "description": "实际更新行数" }, { "name": "ids", "type": "number[]", "required": true, "description": "本次操作的订单ID 列表" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.export", "title": "提交订单导出任务(异步)。入参支持 table_type/tableType 与 module/module_name;where 与 sort 语义与 order.list 一致。提交后立即返回 task_id,后台异步执行,导出进度/下载请通过 order.exportTaskProgress 查询。", "description": "提交订单导出任务(异步)。入参支持 table_type/tableType 与 module/module_name;where 与 sort 语义与 order.list 一致。提交后立即返回 task_id,后台异步执行,导出进度/下载请通过 order.exportTaskProgress 查询。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "table_type / tableType", "type": "string", "required": false, "description": "导出表类型,枚举:current/history/dispatch/outsourced;兼容订单模块别名(order/reviewOrder/pendingOrder 等);支持 table_type 与 tableType 两种写法" }, { "name": "module / module_name", "type": "string", "required": false, "description": "订单模块名,兼容 module(驼峰)与 module_name(下划线)两种写法" }, { "name": "where", "type": "object", "required": false, "description": "查询条件,语义与 order.list 的 where 一致(推荐使用 { operator, value, type } 标准结构);禁止传入 warehouse_id/warehouseId" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,语义与 order.list 的 sort 一致" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID(后端生成)" }, { "name": "status", "type": "string", "required": true, "description": "任务状态,枚举:submitted/running/success/failed/not_found" }, { "name": "progress", "type": "number", "required": true, "description": "当前进度百分比(0-100)" }, { "name": "current_count", "type": "number", "required": true, "description": "当前已处理记录数" }, { "name": "total_count", "type": "number", "required": true, "description": "总记录数(若有)" }, { "name": "message", "type": "string", "required": true, "description": "任务提示信息" }, { "name": "result", "type": "object", "required": true, "description": "任务执行结果(可选,可能包含文件 url/fileKey 等)" }, { "name": "error", "type": "string", "required": true, "description": "失败时的错误信息(可选)" }, { "name": "update_time", "type": "string", "required": true, "description": "任务更新时间(Unix ms 或 ISO 字符串)" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.exportTaskProgress", "title": "按 task_id 查询订单导出任务进度,返回 task_id、status、progress、current_count、total_count、message、error、download_url、update_time;上传完成后 download_url 返回下载链接;未找到时 status=not_found。", "description": "按 task_id 查询订单导出任务进度,返回 task_id、status、progress、current_count、total_count、message、error、download_url、update_time;上传完成后 download_url 返回下载链接;未找到时 status=not_found。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务 ID,兼容 taskId" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID" }, { "name": "status", "type": "string", "required": true, "description": "任务状态:submitted/running/success/failed/not_found" }, { "name": "progress", "type": "number", "required": true, "description": "进度百分比(0-100)" }, { "name": "current_count", "type": "number", "required": true, "description": "当前已处理记录数" }, { "name": "total_count", "type": "number", "required": true, "description": "总记录数" }, { "name": "message", "type": "string", "required": true, "description": "额外提示信息" }, { "name": "error", "type": "string", "required": true, "description": "失败信息(可选)" }, { "name": "download_url", "type": "string", "required": true, "description": "任务完成后下载链接(若有)" }, { "name": "update_time", "type": "string", "required": true, "description": "最近一次状态更新时间(Unix ms 或 ISO 字符串)" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.list", "title": "订单工作台总列表入口,查询当前登录用户仓库上下文下的订单总列表,支持 pagination / where / sort。", "description": "订单工作台总列表入口,查询当前登录用户仓库上下文下的订单总列表,支持 pagination / where / sort。", "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 } 标准结构,历史简写会自动标准化;禁止传入 warehouse_id / warehouseId。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" }, { "name": "recheck_status", "type": "string", "required": false, "description": "复核状态:none=未复核,fin=已复核" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.manualOutboundOrder", "title": "手动触发出库迁移,将当前仓库内已出库订单同步到配送表。请求体直接透传给 orderDeliveryMigration.syncOutboundOrdersToDelivery。", "description": "手动触发出库迁移,将当前仓库内已出库订单同步到配送表。请求体直接透传给 orderDeliveryMigration.syncOutboundOrdersToDelivery。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouseId", "type": "number", "required": false, "description": "单仓库ID,兼容 warehouse_id" }, { "name": "warehouseIds", "type": "array", "required": false, "description": "仓库ID 数组" }, { "name": "queryTimeoutMs", "type": "number", "required": false, "description": "查询超时时间(毫秒)" }, { "name": "executionTimeoutMs", "type": "number", "required": false, "description": "执行超时时间(毫秒)" } ], "response": [ { "name": "warehouseIds", "type": "array", "required": true, "description": "参与迁移的仓库ID列表" }, { "name": "batchSize", "type": "number", "required": true, "description": "单批处理上限,当前固定为 1000" }, { "name": "outboundStatuses", "type": "array", "required": true, "description": "本次迁移匹配的出库状态" }, { "name": "totalSelected", "type": "number", "required": true, "description": "命中的源订单数量" }, { "name": "totalCreated", "type": "number", "required": true, "description": "实际创建到配送表的订单数量" }, { "name": "totalSkipped", "type": "number", "required": true, "description": "本次跳过的源订单数量" }, { "name": "totalTimeout", "type": "number", "required": true, "description": "被标记为出库超时的订单数量" }, { "name": "results", "type": "array", "required": true, "description": "按仓库维度返回的批次结果数组,元素包含 selectedCount、createdCount、skippedCount、timeoutCount、retryableFailure 等字段" } ] }, { "moduleName": "订单待出库模块", "moduleKey": "order.outboundOrder", "moduleFolder": "order.outboundorder", "method": "order.outboundOrder.detail", "title": "查询单个订单详情,返回订单头、商品明细和运单信息", "description": "查询单个订单详情,返回订单头、商品明细和运单信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / id / order_id / orderId", "type": "array|string|number", "required": true, "description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项" }, { "name": "tableType / tablePosition / type / moduleName", "type": "string", "required": false, "description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等" } ], "response": [ { "name": "order", "type": "object", "required": false, "description": "订单头对象(raw 行数据)" }, { "name": "detail", "type": "object", "required": false, "description": "等同于 order" }, { "name": "orderItems / items", "type": "array", "required": false, "description": "商品明细数组" }, { "name": "expresses", "type": "array", "required": false, "description": "运单信息数组" }, { "name": "waybill_codes", "type": "array", "required": false, "description": "去重后的运单号字符串数组" } ] }, { "moduleName": "订单待出库模块", "moduleKey": "order.outboundOrder", "moduleFolder": "order.outboundorder", "method": "order.outboundOrder.list", "title": "待出库订单列表,默认筛选 outbound_status in [none,padding] 且 step in [1,2]。", "description": "待出库订单列表,默认筛选 outbound_status in [none,padding] 且 step in [1,2]。", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }, { "name": "recheck_status", "type": "string", "required": false, "description": "复核状态:none=未复核,fin=已复核" } ] }, { "moduleName": "订单待出库模块", "moduleKey": "order.outboundOrder", "moduleFolder": "order.outboundorder", "method": "order.outboundOrder.manualOutboundOrder", "title": "待出库模块的手动出库入口,行为与 order.manualOutboundOrder 一致。", "description": "待出库模块的手动出库入口,行为与 order.manualOutboundOrder 一致。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouseId", "type": "number", "required": false, "description": "单仓库ID,兼容 warehouse_id" }, { "name": "warehouseIds", "type": "array", "required": false, "description": "仓库ID 数组" }, { "name": "queryTimeoutMs", "type": "number", "required": false, "description": "查询超时时间(毫秒)" }, { "name": "executionTimeoutMs", "type": "number", "required": false, "description": "执行超时时间(毫秒)" } ], "response": [ { "name": "warehouseIds", "type": "array", "required": true, "description": "参与迁移的仓库ID列表" }, { "name": "batchSize", "type": "number", "required": true, "description": "单批处理上限,当前固定为 1000" }, { "name": "outboundStatuses", "type": "array", "required": true, "description": "本次迁移匹配的出库状态" }, { "name": "totalSelected", "type": "number", "required": true, "description": "命中的源订单数量" }, { "name": "totalCreated", "type": "number", "required": true, "description": "实际创建到配送表的订单数量" }, { "name": "totalSkipped", "type": "number", "required": true, "description": "本次跳过的源订单数量" }, { "name": "totalTimeout", "type": "number", "required": true, "description": "被标记为出库超时的订单数量" }, { "name": "results", "type": "array", "required": true, "description": "按仓库维度返回的批次结果数组,元素包含 selectedCount、createdCount、skippedCount、timeoutCount、retryableFailure 等字段" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.allocateExpressCode", "title": "批量分配待处理订单的快递号,接收订单对象数组,复用 express.createWaybillCodePipeline。", "description": "批量分配待处理订单的快递号,接收订单对象数组,复用 express.createWaybillCodePipeline。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "orders", "type": "array", "required": true, "description": "订单对象数组;每个对象应为待处理订单列表或详情中获取的原始订单对象。每个订单对象必须包含 order_id 与 business_key;sys_platform_code 与 logistics_code 为订单对象自带字段,前端无需额外拼装或从外部构造,直接原样回传订单对象即可。其余字段会原样透传给运单创建链路。business_key 说明:business_key 是运单创建的序号键数组(例如:新分配 1 个运单号时传 [1];订单拆单时可能传 [2,3]),该字段会在 createWaybillCodePipeline 的返回 data 中原样返回,便于前端关联订单与运单创建结果。" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "全局调用结果标识,成功时为 success" }, { "name": "code", "type": "number", "required": true, "description": "业务状态码,200 表示成功" }, { "name": "message", "type": "string", "required": false, "description": "返回信息" }, { "name": "data", "type": "object", "required": false, "description": "createWaybillCodePipeline 返回的运单创建结果,包含 success/failed 列表与 summary 等字段" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.allocateStorage", "title": "按订单批量分配储位(迁移自 order.storageAllocation.allocateStorage)。这是一个异步提交接口:调用后接口立即返回受理信息(包含 request_id),后端异步执行实际的储位分配与锁定操作;仓库上下文由当前登录用户提供(ctx.user.store_id)。接口不会在同步响应中返回分配明细(如 requested_order_ids、allocated_order_ids 等),客户端可通过请求 ID 或事件/查询链路获取最终结果。", "description": "按订单批量分配储位(迁移自 order.storageAllocation.allocateStorage)。这是一个异步提交接口:调用后接口立即返回受理信息(包含 request_id),后端异步执行实际的储位分配与锁定操作;仓库上下文由当前登录用户提供(ctx.user.store_id)。接口不会在同步响应中返回分配明细(如 requested_order_ids、allocated_order_ids 等),客户端可通过请求 ID 或事件/查询链路获取最终结果。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "allow_storage_location / allowStorageLocation / is_allow_storage / isAllowStorage", "type": "boolean", "required": false, "description": "是否允许使用存储储位,支持多种字段别名。" }, { "name": "order_ids / orderIds / ids / order_id / orderId / id", "type": "array|string|number", "required": true, "description": "订单 ID 列表,支持数组、逗号分隔字符串或单个 ID(兼容多种别名)。" } ], "response": [ { "name": "request_id", "type": "string", "required": true, "description": "请求 ID(后端生成的唯一标识),用于查询任务状态或结果" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "生效的仓库 ID(来自当前用户 store_id)" }, { "name": "message", "type": "string", "required": true, "description": "受理提示信息,通常为 '请求已受理,后端异步处理中' 或错误说明" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.allocateStorageProgress", "title": "按 request_id 查询储位分配异步任务状态/结果(由 allocateStorage 提交)", "description": "按 request_id 查询储位分配异步任务状态/结果(由 allocateStorage 提交)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "request_id / requestId", "type": "string", "required": true, "description": "任务请求 ID,兼容字段 requestId" } ], "response": [ { "name": "request_id", "type": "string", "required": true, "description": "请求 ID(后端生成的唯一标识)" }, { "name": "status", "type": "string", "required": true, "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" }, { "name": "result", "type": "object", "required": false, "description": "成功时返回底层分配结果,结构视实现而定" }, { "name": "error", "type": "string", "required": false, "description": "失败时返回的错误信息" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "关联仓库 ID(若任务关联仓库时返回)" }, { "name": "update_time", "type": "string", "required": false, "description": "最近一次状态更新时间,ISO8601 字符串" }, { "name": "message", "type": "string", "required": false, "description": "额外提示信息" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.batchIntercept", "title": "批量提交订单拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'requested' 并写入操作日志(ORDER_INTERCEPT_REQUEST)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", "description": "批量提交订单拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'requested' 并写入操作日志(ORDER_INTERCEPT_REQUEST)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids / orderIds / ids", "type": "number[]", "required": true, "description": "订单ID数组;优先级 order_ids > orderIds > ids" }, { "name": "task_id / taskId", "type": "string", "required": false, "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务ID,格式 recheck_intercept_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "仓库ID(取自当前上下文)" }, { "name": "message", "type": "string", "required": true, "description": "任务提交状态说明:'批量拦截任务已提交。' 或 '批量拦截任务已存在,请勿重复提交。'" }, { "name": "accepted_at", "type": "string", "required": true, "description": "任务受理时间(ISO 字符串)" }, { "name": "status", "type": "string", "required": false, "description": "提交状态(固定为 'success')" }, { "name": "state", "type": "string", "required": false, "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.batchInterceptTaskProgress", "title": "查询批量拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", "description": "查询批量拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务ID" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务ID" }, { "name": "state", "type": "string", "required": true, "description": "任务状态:submitted / running / success / failed / not_found" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "仓库ID(not_found 时不返回)" }, { "name": "submitted_at", "type": "number|null", "required": false, "description": "任务提交时间戳(毫秒)" }, { "name": "start_time", "type": "number|null", "required": false, "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" }, { "name": "end_time", "type": "number|null", "required": false, "description": "任务结束时间戳(毫秒,success/failed 时返回)" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" }, { "name": "total_order_count", "type": "number", "required": false, "description": "总订单数(submitted/running/success/failed 时返回)" }, { "name": "processed_order_count", "type": "number", "required": false, "description": "已处理订单数(仅 submitted/running 时返回)" }, { "name": "intercepted_order_count", "type": "number", "required": false, "description": "已拦截订单数(submitted/running/success/failed 时返回)" }, { "name": "intercepted_order_ids", "type": "number[]", "required": false, "description": "已拦截订单ID列表(仅 success 时返回)" }, { "name": "duration_ms", "type": "number", "required": false, "description": "任务耗时(毫秒,success/failed 时返回)" }, { "name": "error_message", "type": "string", "required": false, "description": "错误信息(仅 failed 时返回)" }, { "name": "error_code", "type": "string", "required": false, "description": "错误码(仅 failed 时返回,默认 'BATCH_INTERCEPT_FAILED')" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.batchLock", "title": "批量提交订单锁定请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'warehouse' 并写入操作日志(ORDER_LOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", "description": "批量提交订单锁定请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'warehouse' 并写入操作日志(ORDER_LOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids / orderIds / ids", "type": "number[]", "required": true, "description": "订单ID数组;优先级 order_ids > orderIds > ids" }, { "name": "task_id / taskId", "type": "string", "required": false, "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务ID,格式 order_lock_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "仓库ID(取自当前上下文)" }, { "name": "message", "type": "string", "required": true, "description": "任务提交状态说明:'批量锁定任务已提交。' 或 '批量锁定任务已存在,请勿重复提交。'" }, { "name": "accepted_at", "type": "string", "required": true, "description": "任务受理时间(ISO 字符串)" }, { "name": "status", "type": "string", "required": false, "description": "提交状态(固定为 'success')" }, { "name": "state", "type": "string", "required": false, "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.batchLockTaskProgress", "title": "查询批量锁定任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已锁定订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", "description": "查询批量锁定任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已锁定订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务ID" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务ID" }, { "name": "state", "type": "string", "required": true, "description": "任务状态:submitted / running / success / failed / not_found" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "仓库ID(not_found 时不返回)" }, { "name": "submitted_at", "type": "number|null", "required": false, "description": "任务提交时间戳(毫秒)" }, { "name": "start_time", "type": "number|null", "required": false, "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" }, { "name": "end_time", "type": "number|null", "required": false, "description": "任务结束时间戳(毫秒,success/failed 时返回)" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" }, { "name": "total_order_count", "type": "number", "required": false, "description": "总订单数(submitted/running/success/failed 时返回)" }, { "name": "processed_order_count", "type": "number", "required": false, "description": "已处理订单数(仅 submitted/running 时返回)" }, { "name": "locked_order_count", "type": "number", "required": false, "description": "已锁定订单数(submitted/running/success/failed 时返回)" }, { "name": "locked_order_ids", "type": "number[]", "required": false, "description": "已锁定订单ID列表(仅 success 时返回)" }, { "name": "duration_ms", "type": "number", "required": false, "description": "任务耗时(毫秒,success/failed 时返回)" }, { "name": "error_message", "type": "string", "required": false, "description": "错误信息(仅 failed 时返回)" }, { "name": "error_code", "type": "string", "required": false, "description": "错误码(仅 failed 时返回,默认 'BATCH_LOCK_FAILED')" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.batchUnintercept", "title": "批量提交解除拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'none' 并写入操作日志(ORDER_INTERCEPT_CANCEL)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", "description": "批量提交解除拦截请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 intercept_status 更新为 'none' 并写入操作日志(ORDER_INTERCEPT_CANCEL)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids / orderIds / ids", "type": "number[]", "required": true, "description": "订单ID数组;优先级 order_ids > orderIds > ids" }, { "name": "task_id / taskId", "type": "string", "required": false, "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务ID,格式 order_unintercept_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "仓库ID(取自当前上下文)" }, { "name": "message", "type": "string", "required": true, "description": "任务提交状态说明:'批量解除拦截任务已提交。' 或 '批量解除拦截任务已存在,请勿重复提交。'" }, { "name": "accepted_at", "type": "string", "required": true, "description": "任务受理时间(ISO 字符串)" }, { "name": "status", "type": "string", "required": false, "description": "提交状态(固定为 'success')" }, { "name": "state", "type": "string", "required": false, "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.batchUninterceptTaskProgress", "title": "查询批量解除拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解除拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", "description": "查询批量解除拦截任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解除拦截订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务ID" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务ID" }, { "name": "state", "type": "string", "required": true, "description": "任务状态:submitted / running / success / failed / not_found" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "仓库ID(not_found 时不返回)" }, { "name": "submitted_at", "type": "number|null", "required": false, "description": "任务提交时间戳(毫秒)" }, { "name": "start_time", "type": "number|null", "required": false, "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" }, { "name": "end_time", "type": "number|null", "required": false, "description": "任务结束时间戳(毫秒,success/failed 时返回)" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" }, { "name": "total_order_count", "type": "number", "required": false, "description": "总订单数(submitted/running/success/failed 时返回)" }, { "name": "processed_order_count", "type": "number", "required": false, "description": "已处理订单数(仅 submitted/running 时返回)" }, { "name": "unintercepted_order_count", "type": "number", "required": false, "description": "已解除拦截订单数(submitted/running/success/failed 时返回)" }, { "name": "unintercepted_order_ids", "type": "number[]", "required": false, "description": "已解除拦截订单ID列表(仅 success 时返回)" }, { "name": "duration_ms", "type": "number", "required": false, "description": "任务耗时(毫秒,success/failed 时返回)" }, { "name": "error_message", "type": "string", "required": false, "description": "错误信息(仅 failed 时返回)" }, { "name": "error_code", "type": "string", "required": false, "description": "错误码(仅 failed 时返回,默认 'BATCH_UNINTERCEPT_FAILED')" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.batchUnlock", "title": "批量提交订单解锁请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'none' 并写入操作日志(ORDER_UNLOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", "description": "批量提交订单解锁请求(异步任务模式)。接收订单ID数组,提交后立即返回 task_id 和受理信息,后端异步将每个订单的 lock_status 更新为 'none' 并写入操作日志(ORDER_UNLOCK)。相同 task_id 幂等提交会返回已存在任务的信息。仓库ID统一使用当前上下文(ctx.user.store_id)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids / orderIds / ids", "type": "number[]", "required": true, "description": "订单ID数组;优先级 order_ids > orderIds > ids" }, { "name": "task_id / taskId", "type": "string", "required": false, "description": "外部指定任务ID(用于幂等提交,不传则自动生成)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务ID,格式 order_unlock_{warehouseId}_{timestamp}_{rand}(幂等提交时返回已有任务的 task_id)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "仓库ID(取自当前上下文)" }, { "name": "message", "type": "string", "required": true, "description": "任务提交状态说明:'批量解锁任务已提交。' 或 '批量解锁任务已存在,请勿重复提交。'" }, { "name": "accepted_at", "type": "string", "required": true, "description": "任务受理时间(ISO 字符串)" }, { "name": "status", "type": "string", "required": false, "description": "提交状态(固定为 'success')" }, { "name": "state", "type": "string", "required": false, "description": "幂等提交时返回已有任务的状态:submitted / running / success / failed" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.batchUnlockTaskProgress", "title": "查询批量解锁任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解锁订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", "description": "查询批量解锁任务进度。根据 task_id 返回任务的当前状态、进度百分比、已处理/已解锁订单数等信息。任务状态 state 包含 submitted(已提交)、running(执行中)、success(已完成)、failed(失败)、not_found(未找到)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务ID" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务ID" }, { "name": "state", "type": "string", "required": true, "description": "任务状态:submitted / running / success / failed / not_found" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "仓库ID(not_found 时不返回)" }, { "name": "submitted_at", "type": "number|null", "required": false, "description": "任务提交时间戳(毫秒)" }, { "name": "start_time", "type": "number|null", "required": false, "description": "任务开始执行时间戳(毫秒,running/success/failed 时返回)" }, { "name": "end_time", "type": "number|null", "required": false, "description": "任务结束时间戳(毫秒,success/failed 时返回)" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比 0-100(submitted/running/success/failed 时返回)" }, { "name": "total_order_count", "type": "number", "required": false, "description": "总订单数(submitted/running/success/failed 时返回)" }, { "name": "processed_order_count", "type": "number", "required": false, "description": "已处理订单数(仅 submitted/running 时返回)" }, { "name": "unlocked_order_count", "type": "number", "required": false, "description": "已解锁订单数(submitted/running/success/failed 时返回)" }, { "name": "unlocked_order_ids", "type": "number[]", "required": false, "description": "已解锁订单ID列表(仅 success 时返回)" }, { "name": "duration_ms", "type": "number", "required": false, "description": "任务耗时(毫秒,success/failed 时返回)" }, { "name": "error_message", "type": "string", "required": false, "description": "错误信息(仅 failed 时返回)" }, { "name": "error_code", "type": "string", "required": false, "description": "错误码(仅 failed 时返回,默认 'BATCH_UNLOCK_FAILED')" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.cancelAllocateStorage", "title": "待处理模块的取消分配储位入口,直接对接 system service 的 cancelAllocateStorage。仅接受订单ID(order_ids)作为入参,不接受 allow_storage_location 或 warehouse_id/warehouseId;仓库上下文来自当前登录用户的 store_id。", "description": "待处理模块的取消分配储位入口,直接对接 system service 的 cancelAllocateStorage。仅接受订单ID(order_ids)作为入参,不接受 allow_storage_location 或 warehouse_id/warehouseId;仓库上下文来自当前登录用户的 store_id。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids / orderIds / ids / order_id / orderId / id", "type": "array|string|number", "required": true, "description": "订单 ID 列表;支持数组、逗号字符串或单个 ID(兼容多种别名)。" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "全局调用结果标识,成功为 success" }, { "name": "code", "type": "number", "required": true, "description": "业务状态码,200 表示成功" }, { "name": "message", "type": "string", "required": true, "description": "返回信息,成功或部分成功时给出摘要" }, { "name": "data", "type": "object", "required": false, "description": "取消分配汇总结果,包含下列字段" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.cancelOrder", "title": "将待处理订单批量取消,仅允许当前状态可取消的订单。", "description": "将待处理订单批量取消,仅允许当前状态可取消的订单。", "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、order_id 或逗号字符串" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "首条更新记录 ID" }, { "name": "status", "type": "string", "required": true, "description": "新的订单状态" }, { "name": "step", "type": "number", "required": true, "description": "新的流程步骤" }, { "name": "updated_at", "type": "string", "required": true, "description": "更新时间" }, { "name": "updated_count", "type": "number", "required": true, "description": "受影响行数" }, { "name": "ids", "type": "array", "required": true, "description": "实际更新的订单 ID 列表" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.cloneOrder", "title": "克隆待处理订单。完整流程:1. 查找原订单,校验可取消状态(step 0/1/2/3);2. 若原订单已分配储位(storage_status='fin'),先清除已分配库存;3. 取消原订单(step→9, status→cancel),记录克隆日志;4. 以原订单业务数据创建新订单,所有流程状态字段重置为初始落库状态;5. 克隆订单明细(含 stock_id),重置 order_id 为新订单 ID;6. 对新订单记录克隆创建日志。", "description": "克隆待处理订单。完整流程:1. 查找原订单,校验可取消状态(step 0/1/2/3);2. 若原订单已分配储位(storage_status='fin'),先清除已分配库存;3. 取消原订单(step→9, status→cancel),记录克隆日志;4. 以原订单业务数据创建新订单,所有流程状态字段重置为初始落库状态;5. 克隆订单明细(含 stock_id),重置 order_id 为新订单 ID;6. 对新订单记录克隆创建日志。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_id", "type": "number", "required": true, "description": "原订单ID,正整数" } ], "response": [ { "name": "source_order_id", "type": "number", "required": true, "description": "原订单ID(已取消)" }, { "name": "new_order_id", "type": "number", "required": true, "description": "新订单ID(克隆生成)" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.createOrder", "title": "手动创建待处理订单。根据货主策略(need_order_approval)决定初始步骤:need_order_approval=1 进待审核(step=0),need_order_approval=0 直接进待处理(step=1)。", "description": "手动创建待处理订单。根据货主策略(need_order_approval)决定初始步骤:need_order_approval=1 进待审核(step=0),need_order_approval=0 直接进待处理(step=1)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "store_id", "type": "number", "required": true, "description": "货主ID(正整数)" }, { "name": "name", "type": "string", "required": true, "description": "收件人姓名" }, { "name": "mobile", "type": "string", "required": false, "description": "收件人手机号,mobile 与 tel 至少填一项" }, { "name": "tel", "type": "string", "required": false, "description": "收件人电话,mobile 与 tel 至少填一项" }, { "name": "detail_address", "type": "string", "required": true, "description": "详细地址" }, { "name": "province", "type": "string", "required": true, "description": "省份(必填,空值返回 400)" }, { "name": "city", "type": "string", "required": true, "description": "城市(必填,空值返回 400)" }, { "name": "area", "type": "string", "required": true, "description": "区/县(必填,空值返回 400)" }, { "name": "town", "type": "string", "required": false, "description": "镇/街道" }, { "name": "zip_code", "type": "string", "required": false, "description": "邮编" }, { "name": "items", "type": "array", "required": true, "description": "订单明细数组,每项含 item_id(商品主键,必填,正整数)和 plan_qty(计划数量,正整数);item_name(优先外部传入,其次从 StockStore 缓存获取,最后兜底'商品')、order_line_no、actual_price 为可选" }, { "name": "delivery_order_code", "type": "string", "required": false, "description": "订单号,不填则自动生成(SYS + 时间戳 + 随机4位)" }, { "name": "logistics_code", "type": "string", "required": false, "description": "快递编码,不填则读货主默认快递策略(policy_config.default_express_code)" }, { "name": "logistics_name", "type": "string", "required": false, "description": "快递名称" }, { "name": "sys_platform_code", "type": "string", "required": false, "description": "系统平台编码,不填则读货主默认平台策略(policy_config.default_platform_code)" }, { "name": "source_platform_code", "type": "string", "required": false, "description": "来源平台编码" }, { "name": "source_order_codes", "type": "string", "required": false, "description": "来源订单号" }, { "name": "shop_nick", "type": "string", "required": false, "description": "店铺名称(自定义),最大长度 200" }, { "name": "order_type", "type": "string", "required": false, "description": "订单类型" }, { "name": "is_urgency", "type": "string", "required": false, "description": "是否紧急:Y/N,默认 N" }, { "name": "invoice_flag", "type": "string", "required": false, "description": "是否需要发票:Y/N,默认 N" } ], "response": [ { "name": "order_id", "type": "number", "required": true, "description": "新创建的订单 ID" }, { "name": "delivery_order_code", "type": "string", "required": true, "description": "订单号(传入值或自动生成值)" }, { "name": "step", "type": "number", "required": true, "description": "初始步骤:0=待审核,1=待处理" }, { "name": "step_label", "type": "string", "required": true, "description": "步骤说明:待审核 / 待处理" }, { "name": "items_count", "type": "number", "required": true, "description": "商品种类数" }, { "name": "items_total", "type": "number", "required": true, "description": "商品总件数" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.detail", "title": "查询单个订单详情,返回订单头、商品明细和运单信息", "description": "查询单个订单详情,返回订单头、商品明细和运单信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / id / order_id / orderId", "type": "array|string|number", "required": true, "description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项" }, { "name": "tableType / tablePosition / type / moduleName", "type": "string", "required": false, "description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等" } ], "response": [ { "name": "order", "type": "object", "required": false, "description": "订单头对象(raw 行数据)" }, { "name": "detail", "type": "object", "required": false, "description": "等同于 order" }, { "name": "orderItems / items", "type": "array", "required": false, "description": "商品明细数组" }, { "name": "expresses", "type": "array", "required": false, "description": "运单信息数组" }, { "name": "waybill_codes", "type": "array", "required": false, "description": "去重后的运单号字符串数组" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order", "moduleFolder": "order", "method": "order.pendingOrder.downloadCreateTemplate", "title": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为 .xlsx 附件下载。表头中标注 * 的列为必填项(橙色背景),可选列为灰色背景,包含示例数据行和填写说明工作表。多行相同订单号的行组成一个完整订单,每行代表一条商品明细。模板共 25 列(A-Y):店铺名称(shop_nick)位于第2列B列,紧接*订单号(delivery_order_code)之后;其余必填列为*收件人姓名(name)、*手机号(mobile)、*详细地址(detail_address)、*商品编码(item_code)、*计划数量(plan_qty);非必填列依次为货主ID(store_id)、电话(tel)、省份(province)、城市(city)、区/县(area)、镇/街道(town)、邮编(zip_code)、快递编码(logistics_code)、快递名称(logistics_name)、系统平台编码(sys_platform_code)、来源平台编码(source_platform_code)、来源订单号(source_order_codes)、订单类型(order_type)、是否紧急(is_urgency)、是否需要发票(invoice_flag)、商品名称(item_name)、行号(order_line_no)、实际价格(actual_price)。", "description": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为 .xlsx 附件下载。表头中标注 * 的列为必填项(橙色背景),可选列为灰色背景,包含示例数据行和填写说明工作表。多行相同订单号的行组成一个完整订单,每行代表一条商品明细。模板共 25 列(A-Y):店铺名称(shop_nick)位于第2列B列,紧接*订单号(delivery_order_code)之后;其余必填列为*收件人姓名(name)、*手机号(mobile)、*详细地址(detail_address)、*商品编码(item_code)、*计划数量(plan_qty);非必填列依次为货主ID(store_id)、电话(tel)、省份(province)、城市(city)、区/县(area)、镇/街道(town)、邮编(zip_code)、快递编码(logistics_code)、快递名称(logistics_name)、系统平台编码(sys_platform_code)、来源平台编码(source_platform_code)、来源订单号(source_order_codes)、订单类型(order_type)、是否紧急(is_urgency)、是否需要发票(invoice_flag)、商品名称(item_name)、行号(order_line_no)、实际价格(actual_price)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [ { "name": "base64", "type": "string", "required": true, "description": "base64 编码的 xlsx 文件内容" }, { "name": "filename", "type": "string", "required": true, "description": "建议保存的文件名,固定为 创建订单导入模板.xlsx" }, { "name": "mime", "type": "string", "required": true, "description": "文件 MIME 类型,固定为 application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.importOrdersFromExcel", "title": "通过 Excel 文件批量创建订单。接受 base64 编码的 xlsx 内容,按订单号分组,每组创建一个订单(step 由货主策略决定)。每行代表一条商品明细;同一订单号的多行组成一个完整订单,头信息取每组第一行。(已作废)", "description": "通过 Excel 文件批量创建订单。接受 base64 编码的 xlsx 内容,按订单号分组,每组创建一个订单(step 由货主策略决定)。每行代表一条商品明细;同一订单号的多行组成一个完整订单,头信息取每组第一行。(已作废)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "file_base64", "type": "string", "required": true, "description": "base64 编码的 .xlsx 文件内容" } ], "response": [ { "name": "total", "type": "number", "required": true, "description": "解析到的订单总数" }, { "name": "success_count", "type": "number", "required": true, "description": "创建成功的订单数" }, { "name": "fail_count", "type": "number", "required": true, "description": "创建失败的订单数" }, { "name": "success_orders", "type": "array", "required": true, "description": "成功订单列表,每项含 delivery_order_code、order_id、step、step_label" }, { "name": "fail_orders", "type": "array", "required": true, "description": "失败订单列表,每项含 delivery_order_code、error(失败原因)" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.list", "title": "待处理订单列表,默认筛选 outbound_status != padding 且 step in [1,2]。", "description": "待处理订单列表,默认筛选 outbound_status != padding 且 step in [1,2]。", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }, { "name": "recheck_status", "type": "string", "required": false, "description": "复核状态:none=未复核,fin=已复核" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order", "moduleFolder": "order", "method": "order.pendingOrder.manualWaybill", "title": "手工录入运单号。为指定待处理订单创建一条运单记录(wms_order_express 表),仅允许 step 在 [1,2,3] 且 outbound_status 不为 'padding' 的订单操作。完成后自动更新订单表的 print_status 与 post_status 为 'fin',表示外部已打印。", "description": "手工录入运单号。为指定待处理订单创建一条运单记录(wms_order_express 表),仅允许 step 在 [1,2,3] 且 outbound_status 不为 'padding' 的订单操作。完成后自动更新订单表的 print_status 与 post_status 为 'fin',表示外部已打印。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_id", "type": "number", "required": true, "description": "订单 ID,必须为正整数" }, { "name": "waybill_code", "type": "string", "required": true, "description": "运单号,非空字符串" }, { "name": "logistics_interface_name", "type": "string", "required": false, "description": "物流接口名称(选填),手工填入的值,trim 后为空则传 null" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "创建的运单记录 ID" }, { "name": "order_id", "type": "number", "required": true, "description": "订单 ID" }, { "name": "waybill_code", "type": "string", "required": true, "description": "运单号" }, { "name": "business_key", "type": "number", "required": true, "description": "递增的业务键,同一订单下从 1 开始递增" }, { "name": "logistics_interface_name", "type": "string", "required": false, "description": "写入的物流接口名称,未传时为 null" }, { "name": "create_at", "type": "string", "required": true, "description": "创建时间" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.markPendingOutboundOrder", "title": "将待处理订单批量标记为待出库。", "description": "将待处理订单批量标记为待出库。", "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、order_id 或逗号字符串" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "首条更新记录 ID" }, { "name": "outbound_status", "type": "string", "required": true, "description": "新的出库状态" }, { "name": "updated_at", "type": "string", "required": true, "description": "更新时间" }, { "name": "updated_count", "type": "number", "required": true, "description": "受影响行数" }, { "name": "ids", "type": "array", "required": true, "description": "实际更新的订单 ID 列表" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.parseAddress", "title": "智能地址解析:使用 AI 将非结构化地址字符串解析为省/市/区/详细地址/收件人/手机号", "description": "智能地址解析:使用 AI 将非结构化地址字符串解析为省/市/区/详细地址/收件人/手机号", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "address", "type": "string", "required": true, "description": "原始地址字符串(必填),如\"张三 13800138000 广东省广州市天河区体育西路100号\"" } ], "response": [ { "name": "code", "type": "number", "required": true, "description": "1=成功,0=失败" }, { "name": "message", "type": "string", "required": true, "description": "提示消息" }, { "name": "data", "type": "object", "required": false, "description": "解析成功时返回 province/city/area/detailAddress/name/mobile" }, { "name": "data.province", "type": "string", "required": false, "description": "省份,如 广东省" }, { "name": "data.city", "type": "string", "required": false, "description": "城市,如 广州市" }, { "name": "data.area", "type": "string", "required": false, "description": "区/县,如 天河区" }, { "name": "data.town", "type": "string", "required": false, "description": "乡镇/街道,如 员村街道" }, { "name": "data.detailAddress", "type": "string", "required": false, "description": "详细地址,如 体育西路100号" }, { "name": "data.name", "type": "string", "required": false, "description": "收件人姓名,如 张三" }, { "name": "data.mobile", "type": "string", "required": false, "description": "收件人手机号,如 13800138000" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.reverseReviewOrder", "title": "将待处理订单反审回待审核状态。", "description": "将待处理订单反审回待审核状态。", "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": false, "description": "订单 ID 列表;兼容 ids / id / order_id,建议传 ids" }, { "name": "id", "type": "number", "required": false, "description": "兼容单个订单 ID" }, { "name": "order_id", "type": "number", "required": false, "description": "兼容单个订单 ID" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "首条更新记录 ID" }, { "name": "inspection_status", "type": "string", "required": true, "description": "新的审核状态" }, { "name": "step", "type": "number", "required": true, "description": "新的流程步骤" }, { "name": "updated_at", "type": "string", "required": true, "description": "更新时间" }, { "name": "updated_count", "type": "number", "required": true, "description": "受影响行数" }, { "name": "ids", "type": "array", "required": true, "description": "实际更新的订单 ID 列表" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.syncOrderIds", "title": "同步待处理订单入口,支持批量传入 order_ids。服务端会按 create_channel 分组派发同步任务;若命中 SN 管理订单(is_sn_mgmt=Y),该订单会被拦截并标记失败,不允许走批量回传,需改用单订单回传。", "description": "同步待处理订单入口,支持批量传入 order_ids。服务端会按 create_channel 分组派发同步任务;若命中 SN 管理订单(is_sn_mgmt=Y),该订单会被拦截并标记失败,不允许走批量回传,需改用单订单回传。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids / orderIds / ids / order_id / orderId / id", "type": "array|string|number", "required": true, "description": "订单 ID 列表,支持数组、逗号分隔字符串或单个 ID。服务端会校验订单状态并执行批量同步拦截规则(含 SN 订单限制)。" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "全局调用结果标识,成功为 success" }, { "name": "code", "type": "number", "required": true, "description": "业务状态码,200 表示成功" }, { "name": "message", "type": "string", "required": true, "description": "返回信息,当前仅做受理提示" }, { "name": "data", "type": "object", "required": false, "description": "服务层返回值,当前仅透传 order_ids" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.updateAddress", "title": "批量修改待处理订单的收件地址信息和备注。地址字段修改仅允许 post_status='none'(未分配快递)的订单;remark 字段修改不受 post_status 限制可对所有订单生效。至少需要提供一个地址字段(name/mobile/tel/zip_code/province/city/area/town/detail_address)或 remark,空值和纯空白会被忽略。更新成功后写入操作日志。", "description": "批量修改待处理订单的收件地址信息和备注。地址字段修改仅允许 post_status='none'(未分配快递)的订单;remark 字段修改不受 post_status 限制可对所有订单生效。至少需要提供一个地址字段(name/mobile/tel/zip_code/province/city/area/town/detail_address)或 remark,空值和纯空白会被忽略。更新成功后写入操作日志。", "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": "number[]", "required": true, "description": "订单ID 正整数数组,不能为空" }, { "name": "name", "type": "string", "required": false, "description": "收件人姓名" }, { "name": "mobile", "type": "string", "required": false, "description": "收件人手机号" }, { "name": "tel", "type": "string", "required": false, "description": "收件人电话" }, { "name": "zip_code", "type": "string", "required": false, "description": "邮编" }, { "name": "province", "type": "string", "required": false, "description": "省份" }, { "name": "city", "type": "string", "required": false, "description": "城市" }, { "name": "area", "type": "string", "required": false, "description": "区/县" }, { "name": "town", "type": "string", "required": false, "description": "镇/街道" }, { "name": "detail_address", "type": "string", "required": false, "description": "详细地址" }, { "name": "remark", "type": "string", "required": false, "description": "订单留言/备注,最大500字符。非空时批量覆盖所选订单的 remark 字段,不受 post_status 限制。" } ], "response": [ { "name": "updated_count", "type": "number", "required": true, "description": "实际更新的订单行数(取地址更新行数与备注更新行数的最大值)。remark 字段的更新计数独立于地址字段。" }, { "name": "ids", "type": "number[]", "required": true, "description": "请求的订单ID数组(原样返回)" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.updateOrderExpress", "title": "批量修改待处理订单的快递信息。用 express_code 从当前仓库快递列表(带缓存)中查找对应项:若为自定义映射(is_system_setting=true),sys_logistics_code/name 写系统快递编码和名称,logistics_code/name 写自定义编码和名称;若为系统快递(is_system_setting=false),四个字段均写系统快递的 code/name;未找到则报错。只操作当前仓库的当前订单表,不处理其他订单表。", "description": "批量修改待处理订单的快递信息。用 express_code 从当前仓库快递列表(带缓存)中查找对应项:若为自定义映射(is_system_setting=true),sys_logistics_code/name 写系统快递编码和名称,logistics_code/name 写自定义编码和名称;若为系统快递(is_system_setting=false),四个字段均写系统快递的 code/name;未找到则报错。只操作当前仓库的当前订单表,不处理其他订单表。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids", "type": "number[]", "required": true, "description": "订单ID 正整数数组,不能为空" }, { "name": "express_code", "type": "string", "required": true, "description": "快递编码,可为系统编码或仓库自定义编码" } ], "response": [ { "name": "updated_count", "type": "number", "required": true, "description": "实际更新行数" }, { "name": "sys_logistics_code", "type": "string", "required": true, "description": "写入的系统快递编码" }, { "name": "sys_logistics_name", "type": "string", "required": true, "description": "写入的系统快递名称" }, { "name": "logistics_code", "type": "string", "required": true, "description": "写入的快递编码(自定义或系统)" }, { "name": "logistics_name", "type": "string", "required": true, "description": "写入的快递名称(自定义或系统)" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order.pendingOrder", "moduleFolder": "order.pendingorder", "method": "order.pendingOrder.updateOrderPlatform", "title": "批量修改待处理订单的平台信息。用 code 查找 wms_platform 表,若平台存在则将订单的 sys_platform_code 和 sys_platform_name 更新为该平台的 code/name;若平台不存在则返回错误。只操作当前仓库的当前订单表,不处理其他订单表。", "description": "批量修改待处理订单的平台信息。用 code 查找 wms_platform 表,若平台存在则将订单的 sys_platform_code 和 sys_platform_name 更新为该平台的 code/name;若平台不存在则返回错误。只操作当前仓库的当前订单表,不处理其他订单表。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids", "type": "number[]", "required": true, "description": "订单ID 正整数数组,不能为空" }, { "name": "code", "type": "string", "required": true, "description": "平台编码,对应 wms_platform.code" } ], "response": [ { "name": "updated_count", "type": "number", "required": true, "description": "实际更新行数" }, { "name": "sys_platform_code", "type": "string", "required": true, "description": "更新后的平台编码" }, { "name": "sys_platform_name", "type": "string", "required": true, "description": "更新后的平台名称" } ] }, { "moduleName": "打印模块", "moduleKey": "order.print", "moduleFolder": "order.print", "method": "order.print.getOrderPrintData", "title": "按订单ID拉取平台打印中间态数据,与 getWavePlatformPrintData 返回结构一致。不限制打印锁定状态,所有订单(包括已锁定)统一返回。仓库ID统一从当前上下文获取,无需调用方传入。自动过滤快递未完全分配的订单(post_status !== 'fin'),返回 waveGroups(波次 -> 平台 -> 订单)结构。", "description": "按订单ID拉取平台打印中间态数据,与 getWavePlatformPrintData 返回结构一致。不限制打印锁定状态,所有订单(包括已锁定)统一返回。仓库ID统一从当前上下文获取,无需调用方传入。自动过滤快递未完全分配的订单(post_status !== 'fin'),返回 waveGroups(波次 -> 平台 -> 订单)结构。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids", "type": "array", "required": true, "description": "订单ID列表(支持数字或字符串,内部自动去重与归一化,必须为非空数组)" } ], "response": [ { "name": "summary", "type": "object", "required": true, "description": "汇总信息" }, { "name": "wave_ids", "type": "array", "required": true, "description": "通过过滤的波次ID数组" }, { "name": "waveGroups", "type": "array", "required": true, "description": "主返回结构:按波次分组(波次 -> 平台 -> 订单)" }, { "name": "ext", "type": "object", "required": true, "description": "扩展字段" } ] }, { "moduleName": "打印模块", "moduleKey": "order.print", "moduleFolder": "order.print", "method": "order.print.getWavePlatformPrintData", "title": "按波次 IDs 获取平台打印中间态数据,自动过滤快递未完全分配的波次,返回 waveGroups(波次 -> 平台 -> 订单)结构", "description": "按波次 IDs 获取平台打印中间态数据,自动过滤快递未完全分配的波次,返回 waveGroups(波次 -> 平台 -> 订单)结构", "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", "type": "number", "required": true, "description": "仓库ID(必须与当前用户上下文 store_id 一致)" }, { "name": "wave_ids", "type": "array", "required": true, "description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)" } ], "response": [ { "name": "summary", "type": "object", "required": false, "description": "汇总信息" }, { "name": "wave_ids", "type": "array", "required": false, "description": "通过过滤的波次ID数组" }, { "name": "waveGroups", "type": "array", "required": false, "description": "主返回结构:按波次分组(波次 -> 平台 -> 订单)" }, { "name": "platform_groups", "type": "array", "required": false, "description": "兼容字段:按平台分组结果(保留以兼容旧客户端)" }, { "name": "order_list", "type": "array", "required": false, "description": "兼容字段:逐单平台打印中间态明细(保留以兼容旧客户端)" }, { "name": "ext", "type": "object", "required": false, "description": "扩展字段" } ] }, { "moduleName": "打印模块", "moduleKey": "order.print", "moduleFolder": "order.print", "method": "order.print.getWavePrintData", "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": "warehouse_id", "type": "number", "required": true, "description": "仓库ID" }, { "name": "wave_ids", "type": "array", "required": true, "description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)" } ], "response": [ { "name": "summary", "type": "object", "required": false, "description": "汇总信息" }, { "name": "wave_list", "type": "array", "required": false, "description": "波次列表(按 wave_no 排序)" }, { "name": "ext", "type": "object", "required": false, "description": "扩展字段" } ] }, { "moduleName": "打印模块", "moduleKey": "order.print", "moduleFolder": "order.print", "method": "order.print.unlockWavePlatformPrintDataByGroup", "title": "按分组解锁波次平台打印锁:按传入的 groups 条件匹配已锁定订单并将其 print_lock_status 置为 none,返回解锁统计与解锁订单列表。", "description": "按分组解锁波次平台打印锁:按传入的 groups 条件匹配已锁定订单并将其 print_lock_status 置为 none,返回解锁统计与解锁订单列表。", "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", "type": "number", "required": true, "description": "仓库ID(必须与当前用户上下文 store_id 一致)" }, { "name": "wave_ids", "type": "array", "required": true, "description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)" }, { "name": "group_type", "type": "string", "required": false, "description": "分组类型,支持 platform、platform_express、order;默认 platform_express" }, { "name": "unlock_scope", "type": "string", "required": false, "description": "解锁范围,支持 group、wave;默认 group" }, { "name": "groups", "type": "array", "required": true, "description": "分组条件列表。元素为对象,可包含字段:wave_id(必填)、platform(平台编码)、sys_logistics_code(系统快递编码)、order_ids(订单ID数组)" } ], "response": [ { "name": "summary", "type": "object", "required": true, "description": "解锁操作的汇总统计" }, { "name": "wave_ids", "type": "array", "required": true, "description": "通过过滤的波次ID数组" }, { "name": "unlocked_order_ids", "type": "array", "required": true, "description": "被解锁的订单ID数组" }, { "name": "unlocked_orders", "type": "array", "required": true, "description": "被解锁订单简要信息列表" }, { "name": "ext", "type": "object", "required": false, "description": "扩展字段" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.queryOrderLogList", "title": "按 order_id 查询订单操作日志,返回全量日志(不分页)。接口按当前登录用户的仓库上下文过滤(method 层从 ctx.user.store_id 获取 warehouse_id),以防跨仓越界。", "description": "按 order_id 查询订单操作日志,返回全量日志(不分页)。接口按当前登录用户的仓库上下文过滤(method 层从 ctx.user.store_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": "order_id / id / orderId", "type": "string|number", "required": true, "description": "订单ID;支持别名 id 与 orderId,接口会兼容解析。" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "日志列表(全量返回,无分页)。每项字段与 stock.warehouse.queryStockLogs 保持一致,典型字段包括 id、action、message、actor、created_at、warehouse_id 等。" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.queryOrderLogs", "title": "查询当前仓库下订单操作日志,底层复用通用日志查询分页结构,按订单ID筛选。", "description": "查询当前仓库下订单操作日志,底层复用通用日志查询分页结构,按订单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": "string", "required": true, "description": "订单ID" }, { "name": "page", "type": "number", "required": false, "description": "页码" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "日志列表,字段与 stock.warehouse.queryStockLogs 保持一致" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息,包含 page、pageSize、total、totalPages" } ] }, { "moduleName": "订单复核模块", "moduleKey": "order.recheckOrder", "moduleFolder": "order.recheckorder", "method": "order.recheckOrder.batchQuickRecheck", "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|string", "required": true, "description": "订单 ID 列表,支持数组或以逗号分隔的字符串" } ], "response": [ { "name": "success", "type": "array", "required": true, "description": "复核成功的订单列表" }, { "name": "failed", "type": "array", "required": true, "description": "复核失败的订单列表" }, { "name": "success_count", "type": "number", "required": true, "description": "成功数量" }, { "name": "failed_count", "type": "number", "required": true, "description": "失败数量" } ] }, { "moduleName": "订单复核模块", "moduleKey": "order.recheckOrder", "moduleFolder": "order.recheckorder", "method": "order.recheckOrder.confirmIntercept", "title": "确认拦截:通过订单ID直接匹配订单,将其拦截状态更新为 intercepted_at_warehouse(仓库已拦截)。仅拦截当前指定订单,不波及波次内其他订单。操作成功后写入操作日志(ORDER_INTERCEPT_CONFIRM),日志写入失败不影响主流程。", "description": "确认拦截:通过订单ID直接匹配订单,将其拦截状态更新为 intercepted_at_warehouse(仓库已拦截)。仅拦截当前指定订单,不波及波次内其他订单。操作成功后写入操作日志(ORDER_INTERCEPT_CONFIRM),日志写入失败不影响主流程。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_id", "type": "number", "required": true, "description": "订单 ID" } ], "response": [ { "name": "order_id", "type": "number", "required": true, "description": "订单 ID" }, { "name": "order_no", "type": "string", "required": true, "description": "订单号(优先 delivery_order_code,其次 pre_delivery_order_code)" }, { "name": "intercept_status", "type": "string", "required": true, "description": "拦截状态(固定为 'intercepted_at_warehouse')" }, { "name": "updated_at", "type": "string", "required": true, "description": "更新时间(ISO 字符串)" } ] }, { "moduleName": "订单复核模块", "moduleKey": "order.recheckOrder", "moduleFolder": "order.recheckorder", "method": "order.recheckOrder.confirmRecheck", "title": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)。确认复核后,若该订单所属波次拣货任务下所有订单均已复核完成,则自动解绑车任务:清空 wms_wave_pick_task 的车绑定信息(current_cart_id、current_cart_code_snapshot)、停用 wms_pick_task_cart_binding 绑定记录(is_active=0 并记录解绑人和时间)并释放 wms_pick_cart(清空 current_task_id、bind_user_id)。解绑失败仅记录 warn 日志,不影响复核主流程。", "description": "按订单 ID 确认复核并记录复核任务到 wms_recheck_task(入参兼容 id/orderId)。确认复核后,若该订单所属波次拣货任务下所有订单均已复核完成,则自动解绑车任务:清空 wms_wave_pick_task 的车绑定信息(current_cart_id、current_cart_code_snapshot)、停用 wms_pick_task_cart_binding 绑定记录(is_active=0 并记录解绑人和时间)并释放 wms_pick_cart(清空 current_task_id、bind_user_id)。解绑失败仅记录 warn 日志,不影响复核主流程。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_id / id / orderId", "type": "string|number", "required": true, "description": "订单 ID;优先使用 order_id,兼容别名 id 与 orderId" } ], "response": [ { "name": "order_id", "type": "number", "required": true, "description": "订单 ID" }, { "name": "waybill_no", "type": "string", "required": true, "description": "运单号" }, { "name": "recheck_status", "type": "string", "required": true, "description": "复核结果状态(固定为 'fin')" }, { "name": "recheck_time", "type": "string", "required": true, "description": "复核时间(ISO 字符串)" }, { "name": "review_no", "type": "string", "required": true, "description": "复核任务编号" } ] }, { "moduleName": "订单复核模块", "moduleKey": "order.recheckOrder", "moduleFolder": "order.recheckorder", "method": "order.recheckOrder.queryRecheckOrderSingleList", "title": "散单模式复核列表查询,按订单维度返回待复核订单(排除 pick_status='none' 和 recheck_status='fin'),支持分页与关键词/波次号/复核状态筛选。与 recheckOrderList 不同:本方法仅处理散单模式,不包含团购分支。", "description": "散单模式复核列表查询,按订单维度返回待复核订单(排除 pick_status='none' 和 recheck_status='fin'),支持分页与关键词/波次号/复核状态筛选。与 recheckOrderList 不同:本方法仅处理散单模式,不包含团购分支。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "where", "type": "object", "required": false, "description": "筛选条件。支持 keyword(运单号/订单号模糊搜索)、wave_no(精确匹配)、recheck_status、pick_status" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数,支持 page / pageSize(默认 page=1, pageSize=20)" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "散单复核订单列表,每项含 order_id、delivery_order_code、order_type、wave_id、wave_no、pick_status、recheck_status、shop_nick、logistics_name、items_count、items_total、items_weight、weight_type、status、create_at、pick_time、recheck_time" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息,含 page、pageSize、total、totalPages、hasPrevious、hasNext" } ] }, { "moduleName": "订单复核模块", "moduleKey": "order.recheckOrder", "moduleFolder": "order.recheckorder", "method": "order.recheckOrder.recheckOrderList", "title": "复核订单列表查询,通过入参 list_type 区分散单模式与团购模式。散单模式(single,默认)返回待复核订单列表(每项为一个订单,排除 pick_status='none' 和 recheck_status='fin'),团购模式(group)返回波次维度的复核汇总列表(每项为一个波次及其订单复核统计,含 review_assignment_status 计算字段)。统一使用 list 字段名输出,均支持分页与筛选。", "description": "复核订单列表查询,通过入参 list_type 区分散单模式与团购模式。散单模式(single,默认)返回待复核订单列表(每项为一个订单,排除 pick_status='none' 和 recheck_status='fin'),团购模式(group)返回波次维度的复核汇总列表(每项为一个波次及其订单复核统计,含 review_assignment_status 计算字段)。统一使用 list 字段名输出,均支持分页与筛选。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "list_type", "type": "string", "required": false, "description": "列表模式:single(散单模式,默认)/ group(团购模式)" }, { "name": "where", "type": "object", "required": false, "description": "筛选条件。散单模式支持 keyword(运单号/订单号模糊搜索)、wave_no(精确匹配)、recheck_status、pick_status;团购模式支持 wave_no(模糊搜索)、wave_type、wave_status" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数,支持 page / pageSize(默认 page=1, pageSize=20)" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "散单模式(list_type=single):订单数组,每项含 order_id、delivery_order_code、order_type、wave_id、wave_no、pick_status、recheck_status、shop_nick、logistics_name、items_count、items_total、status、create_at、pick_time、recheck_time。团购模式(list_type=group):波次汇总数组,每项含 wave_id、wave_no、wave_type、wave_status、total_orders、processed_orders、creator、create_time、update_time、order_count、reviewed_count、unreviewed_count、review_assignment_status(unreviewed/partially_reviewed/reviewed)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息,含 page、pageSize、total、totalPages、hasPrevious、hasNext" } ] }, { "moduleName": "订单复核模块", "moduleKey": "order.recheckOrder", "moduleFolder": "order.recheckorder", "method": "order.recheckOrder.scanOrder", "title": "扫描关键词并返回以波次为单位的复核视图。支持运单号、波次号、车号三种匹配模式。运单号/波次号命中(散单)返回扁平化订单列表 list_type='single',车号命中(团单)返回嵌套波次结构 list_type='group'。运单号命中但订单无波次信息时,退回单订单详情模式(list 每项含 detail/items/expresses/logs)。", "description": "扫描关键词并返回以波次为单位的复核视图。支持运单号、波次号、车号三种匹配模式。运单号/波次号命中(散单)返回扁平化订单列表 list_type='single',车号命中(团单)返回嵌套波次结构 list_type='group'。运单号命中但订单无波次信息时,退回单订单详情模式(list 每项含 detail/items/expresses/logs)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "keyword / value / waybill_no / waybillCode / waybill_code / wave_no / waveNo / cart_code / cartCode", "type": "string", "required": true, "description": "扫描关键词;匹配优先级:运单号 → 波次号 → 车号。支持别名 waybillCode/waybill_code(运单号)、waveNo(波次号)、cartCode(车号)" } ], "response": [ { "name": "match_type", "type": "string", "required": true, "description": "命中类型:waybill(运单号命中)/ wave(波次号命中)/ cart(车号命中)" }, { "name": "list_type", "type": "string", "required": true, "description": "列表模式:single(散单扁平列表)/ group(团购嵌套波次列表)" }, { "name": "waybill_no", "type": "string", "required": false, "description": "仅 waybill 命中时返回,匹配到的运单号" }, { "name": "task_id", "type": "number|null", "required": false, "description": "散单有波次信息时返回(来自拣货任务表 wms_wave_pick_task.id),团单车号命中时返回 cartMatchContext 中的任务 ID" }, { "name": "picker_id", "type": "number|null", "required": false, "description": "仅散单模式(有波次信息时)返回,拣货人ID(来自 wms_wave_pick_task.pick_user_id)" }, { "name": "picker_name", "type": "string", "required": false, "description": "仅散单模式(有波次信息时)返回,拣货人名称(来自 wms_wave_pick_task.pick_user_name)" }, { "name": "wave_id", "type": "number", "required": false, "description": "仅散单模式(有波次信息时)返回,波次ID" }, { "name": "wave_no", "type": "string", "required": false, "description": "仅散单模式(有波次信息时)返回,波次号" }, { "name": "wave_type", "type": "number", "required": false, "description": "仅散单模式(有波次信息时)返回,波次类型编码(来自 wms_wave_batch.wave_type)" }, { "name": "pick_mode", "type": "number", "required": false, "description": "拣货模式:1-团购小波次 2-散单单品单件 3-散单先拣后分 4-边拣边分 5-团购大波次。散单模式在顶层返回,团购模式在每个波次视图项内返回" }, { "name": "strategy_id", "type": "number|null", "required": false, "description": "仅散单模式返回,波次策略ID" }, { "name": "strategy_name", "type": "string", "required": false, "description": "仅散单模式返回,波次策略名称" }, { "name": "total_orders", "type": "number", "required": false, "description": "仅散单模式返回,波次内订单总数" }, { "name": "reviewed_count", "type": "number", "required": false, "description": "仅散单模式返回,已复核订单数" }, { "name": "unreviewed_count", "type": "number", "required": false, "description": "仅散单模式返回,未复核订单数" }, { "name": "list", "type": "array", "required": true, "description": "统一列表输出。散单模式(list_type=single)有波次信息时:扁平订单数组;无波次信息时退回单订单详情模式(每项含 detail、items、expresses、logs)。团购模式(list_type=group):波次视图数组(每项含 wave_id、wave_no、wave_type、wave_status、total_orders、processed_orders、creator、create_time、update_time、order_count、pick_mode、box_no、order_ids、orders_detail、stocks[])" } ] }, { "moduleName": "订单复核模块", "moduleKey": "order.recheckOrder", "moduleFolder": "order.recheckorder", "method": "order.recheckOrder.scanTask", "title": "按拣货任务 ID 拉取复核扫描视图。根据任务的 pick_mode 区分散单/团单模式,返回与 scanOrder 一致的数据结构,用于前端刷新数据。散单模式(pick_mode 2/3/4)扁平化任务下所有波次的订单列表(按 order_id 去重,未复核优先、wave_index 升序),顶层携带拣货人/任务等汇总信息(包括 picker_id、picker_name、pick_mode、total_orders、reviewed_count、unreviewed_count);团购模式(pick_mode 1/5)返回任务下所有团购波次及订单的分组列表(list_type='group')。", "description": "按拣货任务 ID 拉取复核扫描视图。根据任务的 pick_mode 区分散单/团单模式,返回与 scanOrder 一致的数据结构,用于前端刷新数据。散单模式(pick_mode 2/3/4)扁平化任务下所有波次的订单列表(按 order_id 去重,未复核优先、wave_index 升序),顶层携带拣货人/任务等汇总信息(包括 picker_id、picker_name、pick_mode、total_orders、reviewed_count、unreviewed_count);团购模式(pick_mode 1/5)返回任务下所有团购波次及订单的分组列表(list_type='group')。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id", "type": "number", "required": true, "description": "拣货任务 ID(对应 wms_wave_pick_task.id)" } ], "response": [ { "name": "match_type", "type": "string", "required": true, "description": "固定为 'task',表示通过任务 ID 匹配" }, { "name": "list_type", "type": "string", "required": true, "description": "列表模式:single(散单扁平列表)/ group(团购嵌套波次列表),由拣货任务的 pick_mode 决定" }, { "name": "task_id", "type": "number", "required": true, "description": "拣货任务 ID" }, { "name": "picker_id", "type": "number|null", "required": false, "description": "拣货人 ID(来自 wms_wave_pick_task.pick_user_id),散单模式返回" }, { "name": "picker_name", "type": "string", "required": false, "description": "拣货人名称(来自 wms_wave_pick_task.pick_user_name),散单模式返回" }, { "name": "pick_mode", "type": "number", "required": false, "description": "拣货模式:1-团购小波次 2-散单单品单件 3-散单先拣后分 4-边拣边分 5-团购大波次" }, { "name": "wave_id", "type": "number", "required": false, "description": "散单模式固定为 0,团购模式不返回" }, { "name": "wave_no", "type": "string", "required": false, "description": "散单模式固定为空字符串,团购模式不返回" }, { "name": "wave_type", "type": "number", "required": false, "description": "波次类型编码(取任务下第一个有效波次的 wave_type),散单模式返回" }, { "name": "strategy_id", "type": "number|null", "required": false, "description": "散单模式固定为 null(任务级别不绑定单一策略)" }, { "name": "strategy_name", "type": "string", "required": false, "description": "散单模式固定为空字符串(任务级别不绑定单一策略)" }, { "name": "total_orders", "type": "number", "required": false, "description": "任务下订单总数(去重后),散单模式返回" }, { "name": "reviewed_count", "type": "number", "required": false, "description": "已复核订单数,散单模式返回" }, { "name": "unreviewed_count", "type": "number", "required": false, "description": "未复核订单数,散单模式返回" }, { "name": "list", "type": "array", "required": true, "description": "统一列表输出。散单模式(list_type=single):扁平订单数组(每项结构与 scanOrder 散单有波次模式一致,含 order_id/delivery_order_code/waybill_no/pick_status/is_printed/is_reviewed/shop_nick/items_count/wave_index/recheck_status/order_type/status/logistics_name/store_remark/intercept_status/stock[])。团购模式(list_type=group):波次视图数组(结构与 scanOrder 团购模式一致,每项含 wave_id/wave_no/wave_type/wave_status/total_orders/processed_orders/creator/create_time/update_time/order_count/pick_mode/box_no/orders[])" } ] }, { "moduleName": "订单待审核模块", "moduleKey": "order.reviewOrder", "moduleFolder": "order.revieworder", "method": "order.reviewOrder.detail", "title": "查询单个订单详情,返回订单头、商品明细和运单信息", "description": "查询单个订单详情,返回订单头、商品明细和运单信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / id / order_id / orderId", "type": "array|string|number", "required": true, "description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项" }, { "name": "tableType / tablePosition / type / moduleName", "type": "string", "required": false, "description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等" } ], "response": [ { "name": "order", "type": "object", "required": false, "description": "订单头对象(raw 行数据)" }, { "name": "detail", "type": "object", "required": false, "description": "等同于 order" }, { "name": "orderItems / items", "type": "array", "required": false, "description": "商品明细数组" }, { "name": "expresses", "type": "array", "required": false, "description": "运单信息数组" }, { "name": "waybill_codes", "type": "array", "required": false, "description": "去重后的运单号字符串数组" } ] }, { "moduleName": "订单待审核模块", "moduleKey": "order.reviewOrder", "moduleFolder": "order.revieworder", "method": "order.reviewOrder.list", "title": "待审核订单列表,默认仅查询 step=0 的订单。", "description": "待审核订单列表,默认仅查询 step=0 的订单。", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "订单列表(raw 行数据,字段字典见 docs/order-workbench-list-api.md 中的“订单列表 raw 字段字典”章节)" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" }, { "name": "recheck_status", "type": "string", "required": false, "description": "复核状态:none=未复核,fin=已复核" } ] }, { "moduleName": "订单待审核模块", "moduleKey": "order.reviewOrder", "moduleFolder": "order.revieworder", "method": "order.reviewOrder.reviewOrder", "title": "批量审核通过订单并进入待处理。", "description": "批量审核通过订单并进入待处理。", "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 数组;仅允许 ids 字段,建议传数组,也兼容逗号字符串或单值" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "首条更新记录 ID" }, { "name": "inspection_status", "type": "string", "required": true, "description": "新的审核状态" }, { "name": "step", "type": "number", "required": true, "description": "新的流程步骤" }, { "name": "updated_at", "type": "string", "required": true, "description": "更新时间" }, { "name": "updated_count", "type": "number", "required": true, "description": "受影响行数" }, { "name": "ids", "type": "array", "required": true, "description": "实际更新的订单 ID 列表" } ] }, { "moduleName": "订单工作台入口模块", "moduleKey": "order.index", "moduleFolder": "order.index", "method": "order.updateExpressWeighingWeight", "title": "更新订单运单称重重量。支持两种模式:1) 订单模式(order_id>0):规则:订单仅一个运单时,直接写入该运单重量;多运单时,必须传 waybill_code 并按运单写入;团购波次批量设置同一重量到波次下所有订单运单,并返回拆单汇总信息(total_weight/split_count/splits/store_name/sys_logistics_name)。2) 运单号模式(order_id=0):从运单号反查订单与波次,散单/非团购波次仅更新单个运单重量,团购波次按 wave_no+business_key 批量设置并返回拆单汇总信息。", "description": "更新订单运单称重重量。支持两种模式:1) 订单模式(order_id>0):规则:订单仅一个运单时,直接写入该运单重量;多运单时,必须传 waybill_code 并按运单写入;团购波次批量设置同一重量到波次下所有订单运单,并返回拆单汇总信息(total_weight/split_count/splits/store_name/sys_logistics_name)。2) 运单号模式(order_id=0):从运单号反查订单与波次,散单/非团购波次仅更新单个运单重量,团购波次按 wave_no+business_key 批量设置并返回拆单汇总信息。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_id", "type": "number|string", "required": true, "description": "订单ID,必填且必须为数字。订单模式下为正整数,设为0时切换为运单号模式(需配合 waybill_code 使用)。" }, { "name": "waybill_code", "type": "string", "required": false, "description": "运单号。订单模式下:订单仅一个运单时可不传且会被忽略,多运单时必填并需匹配订单下运单。运单号模式(order_id=0)下必填。" }, { "name": "weighing_weight", "type": "number|string", "required": true, "description": "称重重量(kg),必填,必须大于 0,最多支持 3 位小数。" } ], "response": [ { "name": "order_id", "type": "number", "required": false, "description": "订单ID。订单模式及运单号散单模式返回。" }, { "name": "waybill_code", "type": "string", "required": false, "description": "写入重量的运单号。订单模式及运单号散单模式返回。" }, { "name": "weighing_weight", "type": "number", "required": true, "description": "已写入的称重重量(kg)。" }, { "name": "wave_no", "type": "string", "required": false, "description": "波次号。团购批量模式返回。" }, { "name": "business_key", "type": "string", "required": false, "description": "业务键。运单号团购批量模式返回。" }, { "name": "wave_id", "type": "number", "required": false, "description": "波次ID。团购批量模式返回。" }, { "name": "total_weight", "type": "number", "required": false, "description": "所有拆单重量累加(kg)。团购批量模式返回。" }, { "name": "split_count", "type": "number", "required": false, "description": "waybill_code 非空的 business_key 数量。团购批量模式返回。" }, { "name": "splits", "type": "array", "required": false, "description": "按 business_key 分组的拆单明细。每项含 business_key(业务键)、weighing_weight(该拆单累加重量)、waybill_code(代表运单号)。团购批量模式返回。" }, { "name": "store_name", "type": "string", "required": false, "description": "货主名称(订单 shop_nick)。团购批量模式返回。" }, { "name": "sys_logistics_name", "type": "string", "required": false, "description": "系统快递名称。团购批量模式返回。" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchAllocateExpress", "title": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。", "description": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "wave_ids / waveIds / ids", "type": "array|string|number", "required": true, "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" }, { "name": "task_id / taskId", "type": "string", "required": false, "description": "可选外部任务ID,用于幂等提交" } ], "response": [ { "name": "status", "type": "string", "required": true, "description": "提交状态,固定 success" }, { "name": "task_id", "type": "string", "required": true, "description": "任务 ID(用于查询任务进度)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "当前仓库ID" }, { "name": "accepted_at", "type": "string", "required": true, "description": "任务受理时间(ISO8601)" }, { "name": "message", "type": "string", "required": false, "description": "受理提示信息" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchAllocateExpressTaskProgress", "title": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", "description": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务 ID(后端生成或提交时传入)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID" }, { "name": "state", "type": "string", "required": true, "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "任务关联仓库ID" }, { "name": "total_wave_count", "type": "number", "required": false, "description": "波次数量" }, { "name": "total_order_count", "type": "number", "required": false, "description": "参与分配的订单数量" }, { "name": "processed_order_count", "type": "number", "required": false, "description": "已处理订单数量" }, { "name": "success_order_count", "type": "number", "required": false, "description": "成功提交分配的订单数量" }, { "name": "failed_order_count", "type": "number", "required": false, "description": "提交分配失败的订单数量" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比(0-100)" }, { "name": "duration_ms", "type": "number", "required": false, "description": "任务耗时(毫秒)" }, { "name": "error_message", "type": "string", "required": false, "description": "失败时的错误信息" }, { "name": "error_code", "type": "string", "required": false, "description": "失败时的错误码" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchAllocateStorage", "title": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。", "description": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "wave_ids / waveIds / ids", "type": "array|string|number", "required": true, "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" }, { "name": "task_id / taskId", "type": "string", "required": false, "description": "可选外部任务ID,用于幂等提交" } ], "response": [ { "name": "status", "type": "string", "required": true, "description": "提交状态,固定 success" }, { "name": "task_id", "type": "string", "required": true, "description": "任务 ID(用于查询任务进度)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "当前仓库ID" }, { "name": "accepted_at", "type": "string", "required": true, "description": "任务受理时间(ISO8601)" }, { "name": "message", "type": "string", "required": false, "description": "受理提示信息" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchAllocateStorageTaskProgress", "title": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", "description": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务 ID(后端生成或提交时传入)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID" }, { "name": "state", "type": "string", "required": true, "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "任务关联仓库ID" }, { "name": "total_wave_count", "type": "number", "required": false, "description": "波次数量" }, { "name": "total_order_count", "type": "number", "required": false, "description": "参与分配的订单数量" }, { "name": "processed_order_count", "type": "number", "required": false, "description": "已处理订单数量" }, { "name": "success_order_count", "type": "number", "required": false, "description": "成功提交分配的订单数量" }, { "name": "failed_order_count", "type": "number", "required": false, "description": "提交分配失败的订单数量" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比(0-100)" }, { "name": "duration_ms", "type": "number", "required": false, "description": "任务耗时(毫秒)" }, { "name": "error_message", "type": "string", "required": false, "description": "失败时的错误信息" }, { "name": "error_code", "type": "string", "required": false, "description": "失败时的错误码" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchAutoGrouping", "title": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。", "description": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件: - 跳过已打印及之后状态的波次(wave_status >= 2); - 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。", "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|string|number", "required": true, "description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID" } ], "response": [ { "name": "ids", "type": "array", "required": false, "description": "归一化后的请求ID" }, { "name": "affected_wave_ids", "type": "array", "required": false, "description": "实际命中的波次ID" }, { "name": "updated_wave_count", "type": "number", "required": false, "description": "实际更新数量" }, { "name": "skipped_wave_ids", "type": "array", "required": false, "description": "被跳过的波次ID数组(不修改状态)" }, { "name": "skipped_wave_count", "type": "number", "required": false, "description": "被跳过的波次数量" }, { "name": "skipped_details", "type": "array", "required": false, "description": "被跳过的波次明细數組,元素包含 wave_id 与 reason,reason 枚举 printed_or_after_printed / reach_max_wave_quantity" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchCancel", "title": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。", "description": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "wave_ids / waveIds / ids", "type": "array|string|number", "required": true, "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" }, { "name": "task_id / taskId", "type": "string", "required": false, "description": "可选外部任务ID,用于幂等提交" } ], "response": [ { "name": "status", "type": "string", "required": true, "description": "提交状态,固定 success" }, { "name": "task_id", "type": "string", "required": true, "description": "任务 ID(用于查询任务进度)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "当前仓库ID" }, { "name": "accepted_at", "type": "string", "required": true, "description": "任务受理时间(ISO8601)" }, { "name": "message", "type": "string", "required": false, "description": "受理提示信息" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchCancelTaskProgress", "title": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。", "description": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务 ID(后端生成或提交时传入)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID" }, { "name": "state", "type": "string", "required": true, "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比(0-100)" }, { "name": "processed_wave_count", "type": "number", "required": false, "description": "已处理的波次数量" }, { "name": "total_wave_count", "type": "number", "required": false, "description": "总波次数量" }, { "name": "duration_ms", "type": "number", "required": false, "description": "任务耗时(毫秒)" }, { "name": "error_message", "type": "string", "required": false, "description": "失败时的错误信息(仅在 state=failed 时返回)" }, { "name": "error_code", "type": "string", "required": false, "description": "失败时的错误码(仅在 state=failed 时返回)" }, { "name": "result", "type": "object", "required": false, "description": "成功时返回的汇总结果(仅在 state=success 时返回),例如 { \"processed_wave_count\": number, \"canceled_wave_count\": number }" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchFinishAutoGrouping", "title": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。", "description": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。", "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|string|number", "required": true, "description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID" } ], "response": [ { "name": "ids", "type": "array", "required": false, "description": "归一化后的请求ID" }, { "name": "affected_wave_ids", "type": "array", "required": false, "description": "实际命中的波次ID" }, { "name": "updated_wave_ids", "type": "array", "required": false, "description": "实际更新为已就绪的波次ID" }, { "name": "updated_wave_count", "type": "number", "required": false, "description": "实际更新数量" } ] }, { "moduleName": "订单待处理模块", "moduleKey": "order", "moduleFolder": "order", "method": "order.wave.batchList", "title": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。", "description": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。", "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" }, { "name": "only_todo", "type": "number|boolean|string", "required": false, "description": "是否仅返回待处理(仍有未复核订单)的波次,默认 0;传 1/true 时仅返回 unreviewed_order_count > 0 的波次。" }, { "name": "where", "type": "object", "required": false, "description": "筛选白名单字段(object,可选)。仅支持下列字段过滤,且禁止传入 warehouse_id / warehouseId: - wave_id(等值) - wave_no(模糊) - wave_type(等值) - wave_status(等值,接口固定叠加状态 0/1) - creator(模糊) - logistics_name(模糊) - item_part_type(等值) - item_part(模糊) - item_snapshot_key(模糊) - item_detail_machine(模糊) - distinguish_express(等值) - total_orders_min / total_orders_max(范围) - processed_orders_min / processed_orders_max(范围) - express_assignment_status(等值,string,可选,英文枚举,取值:unassigned、partially_assigned、assigned;语义:按快递分配聚合判断,assigned 表示聚合后全部 fin,partially_assigned 表示部分已分配且不含 error,unassigned 表示全 none 或包含 error(异常并入未分配集合))。 - print_assignment_status(等值,string,可选,英文枚举,取值:unprinted、partially_printed、printed;语义:按打印分配聚合判断,printed 表示聚合后全部已打印)。 - storage_assignment_status(等值,string,可选,取值:未分配、部分分配、已分配;默认不传不做限制)。过滤语义:已分配=聚合后全部 fin;部分分配=不含 error,且既不是全 none,也不是全 fin;未分配=全 none 或包含 error(异常并入未分配筛选集合)。说明:返回字段 storage_assignment_status 的展示值保持不变,包含 error 时仍可显示“分配异常”;此处 where 的过滤语义会把异常计入“未分配”,以避免把过滤语义与展示值混淆。 - source(可选,number)来源过滤:0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务;不传则不过滤。 说明:express_assignment_status 与 print_assignment_status 要求使用英文枚举值;storage_assignment_status 仍向后兼容中文展示值。若传入的枚举值不在允许集合内,接口会返回 400(参数校验失败),并在 message 中说明错误字段与允许取值。 - review_assignment_status(等值,string,可选,英文枚举:unreviewed、partially_reviewed、reviewed;分别表示未复核、部分复核、已复核)。" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "波次列表,包含波次基础信息与状态汇总(order_count / storage_assignment_status / express_assignment_status / print_assignment_status / review_assignment_status / unreviewed_order_count)。每条记录新增字段 source(number):来源标识,0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务。" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchRemoveExceptionOrders", "title": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。", "description": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "wave_ids / waveIds / ids", "type": "array|string|number", "required": true, "description": "波次ID列表;支持数组、逗号分隔字符串或单个ID" }, { "name": "task_id / taskId", "type": "string", "required": false, "description": "可选外部任务ID,用于幂等提交" } ], "response": [ { "name": "status", "type": "string", "required": true, "description": "提交状态,固定 success" }, { "name": "task_id", "type": "string", "required": true, "description": "任务 ID(用于查询任务进度)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "当前仓库ID" }, { "name": "accepted_at", "type": "string", "required": true, "description": "任务受理时间(ISO8601)" }, { "name": "message", "type": "string", "required": false, "description": "受理提示信息" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchRemoveExceptionOrdersTaskProgress", "title": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", "description": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务 ID(后端生成或提交时传入)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID" }, { "name": "state", "type": "string", "required": true, "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "任务关联仓库ID" }, { "name": "total_wave_count", "type": "number", "required": false, "description": "波次数量" }, { "name": "total_order_count", "type": "number", "required": false, "description": "参与处理的订单数量" }, { "name": "processed_order_count", "type": "number", "required": false, "description": "已处理订单数量" }, { "name": "removed_order_count", "type": "number", "required": false, "description": "已成功移出波次的订单数量" }, { "name": "failed_order_count", "type": "number", "required": false, "description": "处理失败的订单数量" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比(0-100)" }, { "name": "duration_ms", "type": "number", "required": false, "description": "任务耗时(毫秒)" }, { "name": "error_message", "type": "string", "required": false, "description": "失败时的错误信息" }, { "name": "error_code", "type": "string", "required": false, "description": "失败时的错误码" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.batchRemoveOrders", "title": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.store_id)。", "description": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.store_id)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / order_ids / orderIds / order_id / orderId / id", "type": "array|string|number", "required": true, "description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID,以上别名均可用(ids、order_ids、orderIds、order_id、orderId、id)" } ], "response": [ { "name": "ids", "type": "array", "required": true, "description": "归一化后的请求 ID 列表" }, { "name": "removed_order_ids", "type": "array", "required": true, "description": "实际被移出波次的订单 ID 列表" }, { "name": "removed_order_count", "type": "number", "required": true, "description": "被移出波次的订单数量" }, { "name": "affected_wave_ids", "type": "array", "required": true, "description": "本次操作涉及的波次 ID 列表" }, { "name": "updated_wave_ids", "type": "array", "required": true, "description": "实际更新了 total_orders 的波次 ID 列表" }, { "name": "emptied_wave_ids", "type": "array", "required": true, "description": "被清空且已置为 wave_status=-1 的波次 ID 列表" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.fetch", "title": "兼容别名(等同 groupFetch)", "description": "兼容别名(等同 groupFetch)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "structure_list", "type": "array", "required": true, "description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "生效的仓库 ID" }, { "name": "structure_count", "type": "number", "required": true, "description": "本次入参的结构数量(structure_list 长度)" }, { "name": "default_quantity", "type": "number", "required": true, "description": "仓库默认抓取数量或全局默认值" }, { "name": "fetch_mode", "type": "string", "required": false, "description": "抓取模式,值为 'group'(团购)或 'single'(散单)" }, { "name": "message", "type": "string", "required": false, "description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.fetchTaskProgress", "title": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。", "description": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务 ID(后端生成的唯一标识),兼容旧参数名 taskId,可从 order.wave.fetch 的返回值中获取" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID" }, { "name": "status", "type": "string", "required": true, "description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "生效的仓库 ID(若任务关联仓库时返回)" }, { "name": "structure_count", "type": "number", "required": false, "description": "本次任务的结构数量(structure_list 长度)" }, { "name": "finished_structure_count", "type": "number", "required": false, "description": "已完成抓取的结构数量" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比(0-100,可能为小数)" }, { "name": "total_fetched_quantity", "type": "number", "required": false, "description": "已抓取的总件数" }, { "name": "duration_ms", "type": "number", "required": false, "description": "任务已运行时长,毫秒级" }, { "name": "error", "type": "string", "required": false, "description": "错误信息,仅当 status=failed 时返回" }, { "name": "fetch_mode", "type": "string", "required": false, "description": "抓取模式,值为 'group'(团购)或 'single'(散单);single 模式时可能返回下列额外字段" }, { "name": "max_fetch_quantity", "type": "number", "required": false, "description": "当 fetch_mode=single 时返回的最大抓取上限(订单数,正整数)" }, { "name": "limit_reached", "type": "boolean", "required": false, "description": "当 fetch_mode=single 时指示是否已达到 max_fetch_quantity 限制" }, { "name": "stop_reason", "type": "string", "required": false, "description": "任务停止原因(如达到上限、人工停止或其他失败原因)" }, { "name": "update_time", "type": "string", "required": false, "description": "最近一次状态更新时间,ISO8601 字符串" }, { "name": "message", "type": "string", "required": false, "description": "额外提示信息" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.groupFetch", "title": "抓取团购接口(异步任务提交)", "description": "抓取团购接口(异步任务提交)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "structure_list", "type": "array", "required": true, "description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "生效的仓库 ID" }, { "name": "structure_count", "type": "number", "required": true, "description": "本次入参的结构数量(structure_list 长度)" }, { "name": "default_quantity", "type": "number", "required": true, "description": "仓库默认抓取数量或全局默认值" }, { "name": "fetch_mode", "type": "string", "required": false, "description": "抓取模式,值为 'group'(团购)或 'single'(散单)" }, { "name": "message", "type": "string", "required": false, "description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.groupOrderFetchList", "title": "按机器结构分组的可抓取列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。", "description": "按机器结构分组的可抓取列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。", "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" }, { "name": "distinguish_express", "type": "boolean", "required": false, "description": "是否区分快递(影响分组粒度)" }, { "name": "store_id", "type": "number", "required": false, "description": "货主ID(仅作为筛选条件)" }, { "name": "same_order_quantity", "type": "number", "required": false, "description": "最小同组订单数量阈值(>=)。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。" }, { "name": "shop_name", "type": "string", "required": false, "description": "店铺名称(模糊匹配)" }, { "name": "include_sku", "type": "string", "required": false, "description": "仅保留包含该 SKU 的分组(页内过滤)" }, { "name": "return_order_ids", "type": "boolean", "required": false, "description": "是否在结果中返回组内订单ID列表" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "分组列表,每项包含 item_detail、item_detail_machine、item_detail_machine_snapshot、item_snapshot、group、group_count、items_total、items_weight(总重量kg,取组内首单 items_weight)、store_id、store_ids、logistics_name、distinguish_express、first_order_time、last_order_time、status_summary 等字段;若指定 return_order_ids=true 则额外包含 order_ids" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.singleFetch", "title": "抓取散单接口(异步任务提交)", "description": "抓取散单接口(异步任务提交)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "structure_list", "type": "array", "required": true, "description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识)并包含必填字段 max_fetch_quantity(最大抓取上限,订单数,正整数);可选 quantity(未传入时使用仓库默认或全局默认)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "生效的仓库 ID" }, { "name": "structure_count", "type": "number", "required": true, "description": "本次入参的结构数量(structure_list 长度)" }, { "name": "default_quantity", "type": "number", "required": true, "description": "仓库默认抓取数量或全局默认值" }, { "name": "fetch_mode", "type": "string", "required": false, "description": "抓取模式,值为 'group'(团购)或 'single'(散单)" }, { "name": "max_fetch_quantity", "type": "number", "required": false, "description": "提交时生效的最大抓取上限(订单数,正整数)" }, { "name": "message", "type": "string", "required": false, "description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.singleFetchByIds", "title": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。", "description": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids / order_ids / orderIds", "type": "array|string|number", "required": true, "description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID。入参会被去重并转换为正整数。字段解析优先顺序:ids -> order_ids -> orderIds。" } ], "response": [ { "name": "ids", "type": "array", "required": true, "description": "请求归一化后的 ids 列表(去重且为正整数)" }, { "name": "wave_id", "type": "number", "required": true, "description": "创建的波次 ID;若无可抓取订单返回 0" }, { "name": "wave_no", "type": "string", "required": true, "description": "创建的波次号;无可抓取时为空字符串" }, { "name": "fetched_order_ids", "type": "array", "required": true, "description": "实际被抓取并成功分配到波次的订单 ID 列表(为归一化后的 ids 的子集)" }, { "name": "fetched_order_count", "type": "number", "required": true, "description": "实际被抓取的订单数量(等于 fetched_order_ids.length)" }, { "name": "excluded_existing_wave_order_ids", "type": "array", "required": false, "description": "原始入参中已在其它波次中的订单 ID(被排除,不会被抓取)" }, { "name": "skipped_order_ids", "type": "array", "required": false, "description": "因订单状态不符、正在出库或其他业务原因被跳过的订单 ID(不会被抓取)" }, { "name": "not_found_order_ids", "type": "array", "required": false, "description": "入参中未在数据库中找到的订单 ID" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.singleOrderFetchList", "title": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。", "description": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。", "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" }, { "name": "distinguish_express", "type": "boolean", "required": false, "description": "是否区分快递(影响分组粒度)" }, { "name": "store_id", "type": "number", "required": false, "description": "货主ID(仅作为筛选条件)" }, { "name": "same_order_quantity", "type": "number", "required": false, "description": "最小同组订单数量阈值(用于判定团购命中);本接口返回同组订单数量小于该阈值的分组。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。" }, { "name": "shop_name", "type": "string", "required": false, "description": "店铺名称(模糊匹配)" }, { "name": "include_sku", "type": "string", "required": false, "description": "仅保留包含该 SKU 的分组(页内过滤)" }, { "name": "return_order_ids", "type": "boolean", "required": false, "description": "是否在结果中返回组内订单ID列表" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "散单候选分组列表,每项包含 item_detail、item_detail_machine、item_detail_machine_snapshot、item_snapshot、group、group_count、items_total、items_weight(总重量kg,取组内首单 items_weight)、store_id、store_ids、logistics_name、distinguish_express、first_order_time、last_order_time、status_summary 等字段;返回的 group_count 均小于 same_order_quantity(或仓库配置的 min_group_order_fetch_quantity);若指定 return_order_ids=true 则额外包含 order_ids" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.wavePickTaskCancel", "title": "取消拣货任务(批量)。可取消的状态:0=待开始、1=拣货中、2=待复核(拣货完成)、3=已完成,状态9(已取消)或其他状态不允许取消。同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。对于status=2或3的任务,取消时会自动回退订单拣货状态:wms_wave_pick_task_order.pick_status(1→0)、order_delivery.pick_status(fin→padding)。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。", "description": "取消拣货任务(批量)。可取消的状态:0=待开始、1=拣货中、2=待复核(拣货完成)、3=已完成,状态9(已取消)或其他状态不允许取消。同时释放关联波次(物理删除波次记录,订单回池)、解绑拣货车、写操作日志。对于status=2或3的任务,取消时会自动回退订单拣货状态:wms_wave_pick_task_order.pick_status(1→0)、order_delivery.pick_status(fin→padding)。入参仅支持 task_ids(数组,必填),不再支持单个 task_id。操作人与仓库从请求上下文获取(例如当前登录用户上下文 ctx.user),若上下文缺失接口将返回错误。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_ids", "type": "array", "required": true, "description": "任务ID数组,例如 [123,124];仅支持批量处理,不再支持单个 task_id。" } ], "response": [ { "name": "cancelled_count", "type": "number", "required": false, "description": "成功取消的任务数量" }, { "name": "task_ids", "type": "array", "required": false, "description": "处理的任务ID数组(若后端返回)" }, { "name": "task_nos", "type": "array", "required": false, "description": "处理的任务编号数组(若后端返回)" }, { "name": "task_id", "type": "number", "required": false, "description": "任务ID(历史兼容,若后端仍返回)" }, { "name": "task_no", "type": "string", "required": false, "description": "任务编号(历史兼容,若后端仍返回)" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.wavePickTaskCancelSelf", "title": "取消单个拣货任务(仅允许取消当前操作人本人创建的任务;仅支持单个 task_id,明确不支持 task_ids)", "description": "取消单个拣货任务(仅允许取消当前操作人本人创建的任务;仅支持单个 task_id,明确不支持 task_ids)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id", "type": "number", "required": true, "description": "要取消的单个任务 ID(仅支持单个,不支持 task_ids)" } ], "response": [ { "name": "cancelled_count", "type": "number", "required": false, "description": "成功取消的任务数量(0 或 1)" }, { "name": "task_id", "type": "number", "required": false, "description": "被处理的任务ID" }, { "name": "task_no", "type": "string", "required": false, "description": "被处理的任务编号(若后端返回)" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.wavePickTaskList", "title": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。", "description": "按当前仓库分页查询拣货任务列表。支持顶层分页参数 `page_no`/`page_size`(兼容 `pagination` 对象与 `current/size`),支持 `status` 单值或数组;兼容历史 `where` 结构,顶层参数优先。默认按 create_time desc 排序。", "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", "type": "number", "required": true, "description": "仓库ID(必填)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数,支持 page / pageSize,兼容 current / size(兼容旧客户端)" }, { "name": "page_no", "type": "number", "required": false, "description": "页码(优先于 pagination.page/current)" }, { "name": "page_size", "type": "number", "required": false, "description": "每页大小(优先于 pagination.pageSize/size)" }, { "name": "status", "type": "array", "required": false, "description": "拣货任务状态过滤;建议传数组,也兼容单值或逗号分隔字符串,兼容 where.status;顶层参数优先" }, { "name": "review_status", "type": "number", "required": false, "description": "复核状态过滤" }, { "name": "pick_mode", "type": "number", "required": false, "description": "拣货模式(如批量/逐单等)" }, { "name": "source", "type": "string", "required": false, "description": "任务来源标识(业务端语义)" }, { "name": "pick_user_id", "type": "number", "required": false, "description": "拣货执行人ID(兼容旧字段)" }, { "name": "review_user_id", "type": "number", "required": false, "description": "复核人ID" }, { "name": "task_no", "type": "string", "required": false, "description": "任务编号(支持模糊匹配)" }, { "name": "cart_id", "type": "number", "required": false, "description": "拣货车/作业车ID" }, { "name": "keyword", "type": "string", "required": false, "description": "关键字搜索:支持 task_no / batch_no / current_cart_code_snapshot 等字段的模糊匹配" }, { "name": "start_time_start", "type": "string", "required": false, "description": "开始时间(ISO 字符串),与 start_time_end 一起用于时间范围过滤" }, { "name": "start_time_end", "type": "string", "required": false, "description": "结束时间(ISO 字符串),与 start_time_start 一起用于时间范围过滤" }, { "name": "where", "type": "object", "required": false, "description": "兼容历史 where 结构(可包含 status 等字段);当存在顶层同名参数时,顶层参数优先" }, { "name": "strategy_id", "type": "number", "required": false, "description": "策略ID(当前主表未存,该接口会忽略此过滤,建议勿使用)" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "拣货任务列表(数组),每项字段如下" }, { "name": "total", "type": "number", "required": true, "description": "总记录数" }, { "name": "page", "type": "number", "required": true, "description": "当前页码" }, { "name": "page_size", "type": "number", "required": true, "description": "每页大小" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.waveStrategyCreate", "title": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", "description": "新增波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。创建成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "strategy_name", "type": "string", "required": true, "description": "策略名称(必填)" }, { "name": "strategy_type", "type": "number", "required": true, "description": "策略类型(必填,正整数):1-散单 2-团购" }, { "name": "batch_mode", "type": "number", "required": true, "description": "拣货模式(必填,正整数)" }, { "name": "status", "type": "number", "required": false, "description": "状态:1-启用 0-停用(可选)" }, { "name": "order_min_sku", "type": "number", "required": false, "description": "订单最小 SKU 种类数(可选,正整数或 null)" }, { "name": "order_max_sku", "type": "number", "required": false, "description": "订单最大 SKU 种类数(可选,正整数或 null)" }, { "name": "order_min_qty", "type": "number", "required": false, "description": "订单最小商品总数(可选,正整数或 null)" }, { "name": "order_max_qty", "type": "number", "required": false, "description": "订单最大商品总数(可选,正整数或 null)" }, { "name": "min_same_structure", "type": "number", "required": false, "description": "最小相同结构订单数(可选,正整数或 null)" }, { "name": "max_same_structure", "type": "number", "required": false, "description": "最大相同结构订单数(可选,正整数或 null)。注意:若传入值 >= 仓库配置的 min_group_order_fetch_quantity,则会被下调为 min_group_order_fetch_quantity - 1,最小为 1。" }, { "name": "batch_max_orders", "type": "number", "required": false, "description": "批次最大订单数(可选)" }, { "name": "batch_max_skus", "type": "number", "required": false, "description": "批次最大 SKU 总数(可选)" }, { "name": "group_batch_max_orders", "type": "number", "required": false, "description": "团购批次最大订单数(可选)" }, { "name": "require_same_express", "type": "boolean", "required": false, "description": "是否要求相同快递(可选,布尔)" }, { "name": "allow_cross_owner", "type": "boolean", "required": false, "description": "是否允许跨货主(可选,布尔)" }, { "name": "description", "type": "string", "required": false, "description": "策略描述(可选)" }, { "name": "allowed_provinces", "type": "array|string", "required": false, "description": "允许的省份列表(可选,支持数组、JSON 字符串或逗号分隔字符串)" }, { "name": "allowed_platforms", "type": "array|string", "required": false, "description": "允许的平台列表(可选,支持数组、JSON 字符串或逗号分隔字符串)" }, { "name": "allowed_owners", "type": "array|string", "required": false, "description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。" }, { "name": "allowed_expresses", "type": "array|string", "required": false, "description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。" }, { "name": "wave_prefix", "type": "string", "required": false, "description": "波次编号前缀(可选),最多 5 个字符,如 D、B、A;不传则保持原值" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "创建的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示" }, { "name": "code", "type": "number", "required": true, "description": "HTTP-like 状态码,成功时返回 200" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.waveStrategyFallbackOrderList", "title": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 2。用于展示策略未命中但需回退处理的订单候选。", "description": "基于波次策略的回退候选订单列表。该接口内置固定筛选条件:step != 0、wave_id = 0、wave_scan_result = 2。用于展示策略未命中但需回退处理的订单候选。", "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" }, { "name": "where", "type": "object", "required": false, "description": "筛选白名单字段(object)。仅支持下列字段,且禁止传入 warehouse_id / warehouseId: - id(等值) - delivery_no / deliveryNo(模糊) - tracking_no / trackingNo(模糊) - items_count_min / items_count_max(范围) - items_total_min / items_total_max(范围) - sys_logistics_name(模糊) - store_name(模糊) - owner_name(等值) - province(模糊) - sys_platform_name(模糊) 说明:若传入未列出的字段或禁止字段(如 warehouse_id)接口会返回 400。" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "回退候选订单简要列表。数组内对象字段说明见 children。" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.waveStrategyFetchAdmin", "title": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", "description": "按策略提交并创建抓取主流程任务(后台管理)。当前为最小主流程:执行入参校验并创建任务记录,返回创建结果与计划预览;后续将扩展完整扫描/执行链路。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "strategy_id / strategyId", "type": "number", "required": true, "description": "策略ID(正整数,支持下划线/驼峰)" }, { "name": "cart_id / cartId", "type": "string|number", "required": false, "description": "可选,关联拣货车/作业车ID,用于记录作业上下文或幂等识别" }, { "name": "source / operation_source", "type": "string", "required": false, "description": "可选,操作来源标识(例如 admin/pda/manual/auto),用于审计与分流策略" }, { "name": "strategy_params / strategyParams", "type": "object", "required": false, "description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用" } ], "response": [ { "name": "state", "type": "string", "required": true, "description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed" }, { "name": "task_id", "type": "string", "required": true, "description": "任务唯一 ID(用于后续查询或关联)" }, { "name": "task_no", "type": "string", "required": true, "description": "任务业务编号(便于展示与关联)" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "生效的仓库 ID(来自当前上下文,如可用则返回)" }, { "name": "strategy_id", "type": "number", "required": false, "description": "生效的策略 ID(与入参保持一致,兼容回传)" }, { "name": "plan", "type": "object", "required": true, "description": "任务计划/执行预览对象,描述本次任务预估的执行计划" }, { "name": "plan_summary", "type": "string", "required": true, "description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')" }, { "name": "validation_errors", "type": "array", "required": false, "description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题" }, { "name": "message", "type": "string", "required": false, "description": "可选提示信息或错误说明(创建失败时返回简短说明)" }, { "name": "fetch_state", "type": "number", "required": true, "description": "抓取结果三态:1=成功创建任务(返回 task_id/task_no),2=普通失败(task_id=null),3=存在未完成任务(返回 existing task_id/task_no,前端可进入拣货流程)" }, { "name": "tip", "type": "string", "required": false, "description": "简短提示,用于向前端展示简要原因或下一步建议" }, { "name": "can_enter_pick_flow", "type": "boolean", "required": false, "description": "仅当 fetch_state=3 时为 true,表示前端可直接进入拣货流程" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.waveStrategyFetchPda", "title": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", "description": "按策略提交并创建抓取主流程任务(PDA)。当前为最小主流程:进行入参校验并创建任务记录,返回创建结果与计划预览;后续扫描/执行阶段将扩展为完整执行流。 注意:当存在未完成任务时,接口返回 fetch_state=3 且同时返回 existing task_id/task_no,前端可直接进入拣货流程。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "strategy_id / strategyId", "type": "number", "required": true, "description": "策略ID(正整数,支持下划线/驼峰)" }, { "name": "cart_id / cartId", "type": "string|number", "required": false, "description": "可选,关联拣货车/作业车ID,支持字符串或数字,用于记录作业上下文" }, { "name": "source / operation_source", "type": "string", "required": false, "description": "可选,操作来源标识(例如 pda/admin/manual/auto),用于审计与分流策略" }, { "name": "strategy_params / strategyParams", "type": "object", "required": false, "description": "可选,策略参数透传对象(如 order_min_qty/order_max_qty/allow_cross_owner 等),在创建任务时作为策略覆盖或附加参数使用" } ], "response": [ { "name": "state", "type": "string", "required": true, "description": "任务状态:created(已创建主流程任务),后续可能为 running/success/failed" }, { "name": "task_id", "type": "string", "required": true, "description": "任务唯一 ID(用于后续查询或关联)" }, { "name": "task_no", "type": "string", "required": true, "description": "任务业务编号(便于展示与关联)" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "生效的仓库 ID(来自当前上下文,如可用则返回)" }, { "name": "strategy_id", "type": "number", "required": false, "description": "生效的策略 ID(与入参保持一致,兼容回传)" }, { "name": "plan", "type": "object", "required": true, "description": "任务计划/执行预览对象,描述本次任务预估的执行计划" }, { "name": "plan_summary", "type": "string", "required": true, "description": "计划摘要字符串,便于前端在受理后快速展示(例如:'创建 3 个波次,涉及 120 单,约 450 件')" }, { "name": "validation_errors", "type": "array", "required": false, "description": "当入参校验失败时返回的数组,每项为 { field, message } 对象,供前端展示或定位问题" }, { "name": "message", "type": "string", "required": false, "description": "可选提示信息或错误说明(创建失败时返回简短说明)" }, { "name": "fetch_state", "type": "number", "required": true, "description": "抓取结果三态:1=成功创建任务(返回 task_id/task_no),2=普通失败(task_id=null),3=存在未完成任务(返回 existing task_id/task_no,前端可进入拣货流程)" }, { "name": "tip", "type": "string", "required": false, "description": "简短提示,用于向前端展示简要原因或下一步建议" }, { "name": "can_enter_pick_flow", "type": "boolean", "required": false, "description": "仅当 fetch_state=3 时为 true,表示前端可直接进入拣货流程" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.waveStrategyList", "title": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/pagination 结构。", "description": "查询当前仓库波次策略列表。仅查询当前登录仓库在 wms_wave_strategy 中的数据,返回标准 list/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" }, { "name": "strategy_type", "type": "number", "required": false, "description": "仅支持 1=散单、2=团购;与 where.strategy_type 同时存在时以顶层 strategy_type 为准。" }, { "name": "where", "type": "object", "required": false, "description": "当前仅支持 where.strategy_type(1/2);其余 where 字段暂不支持。" }, { "name": "calculate_next_fetch_order_count / calculateNextFetchOrderCount", "type": "number", "required": false, "description": "0-不计算(默认),1-计算并返回每条策略的 next_fetch_order_count;支持别名 calculateNextFetchOrderCount" }, { "name": "debug", "type": "number", "required": false, "description": "0-不启用(默认),1-启用调试输出,返回每条策略的 next_fetch_order_list(含结构/快递/货主ID等指标明细)" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "策略列表,每项为波次策略记录" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.waveStrategyQuickScan", "title": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。", "description": "提交波次策略快速扫描异步任务。无外部参数,使用当前仓库上下文;同一仓库同一时刻仅允许一个任务运行,若已有运行任务直接返回已有 task_id。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [ { "name": "status", "type": "string", "required": true, "description": "提交状态,固定 success" }, { "name": "task_id", "type": "string", "required": true, "description": "任务 ID(用于后续查询进度)" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "仓库 ID(来自当前上下文)" }, { "name": "state", "type": "string", "required": true, "description": "任务状态(一般为 submitted 或 running)" }, { "name": "message", "type": "string", "required": false, "description": "可选提示信息" }, { "name": "accepted_at", "type": "string", "required": false, "description": "任务受理时间(ISO 字符串)" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.waveStrategyQuickScanTaskProgress", "title": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='not_found'。", "description": "查询波次策略快速扫描任务进度。接受 task_id / taskId,若未找到返回 state='not_found'。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务 ID(下划线或驼峰兼容,必填)" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "任务 ID" }, { "name": "state", "type": "string", "required": true, "description": "任务状态:submitted/running/success/failed/not_found" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "仓库 ID" }, { "name": "total_order_count", "type": "number", "required": false, "description": "扫描订单总数" }, { "name": "processed_order_count", "type": "number", "required": false, "description": "已处理订单数" }, { "name": "matched_order_count", "type": "number", "required": false, "description": "命中策略的订单数" }, { "name": "unmatched_order_count", "type": "number", "required": false, "description": "未命中策略的订单数" }, { "name": "progress_percent", "type": "number", "required": false, "description": "进度百分比(0-100)" }, { "name": "submitted_at", "type": "string", "required": false, "description": "提交时间(timestamp 或 ISO)" }, { "name": "start_time", "type": "string", "required": false, "description": "实际开始时间(ISO)" }, { "name": "end_time", "type": "string", "required": false, "description": "结束时间(ISO)" }, { "name": "error_message", "type": "string", "required": false, "description": "错误信息(若失败)" }, { "name": "error_code", "type": "string", "required": false, "description": "错误码(若失败)" }, { "name": "duration_ms", "type": "number", "required": false, "description": "耗时,毫秒" } ] }, { "moduleName": "订单波次模块", "moduleKey": "order.wave", "moduleFolder": "order.wave", "method": "order.wave.waveStrategyUpdate", "title": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", "description": "修改波次策略。warehouse_id 与 creator_name 强制使用当前上下文,不接受外部覆盖。id(或 strategy_id/strategyId)为必填主键,其他字段为可选更新;更新成功后会推进仓库的 wave_strategy_version 并失效相关缓存。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id / strategy_id / strategyId", "type": "number", "required": true, "description": "策略主键,兼容 id / strategy_id / strategyId(必填)" }, { "name": "strategy_name", "type": "string", "required": false, "description": "策略名称(可选)" }, { "name": "strategy_type", "type": "number", "required": false, "description": "策略类型(可选,正整数)" }, { "name": "batch_mode", "type": "number", "required": false, "description": "拣货模式(可选,正整数)" }, { "name": "status", "type": "number", "required": false, "description": "状态:1-启用 0-停用(可选)" }, { "name": "order_min_sku", "type": "number", "required": false, "description": "订单最小 SKU 种类数(可选,正整数或 null)" }, { "name": "order_max_sku", "type": "number", "required": false, "description": "订单最大 SKU 种类数(可选,正整数或 null)" }, { "name": "order_min_qty", "type": "number", "required": false, "description": "订单最小商品总数(可选,正整数或 null)" }, { "name": "order_max_qty", "type": "number", "required": false, "description": "订单最大商品总数(可选,正整数或 null)" }, { "name": "min_same_structure", "type": "number", "required": false, "description": "最小相同结构订单数(可选,正整数或 null)" }, { "name": "max_same_structure", "type": "number", "required": false, "description": "最大相同结构订单数(可选,正整数或 null)。会受仓库 min_group_order_fetch_quantity 约束,接口会自动调整。" }, { "name": "batch_max_orders", "type": "number", "required": false, "description": "批次最大订单数(可选)" }, { "name": "batch_max_skus", "type": "number", "required": false, "description": "批次最大 SKU 总数(可选)" }, { "name": "group_batch_max_orders", "type": "number", "required": false, "description": "团购批次最大订单数(可选)" }, { "name": "require_same_express", "type": "boolean", "required": false, "description": "是否要求相同快递(可选,布尔)" }, { "name": "allow_cross_owner", "type": "boolean", "required": false, "description": "是否允许跨货主(可选,布尔)" }, { "name": "description", "type": "string", "required": false, "description": "策略描述(可选)" }, { "name": "allowed_provinces", "type": "array|string", "required": false, "description": "允许的省份列表(可选,支持数组/JSON/逗号分隔)" }, { "name": "allowed_platforms", "type": "array|string", "required": false, "description": "允许的平台列表(可选,支持数组/JSON/逗号分隔)" }, { "name": "allowed_owners", "type": "array|string", "required": false, "description": "允许的货主列表(可选,支持数组/JSON/逗号分隔);系统会校验所传货主是否在仓库可用货主范围内,非法值将导致 400 错误。" }, { "name": "allowed_expresses", "type": "array|string", "required": false, "description": "允许的快递编码列表(可选,支持数组/JSON/逗号分隔);系统会校验所传编码是否在可用快递列表内,非法值将导致 400 错误。" }, { "name": "wave_prefix", "type": "string", "required": false, "description": "波次编号前缀(可选),最多 5 个字符,如 D、B、A;不传则保持原值" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "更新后的策略对象,字段同 order.wave.waveStrategyList.list[*] 所示" }, { "name": "code", "type": "number", "required": true, "description": "HTTP-like 状态码,成功时返回 200" } ] }, { "moduleName": "拣货模块", "moduleKey": "pick", "moduleFolder": "pick", "method": "pick.query", "title": "按 keyword(运单号或波次号)获取或创建当前用户的拣货任务:命中同用户活动任务返回 existing;无活动任务则创建并返回 created;若活动任务归属他人则返回冲突提示。", "description": "按 keyword(运单号或波次号)获取或创建当前用户的拣货任务:命中同用户活动任务返回 existing;无活动任务则创建并返回 created;若活动任务归属他人则返回冲突提示。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "keyword", "type": "string", "required": true, "description": "关键字,支持运单号或波次号。" } ], "response": [ { "name": "task_id", "type": "number", "required": true, "description": "拣货任务ID。" }, { "name": "status", "type": "string", "required": true, "description": "任务状态:existing(命中当前用户已有活动任务)或 created(新建成功)。" }, { "name": "tip", "type": "string", "required": true, "description": "提示文案。" } ] }, { "moduleName": "拣货模块", "moduleKey": "pick", "moduleFolder": "pick", "method": "pick.wavePickTaskComplete", "title": "完全提交拣货任务。支持 mode=1 全部确认,mode=2 部分确认(需传 order_ids)。提交后根据是否全部完成自动推进任务状态。后台抓取创建的任务(source=2)必须先绑定拣货车才能提交,否则返回 400。", "description": "完全提交拣货任务。支持 mode=1 全部确认,mode=2 部分确认(需传 order_ids)。提交后根据是否全部完成自动推进任务状态。后台抓取创建的任务(source=2)必须先绑定拣货车才能提交,否则返回 400。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id", "type": "number", "required": true, "description": "拣货任务ID" }, { "name": "mode", "type": "number", "required": false, "description": "提交模式:1=全部确认(默认),2=部分确认" }, { "name": "order_ids", "type": "array", "required": false, "description": "部分确认模式(mode=2)时必填;仅会确认命中当前任务的订单ID" } ], "response": [ { "name": "task_id", "type": "number", "required": true, "description": "拣货任务ID" }, { "name": "mode", "type": "number", "required": true, "description": "实际生效的提交模式(1=全部确认,2=部分确认)" }, { "name": "confirmed_order_ids", "type": "array", "required": true, "description": "本次成功确认的订单ID列表" }, { "name": "is_completed", "type": "boolean", "required": true, "description": "提交后任务是否已完成" }, { "name": "progress", "type": "object", "required": true, "description": "任务订单拣货进度统计" } ] }, { "moduleName": "拣货模块", "moduleKey": "pick", "moduleFolder": "pick", "method": "pick.wavePickTaskDetail", "title": "按任务ID获取拣货任务详情。查询前会校验任务内订单是否全部完成快递号与储位分配:若存在未分配快递号或未分配储位订单,将返回 400 并在 data 中返回 action 与 order_ids 供前端触发一键分配;详情响应新增中间态进度语义(task.is_completed、task.progress 与顶层 is_completed),用于前端判断是否已完成与展示阶段进度;仅允许任务的 pick_user_id 与当前登录用户一致时返回详情。当 pick_mode=1(团购小波次)时,picking_details 字段不返回以减少带宽。", "description": "按任务ID获取拣货任务详情。查询前会校验任务内订单是否全部完成快递号与储位分配:若存在未分配快递号或未分配储位订单,将返回 400 并在 data 中返回 action 与 order_ids 供前端触发一键分配;详情响应新增中间态进度语义(task.is_completed、task.progress 与顶层 is_completed),用于前端判断是否已完成与展示阶段进度;仅允许任务的 pick_user_id 与当前登录用户一致时返回详情。当 pick_mode=1(团购小波次)时,picking_details 字段不返回以减少带宽。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id", "type": "number", "required": true, "description": "wms_wave_pick_task 主键 ID" } ], "response": [ { "name": "task", "type": "object", "required": false, "description": "拣货任务主表(精简字段)" }, { "name": "is_completed", "type": "boolean", "required": false, "description": "任务是否已完成(与 task.is_completed 含义一致,便于前端直接判断)" }, { "name": "boxes", "type": "array", "required": false, "description": "箱列表;包含用于前端展示与拣货进度的统计字段" }, { "name": "picking_details", "type": "array", "required": false, "description": "拣货明细列表(按库位/商品/数量拆分),用于从明细视角展示拣货要求。注意:当 pick_mode=1(团购小波次)时该字段不返回,减少带宽浪费;其他 pick_mode(2/3/4/5)正常返回。" }, { "name": "picking_summary", "type": "object", "required": false, "description": "对 picking_details 的汇总信息,用于统计与前端显示" }, { "name": "picking_view", "type": "object", "required": false, "description": "按 pick_mode 区分的 picking_view 形态输出(五种形态);用于前端按任务类型展示聚合视图。" } ] }, { "moduleName": "拣货模块", "moduleKey": "pick", "moduleFolder": "pick", "method": "pick.wavePickTaskSubmit", "title": "提交拣货任务中间态。用于保存阶段性数据到任务 ext_json.pick_intermediate,并在任务初始状态时自动推进到进行中。", "description": "提交拣货任务中间态。用于保存阶段性数据到任务 ext_json.pick_intermediate,并在任务初始状态时自动推进到进行中。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id", "type": "number", "required": true, "description": "拣货任务ID" }, { "name": "payload", "type": "object", "required": false, "description": "中间态业务数据对象,将原样保存到 ext_json.pick_intermediate.payload" } ], "response": [ { "name": "task_id", "type": "number", "required": true, "description": "拣货任务ID" }, { "name": "status", "type": "string", "required": true, "description": "提交结果状态,固定为 submitted" }, { "name": "is_completed", "type": "boolean", "required": true, "description": "当前任务是否已完成" }, { "name": "progress", "type": "object", "required": true, "description": "任务订单拣货进度统计" } ] }, { "moduleName": "拣货车模块", "moduleKey": "pickCart", "moduleFolder": "pickcart", "method": "pickCart.bindTaskCart", "title": "绑定拣货任务与拣货车。支持传 cart_id 或 cart_code;若任务已绑定其他拣货车则自动改绑,若目标拣货车已绑定其他活动任务则返回冲突。", "description": "绑定拣货任务与拣货车。支持传 cart_id 或 cart_code;若任务已绑定其他拣货车则自动改绑,若目标拣货车已绑定其他活动任务则返回冲突。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id", "type": "number", "required": true, "description": "拣货任务ID" }, { "name": "cart_id", "type": "number", "required": false, "description": "拣货车ID,和 cart_code 二选一即可" }, { "name": "cart_code", "type": "string", "required": false, "description": "拣货车编码,和 cart_id 二选一即可" } ], "response": [ { "name": "task_id", "type": "number", "required": true, "description": "拣货任务ID" }, { "name": "task_no", "type": "string", "required": true, "description": "拣货任务编号" }, { "name": "cart", "type": "object", "required": true, "description": "绑定后的拣货车信息" } ] }, { "moduleName": "拣货车模块", "moduleKey": "pickCart", "moduleFolder": "pickcart", "method": "pickCart.codeDuplicateCheck", "title": "拣货车编码查重。支持传 exclude_cart_id 排除自身,用于编辑场景判断是否与其他车重复。", "description": "拣货车编码查重。支持传 exclude_cart_id 排除自身,用于编辑场景判断是否与其他车重复。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "cart_code", "type": "string", "required": true, "description": "待校验的拣货车编码" }, { "name": "exclude_cart_id", "type": "number", "required": false, "description": "需排除的拣货车ID,通常为当前编辑记录自身ID" } ], "response": [ { "name": "duplicated", "type": "boolean", "required": true, "description": "是否存在重复编码" }, { "name": "cart_id", "type": "number", "required": false, "description": "命中的重复拣货车ID,无重复时为 null" }, { "name": "cart_code", "type": "string", "required": false, "description": "命中的重复编码,无重复时为 null" }, { "name": "cart_name", "type": "string", "required": false, "description": "命中的重复拣货车名称,无重复时为 null" }, { "name": "status", "type": "number", "required": false, "description": "命中的重复拣货车状态,无重复时为 null" } ] }, { "moduleName": "拣货车模块", "moduleKey": "pickCart", "moduleFolder": "pickcart", "method": "pickCart.create", "title": "创建拣货车。拣货车编码在当前仓库内不可重复。", "description": "创建拣货车。拣货车编码在当前仓库内不可重复。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "cart_code", "type": "string", "required": true, "description": "拣货车编码,当前仓库内唯一" }, { "name": "cart_name", "type": "string", "required": false, "description": "拣货车名称" }, { "name": "status", "type": "number", "required": false, "description": "状态:0-停用 1-启用,默认 1" } ], "response": [ { "name": "cart_id", "type": "number", "required": true, "description": "拣货车ID" }, { "name": "cart_code", "type": "string", "required": true, "description": "拣货车编码" }, { "name": "cart_name", "type": "string", "required": false, "description": "拣货车名称" }, { "name": "status", "type": "number", "required": true, "description": "状态:0-停用 1-启用" } ] }, { "moduleName": "拣货车模块", "moduleKey": "pickCart", "moduleFolder": "pickcart", "method": "pickCart.delete", "title": "删除拣货车。若拣货车当前已绑定任务或存在有效绑定记录,则不允许删除。", "description": "删除拣货车。若拣货车当前已绑定任务或存在有效绑定记录,则不允许删除。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "cart_id", "type": "number", "required": true, "description": "拣货车ID" } ], "response": [ { "name": "cart_id", "type": "number", "required": true, "description": "被删除的拣货车ID" }, { "name": "deleted", "type": "boolean", "required": true, "description": "是否删除成功,固定为 true" } ] }, { "moduleName": "拣货车模块", "moduleKey": "pickCart", "moduleFolder": "pickcart", "method": "pickCart.detail", "title": "查询拣货车详情。", "description": "查询拣货车详情。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "cart_id", "type": "number", "required": true, "description": "拣货车ID" } ], "response": [ { "name": "cart_id", "type": "number", "required": true, "description": "拣货车ID" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "仓库ID" }, { "name": "cart_code", "type": "string", "required": true, "description": "拣货车编码" }, { "name": "cart_name", "type": "string", "required": false, "description": "拣货车名称" }, { "name": "status", "type": "number", "required": true, "description": "状态:0-停用 1-启用" }, { "name": "current_task_id", "type": "number", "required": false, "description": "当前绑定任务ID,无绑定时为 null" }, { "name": "current_task_no", "type": "string", "required": false, "description": "当前绑定任务编号,无绑定时为 null" } ] }, { "moduleName": "拣货车模块", "moduleKey": "pickCart", "moduleFolder": "pickcart", "method": "pickCart.list", "title": "分页查询拣货车列表。支持按关键字、状态、当前绑定任务筛选。", "description": "分页查询拣货车列表。支持按关键字、状态、当前绑定任务筛选。", "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,默认 1/20" }, { "name": "where", "type": "object", "required": false, "description": "筛选条件,支持 keyword、status、current_task_id" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "拣货车列表,元素结构同 pickCart.detail 返回" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息,包含 page、pageSize、total、totalPages" } ] }, { "moduleName": "拣货车模块", "moduleKey": "pickCart", "moduleFolder": "pickcart", "method": "pickCart.scan", "title": "按拣货车条码/编码查询拣货车信息,供 PDA 扫码后用于拣货任务绑定。", "description": "按拣货车条码/编码查询拣货车信息,供 PDA 扫码后用于拣货任务绑定。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "cart_code", "type": "string", "required": true, "description": "拣货车条码/编码" } ], "response": [ { "name": "cart_id", "type": "number", "required": true, "description": "拣货车ID" }, { "name": "warehouse_id", "type": "number", "required": true, "description": "仓库ID" }, { "name": "cart_code", "type": "string", "required": true, "description": "拣货车编码" }, { "name": "cart_name", "type": "string", "required": false, "description": "拣货车名称" }, { "name": "status", "type": "number", "required": true, "description": "拣货车状态:0-停用 1-启用" }, { "name": "current_task_id", "type": "number", "required": false, "description": "当前绑定任务ID,无绑定时为 null" }, { "name": "current_task_no", "type": "string", "required": false, "description": "当前绑定任务编号,无绑定时为 null" } ] }, { "moduleName": "拣货车模块", "moduleKey": "pickCart", "moduleFolder": "pickcart", "method": "pickCart.update", "title": "更新拣货车。支持修改编码、名称、状态;若修改后的编码与当前仓库内其他拣货车重复则拦截。", "description": "更新拣货车。支持修改编码、名称、状态;若修改后的编码与当前仓库内其他拣货车重复则拦截。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "cart_id", "type": "number", "required": true, "description": "拣货车ID" }, { "name": "cart_code", "type": "string", "required": false, "description": "新的拣货车编码" }, { "name": "cart_name", "type": "string", "required": false, "description": "新的拣货车名称" }, { "name": "status", "type": "number", "required": false, "description": "新的状态:0-停用 1-启用" } ], "response": [ { "name": "cart_id", "type": "number", "required": true, "description": "拣货车ID" }, { "name": "cart_code", "type": "string", "required": true, "description": "拣货车编码" }, { "name": "cart_name", "type": "string", "required": false, "description": "拣货车名称" }, { "name": "status", "type": "number", "required": true, "description": "状态:0-停用 1-启用" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.add", "title": "新增打印台:关联打印电脑并可保存 subject_config(会由模型 normalizeSubjectConfig 校验)。", "description": "新增打印台:关联打印电脑并可保存 subject_config(会由模型 normalizeSubjectConfig 校验)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "computer_id", "type": "number", "required": true, "description": "关联的打印电脑 ID(必填)" }, { "name": "name", "type": "string", "required": true, "description": "打印台名称(必填)" }, { "name": "custom_barcode", "type": "string", "required": false, "description": "自定义条码" }, { "name": "default_printer_name", "type": "string", "required": false, "description": "默认打印机名称" }, { "name": "subject_config", "type": "object", "required": false, "description": "打印台的主题/业务配置(可选,若存在将调用模型 normalizeSubjectConfig 进行校验)" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "新建的打印台对象(raw)" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.del", "title": "批量删除(软删除)打印台:将指定 ids 的记录标记为 deleted=1。", "description": "批量删除(软删除)打印台:将指定 ids 的记录标记为 deleted=1。", "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 数组,必须为非空数组(示例: [1,2,3])" } ], "response": [ { "name": "data", "type": "object", "required": false, "description": "返回空数据结构,表示操作成功" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.getComputer", "title": "查询当前仓库下状态为 1 的打印电脑列表(raw 列表)。", "description": "查询当前仓库下状态为 1 的打印电脑列表(raw 列表)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [ { "name": "data", "type": "array", "required": true, "description": "打印电脑数组,每项为打印电脑的原始记录" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.getComputerPrinter", "title": "获取指定打印电脑的打印机列表(从 redis: printer:{id}:printerList 读取并返回 data 数组,通常为打印机名称数组或对象数组)。", "description": "获取指定打印电脑的打印机列表(从 redis: printer:{id}:printerList 读取并返回 data 数组,通常为打印机名称数组或对象数组)。", "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,必填" } ], "response": [ { "name": "data", "type": "array", "required": true, "description": "打印机数组,通常为字符串名称数组或打印机对象数组(取决于 redis 存储格式)" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.getItem", "title": "查询单个打印台详情,返回打印台对象(raw 行记录,含 subject_config)", "description": "查询单个打印台详情,返回打印台对象(raw 行记录,含 subject_config)", "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,必填" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "打印台原始记录(PrintStation raw),字段示例" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.getList", "title": "查询当前仓库下的打印台列表,支持分页与 where 条件筛选(支持字段:id、name、computer_id、custom_barcode)。", "description": "查询当前仓库下的打印台列表,支持分页与 where 条件筛选(支持字段:id、name、computer_id、custom_barcode)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "page", "type": "number", "required": false, "description": "页码,默认 1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量,默认 20" }, { "name": "where", "type": "object", "required": false, "description": "筛选条件对象;支持字段:id(等值)、name、computer_id、custom_barcode;推荐使用 { operator, value, type } 标准结构" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "返回数据对象,包含 list 与 pagination" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.getPrintRecordItem", "title": "print.getPrintRecordItem 接口", "description": "print.getPrintRecordItem 接口", "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 参数" } ], "response": [] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.getPrintResult", "title": "print.getPrintResult 接口", "description": "print.getPrintResult 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "printId", "type": "string", "required": true, "description": "printId 参数" } ], "response": [] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.hasName", "title": "print.hasName 接口", "description": "print.hasName 接口", "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": "id", "type": "number", "required": false, "description": "id 参数" } ], "response": [] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.notify_lock", "title": "兼容别名(等价转调到 print.notifyLock);建议使用 print.notifyLock。", "description": "兼容别名(等价转调到 print.notifyLock);建议使用 print.notifyLock。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.notifyLock", "title": "仅执行订单锁定流程,不发送打印任务;记录打印任务日志并写入订单操作日志。兼容别名:print.notify_lock(等价转调)。", "description": "仅执行订单锁定流程,不发送打印任务;记录打印任务日志并写入订单操作日志。兼容别名:print.notify_lock(等价转调)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "order_ids", "type": "array", "required": false, "description": "订单 ID 数组(与 orderIds 互为别名)。至少需提供 order_ids/orderIds/waveGroups/data.waveGroups 中的一类以提取订单 ID。" }, { "name": "orderIds", "type": "array", "required": false, "description": "订单 ID 数组(驼峰兼容,等同于 order_ids)。" }, { "name": "waveGroups", "type": "array", "required": false, "description": "波次分组结构(可从中提取订单 ID,参考 order.print.getWavePlatformPrintData 返回的 waveGroups)。" }, { "name": "data", "type": "object", "required": false, "description": "兼容包装对象;若传入 data.waveGroups,可从中提取订单 ID。" } ], "response": [ { "name": "locked_count", "type": "number", "required": false, "description": "成功锁定的订单数量" }, { "name": "order_ids_count", "type": "number", "required": false, "description": "请求中识别出的订单 ID 数量" }, { "name": "order_ids", "type": "array", "required": false, "description": "本次尝试锁定的订单 ID 列表" }, { "name": "source", "type": "string", "required": false, "description": "操作来源标识(可选,若后端返回则提供具体来源)" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.retryFailed", "title": "失败项补打:重试指定打印记录的发送。被定时任务 print-retry-compensation 调用以批量触发失败项补打。", "description": "失败项补打:重试指定打印记录的发送。被定时任务 print-retry-compensation 调用以批量触发失败项补打。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "print_ids", "type": "array", "required": true, "description": "要补打的打印记录 ID 数组" }, { "name": "force", "type": "boolean", "required": false, "description": "是否强制补打(当前实现仍不放宽状态判定)" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "显式指定仓库 ID(调度任务推荐提供),若缺失将使用当前用户的 store_id" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "调用标识,成功为 success" }, { "name": "code", "type": "number", "required": true, "description": "业务状态码,成功通常为 200" }, { "name": "message", "type": "string", "required": true, "description": "返回信息" }, { "name": "success_count", "type": "number", "required": false, "description": "成功补打数量" }, { "name": "failed_count", "type": "number", "required": false, "description": "补打失败数量" }, { "name": "skipped_count", "type": "number", "required": false, "description": "被跳过的记录数量" }, { "name": "retried", "type": "array", "required": false, "description": "补打尝试结果数组" }, { "name": "skipped", "type": "array", "required": false, "description": "跳过项明细" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.savePrinters", "title": "保存 default_printer_name 与 subject_config.express_bind_printer。", "description": "保存 default_printer_name 与 subject_config.express_bind_printer。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "defaultPrinter", "type": "string", "required": true, "description": "默认打印机名称(必填),会写入打印台的 `default_printer_name` 字段" }, { "name": "express", "type": "array", "required": true, "description": "快递与打印机绑定数组(必填)。每项应包含首选字段 `express_code`(string)和 `printer_name`(string)。为兼容历史字段,也接受 `express_id`(可映射为 `express_code`)和 `name`(可映射为 `printer_name`)。接口实现会将结果序列化后写入打印台的 `subject_config.express_bind_printer`。" }, { "name": "print_station_id", "type": "number", "required": true, "description": "目标打印台 ID(必填)。接口会根据此 ID 更新对应打印台记录的 default_printer_name 与 subject_config.express_bind_printer" } ], "response": [ { "name": "data", "type": "object", "required": false, "description": "成功不返回业务数据,语义为成功(实现中返回 { data: null, code: 0 })" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.send", "title": "发送打印任务到打印电脑,并记录打印单。说明:当 type=express 时,接口按 data.waveGroups(来源于 order.print.getWavePlatformPrintData 返回的 data.waveGroups)进行处理,按 waveGroups -> platforms 串行处理,每个平台+快递 组分别发送;返回沿用现有简要风格,不返回明细。接口在记录打印单的同时,也会写入订单操作日志(记录打印相关操作)。", "description": "发送打印任务到打印电脑,并记录打印单。说明:当 type=express 时,接口按 data.waveGroups(来源于 order.print.getWavePlatformPrintData 返回的 data.waveGroups)进行处理,按 waveGroups -> platforms 串行处理,每个平台+快递 组分别发送;返回沿用现有简要风格,不返回明细。接口在记录打印单的同时,也会写入订单操作日志(记录打印相关操作)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "computerId", "type": "string", "required": false, "description": "打印电脑 ID;历史/customize 分支可能使用。注意:type=express 场景下不适用(该字段不再作为 express 路径的必填或传输约束)。" }, { "name": "count", "type": "number", "required": false, "description": "打印份数;对 type=customize 有效。type=express 场景下不保留,相应字段会被忽略。" }, { "name": "data", "type": "object", "required": true, "description": "打印业务数据对象。对于 type=express:必须提供 data.waveGroups(来源于 order.print.getWavePlatformPrintData 的返回值 data.waveGroups),接口按 waveGroups->platforms 串行处理,每个 平台+快递 组分别发送;对于 type=customize,data 的具体字段由模板决定。" }, { "name": "printer", "type": "string", "required": false, "description": "打印机名称;type=customize 使用。type=express 下忽略(由快递平台/站点决定打印目标)。" }, { "name": "template", "type": "object", "required": false, "description": "打印模板对象;仅 type=customize 时必填且应包含 page_width、page_height、template_content。type=express 场景下忽略 template 字段。" }, { "name": "timestamp", "type": "string", "required": false, "description": "业务时间戳;历史字段。type=express 场景下不适用。" }, { "name": "type", "type": "string", "required": true, "description": "打印类型;支持 customize、express。对于 express 场景,必须遵守下列额外约束:提供 printStationId、requestCode,并在 data.waveGroups 中传入来自 order.print.getWavePlatformPrintData 的 waveGroups 数据。" }, { "name": "printStationId", "type": "string", "required": true, "description": "打印站点/工作站标识(必填,type=express 时必须提供),用于指示目标打印站或分发单元。" }, { "name": "requestCode", "type": "string", "required": true, "description": "请求去重/防重放 ID(必填,type=express 时必须提供)。接口约束:requestCode 在约定周期内不得变更(例如一次批次/会话期间),系统在同一次请求处理范围内保证对重复 requestCode 进行防重放处理;此保护仅保证同一次请求内的去重/防重放,不等同于跨请求的强幂等保证。" } ], "response": [ { "name": "flag", "type": "string", "required": false, "description": "全局调用结果标识,成功时为 success,失败时为 failure" }, { "name": "code", "type": "number", "required": false, "description": "业务状态码;成功时为 200,失败时通常为 1001 或 504" }, { "name": "message", "type": "string", "required": false, "description": "返回信息" }, { "name": "printId", "type": "number", "required": false, "description": "打印记录 ID;任务入库成功后返回,失败时若已生成记录也会返回。接口在 express 场景下不返回明细结果,只给出调用结果摘要。" } ] }, { "moduleName": "打印模块", "moduleKey": "print", "moduleFolder": "print", "method": "print.updateItem", "title": "更新打印台信息:支持更新 name、computer_id、custom_barcode、default_printer_name 以及 subject_config(会走 normalizeSubjectConfig)。", "description": "更新打印台信息:支持更新 name、computer_id、custom_barcode、default_printer_name 以及 subject_config(会走 normalizeSubjectConfig)。", "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": "computer_id", "type": "number", "required": false, "description": "要更新的打印电脑 ID" }, { "name": "custom_barcode", "type": "string", "required": false, "description": "自定义条码" }, { "name": "name", "type": "string", "required": false, "description": "打印台名称" }, { "name": "default_printer_name", "type": "string", "required": false, "description": "默认打印机名称" }, { "name": "subject_config", "type": "object", "required": false, "description": "subject_config(可选),传入将替换/规范化配置" } ], "response": [ { "name": "data", "type": "object", "required": false, "description": "更新结果,通常返回 null" } ] }, { "moduleName": "打印机站点模块", "moduleKey": "printer.station", "moduleFolder": "printer.station", "method": "printer.station.list", "title": "获取打印站点列表", "description": "获取打印站点列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "账号管理模块", "moduleKey": "setting.account", "moduleFolder": "setting.account", "method": "setting.account.add", "title": "新增工号,按手机号复用或创建账号后绑定到当前主体", "description": "新增工号,按手机号复用或创建账号后绑定到当前主体", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "phone", "type": "string", "required": true, "description": "手机号,作为账号复用/创建依据" }, { "name": "real_name", "type": "string", "required": true, "description": "工号姓名,新增时禁止直接使用保留名称" }, { "name": "username", "type": "string", "required": false, "description": "新账号用户名,不传时系统自动生成" }, { "name": "password", "type": "string", "required": false, "description": "新账号密码,不传默认 111111" }, { "name": "role_id", "type": "number", "required": false, "description": "工号角色,不传时继承当前操作人工号角色" }, { "name": "email", "type": "string", "required": false, "description": "新账号邮箱,不传时按 username 自动生成" } ], "response": [ { "name": "employee_id", "type": "number", "required": true, "description": "新增或复用后的工号ID" }, { "name": "account_id", "type": "number", "required": true, "description": "绑定账号ID" }, { "name": "role_id", "type": "number", "required": true, "description": "绑定后的角色ID" }, { "name": "is_new_account", "type": "boolean", "required": true, "description": "是否为本次新建账号" }, { "name": "phone", "type": "string", "required": true, "description": "绑定账号手机号" }, { "name": "username", "type": "string", "required": true, "description": "绑定账号用户名" } ] }, { "moduleName": "账号管理模块", "moduleKey": "setting.account", "moduleFolder": "setting.account", "method": "setting.account.delete", "title": "删除工号绑定关系,仅停用工号,不删除账号", "description": "删除工号绑定关系,仅停用工号,不删除账号", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "employee_id", "type": "number", "required": true, "description": "要删除的工号ID" } ], "response": [ { "name": "employee_id", "type": "number", "required": true, "description": "被停用的工号ID" }, { "name": "account_id", "type": "number", "required": true, "description": "关联账号ID" }, { "name": "status", "type": "string", "required": true, "description": "固定返回 deleted" }, { "name": "already_deleted", "type": "boolean", "required": false, "description": "可选,true 表示该工号原本已停用" } ] }, { "moduleName": "账号管理模块", "moduleKey": "setting.account", "moduleFolder": "setting.account", "method": "setting.account.getBindWechatCode", "title": "为指定工号账号获取微信绑定码", "description": "为指定工号账号获取微信绑定码", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "account_id", "type": "number", "required": true, "description": "目标账号ID,兼容 user_id / id" }, { "name": "longPoll", "type": "boolean", "required": false, "description": "是否开启长轮询等待状态变化,最长60秒" }, { "name": "waitTimeoutMs", "type": "number", "required": false, "description": "等待超时毫秒数,后端自动封顶60000" } ], "response": [] }, { "moduleName": "账号管理模块", "moduleKey": "setting.account", "moduleFolder": "setting.account", "method": "setting.account.list", "title": "查询当前主体下的工号基础信息列表", "description": "查询当前主体下的工号基础信息列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "status", "type": "number", "required": false, "description": "状态筛选,默认 1,仅查有效工号" }, { "name": "includeDisabled", "type": "boolean", "required": false, "description": "是否包含已删除工号" } ], "response": [ { "name": "data[]", "type": "object", "required": true, "description": "工号列表项" }, { "name": "data[].employee_id", "type": "number", "required": true, "description": "工号ID" }, { "name": "data[].account_id", "type": "number", "required": true, "description": "账号ID" }, { "name": "data[].store_id", "type": "number", "required": true, "description": "主体ID" }, { "name": "data[].real_name", "type": "string", "required": true, "description": "工号姓名" }, { "name": "data[].status", "type": "number", "required": true, "description": "工号状态:1=启用,0=停用" }, { "name": "data[].username", "type": "string", "required": true, "description": "账号用户名" }, { "name": "data[].phone", "type": "string", "required": true, "description": "账号手机号" }, { "name": "data[].email", "type": "string", "required": true, "description": "账号邮箱" }, { "name": "data[].avatar_file_id", "type": "number", "required": false, "description": "头像文件ID,为空表示未设置" }, { "name": "data[].avatar_url", "type": "string", "required": true, "description": "头像访问地址" } ] }, { "moduleName": "账号管理模块", "moduleKey": "setting.account", "moduleFolder": "setting.account", "method": "setting.account.unbindWechat", "title": "为指定工号账号解绑微信", "description": "为指定工号账号解绑微信", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "account_id", "type": "number", "required": true, "description": "目标账号ID,兼容 user_id / id" } ], "response": [] }, { "moduleName": "账号管理模块", "moduleKey": "setting.account", "moduleFolder": "setting.account", "method": "setting.account.update", "title": "更新工号姓名和头像引用", "description": "更新工号姓名和头像引用", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "employee_id", "type": "number", "required": true, "description": "要更新的工号ID" }, { "name": "real_name", "type": "string", "required": false, "description": "更新后的工号姓名" }, { "name": "file_id", "type": "number", "required": false, "description": "已有文件ID,作为头像引用" } ], "response": [ { "name": "employee_id", "type": "number", "required": true, "description": "更新后的工号ID" }, { "name": "real_name", "type": "string", "required": true, "description": "更新后的工号姓名" }, { "name": "avatar_file_id", "type": "number", "required": false, "description": "更新后的头像文件ID" }, { "name": "avatar_url", "type": "string", "required": true, "description": "更新后的头像地址" } ] }, { "moduleName": "快递编码管理模块", "moduleKey": "setting.express", "moduleFolder": "setting.express", "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": [] }, { "moduleName": "快递编码管理模块", "moduleKey": "setting.express", "moduleFolder": "setting.express", "method": "setting.express.create", "title": "创建快递映射,仅写入已实现字段(code、name、express_code 等)", "description": "创建快递映射,仅写入已实现字段(code、name、express_code 等)", "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": "快递名称(最大 50 字符)" }, { "name": "express_code", "type": "string", "required": true, "description": "系统快递编码;同时支持驼峰写法 expressCode" } ], "response": [] }, { "moduleName": "快递编码管理模块", "moduleKey": "setting.express", "moduleFolder": "setting.express", "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'" } ] }, { "moduleName": "快递编码管理模块", "moduleKey": "setting.express", "moduleFolder": "setting.express", "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": [] }, { "moduleName": "快递编码管理模块", "moduleKey": "setting.express", "moduleFolder": "setting.express", "method": "setting.express.listBase", "title": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)", "description": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [], "response": [] }, { "moduleName": "快递编码管理模块", "moduleKey": "setting.express", "moduleFolder": "setting.express", "method": "setting.express.update", "title": "更新快递映射。必须提供 `id`(必填),且至少提供 `code`、`name` 或 `express_code` 中的一个用于更新;同时支持 `expressCode` 驼峰写法。", "description": "更新快递映射。必须提供 `id`(必填),且至少提供 `code`、`name` 或 `express_code` 中的一个用于更新;同时支持 `expressCode` 驼峰写法。", "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;也兼容别名 `setting_id` / `settingId`" }, { "name": "code", "type": "string", "required": false, "description": "快递映射编码(最大 50 字符,接口会大写化并校验在当前仓库的唯一性)" }, { "name": "name", "type": "string", "required": false, "description": "快递名称(最大 50 字符)" }, { "name": "express_code", "type": "string", "required": false, "description": "系统快递编码(必须为系统已存在的编码);支持 `expressCode` 驼峰写法" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "更新后的快递映射对象(规范化字段)" } ] }, { "moduleName": "快递接口管理模块", "moduleKey": "setting.expressInterface", "moduleFolder": "setting.expressinterface", "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 处理" }, { "name": "address", "type": "string", "required": false, "description": "发件人详细地址(可选),使用 index.getShopExpressList 返回的 detail 字段值,非 full_address" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "新建记录 ID" } ] }, { "moduleName": "快递接口管理模块", "moduleKey": "setting.expressInterface", "moduleFolder": "setting.expressinterface", "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" } ] }, { "moduleName": "快递接口管理模块", "moduleKey": "setting.expressInterface", "moduleFolder": "setting.expressinterface", "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" } ] }, { "moduleName": "快递接口管理模块", "moduleKey": "setting.expressInterface", "moduleFolder": "setting.expressinterface", "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 全量返回,不分页),每项包含以下字段:" } ] }, { "moduleName": "快递接口管理模块", "moduleKey": "setting.expressInterface", "moduleFolder": "setting.expressinterface", "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" }, { "name": "address", "type": "string", "required": false, "description": "发件人详细地址(可选),使用 index.getShopExpressList 返回的 detail 字段值,非 full_address" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "id" } ] }, { "moduleName": "包材管理模块", "moduleKey": "setting.packageMaterial", "moduleFolder": "setting.packagematerial", "method": "setting.packageMaterial.create", "title": "创建包材(当前仓库范围)", "description": "创建包材(当前仓库范围)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "material_code", "type": "string", "required": true, "description": "包材编码(大写且在当前仓库唯一)" }, { "name": "material_name", "type": "string", "required": true, "description": "包材名称" }, { "name": "material_type", "type": "string", "required": false, "description": "包材类型" }, { "name": "spec", "type": "string", "required": false, "description": "规格" }, { "name": "length", "type": "number", "required": false, "description": "长度" }, { "name": "width", "type": "number", "required": false, "description": "宽度" }, { "name": "height", "type": "number", "required": false, "description": "高度" }, { "name": "weight", "type": "number", "required": false, "description": "重量" }, { "name": "cost_price", "type": "number", "required": false, "description": "成本价" }, { "name": "status", "type": "number", "required": false, "description": "状态 0/1,默认 1" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "包材 ID" } ] }, { "moduleName": "包材管理模块", "moduleKey": "setting.packageMaterial", "moduleFolder": "setting.packagematerial", "method": "setting.packageMaterial.delete", "title": "删除包材(支持 ids 数组或逗号分隔字符串,兼容 id/material_id/materialId)", "description": "删除包材(支持 ids 数组或逗号分隔字符串,兼容 id/material_id/materialId)", "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|number|string", "required": true, "description": "要删除的 ID 列表" } ], "response": [ { "name": "deleted", "type": "boolean", "required": true, "description": "是否删除成功" } ] }, { "moduleName": "包材管理模块", "moduleKey": "setting.packageMaterial", "moduleFolder": "setting.packagematerial", "method": "setting.packageMaterial.get", "title": "查询包材列表,支持 where + pagination(兼容旧别名 list,建议使用 get)", "description": "查询包材列表,支持 where + pagination(兼容旧别名 list,建议使用 get)", "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" }, { "name": "where", "type": "object", "required": false, "description": "筛选条件,支持 material_code/material_name/material_type/status/quickWhere" } ], "response": [ { "name": "page", "type": "number", "required": true, "description": "当前页" }, { "name": "page_size", "type": "number", "required": true, "description": "每页大小" }, { "name": "total", "type": "number", "required": true, "description": "总数" }, { "name": "list", "type": "array", "required": true, "description": "包材项数组" } ] }, { "moduleName": "包材管理模块", "moduleKey": "setting.packageMaterial", "moduleFolder": "setting.packagematerial", "method": "setting.packageMaterial.list", "title": "兼容旧称 list,内部转发至 get;建议改用 setting.packageMaterial.get", "description": "兼容旧称 list,内部转发至 get;建议改用 setting.packageMaterial.get", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "包材管理模块", "moduleKey": "setting.packageMaterial", "moduleFolder": "setting.packagematerial", "method": "setting.packageMaterial.search", "title": "包材关键字搜索,按 material_code / material_name 模糊匹配,最多返回 50 条(仅返回启用中的包材)", "description": "包材关键字搜索,按 material_code / material_name 模糊匹配,最多返回 50 条(仅返回启用中的包材)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "keyword", "type": "string", "required": false, "description": "搜索关键字,模糊匹配 material_code、material_name;为空时返回前 50 条启用中的包材" } ], "response": [ { "name": "data[]", "type": "array", "required": true, "description": "包材列表,每项包含 id(包材ID)、material_code(包材编码)、material_name(包材名称)、material_type(包材类型)、spec(规格)、status(状态)" } ] }, { "moduleName": "包材管理模块", "moduleKey": "setting.packageMaterial", "moduleFolder": "setting.packagematerial", "method": "setting.packageMaterial.update", "title": "更新包材(按 id 更新,支持部分字段)", "description": "更新包材(按 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(也兼容 material_id/materialId)" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "包材 ID" } ] }, { "moduleName": "package-supplier-module", "moduleKey": "setting.packageSupplier", "moduleFolder": "setting.packagesupplier", "method": "setting.packageSupplier.create", "title": "Create package supplier (current warehouse scope)", "description": "Create package supplier (current warehouse scope)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "supplier_code", "type": "string", "required": true, "description": "Supplier code (uppercased, unique in warehouse)" }, { "name": "supplier_name", "type": "string", "required": true, "description": "Supplier name" }, { "name": "contact_name", "type": "string", "required": false, "description": "Contact name" }, { "name": "contact_phone", "type": "string", "required": false, "description": "Contact phone" }, { "name": "status", "type": "number", "required": false, "description": "Status 0/1, default 1" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "Created supplier id" } ] }, { "moduleName": "package-supplier-module", "moduleKey": "setting.packageSupplier", "moduleFolder": "setting.packagesupplier", "method": "setting.packageSupplier.delete", "title": "Delete package suppliers (supports ids array or comma-separated string)", "description": "Delete package suppliers (supports ids array or comma-separated string)", "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|number|string", "required": true, "description": "IDs to delete" } ], "response": [ { "name": "deleted", "type": "boolean", "required": true, "description": "Deleted flag" } ] }, { "moduleName": "package-supplier-module", "moduleKey": "setting.packageSupplier", "moduleFolder": "setting.packagesupplier", "method": "setting.packageSupplier.get", "title": "Get package supplier list (supports where + pagination). list is an alias to get; prefer get.", "description": "Get package supplier list (supports where + pagination). list is an alias to get; prefer get.", "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 parameters" }, { "name": "where", "type": "object", "required": false, "description": "Filter conditions" } ], "response": [ { "name": "page", "type": "number", "required": true, "description": "Current page" }, { "name": "page_size", "type": "number", "required": true, "description": "Page size" }, { "name": "total", "type": "number", "required": true, "description": "Total" }, { "name": "list", "type": "array", "required": true, "description": "Supplier array" } ] }, { "moduleName": "package-supplier-module", "moduleKey": "setting.packageSupplier", "moduleFolder": "setting.packagesupplier", "method": "setting.packageSupplier.list", "title": "Compatibility alias for get; internally forwards to get. Prefer setting.packageSupplier.get.", "description": "Compatibility alias for get; internally forwards to get. Prefer setting.packageSupplier.get.", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "package-supplier-module", "moduleKey": "setting.packageSupplier", "moduleFolder": "setting.packagesupplier", "method": "setting.packageSupplier.update", "title": "Update package supplier by id (partial update supported)", "description": "Update package supplier by id (partial update supported)", "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": "Supplier id (also supports supplier_id / supplierId)" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "Supplier id" } ] }, { "moduleName": "权限管理模块", "moduleKey": "setting.permission", "moduleFolder": "setting.permission", "method": "setting.permission.add", "title": "新增权限节点", "description": "新增权限节点", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "path", "type": "string", "required": true, "description": "权限路径" }, { "name": "type", "type": "string", "required": true, "description": "权限类型" }, { "name": "name", "type": "string", "required": false, "description": "权限名称" }, { "name": "parent_id", "type": "number", "required": false, "description": "父级权限ID" } ], "response": [] }, { "moduleName": "权限管理模块", "moduleKey": "setting.permission", "moduleFolder": "setting.permission", "method": "setting.permission.delete", "title": "批量停用权限节点", "description": "批量停用权限节点", "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数组" } ], "response": [] }, { "moduleName": "权限管理模块", "moduleKey": "setting.permission", "moduleFolder": "setting.permission", "method": "setting.permission.list", "title": "查询权限树/权限列表,可附带指定角色的选中状态", "description": "查询权限树/权限列表,可附带指定角色的选中状态", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "role_id", "type": "number", "required": false, "description": "角色ID;传入后返回 selected 标记" }, { "name": "type", "type": "string", "required": false, "description": "权限类型筛选:web_pages/pda_pages/btns/api/miniprogram_pages/block" }, { "name": "keyword", "type": "string", "required": false, "description": "关键字模糊搜索 path/name/meta_title" }, { "name": "includeDisabled", "type": "boolean", "required": false, "description": "是否包含已停用权限" } ], "response": [] }, { "moduleName": "权限管理模块", "moduleKey": "setting.permission", "moduleFolder": "setting.permission", "method": "setting.permission.update", "title": "更新权限节点信息", "description": "更新权限节点信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "permission_id", "type": "number", "required": true, "description": "权限ID" } ], "response": [] }, { "moduleName": "平台编码管理模块", "moduleKey": "setting.platform", "moduleFolder": "setting.platform", "method": "setting.platform.create", "title": "创建当前仓库范围的平台设置", "description": "创建当前仓库范围的平台设置", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "平台编码管理模块", "moduleKey": "setting.platform", "moduleFolder": "setting.platform", "method": "setting.platform.delete", "title": "删除当前仓库范围的平台设置", "description": "删除当前仓库范围的平台设置", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "平台编码管理模块", "moduleKey": "setting.platform", "moduleFolder": "setting.platform", "method": "setting.platform.list", "title": "查询当前仓库范围的平台设置列表", "description": "查询当前仓库范围的平台设置列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "平台编码管理模块", "moduleKey": "setting.platform", "moduleFolder": "setting.platform", "method": "setting.platform.update", "title": "更新当前仓库范围的平台设置", "description": "更新当前仓库范围的平台设置", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "打印模板模块", "moduleKey": "setting.printTemplate", "moduleFolder": "setting.printtemplate", "method": "setting.printTemplate.create", "title": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)", "description": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "template_name", "type": "string", "required": true, "description": "模板名称" }, { "name": "business_type", "type": "string", "required": true, "description": "业务类型" }, { "name": "page_width", "type": "number", "required": true, "description": "页面宽度(mm)" }, { "name": "page_height", "type": "number", "required": true, "description": "页面高度(mm)" }, { "name": "template_content", "type": "array", "required": false, "description": "模板内容,可省略;省略时默认创建空模板内容" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "新建模板ID" } ] }, { "moduleName": "打印模板模块", "moduleKey": "setting.printTemplate", "moduleFolder": "setting.printtemplate", "method": "setting.printTemplate.delete", "title": "删除打印模板(软删除)", "description": "删除打印模板(软删除)", "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" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "删除的模板ID" } ] }, { "moduleName": "打印模板模块", "moduleKey": "setting.printTemplate", "moduleFolder": "setting.printtemplate", "method": "setting.printTemplate.list", "title": "获取打印模板树", "description": "获取打印模板树", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "打印模板模块", "moduleKey": "setting.printTemplate", "moduleFolder": "setting.printtemplate", "method": "setting.printTemplate.listTemplatesByType", "title": "按业务类型查询模板", "description": "按业务类型查询模板", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "businessType", "type": "string", "required": true, "description": "businessType 参数" } ], "response": [] }, { "moduleName": "打印模板模块", "moduleKey": "setting.printTemplate", "moduleFolder": "setting.printtemplate", "method": "setting.printTemplate.save", "title": "保存打印模板", "description": "保存打印模板", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "角色管理模块", "moduleKey": "setting.role", "moduleFolder": "setting.role", "method": "setting.role.add", "title": "新增角色并绑定权限集合", "description": "新增角色并绑定权限集合", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "role_code", "type": "string", "required": true, "description": "角色编码" }, { "name": "role_name", "type": "string", "required": true, "description": "角色名称" }, { "name": "permission_ids", "type": "array", "required": true, "description": "权限ID数组,支持 [\"*\"]" }, { "name": "pid", "type": "number", "required": false, "description": "父角色ID" } ], "response": [] }, { "moduleName": "角色管理模块", "moduleKey": "setting.role", "moduleFolder": "setting.role", "method": "setting.role.delete", "title": "批量停用角色", "description": "批量停用角色", "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数组" } ], "response": [] }, { "moduleName": "角色管理模块", "moduleKey": "setting.role", "moduleFolder": "setting.role", "method": "setting.role.list", "title": "获取当前主体可管理的角色树", "description": "获取当前主体可管理的角色树", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "includeDisabled", "type": "boolean", "required": false, "description": "是否包含已停用角色" }, { "name": "includeSystem", "type": "boolean", "required": false, "description": "是否包含系统角色域" } ], "response": [] }, { "moduleName": "角色管理模块", "moduleKey": "setting.role", "moduleFolder": "setting.role", "method": "setting.role.permission", "title": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)", "description": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "role_id", "type": "number", "required": false, "description": "角色ID" } ], "response": [] }, { "moduleName": "角色管理模块", "moduleKey": "setting.role", "moduleFolder": "setting.role", "method": "setting.role.update", "title": "更新角色信息并重设权限集合", "description": "更新角色信息并重设权限集合", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "role_id", "type": "number", "required": true, "description": "角色ID" }, { "name": "permission_ids", "type": "array", "required": true, "description": "权限ID数组,角色权限需一次性提交" } ], "response": [] }, { "moduleName": "仓库设置模块", "moduleKey": "setting.warehouse", "moduleFolder": "setting.warehouse", "method": "setting.warehouse.getFieldMeta", "title": "获取仓库设置字段元信息", "description": "获取仓库设置字段元信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [ { "name": "list", "type": "array", "required": false, "description": "字段元信息数组" } ] }, { "moduleName": "仓库设置模块", "moduleKey": "setting.warehouse", "moduleFolder": "setting.warehouse", "method": "setting.warehouse.getSettings", "title": "获取当前登录仓库的 subject_config", "description": "获取当前登录仓库的 subject_config", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [ { "name": "warehouse_id", "type": "number", "required": true, "description": "仓库 ID" }, { "name": "subject_config", "type": "object", "required": true, "description": "仓库的 subject_config 配置对象" }, { "name": "subject_config.enable_external_express_code", "type": "boolean", "required": true, "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" }, { "name": "subject_config.auto_outbound_rules", "type": "object", "required": true, "description": "自动出库规则配置。全部条件满足时自动标记待出库" }, { "name": "subject_config.auto_outbound_rules.enabled", "type": "boolean", "required": true, "description": "是否启用自动出库,默认 false" }, { "name": "subject_config.auto_outbound_rules.require_recheck", "type": "boolean", "required": true, "description": "是否要求已复核(recheck_status=fin),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_pack", "type": "boolean", "required": true, "description": "是否要求已打包(pack_status=fin),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_weigh", "type": "boolean", "required": true, "description": "是否要求已称重(weighing_weight>0),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_sync", "type": "boolean", "required": true, "description": "是否要求已同步(sync_status=fin),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_print", "type": "boolean", "required": true, "description": "是否要求已打印(print_status=fin),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_pick", "type": "boolean", "required": true, "description": "是否要求已拣货(pick_status=fin),默认 true" } ] }, { "moduleName": "仓库设置模块", "moduleKey": "setting.warehouse", "moduleFolder": "setting.warehouse", "method": "setting.warehouse.saveSettings", "title": "修改仓库设置并清理指定仓库缓存", "description": "修改仓库设置并清理指定仓库缓存", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "subject_config", "type": "object", "required": true, "description": "仓库的 subject_config 对象" }, { "name": "cache_warehouse_id", "type": "number", "required": false, "description": "需清理缓存的仓库 ID(下划线命名兼容)" }, { "name": "cacheWarehouseId", "type": "number", "required": false, "description": "需清理缓存的仓库 ID(驼峰命名兼容)" }, { "name": "subject_config.enable_external_express_code", "type": "boolean", "required": false, "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" }, { "name": "subject_config.auto_outbound_rules", "type": "object", "required": false, "description": "自动出库规则配置。全部条件满足时自动标记待出库" }, { "name": "subject_config.auto_outbound_rules.enabled", "type": "boolean", "required": false, "description": "是否启用自动出库,默认 false" }, { "name": "subject_config.auto_outbound_rules.require_recheck", "type": "boolean", "required": false, "description": "是否要求已复核(recheck_status=fin),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_pack", "type": "boolean", "required": false, "description": "是否要求已打包(pack_status=fin),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_weigh", "type": "boolean", "required": false, "description": "是否要求已称重(weighing_weight>0),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_sync", "type": "boolean", "required": false, "description": "是否要求已同步(sync_status=fin),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_print", "type": "boolean", "required": false, "description": "是否要求已打印(print_status=fin),默认 true" }, { "name": "subject_config.auto_outbound_rules.require_pick", "type": "boolean", "required": false, "description": "是否要求已拣货(pick_status=fin),默认 true" } ], "response": [ { "name": "warehouse_id", "type": "number", "required": true, "description": "生效的仓库 ID" }, { "name": "subject_config", "type": "object", "required": true, "description": "保存后的 subject_config" }, { "name": "cache_cleared_warehouse_id", "type": "number", "required": true, "description": "被清理缓存的仓库 ID(若未清理则为 null)" }, { "name": "subject_config.enable_external_express_code", "type": "boolean", "required": true, "description": "保存后的 subject_config.enable_external_express_code 值" } ] }, { "moduleName": "店铺模块", "moduleKey": "shops", "moduleFolder": "shops", "method": "shops.add", "title": "新增店铺,校验 platform_code 必须匹配已配置且处于 ACTIVE 且未删除的打印平台;custom_name 必填且长度<=100。shop_name 由服务端生成待授权占位名(PENDING_*),授权后再同步真实店铺名。支持 snake_case 与 camelCase 入参兼容。", "description": "新增店铺,校验 platform_code 必须匹配已配置且处于 ACTIVE 且未删除的打印平台;custom_name 必填且长度<=100。shop_name 由服务端生成待授权占位名(PENDING_*),授权后再同步真实店铺名。支持 snake_case 与 camelCase 入参兼容。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "platform_code", "type": "string", "required": true, "description": "平台编码,兼容 platformCode,服务端会标准化为大写并验证" }, { "name": "custom_name", "type": "string", "required": true, "description": "店铺自定义名称,最大长度 100" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "success" }, { "name": "code", "type": "number", "required": true, "description": "200 成功" }, { "name": "message", "type": "string", "required": true, "description": "提示信息" }, { "name": "data.id", "type": "number", "required": true, "description": "新建店铺 ID" } ] }, { "moduleName": "店铺模块", "moduleKey": "shops", "moduleFolder": "shops", "method": "shops.del", "title": "软删除店铺:将 shop_name 修改为 DELETED_SHOP__ 并清空敏感字段;若存在 ExpressInterface 引用则返回 409;返回 deleted=true 与 id。", "description": "软删除店铺:将 shop_name 修改为 DELETED_SHOP__ 并清空敏感字段;若存在 ExpressInterface 引用则返回 409;返回 deleted=true 与 id。", "endpoint": "/system", "authRequired": true, "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,兼容 shop_id/shopId" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "success" }, { "name": "code", "type": "number", "required": true, "description": "200 成功" }, { "name": "message", "type": "string", "required": true, "description": "提示信息" }, { "name": "data.deleted", "type": "boolean", "required": true, "description": "是否已删除" }, { "name": "data.id", "type": "number", "required": true, "description": "删除的店铺 ID" } ] }, { "moduleName": "店铺模块", "moduleKey": "shops", "moduleFolder": "shops", "method": "shops.edit", "title": "编辑店铺,仅允许修改 platform_code 或 custom_name;至少传入其中一个。platform_code 会校验平台存在且为 ACTIVE;custom_name 必填且长度<=100;服务端兼容 snake_case/camelCase。", "description": "编辑店铺,仅允许修改 platform_code 或 custom_name;至少传入其中一个。platform_code 会校验平台存在且为 ACTIVE;custom_name 必填且长度<=100;服务端兼容 snake_case/camelCase。", "endpoint": "/system", "authRequired": true, "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,兼容 shop_id/shopId" }, { "name": "platform_code", "type": "string", "required": false, "description": "平台编码,兼容 platformCode,服务端会转为大写并校验" }, { "name": "custom_name", "type": "string", "required": false, "description": "自定义名称,兼容 customName,若传入需非空且 <=100 字符" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "success" }, { "name": "code", "type": "number", "required": true, "description": "200 成功" }, { "name": "message", "type": "string", "required": true, "description": "提示信息" }, { "name": "data.updated", "type": "boolean", "required": true, "description": "是否已更新" }, { "name": "data.id", "type": "number", "required": true, "description": "被更新的店铺 ID" } ] }, { "moduleName": "店铺模块", "moduleKey": "shops", "moduleFolder": "shops", "method": "shops.GetAuthorizeSessionKey", "title": "按店铺所属平台生成授权会话。入参兼容 id/shop_id/shopId 与 callbackurl/callback_url,callbackurl 必填。对已实现的平台(PDD/CAINIAO)返回 session_key/authorize_url/state,其他平台返回 501 未实现。", "description": "按店铺所属平台生成授权会话。入参兼容 id/shop_id/shopId 与 callbackurl/callback_url,callbackurl 必填。对已实现的平台(PDD/CAINIAO)返回 session_key/authorize_url/state,其他平台返回 501 未实现。", "endpoint": "/system", "authRequired": true, "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,兼容 shop_id/shopId" }, { "name": "callbackurl", "type": "string", "required": true, "description": "回调地址,兼容 callback_url" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "success" }, { "name": "code", "type": "number", "required": true, "description": "200 成功" }, { "name": "message", "type": "string", "required": true, "description": "提示信息" }, { "name": "data.shop_id", "type": "number", "required": true, "description": "店铺 ID" }, { "name": "data.platform_code", "type": "string", "required": true, "description": "平台编码(大写)" }, { "name": "data.callbackurl", "type": "string", "required": true, "description": "回调地址" }, { "name": "data.session_key", "type": "string", "required": true, "description": "授权预占码(session)" }, { "name": "data.authorize_url", "type": "string", "required": true, "description": "平台授权跳转地址(含 state)" }, { "name": "data.state", "type": "string", "required": true, "description": "内部 state 值(platform + '_' + authRandomCode),用于回调解析" } ] }, { "moduleName": "店铺模块", "moduleKey": "shops", "moduleFolder": "shops", "method": "shops.list", "title": "分页查询店铺,支持 where 条件(支持字段:id, platform_code, custom_name, shop_name, status, quickWhere),兼容 snake_case 与 camelCase 入参;返回分页信息与标准化店铺列表。", "description": "分页查询店铺,支持 where 条件(支持字段:id, platform_code, custom_name, shop_name, status, quickWhere),兼容 snake_case 与 camelCase 入参;返回分页信息与标准化店铺列表。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "page", "type": "number", "required": false, "description": "页码,兼容 pagination.page/currentPage" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页大小,兼容 page_size/pagination.page_size,最大 200" }, { "name": "where", "type": "object", "required": false, "description": "查询条件,支持标准 where 结构或 quickWhere 简写,字段兼容 id/platform_code/custom_name/shop_name/status/quickWhere" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "调用结果标识,成功为 success" }, { "name": "code", "type": "number", "required": true, "description": "业务状态码,成功为 200" }, { "name": "message", "type": "string", "required": true, "description": "提示信息" }, { "name": "data.list", "type": "array", "required": true, "description": "店铺数组,元素结构见 children" }, { "name": "data.pagination", "type": "object", "required": true, "description": "分页信息" } ] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.bindItem", "title": "绑定货主商品关系", "description": "绑定货主商品关系", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.checkItemCodeUnique", "title": "检测商品编码唯一性。在同一仓库和货主下,排除商品自身后,判断商品编码是否已存在于未删除商品中。", "description": "检测商品编码唯一性。在同一仓库和货主下,排除商品自身后,判断商品编码是否已存在于未删除商品中。", "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", "type": "number", "required": true, "description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id)" }, { "name": "item_code", "type": "string", "required": true, "description": "要检测的商品编码" }, { "name": "item_id", "type": "number", "required": false, "description": "当前商品ID(编辑场景用,排除自身);兼容字段名 id" }, { "name": "id", "type": "number", "required": false, "description": "兼容字段 id" }, { "name": "owner_id", "type": "number", "required": true, "description": "货主ID(对应表字段 store_id);兼容字段名 store_id" }, { "name": "store_id", "type": "number", "required": true, "description": "兼容字段 store_id" } ], "response": [ { "name": "unique", "type": "boolean", "required": false, "description": "true 表示编码唯一,false 表示已存在重复" }, { "name": "isUnique", "type": "boolean", "required": false, "description": "同 unique(兼容旧字段名)" }, { "name": "message", "type": "string", "required": false, "description": "重复时返回 '商品编码已存在',唯一时不返回该字段" } ] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.createProhibited", "title": "新增违禁品类型", "description": "新增违禁品类型", "endpoint": "/system", "authRequired": true, "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 参数" } ], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.createUnit", "title": "新增库存单位", "description": "新增库存单位", "endpoint": "/system", "authRequired": true, "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 参数" } ], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.createWarehouseStock", "title": "新建仓库商品资料", "description": "新建仓库商品资料", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.deleteProhibited", "title": "删除违禁品类型", "description": "删除违禁品类型", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.deleteUnit", "title": "删除库存单位", "description": "删除库存单位", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.export", "title": "提交导出任务,返回 task_id/status/progress/message/result/error/update_time", "description": "提交导出任务,返回 task_id/status/progress/message/result/error/update_time", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "where", "type": "object", "required": false, "description": "查询条件对象,与 stock.warehouse.list 的 where 语义一致;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数对象,支持 sortField/sortOrder 与 sort_field/sort_order 下划线别名兼容。" }, { "name": "sort.sortField", "type": "string", "required": false, "description": "排序字段(兼容 sort.sortField)。" }, { "name": "sort.sort_field", "type": "string", "required": false, "description": "排序字段下划线别名(兼容 sort.sort_field)。" }, { "name": "sort.sortOrder", "type": "string", "required": false, "description": "排序方向(ASC/DESC,大小写不敏感)。" }, { "name": "sort.sort_order", "type": "string", "required": false, "description": "排序方向下划线别名(兼容 sort.sort_order)。" } ], "response": [ { "name": "task_id", "type": "string", "required": false, "description": "任务 ID(后端生成的唯一标识)" }, { "name": "status", "type": "string", "required": false, "description": "任务状态,枚举:submitted/running/success/failed/not_found" }, { "name": "progress", "type": "number", "required": false, "description": "进度百分比(0-100)" }, { "name": "message", "type": "string", "required": false, "description": "额外提示信息或受理消息" }, { "name": "result", "type": "object", "required": false, "description": "任务成功时返回的结果对象(可选)" }, { "name": "error", "type": "string", "required": false, "description": "失败时的错误信息(可选)" }, { "name": "update_time", "type": "string", "required": false, "description": "最近一次状态更新时间,ISO8601 字符串(可选)" } ] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.exportTaskProgress", "title": "按 task_id 查询导出任务进度,未找到时 status=not_found", "description": "按 task_id 查询导出任务进度,未找到时 status=not_found", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务 ID,兼容 taskId" } ], "response": [ { "name": "task_id", "type": "string", "required": false, "description": "任务 ID" }, { "name": "status", "type": "string", "required": false, "description": "任务状态:submitted/running/success/failed/not_found" }, { "name": "progress", "type": "number", "required": false, "description": "进度百分比(0-100)" }, { "name": "message", "type": "string", "required": false, "description": "额外提示信息" }, { "name": "result", "type": "object", "required": false, "description": "任务成功时返回的结果对象(可选)" }, { "name": "error", "type": "string", "required": false, "description": "失败时的错误信息(可选)" }, { "name": "download_url", "type": "string", "required": false, "description": "任务完成后可直接下载的文件地址(若有)" }, { "name": "update_time", "type": "string", "required": false, "description": "最近一次状态更新时间,ISO8601 字符串(可选)" } ] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.getBarcodes", "title": "查询商品条码列表", "description": "查询商品条码列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.getInfo", "title": "查询仓库商品详情", "description": "查询仓库商品详情", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.getProhibitedType", "title": "查询违禁品类型列表(系统预设+仓库自定义)", "description": "查询违禁品类型列表(系统预设+仓库自定义)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.getStockDetail", "title": "按库位/批次维度查询商品库存分布", "description": "按库位/批次维度查询商品库存分布", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "stock_id", "type": "number", "required": true, "description": "商品库存ID(stock_warehouse.id)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数,包含 page/pageSize" }, { "name": "group_by_batch", "type": "boolean", "required": false, "description": "是否按批次返回明细;true 返回每条明细,false 按库位合并" } ], "response": [ { "name": "stockItem", "type": "object", "required": false, "description": "商品概要,包含 id、item_code、item_name、sku_property、stock_unit、quantity、locked_quantity 等" }, { "name": "storageList", "type": "array", "required": false, "description": "库存明细数组;group_by_batch=true 返回 wms_storage 明细(含 batch_no、production_date、expiry_date、inbound_time、inbound_order_no、supplier_batch_no 等),group_by_batch=false 时按库位合并,批次相关字段为 null" }, { "name": "pagination", "type": "object", "required": false, "description": "分页信息,包含 page、pageSize、total" } ] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.getStockUnits", "title": "查询可用库存单位(系统+仓库)", "description": "查询可用库存单位(系统+仓库)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.getStoreStocks", "title": "查询仓库商品与货主关联列表", "description": "查询仓库商品与货主关联列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.getUnitList", "title": "查询当前仓库自定义单位列表", "description": "查询当前仓库自定义单位列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.handleBatchChange", "title": "批量修改仓库商品字段", "description": "批量修改仓库商品字段", "endpoint": "/system", "authRequired": true, "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 数组(stock_warehouse.id)" }, { "name": "method", "type": "string", "required": true, "description": "要修改的字段名,可选值:brand_name、prohibited_id、gross_weight、packing_requirements、managementFlags、stock_unit" }, { "name": "value", "type": "string|number|object", "required": true, "description": "修改值,类型依 method 而定:brand_name/packing_requirements/stock_unit 为 string(<=255 字符);prohibited_id 为 number(整数);gross_weight 为 number(正数,可含小数);managementFlags 为 object,必须包含 is_sn_mgmt/is_shelf_life_mgmt/is_batch_mgmt,值为 'Y' 或 'N'" }, { "name": "values", "type": "any", "required": false, "description": "兼容字段:当前实现以 `value` 为准,不使用 `values`。若客户端历史使用 `values`,请切换为 `value`。" } ], "response": [ { "name": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功;405 表示参数/权限校验不通过;500 表示服务器错误" }, { "name": "message", "type": "string", "required": false, "description": "业务提示信息" }, { "name": "data", "type": "object", "required": false, "description": "成功时返回的结果对象" } ] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.handleBatchDelete", "title": "批量删除仓库商品资料", "description": "批量删除仓库商品资料", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.import", "title": "批量导入或更新仓库商品。请求体优先直接传入商品数据数组 JSON(主方式为数组);也兼容以 rows/items/list/data 包装。每项仅需包含商品相关字段;当 SKU 为空时创建新商品,SKU 非空时为更新操作;更新会写操作日志以便审计。未传 store_id 时默认使用当前上下文仓库/主体(ctx.user.store_id)。支持导入条码(barcode),新建和更新均生效,条码写入 wms_stock_barcodes 表。", "description": "批量导入或更新仓库商品。请求体优先直接传入商品数据数组 JSON(主方式为数组);也兼容以 rows/items/list/data 包装。每项仅需包含商品相关字段;当 SKU 为空时创建新商品,SKU 非空时为更新操作;更新会写操作日志以便审计。未传 store_id 时默认使用当前上下文仓库/主体(ctx.user.store_id)。支持导入条码(barcode),新建和更新均生效,条码写入 wms_stock_barcodes 表。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "items / rows / list / data", "type": "array", "required": true, "description": "商品数组(主方式为直接传数组 []),也兼容对象包装:{ rows: [...] } / { items: [...] } / { list: [...] } / { data: [...] }。每项可使用下列字段别名:" } ], "response": [ { "name": "total_count", "type": "number", "required": true, "description": "解析到的总条目数" }, { "name": "created_count", "type": "number", "required": true, "description": "成功创建的新商品数" }, { "name": "updated_count", "type": "number", "required": true, "description": "成功更新的商品数" }, { "name": "fail_count", "type": "number", "required": true, "description": "导入失败数" }, { "name": "created_ids", "type": "array", "required": true, "description": "创建成功的商品 ID 列表" }, { "name": "updated_ids", "type": "array", "required": true, "description": "更新成功的商品 ID 列表" }, { "name": "fail_items", "type": "array", "required": true, "description": "失败项明细数组,每项包含原始输入与错误信息" } ] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.list", "title": "仓库商品列表查询(支持 where 条件与分页)", "description": "仓库商品列表查询(支持 where 条件与分页)", "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": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、barcode、prohibited_type、has_bound_item 等商品筛选字段。示例:where.barcode={operator:like,value:69}; where.prohibited_type={operator:eq,value:liquid}; where.has_bound_item={operator:eq,value:true}(已绑定外部商品)/ where.has_bound_item={operator:eq,value:false}(未绑定外部商品)。" } ], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.queryStockLogs", "title": "查询库存操作日志", "description": "查询库存操作日志", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouseId", "type": "string", "required": false, "description": "warehouseId 参数" } ], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.saveWarehouseStock", "title": "更新仓库商品资料", "description": "更新仓库商品资料", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.saveWarehouseStockBarcode", "title": "保存商品条码信息", "description": "保存商品条码信息", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.search", "title": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条", "description": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "keyword", "type": "string", "required": false, "description": "搜索关键字,模糊匹配 item_code、item_name、goods_code 以及关联的 barcode;为空时返回全部(仍受 limit 50 限制)" }, { "name": "store_id", "type": "number", "required": false, "description": "货主ID,传入时仅返回指定货主的商品" }, { "name": "with_stock", "type": "boolean", "required": false, "description": "是否返回关联库存数据(wms_storage),为 true 时每条商品新增 storage[] 字段" }, { "name": "is_batch", "type": "boolean", "required": false, "description": "是否按批次明细返回库存,仅 with_stock=true 时生效。false(默认)按库位分组汇总;true 逐条返回批次明细" } ], "response": [ { "name": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功" }, { "name": "data", "type": "array", "required": false, "description": "商品列表,每项包含以下字段" }, { "name": "total", "type": "number", "required": false, "description": "本次返回的记录条数(≤50)" } ] }, { "moduleName": "商品模块", "moduleKey": "stock", "moduleFolder": "stock", "method": "stock.warehouse.unbindItem", "title": "解绑货主商品关系", "description": "解绑货主商品关系", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "入库单模块", "moduleKey": "storage.entry", "moduleFolder": "storage.entry", "method": "storage.entry.bindReceivingDetails", "title": "入库单明细绑定收货明细。将指定的收货单明细与入库单明细建立绑定关系,并立即更新入库明细的 received_quantity(绑定即实收)。重复调用会先回退旧绑定量再创建新绑定。提交入库时完成收货单侧的入库数量扣减和库存上架。", "description": "入库单明细绑定收货明细。将指定的收货单明细与入库单明细建立绑定关系,并立即更新入库明细的 received_quantity(绑定即实收)。重复调用会先回退旧绑定量再创建新绑定。提交入库时完成收货单侧的入库数量扣减和库存上架。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "entry_item_id", "type": "number", "required": true, "description": "入库单明细ID(wms_entry_items.id)" }, { "name": "bindings", "type": "array", "required": true, "description": "收货明细绑定数组,每项包含 receiving_detail_id(收货明细ID, number, 必填)和 allocated_quantity(分配数量, number, 必填, 正整数)" } ], "response": [ { "name": "entry_item_id", "type": "number", "required": true, "description": "入库明细ID" }, { "name": "binding_count", "type": "number", "required": true, "description": "创建的绑定数量" } ] }, { "moduleName": "入库单模块", "moduleKey": "storage.entry", "moduleFolder": "storage.entry", "method": "storage.entry.cancel", "title": "作废入库单(支持单条或批量作废)", "description": "作废入库单(支持单条或批量作废)", "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": false, "description": "入库单ID,兼容旧调用;与 `ids` 二选一。若同时传入 `ids`,以 `ids` 为准。" }, { "name": "ids", "type": "array", "required": false, "description": "入库单ID数组(number[]),用于批量作废;必须为非空数组,建议批量操作使用 `ids`,优先于 `id`。" } ], "response": [ { "name": "id", "type": "number", "required": false, "description": "单条作废时返回的入库单ID" }, { "name": "ids", "type": "array", "required": false, "description": "批量作废时返回的已成功作废入库单ID数组(number[])" } ] }, { "moduleName": "入库单模块", "moduleKey": "storage.entry", "moduleFolder": "storage.entry", "method": "storage.entry.completeEntry", "title": "完成入库单。入库单状态变更为 COMPLETED 后,异步触发收货单匹配与回传:系统会从入库单 remark 中匹配近 3 天收货单号,明细一致则按来源回传(奇门→奇门确认接口,API→OpenAPI 回调);若收货单覆盖入库单,还会标记收货单为部分入库。异步匹配失败不阻塞主流程,仅记录日志。", "description": "完成入库单。入库单状态变更为 COMPLETED 后,异步触发收货单匹配与回传:系统会从入库单 remark 中匹配近 3 天收货单号,明细一致则按来源回传(奇门→奇门确认接口,API→OpenAPI 回调);若收货单覆盖入库单,还会标记收货单为部分入库。异步匹配失败不阻塞主流程,仅记录日志。", "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" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "完成成功的入库单ID" } ] }, { "moduleName": "入库单模块", "moduleKey": "storage.entry", "moduleFolder": "storage.entry", "method": "storage.entry.get", "title": "查询入库单详情。返回的 entryOrder.items 每项包含 pending_total(当前 pending 绑定的总预分配数量)、total_planned(计划入库数量=count)、bindings(pending 绑定列表,每项含 id/entry_item_id/receiving_detail_id/allocated_quantity/status/receivingDetail)", "description": "查询入库单详情。返回的 entryOrder.items 每项包含 pending_total(当前 pending 绑定的总预分配数量)、total_planned(计划入库数量=count)、bindings(pending 绑定列表,每项含 id/entry_item_id/receiving_detail_id/allocated_quantity/status/receivingDetail)", "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": false, "description": "入库单ID,与 entry_order_code 二选一" }, { "name": "entry_order_code", "type": "string", "required": false, "description": "入库单号,与 id 二选一" } ], "response": [ { "name": "entryOrder", "type": "object", "required": true, "description": "入库单详情,含 items 明细数组" } ] }, { "moduleName": "入库单模块", "moduleKey": "storage.entry", "moduleFolder": "storage.entry", "method": "storage.entry.list", "title": "入库单列表查询", "description": "入库单列表查询", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、order_status、store_id、order_type、日期区间等字段。新增 expense_record(费用是否记录)筛选,支持 eq/in;值会归一化为 0/1,兼容 true/false、1/0、y/n、yes/no(大小写不敏感,含布尔/字符串/数字写法)。示例:where.expense_record={operator:eq,value:true} 等价 where.expense_record={operator:eq,value:1};where.expense_record={operator:in,value:[true,\"0\",\"yes\",\"n\"]} 会归一化为 [1,0]。若部署环境尚未完成 expense_record 字段迁移,传入该筛选可能返回 400,错误提示为“当前环境未提供 expense_record 字段,暂不支持该筛选条件,请先完成表结构升级”。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField/sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "入库单列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" }, { "name": "summary", "type": "object", "required": true, "description": "状态汇总(total、pending、creating、created、completed、cancelled)" } ] }, { "moduleName": "入库单模块", "moduleKey": "storage.entry", "moduleFolder": "storage.entry", "method": "storage.entry.unbindReceivingDetails", "title": "解绑入库明细的收货明细绑定。删除指定入库明细的所有 pending 绑定,并回退 received_quantity(恢复到绑定前的值),收货单明细的可用数量自动恢复(因为绑定记录被删除)。", "description": "解绑入库明细的收货明细绑定。删除指定入库明细的所有 pending 绑定,并回退 received_quantity(恢复到绑定前的值),收货单明细的可用数量自动恢复(因为绑定记录被删除)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "entry_item_id", "type": "number", "required": true, "description": "入库单明细ID" } ], "response": [ { "name": "entry_item_id", "type": "number", "required": true, "description": "入库明细ID" }, { "name": "released_quantity", "type": "number", "required": true, "description": "释放的绑定总量" } ] }, { "moduleName": "库存操作模块", "moduleKey": "storage.inventory", "moduleFolder": "storage.inventory", "method": "storage.expiry.list", "title": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。", "description": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;支持字段:item_code、goods_code、item_name、sku_property、stock_unit、is_shelf_life_mgmt、remaining_threshold_days。示例:where.item_code={operator:like,value:ABC}; where.remaining_threshold_days={operator:lte,value:7}。注意:无需传入 store_id 或 warehouse_id,服务端会从当前登录用户获取仓库上下文。" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" } ], "response": [ { "name": "data.list", "type": "array", "required": true, "description": "匹配到的库存效期项数组" }, { "name": "data.list[]", "type": "object", "required": false, "description": "列表项,包含至少以下字段" }, { "name": "data.pagination", "type": "object", "required": true, "description": "分页信息,含 page、pageSize、total、totalPages" } ] }, { "moduleName": "库存操作模块", "moduleKey": "storage.inventory", "moduleFolder": "storage.inventory", "method": "storage.inventory.list", "title": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)", "description": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象,可用字段:stock_id(商品ID)、space_id(库位ID)、store_id(货主ID)、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、batch_no(批次号)、inbound_order_no(入库单号)、available_quantity(可用数量,支持 gt/lt)、inbound_time(入库时间,支持 between)、created_at(创建时间,支持 between)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'" }, { "name": "group_by_batch", "type": "boolean", "required": false, "description": "是否按批次查询,默认 false。false=合并模式(按库位+商品聚合quantity/locked_quantity/available_quantity),true=明细模式(逐条返回含 batch_no/production_date/expiry_date 等)" } ], "response": [] }, { "moduleName": "库存操作模块", "moduleKey": "storage.inventory", "moduleFolder": "storage.inventory", "method": "storage.inventory.matchPutaway", "title": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,要求收货单已完成且已审核,完成后根据入库单来源(QM/API)自动触发回传", "description": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,要求收货单已完成且已审核,完成后根据入库单来源(QM/API)自动触发回传", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "receiving_ids", "type": "array", "required": true, "description": "收货单ID列表" }, { "name": "entry_order_ids", "type": "array", "required": true, "description": "入库单ID列表" } ], "response": [] }, { "moduleName": "库存操作模块", "moduleKey": "storage.inventory", "moduleFolder": "storage.inventory", "method": "storage.inventory.quickPutaway", "title": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成、已审核、货主已开启快捷入库策略且所有明细已匹配系统商品", "description": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成、已审核、货主已开启快捷入库策略且所有明细已匹配系统商品", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "receiving_id", "type": "number", "required": true, "description": "收货单ID,兼容 id" } ], "response": [] }, { "moduleName": "库存操作模块", "moduleKey": "storage.inventory", "moduleFolder": "storage.inventory", "method": "storage.inventory.transferByProduct", "title": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品", "description": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "space_id", "type": "number", "required": true, "description": "原库位ID" }, { "name": "stock_id", "type": "number", "required": true, "description": "商品SKU ID(wms_stock_warehouse.id)" }, { "name": "target_space_id", "type": "number", "required": true, "description": "目标库位ID" }, { "name": "quantity", "type": "number", "required": true, "description": "移库数量" } ], "response": [] }, { "moduleName": "库存操作模块", "moduleKey": "storage.inventory", "moduleFolder": "storage.inventory", "method": "storage.inventory.transferLocation", "title": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库", "description": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "storage_id", "type": "number", "required": true, "description": "库存记录ID" }, { "name": "target_space_id", "type": "number", "required": true, "description": "目标库位ID" }, { "name": "quantity", "type": "number", "required": false, "description": "移库数量,不传则全部移动" } ], "response": [] }, { "moduleName": "库存管理模块", "moduleKey": "storage.management", "moduleFolder": "storage.management", "method": "storage.management.replenishmentDemand", "title": "分拣缺货补货需求计算(仓库级别)。自动从用户上下文获取仓库,查询所有未完成储位分配的订单,计算每个SKU在分拣区与存货区的库存量、订单需求量、分拣区缺口、建议补货量及可补货库位。支持分页与排序。", "description": "分拣缺货补货需求计算(仓库级别)。自动从用户上下文获取仓库,查询所有未完成储位分配的订单,计算每个SKU在分拣区与存货区的库存量、订单需求量、分拣区缺口、建议补货量及可补货库位。支持分页与排序。", "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,默认 page=1 pageSize=20" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField / sortOrder。sortField 可选值:stock_id / pick_zone_quantity / storage_zone_quantity / total_demand / shortage / replenishment_needed,默认 shortage;sortOrder 可选 ASC / DESC,默认 DESC" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "补货需求明细列表" }, { "name": "summary", "type": "object", "required": true, "description": "汇总信息" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.addDetail", "title": "支持新增可选入参 item;item 有值时按传入字段创建明细(服务端会覆盖 receiving_id 与 creator_id);item 无值时沿原链路创建空白明细。返回的 selectId 与 data.details 语义不变(仍返回新创建明细的 selectId 与更新后的明细列表)。", "description": "支持新增可选入参 item;item 有值时按传入字段创建明细(服务端会覆盖 receiving_id 与 creator_id);item 无值时沿原链路创建空白明细。返回的 selectId 与 data.details 语义不变(仍返回新创建明细的 selectId 与更新后的明细列表)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "receiving_id", "type": "number", "required": true, "description": "收货单ID" }, { "name": "item", "type": "object", "required": false, "description": "可选:按传入字段创建明细;不传则创建空白明细。item.children 需覆盖以下字段(有则写、无则补齐):actual_quantity, box_quantity, boxes_per_pallet, space_id, system_product_id, box_width, box_height, box_length, box_remainder, box_weight, weight, barcode, product_name, pallet_quantity, receiving_time, production_date, expiry_date, remark, batch_number, product_snapshot。若传入 item,服务端仍会覆盖 receiving_id 与 creator_id。" } ], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码,200 表示添加成功" }, { "name": "message", "type": "string", "required": true, "description": "结果描述,成功时为 '添加成功'" }, { "name": "data.details", "type": "array", "required": true, "description": "收货单明细数组(每项为明细对象)" }, { "name": "data.selectId", "type": "number", "required": true, "description": "新创建的明细ID,用于前端选中" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.batchCancelReceiving", "title": "storage.receiving.batchCancelReceiving 接口", "description": "storage.receiving.batchCancelReceiving 接口", "endpoint": "/system", "authRequired": true, "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数组" } ], "response": [ { "name": "message", "type": "string", "required": true, "description": "批量作废处理结果" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.bindDetailProduct", "title": "收货单明细绑定或改绑系统商品", "description": "收货单明细绑定或改绑系统商品", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "detail_id", "type": "number", "required": true, "description": "收货单明细ID(兼容字段 `id`)" }, { "name": "system_product_id", "type": "number", "required": true, "description": "系统商品ID(`StockWarehouse.id`,且必须属于当前仓库)" } ], "response": [ { "name": "data.detail_id", "type": "number", "required": true, "description": "收货单明细ID" }, { "name": "data.receiving_id", "type": "number", "required": true, "description": "收货单ID" }, { "name": "data.system_product_id", "type": "number", "required": true, "description": "已绑定的系统商品ID" }, { "name": "data.product_name", "type": "string", "required": true, "description": "自动回填的商品名称" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.bindStore", "title": "收货单绑定货主", "description": "收货单绑定货主", "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": "store_id", "type": "number", "required": true, "description": "货主ID(必须与当前仓库存在有效签约关系)" } ], "response": [ { "name": "data.id", "type": "number", "required": true, "description": "收货单ID" }, { "name": "data.store_id", "type": "number", "required": true, "description": "已绑定的货主ID" }, { "name": "data.store_name", "type": "string", "required": false, "description": "货主名称/签约备注名" }, { "name": "data.status", "type": "string", "required": true, "description": "当前收货单状态" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.cancel", "title": "storage.receiving.cancel 接口", "description": "storage.receiving.cancel 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.completeReceiving", "title": "storage.receiving.completeReceiving 接口", "description": "storage.receiving.completeReceiving 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.create", "title": "storage.receiving.create 接口", "description": "storage.receiving.create 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "delivery_method", "type": "string", "required": true, "description": "到货方式:truck/express/air_freight/sea_freight/other" }, { "name": "loading_method", "type": "string", "required": true, "description": "装卸方式:with_pallet/without_pallet" }, { "name": "license_plate", "type": "string", "required": false, "description": "车牌号(delivery_method=truck 时建议传)" }, { "name": "tracking_number", "type": "string", "required": false, "description": "物流单号(非 truck/other 场景建议传)" }, { "name": "store_id", "type": "number", "required": false, "description": "货主ID" }, { "name": "total_boxes", "type": "number", "required": false, "description": "总箱数" }, { "name": "total_pallets", "type": "number", "required": false, "description": "总托盘数" }, { "name": "remark", "type": "string", "required": false, "description": "备注" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "新建收货单ID" }, { "name": "receiving_number", "type": "string", "required": true, "description": "收货单号" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.deleteDetail", "title": "删除收货单明细并回算统计。仅允许明细创建者在收货中状态删除未入库的明细;服务端从登录用户上下文获取 creator_id(ctx.user.employees_id)与 warehouse_id(ctx.user.store_id)。若关联收货单状态为 completed(已完成)或 cancelled(已取消),接口会返回删除失败(400),不允许删除明细。", "description": "删除收货单明细并回算统计。仅允许明细创建者在收货中状态删除未入库的明细;服务端从登录用户上下文获取 creator_id(ctx.user.employees_id)与 warehouse_id(ctx.user.store_id)。若关联收货单状态为 completed(已完成)或 cancelled(已取消),接口会返回删除失败(400),不允许删除明细。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "detail_id", "type": "number", "required": true, "description": "收货单明细 ID(必填)" } ], "response": [ { "name": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功,400/404/500 表示失败" }, { "name": "message", "type": "string", "required": false, "description": "简短的错误或成功信息" }, { "name": "data", "type": "object", "required": false, "description": "成功时返回的结果对象" }, { "name": "data.details", "type": "array", "required": false, "description": "删除后收货单剩余的明细数组。每项字段与 storage.receiving.getReceivingDetail 返回的明细项一致;product_snapshot 为解析后的对象或 null" }, { "name": "data.selectId", "type": "number|null", "required": false, "description": "删除后建议前端选中的明细 ID;无剩余明细时为 null" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.detailChange", "title": "修改收货单明细(数量/箱规/批次/商品信息回写等)", "description": "修改收货单明细(数量/箱规/批次/商品信息回写等)", "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": "receiving_id", "type": "number", "required": true, "description": "收货单ID" }, { "name": "actual_quantity", "type": "number", "required": false, "description": "实际收货数量" }, { "name": "batch_number", "type": "string", "required": false, "description": "批次号" }, { "name": "production_date", "type": "string", "required": false, "description": "生产日期(可解析的日期字符串)" }, { "name": "expiry_date", "type": "string", "required": false, "description": "到期日期(可解析的日期字符串)。若早于当前日期,接口会返回 400 并拒绝录入。" }, { "name": "box_quantity", "type": "number", "required": false, "description": "箱数" }, { "name": "boxes_per_pallet", "type": "number", "required": false, "description": "每托盘箱数" }, { "name": "pallet_quantity", "type": "number", "required": false, "description": "托盘数" }, { "name": "space_id", "type": "number", "required": false, "description": "库位 ID(可回写)" }, { "name": "remark", "type": "string", "required": false, "description": "备注" }, { "name": "system_product_id", "type": "number", "required": false, "description": "系统商品 ID(StockWarehouse.id)。若提供,服务端会尝试回填 barcode/weight/箱规/product_name/product_snapshot 等。" }, { "name": "barcode", "type": "string", "required": false, "description": "条码(未传 system_product_id 时可单独更新)" }, { "name": "product_name", "type": "string", "required": false, "description": "商品名称(未传 system_product_id 时可单独更新)" }, { "name": "box_width", "type": "number", "required": false, "description": "箱宽" }, { "name": "box_height", "type": "number", "required": false, "description": "箱高" }, { "name": "box_length", "type": "number", "required": false, "description": "箱长" }, { "name": "box_remainder", "type": "number", "required": false, "description": "箱内剩余数量/零散数量(不满箱时的件数)" }, { "name": "box_weight", "type": "number", "required": false, "description": "实测箱重(单位与系统重量一致,如 kg)" }, { "name": "weight", "type": "number", "required": false, "description": "毛重/重量" } ], "response": [ { "name": "data.id", "type": "number", "required": true, "description": "收货明细 ID" }, { "name": "data.receiving_id", "type": "number", "required": true, "description": "收货单 ID" }, { "name": "data.actual_quantity", "type": "number", "required": false, "description": "实际收货数量" }, { "name": "data.product_name", "type": "string", "required": false, "description": "商品名称" }, { "name": "data.barcode", "type": "string", "required": false, "description": "条码" }, { "name": "data.system_product_id", "type": "number", "required": false, "description": "系统商品 ID" }, { "name": "data.box_remainder", "type": "number", "required": false, "description": "箱内剩余数量/零散数量(不满箱时的件数)" }, { "name": "data.box_weight", "type": "number", "required": false, "description": "实测箱重(单位与系统重量一致,如 kg)" }, { "name": "data.updated_at", "type": "string", "required": false, "description": "记录更新时间(ISO)" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.get", "title": "storage.receiving.get 接口", "description": "storage.receiving.get 接口", "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" } ], "response": [ { "name": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功" }, { "name": "message", "type": "string", "required": false, "description": "返回信息" }, { "name": "data", "type": "object", "required": false, "description": "收货单详情对象,包含 details(明细数组)、images 及主表字段" }, { "name": "data.details", "type": "array", "required": false, "description": "收货单明细数组(每项为明细对象)" }, { "name": "data.details.*.box_remainder", "type": "number", "required": false, "description": "箱内剩余数量/零散数量(不满箱时的件数),默认 0" }, { "name": "data.details.*.box_weight", "type": "number", "required": false, "description": "实测箱重(单位与系统重量一致,如 kg),默认 0" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.getAvailableInboundQuantity", "title": "按 stock_id 查询可入库数量。返回指定商品在已审核收货单中各明细的可入库数量(actual_quantity - stored_quantity - pending_allocated_quantity),仅包含尚有可入库余量的明细,排除未审核和已取消的收货单。", "description": "按 stock_id 查询可入库数量。返回指定商品在已审核收货单中各明细的可入库数量(actual_quantity - stored_quantity - pending_allocated_quantity),仅包含尚有可入库余量的明细,排除未审核和已取消的收货单。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "stock_id", "type": "number", "required": true, "description": "商品库存ID(stock_warehouse.id)" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "可入库明细列表,每项包含 detail_id、receiving_id、receiving_number、product_name、actual_quantity、stored_quantity、pending_allocated_quantity、available_quantity、storage_status、batch_number、production_date、expiry_date、space_id、receiving_status" }, { "name": "total", "type": "number", "required": true, "description": "返回条数" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.getReceivingDetail", "title": "storage.receiving.getReceivingDetail 接口", "description": "storage.receiving.getReceivingDetail 接口", "endpoint": "/system", "authRequired": true, "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": "pagination", "type": "object", "required": true, "description": "明细分页参数,支持 page/pageSize" } ], "response": [ { "name": "receiving", "type": "object", "required": true, "description": "收货单详情(含 details、images、pagination)" }, { "name": "receiving.details", "type": "array", "required": false, "description": "收货单明细列表,单条记录包含明细字段(见下文)" }, { "name": "receiving.details.*.space_id", "type": "string", "required": false, "description": "库位展示名称(string|null)。优先取 custom_space_name,其次取 space_name。兼容说明:该字段历史上为数值库位ID,现已调整为展示名称;原始ID请使用 receiving.details.*.space_id_raw。" }, { "name": "receiving.details.*.space_id_raw", "type": "number", "required": false, "description": "原始库位ID(number|null),用于兼容依赖旧语义(space_id=数字ID)的调用方。" }, { "name": "receiving.details.*.space_name", "type": "string", "required": false, "description": "库位名称/编码(string|null),作为展示名称的回退来源。" }, { "name": "receiving.details.*.custom_space_name", "type": "string", "required": false, "description": "库位自定义名称(string|null,可空)。" }, { "name": "receiving.details.*.box_remainder", "type": "number", "required": false, "description": "箱内剩余数量/零散数量(不满箱时的件数)" }, { "name": "receiving.details.*.box_weight", "type": "number", "required": false, "description": "实测箱重(单位与系统重量一致,如 kg)" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.getReceivingList", "title": "storage.receiving.getReceivingList 接口", "description": "storage.receiving.getReceivingList 接口", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、status、store_id、日期区间等字段。示例:where.status={operator:eq,value:finished}; where.store_id={operator:eq,value:1001}; where.create_time_start={value:2026-03-01}。" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "收货单列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" }, { "name": "summary", "type": "object", "required": true, "description": "汇总信息(total_quantity、total_locked、total_available、total_items)" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.manualMatchEntryOrder", "title": "手动匹配入库单与收货单。传入收货单ID和入库单ID,复用异步匹配服务的明细对比和回传逻辑,同步返回匹配结果(含 matchType、comparisonResult、callbackSent、partialStorageMarked 等)。", "description": "手动匹配入库单与收货单。传入收货单ID和入库单ID,复用异步匹配服务的明细对比和回传逻辑,同步返回匹配结果(含 matchType、comparisonResult、callbackSent、partialStorageMarked 等)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "receivingId", "type": "number", "required": true, "description": "收货单 ID" }, { "name": "entryOrderId", "type": "number", "required": true, "description": "入库单 ID" } ], "response": [ { "name": "matchType", "type": "string", "required": true, "description": "匹配类型枚举:full_match(SKU+数量完全一致)/ receiving_covers_entry(收货单覆盖入库单,触发回传+标记部分入库)/ entry_exceeds_receiving(入库单超出收货单,不触发回传)/ no_match(SKU无交集,不触发回传)" }, { "name": "comparisonResult", "type": "object", "required": true, "description": "明细对比结果对象" }, { "name": "callbackSent", "type": "boolean", "required": true, "description": "是否已发送回传(full_match / receiving_covers_entry 时为 true)" }, { "name": "callbackResult", "type": "object|null", "required": true, "description": "回传结果对象(未发送时为 null);成功时含 success、sourceType(QM/API)、detail 字段" }, { "name": "partialStorageMarked", "type": "boolean", "required": true, "description": "是否已标记部分入库(仅 receiving_covers_entry 时为 true)" }, { "name": "entryOrder", "type": "object", "required": true, "description": "入库单摘要信息" }, { "name": "receivingOrder", "type": "object", "required": true, "description": "收货单摘要信息" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.queryReceivingLogs", "title": "按收货单ID查询操作日志列表(分页),仅返回当前仓库上下文数据", "description": "按收货单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|string", "required": false, "description": "收货单ID(与 receiving_id 二选一)" }, { "name": "receiving_id", "type": "number|string", "required": false, "description": "收货单ID(兼容字段,与 id 二选一)" }, { "name": "page", "type": "number", "required": false, "description": "页码(兼容顶层分页入参)" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量(兼容顶层分页入参)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数,支持 page / pageSize" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "日志列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息,包含 page、pageSize、total、totalPages" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.rejectReceiving", "title": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.", "description": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.", "endpoint": "/system", "authRequired": true, "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数组,所有收货单必须属于当前仓库且状态为 completed,否则整批拒绝" }, { "name": "remark", "type": "string", "required": false, "description": "驳回理由,覆盖收货单原备注字段;不传则保留原备注" } ], "response": [ { "name": "count", "type": "number", "required": false, "description": "成功驳回的收货单数量" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.removeItem", "title": "storage.receiving.removeItem 接口", "description": "storage.receiving.removeItem 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": false, "description": "id 参数" }, { "name": "item_id", "type": "number", "required": false, "description": "item_id 参数" } ], "response": [] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.reviewReceiving", "title": "批量审核收货单:校验所有单据满足条件(收货完成、全部匹配、未入库、已绑定货主、未审核)后统一审核,任意一张不符合则整批失败回滚。审核人信息自动取当前登录用户上下文,无需传入.", "description": "批量审核收货单:校验所有单据满足条件(收货完成、全部匹配、未入库、已绑定货主、未审核)后统一审核,任意一张不符合则整批失败回滚。审核人信息自动取当前登录用户上下文,无需传入.", "endpoint": "/system", "authRequired": true, "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数组,所有单据必须满足:status=completed、detail_status=all_matched、storage_status=none、store_id 已绑定、is_review=0,否则整批拒绝" } ], "response": [ { "name": "count", "type": "number", "required": false, "description": "成功审核的收货单数量" } ] }, { "moduleName": "收货单模块", "moduleKey": "storage_receiving", "moduleFolder": "storage_receiving", "method": "storage.receiving.save", "title": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。", "description": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。", "endpoint": "/system", "authRequired": true, "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,按该ID修改当前仓库下的收货单" }, { "name": "delivery_method", "type": "string", "required": false, "description": "到货方式:truck/express/air_freight/sea_freight/other;不传则保持原值" }, { "name": "loading_method", "type": "string", "required": false, "description": "装卸方式:with_pallet/without_pallet;不传则保持原值" }, { "name": "license_plate", "type": "string", "required": false, "description": "车牌号;当 delivery_method=truck 时可更新,其他到货方式会被清空或忽略" }, { "name": "tracking_number", "type": "string", "required": false, "description": "物流单号;当 delivery_method 为 express/air_freight/sea_freight 时可更新,truck/other 场景会被清空或忽略" }, { "name": "store_id", "type": "number", "required": false, "description": "货主ID;若传入,会校验当前仓库下签约关系并同步更新货主名称;传 0/null 可清空货主" }, { "name": "total_boxes", "type": "number", "required": false, "description": "总箱数,默认 0" }, { "name": "total_pallets", "type": "number", "required": false, "description": "总托盘数,默认 0" }, { "name": "remark", "type": "string", "required": false, "description": "备注信息" }, { "name": "status", "type": "string", "required": false, "description": "收货单状态;不传则保持原值" }, { "name": "video_device_id", "type": "string", "required": false, "description": "录像设备ID" } ], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码;200 表示修改成功" }, { "name": "id", "type": "number", "required": true, "description": "修改的收货单ID" }, { "name": "receiving_number", "type": "string", "required": true, "description": "收货单号" }, { "name": "message", "type": "string", "required": true, "description": "结果描述;成功时通常为收货单修改成功" } ] }, { "moduleName": "库存报表模块", "moduleKey": "storage.report", "moduleFolder": "storage.report", "method": "storage.report.export", "title": "提交库存报表导出异步任务(与 storage.report.search 使用相同查询条件),立即返回任务受理信息,不直接返回文件。", "description": "提交库存报表导出异步任务(与 storage.report.search 使用相同查询条件),立即返回任务受理信息,不直接返回文件。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "where", "type": "object", "required": false, "description": "查询条件对象。支持字段:start_time(闭区间下限)、end_time(闭区间上限)、by_space(是否按库位返回,默认 false)、store_ids(货主ID数组)。仅返回在时间区间内存在流水的数据(无流水键不返回)。" }, { "name": "where.start_time", "type": "string", "required": false, "description": "开始时间,支持字符串/Date;用于闭区间过滤:created_at >= start_time" }, { "name": "where.end_time", "type": "string", "required": false, "description": "结束时间,支持字符串/Date;用于闭区间过滤:created_at <= end_time" }, { "name": "where.by_space", "type": "boolean", "required": false, "description": "是否按库位返回,默认 false。false=按商品+货主聚合(多库位汇总),true=按商品+库位+货主返回;当 where.by_space=true 时,导出汇总 sheet 会额外包含 space_id、space_name。" }, { "name": "where.store_ids", "type": "array", "required": false, "description": "货主ID数组,用于过滤特定货主(空或未传表示不过滤)" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数对象(请求体 data.sort)。支持 data.sort.sortField / data.sort.sort_field 与 data.sort.sortOrder / data.sort.sort_order;sortField 白名单:begin_total、inbound_total、outbound_total、end_total;sortOrder 支持 ASC / DESC(大小写不敏感);非法字段或顺序将回退默认排序。" }, { "name": "sort.sortField", "type": "string", "required": false, "description": "排序字段(兼容 data.sort.sortField)。白名单:begin_total、inbound_total、outbound_total、end_total;非法值回退默认排序。" }, { "name": "sort.sort_field", "type": "string", "required": false, "description": "排序字段下划线别名(兼容 data.sort.sort_field),规则同 sort.sortField。" }, { "name": "sort.sortOrder", "type": "string", "required": false, "description": "排序方向(兼容 data.sort.sortOrder),支持 ASC / DESC(大小写不敏感);非法值回退默认排序。" }, { "name": "sort.sort_order", "type": "string", "required": false, "description": "排序方向下划线别名(兼容 data.sort.sort_order),规则同 sort.sortOrder。" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "导出任务ID,用于后续查询进度。" }, { "name": "status", "type": "string", "required": true, "description": "任务状态,提交受理后初始为 submitted。" }, { "name": "progress", "type": "number", "required": true, "description": "任务进度百分比(0-100)。" }, { "name": "message", "type": "string", "required": true, "description": "任务受理提示信息。" }, { "name": "error", "type": "string", "required": true, "description": "错误信息;受理成功时通常为空字符串。" }, { "name": "result", "type": "object|null", "required": true, "description": "任务结果对象;受理阶段为 null。" }, { "name": "update_time", "type": "number", "required": true, "description": "任务状态更新时间(时间戳)。" } ] }, { "moduleName": "库存报表模块", "moduleKey": "storage.report", "moduleFolder": "storage.report", "method": "storage.report.exportTaskProgress", "title": "根据 task_id 查询库存报表导出任务进度与结果;status 可能值:submitted/running/success/failed/not_found。", "description": "根据 task_id 查询库存报表导出任务进度与结果;status 可能值:submitted/running/success/failed/not_found。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id", "type": "string", "required": false, "description": "导出任务ID(下划线写法)。" }, { "name": "taskId", "type": "string", "required": false, "description": "导出任务ID(驼峰写法,兼容别名)。" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "导出任务ID。" }, { "name": "status", "type": "string", "required": true, "description": "任务状态:submitted/running/success/failed/not_found。" }, { "name": "progress", "type": "number", "required": true, "description": "任务进度百分比(0-100)。" }, { "name": "message", "type": "string", "required": true, "description": "任务状态说明。" }, { "name": "error", "type": "string", "required": true, "description": "失败时的错误信息;成功时通常为空字符串。" }, { "name": "download_url", "type": "string", "required": true, "description": "任务成功后返回的下载链接;未完成或失败时为空字符串。" }, { "name": "update_time", "type": "number", "required": true, "description": "任务状态更新时间(时间戳)。" }, { "name": "result", "type": "object|null", "required": true, "description": "任务结果对象(包含导出文件信息);未完成或失败时可能为 null。" } ] }, { "moduleName": "库存报表模块", "moduleKey": "storage.report", "moduleFolder": "storage.report", "method": "storage.report.search", "title": "库存报表查询(主入口):按时间闭区间统计商品出入库并支持按库位或按商品聚合", "description": "库存报表查询(主入口):按时间闭区间统计商品出入库并支持按库位或按商品聚合", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "where", "type": "object", "required": false, "description": "查询条件对象。支持字段:start_time(闭区间下限)、end_time(闭区间上限)、by_space(是否按库位返回,默认 false)、store_ids(货主ID数组)。仅返回在时间区间内存在流水的数据(无流水键不返回)。" }, { "name": "where.start_time", "type": "string", "required": false, "description": "开始时间,支持字符串/Date;用于闭区间过滤:created_at >= start_time" }, { "name": "where.end_time", "type": "string", "required": false, "description": "结束时间,支持字符串/Date;用于闭区间过滤:created_at <= end_time" }, { "name": "where.by_space", "type": "boolean", "required": false, "description": "是否按库位返回,默认 false。false=按商品+货主聚合(多库位汇总),true=按商品+库位+货主返回;当 where.by_space=true 时,额外返回 space_id、space_name(custom_name 优先,否则使用 space_code)。" }, { "name": "where.store_ids", "type": "array", "required": false, "description": "货主ID数组,用于过滤特定货主(空或未传表示不过滤)" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数对象(请求体 data.sort)。支持 data.sort.sortField / data.sort.sort_field 与 data.sort.sortOrder / data.sort.sort_order;sortField 白名单:begin_total、inbound_total、outbound_total、end_total;sortOrder 支持 ASC / DESC(大小写不敏感);非法字段或顺序将回退默认排序。" }, { "name": "sort.sortField", "type": "string", "required": false, "description": "排序字段(兼容 data.sort.sortField)。白名单:begin_total、inbound_total、outbound_total、end_total;非法值回退默认排序。" }, { "name": "sort.sort_field", "type": "string", "required": false, "description": "排序字段下划线别名(兼容 data.sort.sort_field),规则同 sort.sortField。" }, { "name": "sort.sortOrder", "type": "string", "required": false, "description": "排序方向(兼容 data.sort.sortOrder),支持 ASC / DESC(大小写不敏感);非法值回退默认排序。" }, { "name": "sort.sort_order", "type": "string", "required": false, "description": "排序方向下划线别名(兼容 data.sort.sort_order),规则同 sort.sortOrder。" } ], "response": [ { "name": "data.list", "type": "array", "required": true, "description": "匹配到的报表行列表 已按 sort 规则排序返回。" }, { "name": "data.list[]", "type": "object", "required": true, "description": "单条报表记录字段" } ] }, { "moduleName": "出库单模块", "moduleKey": "storage.stockout", "moduleFolder": "storage.stockout", "method": "storage.stockout.list", "title": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。", "description": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。", "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" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;常用字段包括 delivery_order_code、status、outbound_status、buyer_nick、mobile 与日期区间字段。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField/sortOrder,默认按 updated_at DESC、id DESC" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "出库单列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" } ] }, { "moduleName": "出库单模块", "moduleKey": "storage.stockout", "moduleFolder": "storage.stockout", "method": "storage.stockout.listItems", "title": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。", "description": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "delivery_order_code", "type": "string", "required": false, "description": "出库单号,可用于定位订单" }, { "name": "order_id", "type": "number", "required": false, "description": "订单ID,可与 id 兼容用于定位订单" }, { "name": "id", "type": "number", "required": false, "description": "订单ID,可选;与 delivery_order_code / order_id 至少传一个" } ], "response": [ { "name": "order", "type": "object", "required": true, "description": "订单基础信息(含 id、delivery_order_code)" }, { "name": "items", "type": "array", "required": true, "description": "出库单商品明细" } ] }, { "moduleName": "出库单模块", "moduleKey": "storage.stockout", "moduleFolder": "storage.stockout", "method": "storage.stockout.toOrder", "title": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。", "description": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。", "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": false, "description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。" }, { "name": "delivery_order_code", "type": "string", "required": false, "description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。" } ], "response": [ { "name": "_note", "type": "string", "required": false, "description": "占位接口,当前无有效业务响应" } ] }, { "moduleName": "库存操作模块", "moduleKey": "storage.inventory", "moduleFolder": "storage.inventory", "method": "storage.transaction.list", "title": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)", "description": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象,可用字段:transaction_type(ENUM INBOUND/OUTBOUND)、stock_id、space_id、store_id、order_type(SCRK/MATCH)、order_no、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、operator_name、created_at(支持 between)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'" }, { "name": "group_by_batch", "type": "boolean", "required": false, "description": "是否按批次查询明细,默认 false。false=合并模式(按库位+商品聚合),true=明细模式(逐条返回)" } ], "response": [] }, { "moduleName": "主体模块", "moduleKey": "store", "moduleFolder": "store", "method": "store.auditApply", "title": "store.auditApply 接口", "description": "store.auditApply 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "audit_status", "type": "string", "required": true, "description": "审核状态(approved/rejected)" }, { "name": "code", "type": "string", "required": true, "description": "申请码(join_token)" }, { "name": "store_id", "type": "number", "required": true, "description": "当前审批门店ID" }, { "name": "role_ids", "type": "array", "required": true, "description": "分配角色ID数组" }, { "name": "reject_reason", "type": "string", "required": false, "description": "拒绝原因(audit_status=rejected 时可传)" } ], "response": [] }, { "moduleName": "主体模块", "moduleKey": "store", "moduleFolder": "store", "method": "store.createStore", "title": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", "description": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "subject_config", "type": "object", "required": false, "description": "货主主体配置,不传时自动写入默认值" }, { "name": "subject_config.max_notice_webhook_count", "type": "number", "required": false, "description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5" }, { "name": "subject_config.default_express_code", "type": "string", "required": false, "description": "默认快递编码,缺省为 STO" }, { "name": "subject_config.default_platform_code", "type": "string", "required": false, "description": "默认平台编码,缺省为 TB" }, { "name": "subject_config.group_wave_prefix", "type": "string", "required": false, "description": "团购波次前缀,最多 5 个字符,默认 B" }, { "name": "subject_config.min_group_order_fetch_quantity", "type": "number", "required": false, "description": "最小团购订单抓取数量,默认 13" }, { "name": "subject_config.auto_grouping_enabled", "type": "boolean", "required": false, "description": "是否自动加团,默认 false(关闭)" }, { "name": "subject_config.enable_external_express_code", "type": "boolean", "required": false, "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" } ], "response": [] }, { "moduleName": "主体模块", "moduleKey": "store", "moduleFolder": "store", "method": "store.createWarehouse", "title": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", "description": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))、enable_external_express_code=false(是否启用外部快递编码,默认 false(关闭))", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "subject_config", "type": "object", "required": false, "description": "货主主体配置,不传时自动写入默认值" }, { "name": "subject_config.max_notice_webhook_count", "type": "number", "required": false, "description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5" }, { "name": "subject_config.default_express_code", "type": "string", "required": false, "description": "默认快递编码,缺省为 STO" }, { "name": "subject_config.default_platform_code", "type": "string", "required": false, "description": "默认平台编码,缺省为 TB" }, { "name": "subject_config.group_wave_prefix", "type": "string", "required": false, "description": "团购波次前缀,最多 5 个字符,默认 B" }, { "name": "subject_config.min_group_order_fetch_quantity", "type": "number", "required": false, "description": "最小团购订单抓取数量,默认 13" }, { "name": "subject_config.auto_grouping_enabled", "type": "boolean", "required": false, "description": "是否自动加团,默认 false(关闭)" }, { "name": "subject_config.enable_external_express_code", "type": "boolean", "required": false, "description": "是否启用外部快递编码;默认 false(关闭)。开启后允许按外部系统传入的快递编码进行处理(如无匹配仍以业务校验为准)" } ], "response": [] }, { "moduleName": "主体模块", "moduleKey": "store", "moduleFolder": "store", "method": "store.getStoreRoles", "title": "store.getStoreRoles 接口", "description": "store.getStoreRoles 接口", "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": "申请码(join_token)" } ], "response": [] }, { "moduleName": "主体模块", "moduleKey": "store", "moduleFolder": "store", "method": "store.joinStore", "title": "store.joinStore 接口", "description": "store.joinStore 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "主体模块", "moduleKey": "store", "moduleFolder": "store", "method": "store.joinWarehouse", "title": "store.joinWarehouse 接口", "description": "store.joinWarehouse 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.adjustPrintQuantity", "title": "人工调整签约关系下的面单余额并记录变更日志", "description": "人工调整签约关系下的面单余额并记录变更日志", "endpoint": "/system", "authRequired": true, "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,兼容 contract_id" }, { "name": "print_quantity", "type": "number", "required": false, "description": "目标面单余额(覆盖值);优先使用该字段" }, { "name": "target_quantity", "type": "number", "required": false, "description": "目标面单余额(覆盖值);兼容别名" }, { "name": "change_quantity", "type": "number", "required": true, "description": "兼容旧字段;当前按目标面单余额(覆盖值)解释,差值将自动写入变更日志" }, { "name": "adjust_quantity", "type": "number", "required": false, "description": "兼容旧字段;当前按目标面单余额(覆盖值)解释" }, { "name": "reason", "type": "string", "required": true, "description": "人工调整缘由,必填" }, { "name": "business_type", "type": "string", "required": false, "description": "业务来源类型,预留给后续 order_express 等自动扣减场景" }, { "name": "business_id", "type": "number", "required": false, "description": "业务关联ID,预留给后续关联 wms_order_express.id" } ], "response": [] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.deleteQimenConfig", "title": "删除签约关系下的奇门接口配置", "description": "删除签约关系下的奇门接口配置", "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,兼容 contract_id" }, { "name": "interface_type_id", "type": "number", "required": false, "description": "接口类型ID" } ], "response": [] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.getPolicyConfig", "title": "读取签约策略配置", "description": "读取签约策略配置", "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,兼容 contract_id" } ], "response": [ { "name": "data.contract_id", "type": "number", "required": true, "description": "签约关系ID" }, { "name": "data.policy_config", "type": "object", "required": true, "description": "策略配置对象(包含默认值补齐后的字段)" }, { "name": "data.policy_config.enable_external_express_code", "type": "number", "required": true, "description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)" } ] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.getPolicyConfigFields", "title": "获取签约策略可配置字段元信息列表", "description": "获取签约策略可配置字段元信息列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.list", "title": "查询当前主体可见的仓库-货主签约列表", "description": "查询当前主体可见的仓库-货主签约列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "page", "type": "number", "required": false, "description": "页码,默认 1" }, { "name": "page_size", "type": "number", "required": false, "description": "分页大小,默认 20" }, { "name": "keyword", "type": "string", "required": false, "description": "签约备注或主体名称关键字" } ], "response": [ { "name": "data.list", "type": "array", "required": false, "description": "签约关系列表" }, { "name": "data.list[].id", "type": "number", "required": false, "description": "签约关系主键 ID" }, { "name": "data.list[].store_id", "type": "number", "required": false, "description": "货主 ID" }, { "name": "data.list[].store_name", "type": "string", "required": false, "description": "货主名称(优先取备注名,无则取 company_name)" }, { "name": "data.list[].warehouse_id", "type": "number", "required": false, "description": "仓库 ID" }, { "name": "data.list[].warehouse_name", "type": "string", "required": false, "description": "仓库名称(优先取备注名,无则取 company_name)" }, { "name": "data.list[].counterparty_id", "type": "number", "required": false, "description": "对方主体 ID(当前为仓库则返回货主 ID,反之亦然)" }, { "name": "data.list[].counterparty_name", "type": "string", "required": false, "description": "对方主体名称" }, { "name": "data.list[].current_subject_role", "type": "string", "required": false, "description": "当前主体角色:warehouse 或 store" }, { "name": "data.list[].auth_status", "type": "number", "required": false, "description": "签约状态:1=申请中 2=已通过 3=已拒绝 4=已解除 5=已过期" }, { "name": "data.list[].auth_status_label", "type": "string", "required": false, "description": "签约状态中文标签" }, { "name": "data.list[].apply_reason", "type": "string", "required": false, "description": "申请原因" }, { "name": "data.list[].review_comment", "type": "string", "required": false, "description": "审核评语" }, { "name": "data.list[].apply_time", "type": "string|null", "required": false, "description": "申请时间" }, { "name": "data.list[].review_time", "type": "string|null", "required": false, "description": "审核时间" }, { "name": "data.list[].auth_start", "type": "string|null", "required": false, "description": "授权开始时间" }, { "name": "data.list[].auth_end", "type": "string|null", "required": false, "description": "授权结束时间" }, { "name": "data.list[].actual_end", "type": "string|null", "required": false, "description": "实际结束时间" }, { "name": "data.list[].print_quantity", "type": "number", "required": false, "description": "面单余额数量" }, { "name": "data.list[].applied_by", "type": "number|null", "required": false, "description": "申请人账号 ID" }, { "name": "data.list[].reviewed_by", "type": "number|null", "required": false, "description": "审核人账号 ID" }, { "name": "data.list[].ended_by", "type": "number|null", "required": false, "description": "解除人账号 ID" }, { "name": "data.list[].remask", "type": "string", "required": false, "description": "备注名(当前为仓库则返回货主备注名,反之亦然)" }, { "name": "data.list[].use_status", "type": "number", "required": false, "description": "启用状态:0=禁用 1=启用" }, { "name": "data.list[].policy_config", "type": "object|null", "required": false, "description": "签约策略配置对象,无则为 null" }, { "name": "data.list[].is_auth_valid", "type": "boolean", "required": false, "description": "签约是否在有效期内" }, { "name": "data.list[].remaining_days", "type": "number", "required": false, "description": "剩余有效天数(未在有效期内时为 0)" }, { "name": "data.list[].has_qimen_config", "type": "boolean", "required": false, "description": "该货主是否已配置奇门(true=已配置,false=未配置)" }, { "name": "data.total", "type": "number", "required": false, "description": "总记录数" }, { "name": "data.page", "type": "number", "required": false, "description": "当前页码" }, { "name": "data.page_size", "type": "number", "required": false, "description": "每页条数" }, { "name": "data.current_subject.store_id", "type": "number", "required": false, "description": "当前主体 ID" }, { "name": "data.current_subject.company_name", "type": "string", "required": false, "description": "当前主体公司名称" }, { "name": "data.current_subject.role", "type": "string", "required": false, "description": "当前主体角色:warehouse 或 store" } ] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.listApiConfig", "title": "查询签约关系下的接口配置列表", "description": "查询签约关系下的接口配置列表", "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,兼容 contract_id" }, { "name": "interface_type_id", "type": "number", "required": false, "description": "接口类型ID,默认查询全部可用类型" } ], "response": [ { "name": "data.list[].callback_url", "type": "string", "required": false, "description": "API回调通知URL,来自 serializeQimenConfig 序列化" } ] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.openAccount", "title": "仓库代货主一键开户:同时完成账号注册、货主创建和仓库-货主签约", "description": "仓库代货主一键开户:同时完成账号注册、货主创建和仓库-货主签约", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token(当前主体必须为仓库角色)" } ], "params": [ { "name": "username", "type": "string", "required": true, "description": "登录账号(用户名),全局唯一" }, { "name": "password", "type": "string", "required": false, "description": "初始密码,不传则自动随机生成 12 位密码" }, { "name": "real_name", "type": "string", "required": false, "description": "真实姓名" }, { "name": "company_name", "type": "string", "required": true, "description": "公司全称,全局唯一,1-200 字符" }, { "name": "business_license", "type": "string", "required": false, "description": "营业执照号" }, { "name": "contact_person", "type": "string", "required": true, "description": "联系人姓名,1-50 字符" }, { "name": "contact_phone", "type": "string", "required": false, "description": "联系电话" }, { "name": "legal_person", "type": "string", "required": false, "description": "法人代表" }, { "name": "contact_email", "type": "string", "required": false, "description": "联系邮箱" }, { "name": "address", "type": "string", "required": false, "description": "公司地址" }, { "name": "industry", "type": "string", "required": false, "description": "所属行业" }, { "name": "logo_url", "type": "string", "required": false, "description": "Logo 链接" }, { "name": "domain", "type": "string", "required": false, "description": "绑定域名" }, { "name": "auth_start", "type": "string", "required": false, "description": "授权开始日期,默认当天(ISO 8601 格式)" }, { "name": "auth_end", "type": "string", "required": false, "description": "授权结束日期(ISO 8601 格式)" }, { "name": "print_quantity", "type": "number", "required": false, "description": "初始面单余额,默认 0" }, { "name": "apply_reason", "type": "string", "required": false, "description": "申请原因,默认\"仓库代开户\",最长 2000 字符" }, { "name": "store_remask", "type": "string", "required": false, "description": "货主备注名,最长 50 字符" }, { "name": "warehouse_remask", "type": "string", "required": false, "description": "仓库备注名,最长 50 字符" } ], "response": [ { "name": "store_id", "type": "number", "required": true, "description": "新建的货主 ID" }, { "name": "account_id", "type": "number", "required": true, "description": "新建的账号 ID" }, { "name": "contract_id", "type": "number", "required": true, "description": "新建的签约关系 ID" }, { "name": "company_name", "type": "string", "required": true, "description": "货主公司名称" }, { "name": "username", "type": "string", "required": true, "description": "新建的登录账号名" }, { "name": "role_id", "type": "number", "required": true, "description": "分配的货主管理员角色 ID" } ] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.queryPrintQuantityLogs", "title": "按 store_id 分页查询面单余额变更日志", "description": "按 store_id 分页查询面单余额变更日志", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "store_id", "type": "number|string", "required": true, "description": "货主ID(必填)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页对象,包含 page 与 page_size;默认 { page: 1, page_size: 20 }" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "返回结果对象,包含 list 和 pagination" } ] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.rename", "title": "修改当前主体视角下的签约备注名", "description": "修改当前主体视角下的签约备注名", "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,兼容 contract_id" } ], "response": [] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.saveApiConfig", "title": "新增或更新签约关系下的接口配置。QM_WMS 类型须填写奇门字段;OPEN_API 类型由系统自动生成 self_app_key 和 self_app_secret", "description": "新增或更新签约关系下的接口配置。QM_WMS 类型须填写奇门字段;OPEN_API 类型由系统自动生成 self_app_key 和 self_app_secret", "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,兼容 contract_id" }, { "name": "interface_type_id", "type": "number", "required": true, "description": "接口类型ID,必须是 wms_interface_type 已存在的类型" }, { "name": "qimen_app_key", "type": "string", "required": false, "description": "奇门 AppKey(QM_WMS 类型必填,OPEN_API 类型不需要)" }, { "name": "qimen_customer_id", "type": "string", "required": false, "description": "奇门客户ID(QM_WMS 类型必填,OPEN_API 类型不需要)" }, { "name": "qimen_warehouse_code", "type": "string", "required": false, "description": "奇门仓库编码(QM_WMS 类型必填,OPEN_API 类型不需要)" }, { "name": "app_name", "type": "string", "required": true, "description": "应用名称" }, { "name": "callback_url", "type": "string", "required": false, "description": "API 回调通知 URL(可选),最大 500 字符;配置后订单状态变更时将回调通知推送到此地址;兼容别名 callbackUrl" } ], "response": [] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.savePolicyConfig", "title": "保存签约策略配置", "description": "保存签约策略配置", "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,兼容 contract_id" }, { "name": "policy_config", "type": "object", "required": true, "description": "策略配置对象;支持 receive_mode、auto_allocate_bin、auto_allocate_express(是否自动分配快递)、auto_allocate_storage(是否自动分配储位)、allow_mix_batch、allow_temp_storage、storage_separation、print_recharge_price(面单充值元/单,支持 2 位小数)、max_daily_inbound、remark、waybill_custom_display_type(面单自定义显示类型:1=隐藏,2=商品名称和数量,3=拣货库位和条码和数量,4=拣货库位和条码后5位和数量,5=拣货库位商品名称条码和数量)、enable_external_express_code(是否启用外部快递编码,flag:0=关闭,1=开启;默认 0)" }, { "name": "policy_config.enable_external_express_code", "type": "number", "required": false, "description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)" } ], "response": [ { "name": "data.contract_id", "type": "number", "required": true, "description": "签约关系ID" }, { "name": "data.policy_config", "type": "object", "required": true, "description": "保存后并补齐默认值的策略配置对象" }, { "name": "data.policy_config.enable_external_express_code", "type": "number", "required": true, "description": "是否启用外部快递编码(flag:0=关闭,1=开启;默认 0)" } ] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.sign", "title": "发起或确认仓库-货主签约", "description": "发起或确认仓库-货主签约", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "store_id", "type": "number", "required": false, "description": "货主ID;由仓库侧发起时必传" }, { "name": "warehouse_id", "type": "number", "required": false, "description": "仓库ID;由货主侧发起时必传" }, { "name": "temp_code", "type": "string", "required": false, "description": "临时签约码;传入后进入确认或预览流程" } ], "response": [] }, { "moduleName": "货主-仓库签约模块", "moduleKey": "storeWarehouse.store", "moduleFolder": "storewarehouse.store", "method": "storeWarehouse.store.unbind", "title": "解除或停用签约关系", "description": "解除或停用签约关系", "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,兼容 contract_id" }, { "name": "use_status", "type": "number", "required": false, "description": "使用状态,0=停用,1=恢复" } ], "response": [] }, { "moduleName": "用户模块", "moduleKey": "user", "moduleFolder": "user", "method": "user.changeRole", "title": "user.changeRole 接口", "description": "user.changeRole 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "用户模块", "moduleKey": "user", "moduleFolder": "user", "method": "user.getBindWechatCode", "title": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)", "description": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "forceRefresh", "type": "boolean", "required": false, "description": "是否强制刷新状态,true 时跳过缓存等待窗口" }, { "name": "waitForChange", "type": "boolean", "required": false, "description": "是否显式开启长轮询等待(推荐字段);true 时进入最长60秒等待" }, { "name": "longPoll", "type": "boolean", "required": false, "description": "长轮询开关(兼容字段);true 时进入最长60秒等待" }, { "name": "waitTimeoutMs", "type": "number", "required": false, "description": "等待超时毫秒数;后端自动封顶60000" }, { "name": "init", "type": "boolean", "required": false, "description": "初始化请求标记;true 时强制立即返回,不进入长等待" } ], "response": [] }, { "moduleName": "用户模块", "moduleKey": "user", "moduleFolder": "user", "method": "user.getLoginWechatCode", "title": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)", "description": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "clientCode", "type": "string", "required": false, "description": "客户端编码;首次可不传,后续轮询建议透传已有值" } ], "response": [] }, { "moduleName": "用户模块", "moduleKey": "user", "moduleFolder": "user", "method": "user.info", "title": "获取当前用户信息", "description": "获取当前用户信息", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "用户模块", "moduleKey": "user", "moduleFolder": "user", "method": "user.login", "title": "用户登录(仅返回 token)", "description": "用户登录(仅返回 token)", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "password", "type": "string", "required": false, "description": "password 参数" }, { "name": "username", "type": "string", "required": false, "description": "username 参数" } ], "response": [] }, { "moduleName": "用户模块", "moduleKey": "user", "moduleFolder": "user", "method": "user.loginByCode", "title": "登录码登录(使用 ye4s_user.tmp_code)", "description": "登录码登录(使用 ye4s_user.tmp_code)", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "code", "type": "string", "required": true, "description": "登录码,对应 ye4s_user.tmp_code" } ], "response": [] }, { "moduleName": "用户模块", "moduleKey": "user", "moduleFolder": "user", "method": "user.logout", "title": "用户登出", "description": "用户登出", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "用户模块", "moduleKey": "user", "moduleFolder": "user", "method": "user.register", "title": "user.register 接口", "description": "user.register 接口", "endpoint": "/system", "authRequired": false, "loginRequired": false, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [], "response": [] }, { "moduleName": "用户模块", "moduleKey": "user", "moduleFolder": "user", "method": "user.unbindWechat", "title": "解绑微信账号(清理 ye4s 关联账号数据)", "description": "解绑微信账号(清理 ye4s 关联账号数据)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.batchUpdateSpaceInfo", "title": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。", "description": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": false, "description": "货架ID,传入时校验所有 space_code 必须属于该货架,不传则只校验属于任意货架类型库位" }, { "name": "items", "type": "array", "required": true, "description": "批量修改数据数组;每项支持字段:space_code、custom_name、custom_barcode、pick_sequence、location_type_name" }, { "name": "items[].space_code", "type": "string", "required": true, "description": "仓位编码,作为批量修改的唯一定位键;缺失、重复或不存在都会整批失败" }, { "name": "items[].custom_name", "type": "string", "required": false, "description": "自定义名称,空字符串会被清空" }, { "name": "items[].custom_barcode", "type": "string", "required": false, "description": "自定义条码,批次内或系统内冲突都会整批失败;空字符串会被清空" }, { "name": "items[].pick_sequence", "type": "number", "required": false, "description": "拣货顺序,必须为非负整数,超出边界则整批失败" }, { "name": "items[].location_type_id", "type": "number", "required": false, "description": "仓位类型ID,必须为正整数且在当前仓库或全局类型中存在(is_active=true),否则整批失败;传 null 或不传则不修改仓位类型" } ], "response": [ { "name": "count", "type": "number", "required": false, "description": "成功更新的记录数" } ] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.checkBarcodeUnique", "title": "warehouse.checkBarcodeUnique 接口", "description": "warehouse.checkBarcodeUnique 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "barcode", "type": "string", "required": true, "description": "barcode 参数" }, { "name": "id", "type": "number", "required": true, "description": "id 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.create", "title": "warehouse.create 接口", "description": "warehouse.create 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.createRackWithSpaces", "title": "warehouse.createRackWithSpaces 接口", "description": "warehouse.createRackWithSpaces 接口", "endpoint": "/system", "authRequired": true, "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 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.delete", "title": "warehouse.delete 接口", "description": "warehouse.delete 接口", "endpoint": "/system", "authRequired": true, "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 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.detail", "title": "warehouse.detail 接口", "description": "warehouse.detail 接口", "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 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.exportRackSpaces", "title": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)", "description": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)", "endpoint": "/system", "authRequired": true, "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,仅导出该货架下仓位" } ], "response": [ { "name": "count", "type": "number", "required": false, "description": "导出记录数" }, { "name": "fileName", "type": "string", "required": false, "description": "导出文件名" }, { "name": "fileUrl", "type": "string", "required": false, "description": "导出文件下载地址" } ] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.getAreaRacks", "title": "warehouse.getAreaRacks 接口", "description": "warehouse.getAreaRacks 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "area_id", "type": "number", "required": true, "description": "area_id 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.getChildren", "title": "warehouse.getChildren 接口", "description": "warehouse.getChildren 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "zoneId", "type": "number", "required": true, "description": "zoneId 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.getPath", "title": "warehouse.getPath 接口", "description": "warehouse.getPath 接口", "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 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.getPickPath", "title": "warehouse.getPickPath 接口", "description": "warehouse.getPickPath 接口", "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", "type": "number", "required": true, "description": "warehouse_id 参数" }, { "name": "include_spaces", "type": "string", "required": false, "description": "include_spaces 参数" }, { "name": "limit", "type": "number", "required": false, "description": "limit 参数" }, { "name": "sort_by", "type": "string", "required": false, "description": "sort_by 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.getSpaceInfo", "title": "warehouse.getSpaceInfo 接口", "description": "warehouse.getSpaceInfo 接口", "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 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.getSpacesByRack", "title": "warehouse.getSpacesByRack 接口", "description": "warehouse.getSpacesByRack 接口", "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 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.getWarehouseTree", "title": "warehouse.getWarehouseTree 接口", "description": "warehouse.getWarehouseTree 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouseId", "type": "number", "required": true, "description": "warehouseId 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.getWarehouseZones", "title": "warehouse.getWarehouseZones 接口", "description": "warehouse.getWarehouseZones 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.recalculatePickPath", "title": "warehouse.recalculatePickPath 接口", "description": "warehouse.recalculatePickPath 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouse_id", "type": "number", "required": true, "description": "warehouse_id 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.toggleActive", "title": "warehouse.toggleActive 接口", "description": "warehouse.toggleActive 接口", "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": "isActive", "type": "string", "required": false, "description": "isActive 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.update", "title": "warehouse.update 接口", "description": "warehouse.update 接口", "endpoint": "/system", "authRequired": true, "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": "aisles", "type": "string", "required": false, "description": "aisles 参数" }, { "name": "cell_height", "type": "string", "required": false, "description": "cell_height 参数" }, { "name": "cell_length", "type": "string", "required": false, "description": "cell_length 参数" }, { "name": "cell_width", "type": "string", "required": false, "description": "cell_width 参数" }, { "name": "direction", "type": "string", "required": false, "description": "direction 参数" }, { "name": "height", "type": "number", "required": false, "description": "height 参数" }, { "name": "is_active", "type": "boolean", "required": false, "description": "是否启用,支持 true/false 或 1/0" }, { "name": "length", "type": "number", "required": false, "description": "length 参数" }, { "name": "rack_columns", "type": "string", "required": false, "description": "rack_columns 参数" }, { "name": "rack_levels", "type": "string", "required": false, "description": "rack_levels 参数" }, { "name": "rack_rows", "type": "string", "required": false, "description": "rack_rows 参数" }, { "name": "width", "type": "number", "required": false, "description": "width 参数" }, { "name": "x", "type": "number", "required": false, "description": "x 参数" }, { "name": "y", "type": "number", "required": false, "description": "y 参数" }, { "name": "z", "type": "number", "required": false, "description": "z 参数" }, { "name": "zone_code", "type": "string", "required": false, "description": "zone_code 参数" }, { "name": "zone_name", "type": "string", "required": false, "description": "zone_name 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.updateNeighbors", "title": "warehouse.updateNeighbors 接口", "description": "warehouse.updateNeighbors 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouse_id", "type": "number", "required": true, "description": "warehouse_id 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.updateRackPosition", "title": "warehouse.updateRackPosition 接口", "description": "warehouse.updateRackPosition 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "x", "type": "number", "required": true, "description": "x 参数" }, { "name": "y", "type": "number", "required": true, "description": "y 参数" }, { "name": "rack_id", "type": "number", "required": false, "description": "rack_id 参数" }, { "name": "z", "type": "number", "required": false, "description": "z 参数" } ], "response": [] }, { "moduleName": "仓库模块", "moduleKey": "warehouse", "moduleFolder": "warehouse", "method": "warehouse.updateSpaceInfo", "title": "warehouse.updateSpaceInfo 接口", "description": "warehouse.updateSpaceInfo 接口", "endpoint": "/system", "authRequired": true, "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": "custom_barcode", "type": "string", "required": false, "description": "custom_barcode 参数" }, { "name": "custom_name", "type": "string", "required": false, "description": "custom_name 参数" }, { "name": "location_type_id", "type": "number", "required": false, "description": "location_type_id 参数" }, { "name": "pick_sequence", "type": "string", "required": false, "description": "pick_sequence 参数" }, { "name": "space_status", "type": "string", "required": false, "description": "space_status 参数" } ], "response": [] } ] }