{ "module": "qimen", "description": "奇门接口标准入口,method 对应 qimenMethods 异步方法,全部使用 POST 请求,参数包含 query 与 XML body(request 节点)", "version": "0.3.7", "updatedAt": "2026-08-30", "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": "order.cancel 接口", "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 参数" }, { "name": "request.orderType", "type": "string", "required": false, "source": "body", "description": "request.orderType 参数" } ], "response": [], "errors": [] }, { "method": "order.pending", "description": "order.pending 接口", "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 参数" }, { "name": "request.orderType", "type": "string", "required": false, "source": "body", "description": "request.orderType 参数" } ], "response": [], "errors": [] } ] }, { "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": [] } ] } ] } }