{ "module": "qimen", "description": "奇门接口标准入口,method 对应 qimenMethods 异步方法,全部使用 POST 请求,参数包含 query 与 XML body(request 节点)", "version": "0.3.10", "updatedAt": "2026-09-12", "headers": [], "methods": { "groups": [ { "groupName": "deliveryorder 模块", "module": "deliveryorder", "list": [ { "method": "deliveryorder.batchcreate", "description": "deliveryorder.batchcreate 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" }, { "name": "request.orderCode", "type": "string", "required": false, "source": "body", "description": "request.orderCode 参数" } ], "response": [], "errors": [] }, { "method": "deliveryorder.create", "description": "deliveryorder.create 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" }, { "name": "request.orderCode", "type": "string", "required": false, "source": "body", "description": "request.orderCode 参数" } ], "response": [], "errors": [] }, { "method": "deliveryorder.query", "description": "deliveryorder.query 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" }, { "name": "request.orderCode", "type": "string", "required": false, "source": "body", "description": "request.orderCode 参数" } ], "response": [], "errors": [] } ] }, { "groupName": "entryorder 模块", "module": "entryorder", "list": [ { "method": "entryorder.create", "description": "创建入库单。奇门 XML 推送创建入库单及明细,返回入库单 ID、单号、创建时间和状态。明细行商品匹配三级策略:itemId 主键直查 > itemCode 精确匹配 > itemCode 归一化条码匹配(取编码开头连续数字,剥离中文后缀)", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点,包含 entryOrder 和 orderLines 子节点" }, { "name": "request.entryOrder", "type": "object", "required": true, "source": "body", "description": "入库单头信息" }, { "name": "request.entryOrder.entryOrderCode", "type": "string", "required": true, "source": "body", "description": "入库单号(外部系统单号)" }, { "name": "request.entryOrder.warehouseCode", "type": "string", "required": true, "source": "body", "description": "仓库编码" }, { "name": "request.entryOrder.ownerCode", "type": "string", "required": true, "source": "body", "description": "货主编码" }, { "name": "request.entryOrder.orderType", "type": "string", "required": true, "source": "body", "description": "入库单类型:CGRK(采购入库)、JITRK(JIT入库)、THRK(退货入库)、QTRK(其他入库)等" }, { "name": "request.orderLines.orderLine", "type": "object|array", "required": true, "source": "body", "description": "入库单明细行,单条为 object,多条为 array" }, { "name": "request.orderLines.orderLine.itemCode", "type": "string", "required": true, "source": "body", "description": "商品编码。支持带中文后缀的编码(如 6934864201409-新品):精确匹配不到时取编码开头的连续数字(6934864201409)作为归一化条码与商品主数据对齐匹配" }, { "name": "request.orderLines.orderLine.itemId", "type": "string", "required": false, "source": "body", "description": "商品 ID。纯数字且不超 BIGINT 范围时按 StockStore 主键直查(校验货主一致);非法值(如带中文后缀的编码)视为未提供,降级按 itemCode 匹配。主键查不到或货主不一致时同样降级按 itemCode 匹配" }, { "name": "request.orderLines.orderLine.itemName", "type": "string", "required": true, "source": "body", "description": "商品名称" }, { "name": "request.orderLines.orderLine.planQty", "type": "number", "required": true, "source": "body", "description": "计划入库数量" }, { "name": "request.orderLines.orderLine.orderLineNo", "type": "string", "required": false, "source": "body", "description": "行号" }, { "name": "request.orderLines.orderLine.inventoryType", "type": "string", "required": false, "source": "body", "description": "库存类型,如 ZP(正品),默认 ZP" } ], "response": [ { "name": "entryOrderId", "type": "number", "required": true, "description": "WMS 入库单 ID" }, { "name": "entryOrderCode", "type": "string", "required": true, "description": "入库单号" }, { "name": "createTime", "type": "string", "required": true, "description": "创建时间" }, { "name": "status", "type": "string", "required": true, "description": "入库单状态:CREATED(已创建)或 PENDING(已审核)" } ], "errors": [ { "code": 400, "message": "创建入库单失败,失败原因:订单行N:SKU{itemId}商品《itemName》编码《itemCode》未同步推送到仓库" }, { "code": 400, "message": "创建入库单失败,失败原因:订单行N:SKU{itemId}商品《itemName》编码《itemCode》wms无对应关系,请联系仓库关联创建商品" }, { "code": 400, "message": "创建入库单失败,失败原因:订单行N:编码《itemCode》归一化条码《barcode》匹配到多个商品,请人工核对后重试" }, { "code": 500, "message": "服务器异常" } ], "notes": [ "明细行商品匹配三级策略:itemId 主键直查(纯数字且不超 BIGINT 范围、货主一致)> itemCode 精确匹配 > itemCode 归一化条码匹配(取编码开头连续数字)", "带中文后缀的编码(如 6934864201409-新品)精确匹配不到时按归一化条码对齐;归一化条码命中多个商品时报错,不静默取第一条", "item_id 统一写入实际匹配到的 StockStore 数字主键 id,避免非数字值写入 BIGINT 列触发 MySQL 严格模式报错(Data truncated for column 'item_id')", "失败信息回显真实 SKU/商品/编码并附订单行号", "入口 app/service/qimenMethods/entryorder.js,核心 app/service/systems/entry_order.js addOrder(OpenAPI 渠道共用同一逻辑)" ] }, { "method": "entryorder.query", "description": "entryorder.query 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" } ], "response": [], "errors": [] } ] }, { "groupName": "inventory 模块", "module": "inventory", "list": [ { "method": "inventory.query", "description": "inventory.query 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" }, { "name": "request.criteriaList", "type": "string", "required": false, "source": "body", "description": "request.criteriaList 参数" } ], "response": [], "errors": [] } ] }, { "groupName": "order 模块", "module": "order", "list": [ { "method": "order.cancel", "description": "取消单据接口。按 request.orderType 匹配作业类型分发:ORDER 组(JYCK/HHCK/BFCK)取消发货单(未拣货且未打印直接取消,已拣货/已打印/已同步转拦截);RK 组(B2BRK/SCRK/LYRK/CCRK/CGRK/DBRK/QTRK)委托 ctx.service.systems.storage.entry.cancel 完整作废流程取消入库单(状态守卫 + 状态置 CANCELLED + 按台账回退关联收货单占用 + 写 ENTRY_ORDER_CANCEL 操作日志,不回传奇门事件);CK 组(PTCK/DBCK/B2BCK/QTCK/CGTH)按出库单号取消出库单(wms_order_stockout,仅 CREATED/PENDING 可取消,释放 QM_STOCKOUT 锁定);JG/BACKORDER 组均未开发完成,返回对应提示", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点,包含 orderCode 与 orderType 字段" }, { "name": "request.orderCode", "type": "string", "required": false, "source": "body", "description": "单据编码:ORDER 组为发货单号(delivery_order_code),RK 组为入库单号(entry_order_code),CK 组为出库单号(stockout_order_code)" }, { "name": "request.orderType", "type": "string", "required": false, "source": "body", "description": "作业类型枚举(按 orderType → 作业类型分发):ORDER 组(取消发货单,已实现):JYCK=一般交易出库单、HHCK=换货出库、BFCK=补发出库;RK 组(取消入库单,已实现,委托 ctx.service.systems.storage.entry.cancel 完整作废流程:守卫 COMPLETED/sync_status=SUCCESS、状态置 CANCELLED、按台账回退关联收货单占用、写 ENTRY_ORDER_CANCEL 操作日志,不回传奇门事件):B2BRK=B2B入库、SCRK=生产入库、LYRK=领用入库、CCRK=残次品入库、CGRK=采购入库、DBRK=调拨入库、QTRK=其他入库;CK 组(取消出库单,已实现,按出库单号查 wms_order_stockout,仅 CREATED/PENDING 可取消):PTCK=普通出库单、DBCK=调拨出库、B2BCK=B2B出库、QTCK=其他出库、CGTH=采购退货出库单;JG 组(未开发,返回取消加工单未开发完成):CNJG=仓内加工单;BACKORDER 组(未开发,返回取消退货单未开发完成):XTRK=销退入库、THRK=退货入库、HHRK=换货入库。枚举之外的值无法匹配作业类型,接口返回失败" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "success=成功,failure=失败" }, { "name": "code", "type": "number", "required": true, "description": "1=成功,0=失败" }, { "name": "message", "type": "string", "required": true, "description": "提示信息(如:取消订单成功、取消入库单成功、取消出库单成功、取消失败,已通知拦截执行)" } ], "errors": [ { "code": 0, "message": "订单号不能为空" }, { "code": 0, "message": "未找到对应的订单" }, { "code": 0, "message": "入库单号不能为空" }, { "code": 0, "message": "未找到对应的入库单" }, { "code": 0, "message": "已完成入库单不允许作废" }, { "code": 0, "message": "入库单已完成回传,不可取消" }, { "code": 0, "message": "取消失败,已通知拦截执行" }, { "code": 0, "message": "订单已同步,不可取消,已转为拦截处理" }, { "code": 0, "message": "出库单号不能为空" }, { "code": 0, "message": "未找到对应的出库单" }, { "code": 0, "message": "出库单当前状态(xxx)不允许取消(仅 CREATED/PENDING 可取消)" }, { "code": 0, "message": "取消失败:xxx(释放库存锁定等异常)" }, { "code": 0, "message": "取消加工单未开发完成" }, { "code": 0, "message": "取消退货单未开发完成" } ], "notes": [ "入口:app/service/qimenMethods/order.js cancel,通过 switch (orderType.method) 分发;入参 request.orderCode(单据编码)+ request.orderType(作业类型枚举)", "ORDER 组取消逻辑与 openapi 一致:未拣货且未打印直接取消(status=cancel, outbound_status=fin, step=4);已拣货或已打印改为拦截(intercept_status=intercepting),返回取消失败,已通知拦截执行", "已同步订单(sync_status=fin)转拦截(intercept_status=requested),返回订单已同步,不可取消,已转为拦截处理", "团购单已复核/散单已称重时不写入拦截请求状态,返回订单已复核/已称重,无法拦截(取消)执行,已转快递拦截", "RK 组:空单号返回入库单号不能为空;委托 ctx.service.systems.storage.entry.cancel({ entryOrderCode }, { storeId, warehouseId, operatorLabel=qimen:xxx, skipExternalSync=true, idempotent=true, notFoundMessage=未找到对应的入库单 });守卫 sync_status=SUCCESS 返回入库单已完成回传,不可取消、order_status=COMPLETED 返回已完成入库单不允许作废;已 CANCELLED 幂等返回取消入库单成功(外部渠道重试口径);作废动作 = 状态置 CANCELLED + 按台账回退关联收货单占用(重算 storage_status)+ 写 ENTRY_ORDER_CANCEL 操作日志;skipExternalSync=true 全程不触发 qimenEntrySync,取消成功不回传奇门事件;未找到返回未找到对应的入库单;共享实现的 QM 回传失败分支文案为取消失败: xxx(RK 渠道 skipExternalSync=true 不触发回传,该分支不会出现)", "CK 组:委托 ctx.service.systems.stockoutOrder.cancel(共享实现,单事务 + 行锁),按出库单号查 wms_order_stockout;仅 CREATED/PENDING 允许取消(COMPLETED/TRANSFERRED 拒绝),释放 QM_STOCKOUT 库存锁定(写 UNLOCK 流水,「释放数量超过已锁定库存」视为幂等跳过),状态置 CANCELLED 并写 wms_operation_log(business_type=stockout,operation_code=STOCKOUT_CANCEL);已 CANCELLED 幂等返回取消出库单成功;取消成功不向奇门回传任何事件", "JG/BACKORDER 组:分别返回取消加工单未开发完成、取消退货单未开发完成", "已取消订单(status=cancel)走幂等分支返回取消订单成功;未找到订单返回未找到对应的订单", "响应为奇门 XML 结构(flag/code/message),code=1 成功、code=0 失败" ] }, { "method": "order.pending", "description": "锁定单据接口(占位)。按 request.orderType 匹配作业类型分发,当前所有作业类型(ORDER/RK/CK/JG/BACKORDER)均未开发完成,统一返回锁定XX未开发完成", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点,包含 orderCode 与 orderType 字段" }, { "name": "request.orderCode", "type": "string", "required": false, "source": "body", "description": "单据编码(发货单号/入库单号,视 orderType 作业类型而定)" }, { "name": "request.orderType", "type": "string", "required": false, "source": "body", "description": "作业类型枚举(与 order.cancel 一致):ORDER 组:JYCK=一般交易出库单、HHCK=换货出库、BFCK=补发出库;RK 组:B2BRK=B2B入库、SCRK=生产入库、LYRK=领用入库、CCRK=残次品入库、CGRK=采购入库、DBRK=调拨入库、QTRK=其他入库;CK 组:PTCK=普通出库单、DBCK=调拨出库、B2BCK=B2B出库、QTCK=其他出库、CGTH=采购退货出库单;JG 组:CNJG=仓内加工单;BACKORDER 组:XTRK=销退入库、THRK=退货入库、HHRK=换货入库。当前所有类型均未开发完成,返回锁定XX未开发完成" } ], "response": [ { "name": "flag", "type": "string", "required": true, "description": "success=成功,failure=失败(当前所有分支均返回 failure)" }, { "name": "code", "type": "number", "required": true, "description": "1=成功,0=失败" }, { "name": "message", "type": "string", "required": true, "description": "提示信息(锁定订单/入库单/出库单/加工单/退货单未开发完成)" } ], "errors": [ { "code": 0, "message": "锁定订单未开发完成" }, { "code": 0, "message": "锁定入库单未开发完成" }, { "code": 0, "message": "锁定出库单未开发完成" }, { "code": 0, "message": "锁定加工单未开发完成" }, { "code": 0, "message": "锁定退货单未开发完成" } ], "notes": [ "入口:app/service/qimenMethods/order.js pending,通过 switch (orderType.method) 分发;入参 request.orderCode + request.orderType(枚举同 order.cancel)", "当前所有作业类型分支均未实现,统一返回锁定XX未开发完成(flag=failure、code=0)", "枚举之外的值无法匹配作业类型,接口返回失败" ] } ] }, { "groupName": "returnorder 模块", "module": "returnorder", "list": [ { "method": "returnorder.create", "description": "returnorder.create 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" } ], "response": [], "errors": [] }, { "method": "returnorder.query", "description": "returnorder.query 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" } ], "response": [], "errors": [] } ] }, { "groupName": "singleitem 模块", "module": "singleitem", "list": [ { "method": "singleitem.query", "description": "singleitem.query 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" }, { "name": "request.itemId", "type": "string", "required": false, "source": "body", "description": "request.itemId 参数" } ], "response": [], "errors": [] }, { "method": "singleitem.synchronize", "description": "singleitem.synchronize 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" }, { "name": "request.itemId", "type": "string", "required": false, "source": "body", "description": "request.itemId 参数" } ], "response": [], "errors": [] } ] }, { "groupName": "stockout 模块", "module": "stockout", "list": [ { "method": "stockout.create", "description": "stockout.create 接口(创建非订单出库单;对应 system 出口 storage.stockout.*)", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" }, { "name": "request.deliveryOrder", "type": "object", "required": true, "source": "body", "description": "出库单头信息" }, { "name": "request.deliveryOrder.deliveryOrderCode", "type": "string", "required": true, "source": "body", "description": "出库单号" }, { "name": "request.deliveryOrder.orderType", "type": "string", "required": true, "source": "body", "description": "业务类型(JYCK一般交易出库/HHCK换货出库/BFCK补发出库/QTCK其他出库)" }, { "name": "request.deliveryOrder.warehouseCode", "type": "string", "required": true, "source": "body", "description": "仓库编码" }, { "name": "request.deliveryOrder.createTime", "type": "string", "required": false, "source": "body", "description": "订单创建时间" }, { "name": "request.deliveryOrder.totalOrderLines", "type": "integer", "required": false, "source": "body", "description": "单据总行数" }, { "name": "request.deliveryOrder.remark", "type": "string", "required": false, "source": "body", "description": "备注" }, { "name": "request.orderLines", "type": "object", "required": true, "source": "body", "description": "出库单明细" }, { "name": "request.orderLines.orderLine", "type": "object/array", "required": true, "source": "body", "description": "明细行(单条为对象,多条为数组)" }, { "name": "request.orderLines.orderLine.orderLineNo", "type": "string", "required": true, "source": "body", "description": "订单行号" }, { "name": "request.orderLines.orderLine.ownerCode", "type": "string", "required": true, "source": "body", "description": "货主编码" }, { "name": "request.orderLines.orderLine.itemCode", "type": "string", "required": true, "source": "body", "description": "商品编码" }, { "name": "request.orderLines.orderLine.itemId", "type": "string", "required": true, "source": "body", "description": "WMS商品ID" }, { "name": "request.orderLines.orderLine.itemName", "type": "string", "required": false, "source": "body", "description": "商品名称" }, { "name": "request.orderLines.orderLine.planQty", "type": "integer", "required": true, "source": "body", "description": "计划数量" }, { "name": "request.orderLines.orderLine.inventoryType", "type": "string", "required": false, "source": "body", "description": "库存类型(ZP正品/CC残次等)" } ], "response": [ { "name": "stockoutOrderId", "type": "integer", "required": true, "description": "出库单ID" }, { "name": "stockoutOrderCode", "type": "string", "required": true, "description": "出库单号" } ], "errors": [] }, { "method": "stockout.query", "description": "stockout.query 接口(查询非订单出库单;按 deliveryOrderCode 查 wms_order_stockout 主表+明细表)", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "请求数据" }, { "name": "request.deliveryOrder", "type": "object", "required": true, "source": "body", "description": "出库单查询条件" }, { "name": "request.deliveryOrder.deliveryOrderCode", "type": "string", "required": true, "source": "body", "description": "出库单号" } ], "response": [ { "name": "totalLines", "type": "integer", "required": true, "description": "明细总行数" }, { "name": "deliveryOrder", "type": "object", "required": true, "description": "出库单主单信息" }, { "name": "deliveryOrder.deliveryOrderCode", "type": "string", "required": true, "description": "出库单号" }, { "name": "deliveryOrder.deliveryOrderId", "type": "integer", "required": true, "description": "出库单ID" }, { "name": "deliveryOrder.warehouseCode", "type": "string", "required": true, "description": "仓库编码" }, { "name": "deliveryOrder.orderType", "type": "string", "required": true, "description": "业务类型" }, { "name": "deliveryOrder.status", "type": "string", "required": true, "description": "订单状态" }, { "name": "deliveryOrder.createTime", "type": "string", "required": true, "description": "创建时间" }, { "name": "deliveryOrder.remark", "type": "string", "required": true, "description": "备注" }, { "name": "orderLines", "type": "object", "required": true, "description": "明细集合" }, { "name": "orderLines.orderLine", "type": "array", "required": true, "description": "明细行数组" }, { "name": "orderLines.orderLine[].orderLineNo", "type": "string", "required": true, "description": "订单行号" }, { "name": "orderLines.orderLine[].ownerCode", "type": "string", "required": true, "description": "货主编码" }, { "name": "orderLines.orderLine[].itemCode", "type": "string", "required": true, "description": "商品编码" }, { "name": "orderLines.orderLine[].itemId", "type": "string", "required": true, "description": "WMS商品ID" }, { "name": "orderLines.orderLine[].itemName", "type": "string", "required": true, "description": "商品名称" }, { "name": "orderLines.orderLine[].planQty", "type": "integer", "required": true, "description": "计划数量" }, { "name": "orderLines.orderLine[].inventoryType", "type": "string", "required": true, "description": "库存类型" } ], "errors": [ { "code": 400, "message": "未找到出库单(deliveryOrderCode 对应记录不存在)" } ] } ] }, { "groupName": "taobao.qimen.service 模块", "module": "taobao.qimen.service", "list": [ { "method": "taobao.qimen.service.heartbeat", "description": "taobao.qimen.service.heartbeat 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "app_key", "type": "string", "required": true, "source": "query", "description": "app_key 参数" }, { "name": "method", "type": "string", "required": true, "source": "query", "description": "method 参数" }, { "name": "v", "type": "string", "required": true, "source": "query", "description": "v 参数" }, { "name": "format", "type": "string", "required": true, "source": "query", "description": "format 参数" }, { "name": "sign_method", "type": "string", "required": true, "source": "query", "description": "sign_method 参数" }, { "name": "sign", "type": "string", "required": true, "source": "query", "description": "sign 参数" }, { "name": "timestamp", "type": "string", "required": true, "source": "query", "description": "timestamp 参数" }, { "name": "request", "type": "object", "required": true, "source": "body", "description": "request XML 节点" }, { "name": "request.serialNumber", "type": "string", "required": false, "source": "body", "description": "request.serialNumber 参数" } ], "response": [], "errors": [] } ] } ] } }