WMS_MAIN/methods/openapi.json
liufumingren e19b5fc18c feat(order): 取消单据支持 CK 出库单与 RK 入库单
- 奇门 order.cancel:CK 组(PTCK/DBCK/B2BCK/QTCK/CGTH)委托 systems.stockoutOrder.cancel 取消出库单(仅 CREATED/PENDING 可取消,释放 QM_STOCKOUT 锁定,不回传);RK 组由裸改状态升级为复用 systems.storage.entry.cancel 完整作废流程(状态守卫 + 回退收货单占用 + 操作日志,已作废幂等成功)。

- openapi order.cancel:新增 CK 组与 RK 组路由,成功/失败文案与奇门口径一致。

- storage.stockout.cancel 改为委托共享实现,对外契约与文案不变,改为单事务 + 行锁。

- storage.entry.cancel 扩展入参能力(entryOrderCode 定位 / skipExternalSync / idempotent / notFoundMessage),系统方法入口行为不变。

- 文档:methods/{qimen,openapi,system}.json 及对应 changes 同步。

注:app/service/systems/stockout_order.js 与 methods/openapi.json 同时承载此前未提交的出库单(stockout)共享服务与文档,文件粒度无法拆分,一并纳入本次提交。
2026-09-13 02:24:18 +08:00

2277 lines
121 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"module": "openapi",
"description": "开放 API 统一入口,独立链路,HTTP POST /openapi,记录入口校验/鉴权规则与返回格式。",
"version": "1.2.3",
"updatedAt": "2026-09-12",
"http": {
"path": "/openapi",
"method": "POST"
},
"headers": [],
"methods": {
"groups": [
{
"groupName": "基础模块",
"module": "index",
"list": [
{
"method": "index.ping",
"description": "基础模块 心跳接口,返回服务可用性(部署在 openapiMethods 中)",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务状态码,成功通常为 200 或 1"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示信息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "返回数据,ping 一般为空或包含版本/uptime 等信息"
}
],
"errors": [],
"notes": [
"模块:基础模块",
"方法部署位置:openapiMethods/index.ping",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
}
]
},
{
"groupName": "发货单模块",
"module": "deliveryorder",
"list": [
{
"method": "deliveryorder.create",
"description": "deliveryorder 模块 创建发货单接口,支持传入订单主信息、收件人信息和订单明细",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "deliveryOrder",
"type": "object",
"required": true,
"source": "body",
"description": "发货单主信息对象"
},
{
"name": "deliveryOrder.deliveryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "发货单编码(必填),外部系统的唯一订单号"
},
{
"name": "deliveryOrder.preDeliveryOrderCode",
"type": "string",
"required": false,
"source": "body",
"description": "前发货单编码,用于关联前置订单"
},
{
"name": "deliveryOrder.preDeliveryOrderId",
"type": "string",
"required": false,
"source": "body",
"description": "前发货单ID,用于关联前置订单"
},
{
"name": "deliveryOrder.orderType",
"type": "string",
"required": false,
"source": "body",
"description": "订单类型,如 JYCK(一般出库)、PTCK(普通出库)等"
},
{
"name": "deliveryOrder.warehouseCode",
"type": "string",
"required": false,
"source": "body",
"description": "仓库编码,用于指定发货仓库"
},
{
"name": "deliveryOrder.orderFlag",
"type": "string",
"required": false,
"source": "body",
"description": "订单标记,自定义标记位"
},
{
"name": "deliveryOrder.sourcePlatformCode",
"type": "string",
"required": false,
"source": "body",
"description": "来源平台编码,如 TB(淘宝)、JD(京东)、PDD(拼多多)等;匹配不到时自动使用货主默认平台"
},
{
"name": "deliveryOrder.sourcePlatformName",
"type": "string",
"required": false,
"source": "body",
"description": "来源平台名称"
},
{
"name": "deliveryOrder.createTime",
"type": "string",
"required": false,
"source": "body",
"description": "订单创建时间,支持 ISO 8601 格式"
},
{
"name": "deliveryOrder.placeOrderTime",
"type": "string",
"required": false,
"source": "body",
"description": "下单时间,支持 ISO 8601 格式"
},
{
"name": "deliveryOrder.payTime",
"type": "string",
"required": false,
"source": "body",
"description": "支付时间,支持 ISO 8601 格式"
},
{
"name": "deliveryOrder.payNo",
"type": "string",
"required": false,
"source": "body",
"description": "支付单号"
},
{
"name": "deliveryOrder.shopNick",
"type": "string",
"required": false,
"source": "body",
"description": "店铺昵称"
},
{
"name": "deliveryOrder.sellerNick",
"type": "string",
"required": false,
"source": "body",
"description": "卖家昵称"
},
{
"name": "deliveryOrder.buyerNick",
"type": "string",
"required": false,
"source": "body",
"description": "买家昵称"
},
{
"name": "deliveryOrder.operatorName",
"type": "string",
"required": false,
"source": "body",
"description": "操作人姓名,未传入时自动按 API 应用名称回填"
},
{
"name": "deliveryOrder.operateTime",
"type": "string",
"required": false,
"source": "body",
"description": "操作时间,支持 ISO 8601 格式"
},
{
"name": "deliveryOrder.totalAmount",
"type": "number",
"required": false,
"source": "body",
"description": "订单总金额"
},
{
"name": "deliveryOrder.itemAmount",
"type": "number",
"required": false,
"source": "body",
"description": "商品总金额"
},
{
"name": "deliveryOrder.discountAmount",
"type": "number",
"required": false,
"source": "body",
"description": "折扣金额"
},
{
"name": "deliveryOrder.freight",
"type": "number",
"required": false,
"source": "body",
"description": "运费"
},
{
"name": "deliveryOrder.arAmount",
"type": "number",
"required": false,
"source": "body",
"description": "应收金额"
},
{
"name": "deliveryOrder.gotAmount",
"type": "number",
"required": false,
"source": "body",
"description": "实收金额"
},
{
"name": "deliveryOrder.logisticsCode",
"type": "string",
"required": false,
"source": "body",
"description": "快递编码,用于指定物流公司;匹配不到时自动使用货主默认快递"
},
{
"name": "deliveryOrder.expressCode",
"type": "string",
"required": false,
"source": "body",
"description": "快递公司编码"
},
{
"name": "deliveryOrder.logisticsAreaCode",
"type": "string",
"required": false,
"source": "body",
"description": "快递区域编码"
},
{
"name": "deliveryOrder.isUrgency",
"type": "string",
"required": false,
"source": "body",
"description": "是否加急,Y=是,N=否,默认 N"
},
{
"name": "deliveryOrder.invoiceFlag",
"type": "string",
"required": false,
"source": "body",
"description": "是否需要发票,Y=是,N=否,默认 N"
},
{
"name": "deliveryOrder.enableExternalExpressCode",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否启用外部快递编码匹配,开启后将优先按传入的 logisticsCode 匹配快递设置表"
},
{
"name": "deliveryOrder.receiverInfo",
"type": "object",
"required": false,
"source": "body",
"description": "收件人信息对象"
},
{
"name": "deliveryOrder.receiverInfo.name",
"type": "string",
"required": true,
"source": "body",
"description": "收件人姓名"
},
{
"name": "deliveryOrder.receiverInfo.tel",
"type": "string",
"required": false,
"source": "body",
"description": "收件人固定电话"
},
{
"name": "deliveryOrder.receiverInfo.mobile",
"type": "string",
"required": true,
"source": "body",
"description": "收件人手机号码"
},
{
"name": "deliveryOrder.receiverInfo.email",
"type": "string",
"required": false,
"source": "body",
"description": "收件人邮箱"
},
{
"name": "deliveryOrder.receiverInfo.countryCode",
"type": "string",
"required": false,
"source": "body",
"description": "国家编码"
},
{
"name": "deliveryOrder.receiverInfo.province",
"type": "string",
"required": true,
"source": "body",
"description": "省份"
},
{
"name": "deliveryOrder.receiverInfo.city",
"type": "string",
"required": true,
"source": "body",
"description": "城市"
},
{
"name": "deliveryOrder.receiverInfo.area",
"type": "string",
"required": true,
"source": "body",
"description": "区县"
},
{
"name": "deliveryOrder.receiverInfo.town",
"type": "string",
"required": false,
"source": "body",
"description": "乡镇/街道"
},
{
"name": "deliveryOrder.receiverInfo.detailAddress",
"type": "string",
"required": true,
"source": "body",
"description": "详细地址"
},
{
"name": "deliveryOrder.receiverInfo.zipCode",
"type": "string",
"required": false,
"source": "body",
"description": "邮政编码"
},
{
"name": "orderLines",
"type": "object",
"required": true,
"source": "body",
"description": "订单明细对象,包含 orderLine 数组"
},
{
"name": "orderLines.orderLine",
"type": "array",
"required": true,
"source": "body",
"description": "订单明细列表,数组中每项为一个订单行对象"
},
{
"name": "[].orderLine.itemCode",
"type": "string",
"required": false,
"source": "body",
"description": "商品编码,与 itemId 二选一,用于匹配仓库中的商品"
},
{
"name": "[].orderLine.itemId",
"type": "number",
"required": false,
"source": "body",
"description": "仓库商品主键ID,与 itemCode 二选一"
},
{
"name": "[].orderLine.itemName",
"type": "string",
"required": false,
"source": "body",
"description": "商品名称,用于错误提示中的商品识别"
},
{
"name": "[].orderLine.planQty",
"type": "number",
"required": true,
"source": "body",
"description": "计划发货数量(必填),必须大于 0"
},
{
"name": "[].orderLine.actualPrice",
"type": "number",
"required": false,
"source": "body",
"description": "实际单价"
},
{
"name": "[].orderLine.retailPrice",
"type": "number",
"required": false,
"source": "body",
"description": "零售单价"
},
{
"name": "[].orderLine.extCode",
"type": "string",
"required": false,
"source": "body",
"description": "外部商品编码"
},
{
"name": "[].orderLine.inventoryType",
"type": "string",
"required": false,
"source": "body",
"description": "库存类型,如 ZP(正品)、CC(残次品)"
},
{
"name": "[].orderLine.orderLineNo",
"type": "string",
"required": false,
"source": "body",
"description": "订单行号,未传入时自动按序号生成(1、2、3...)"
},
{
"name": "[].orderLine.ownerCode",
"type": "string",
"required": false,
"source": "body",
"description": "货主编码"
},
{
"name": "[].orderLine.sourceOrderCode",
"type": "string",
"required": false,
"source": "body",
"description": "来源订单编码,用于关联上游订单"
},
{
"name": "[].orderLine.subSourceOrderCode",
"type": "string",
"required": false,
"source": "body",
"description": "子来源订单编码"
},
{
"name": "[].orderLine.extendProps",
"type": "string",
"required": false,
"source": "body",
"description": "扩展属性,JSON 字符串或对象,用于存储自定义字段"
}
],
"requestBody": [
{
"name": "deliveryOrder",
"type": "object",
"required": true,
"source": "body",
"description": "发货单主信息对象"
},
{
"name": "deliveryOrder.deliveryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "发货单编码(必填),外部系统的唯一订单号"
},
{
"name": "deliveryOrder.preDeliveryOrderCode",
"type": "string",
"required": false,
"source": "body",
"description": "前发货单编码,用于关联前置订单"
},
{
"name": "deliveryOrder.preDeliveryOrderId",
"type": "string",
"required": false,
"source": "body",
"description": "前发货单ID,用于关联前置订单"
},
{
"name": "deliveryOrder.orderType",
"type": "string",
"required": false,
"source": "body",
"description": "订单类型,如 JYCK(一般出库)、PTCK(普通出库)等"
},
{
"name": "deliveryOrder.warehouseCode",
"type": "string",
"required": false,
"source": "body",
"description": "仓库编码,用于指定发货仓库"
},
{
"name": "deliveryOrder.orderFlag",
"type": "string",
"required": false,
"source": "body",
"description": "订单标记,自定义标记位"
},
{
"name": "deliveryOrder.sourcePlatformCode",
"type": "string",
"required": false,
"source": "body",
"description": "来源平台编码,如 TB(淘宝)、JD(京东)、PDD(拼多多)等;匹配不到时自动使用货主默认平台"
},
{
"name": "deliveryOrder.sourcePlatformName",
"type": "string",
"required": false,
"source": "body",
"description": "来源平台名称"
},
{
"name": "deliveryOrder.createTime",
"type": "string",
"required": false,
"source": "body",
"description": "订单创建时间,支持 ISO 8601 格式"
},
{
"name": "deliveryOrder.placeOrderTime",
"type": "string",
"required": false,
"source": "body",
"description": "下单时间,支持 ISO 8601 格式"
},
{
"name": "deliveryOrder.payTime",
"type": "string",
"required": false,
"source": "body",
"description": "支付时间,支持 ISO 8601 格式"
},
{
"name": "deliveryOrder.payNo",
"type": "string",
"required": false,
"source": "body",
"description": "支付单号"
},
{
"name": "deliveryOrder.shopNick",
"type": "string",
"required": false,
"source": "body",
"description": "店铺昵称"
},
{
"name": "deliveryOrder.sellerNick",
"type": "string",
"required": false,
"source": "body",
"description": "卖家昵称"
},
{
"name": "deliveryOrder.buyerNick",
"type": "string",
"required": false,
"source": "body",
"description": "买家昵称"
},
{
"name": "deliveryOrder.operatorName",
"type": "string",
"required": false,
"source": "body",
"description": "操作人姓名,未传入时自动按 API 应用名称回填"
},
{
"name": "deliveryOrder.operateTime",
"type": "string",
"required": false,
"source": "body",
"description": "操作时间,支持 ISO 8601 格式"
},
{
"name": "deliveryOrder.totalAmount",
"type": "number",
"required": false,
"source": "body",
"description": "订单总金额"
},
{
"name": "deliveryOrder.itemAmount",
"type": "number",
"required": false,
"source": "body",
"description": "商品总金额"
},
{
"name": "deliveryOrder.discountAmount",
"type": "number",
"required": false,
"source": "body",
"description": "折扣金额"
},
{
"name": "deliveryOrder.freight",
"type": "number",
"required": false,
"source": "body",
"description": "运费"
},
{
"name": "deliveryOrder.arAmount",
"type": "number",
"required": false,
"source": "body",
"description": "应收金额"
},
{
"name": "deliveryOrder.gotAmount",
"type": "number",
"required": false,
"source": "body",
"description": "实收金额"
},
{
"name": "deliveryOrder.logisticsCode",
"type": "string",
"required": false,
"source": "body",
"description": "快递编码,用于指定物流公司;匹配不到时自动使用货主默认快递"
},
{
"name": "deliveryOrder.expressCode",
"type": "string",
"required": false,
"source": "body",
"description": "快递公司编码"
},
{
"name": "deliveryOrder.logisticsAreaCode",
"type": "string",
"required": false,
"source": "body",
"description": "快递区域编码"
},
{
"name": "deliveryOrder.isUrgency",
"type": "string",
"required": false,
"source": "body",
"description": "是否加急,Y=是,N=否,默认 N"
},
{
"name": "deliveryOrder.invoiceFlag",
"type": "string",
"required": false,
"source": "body",
"description": "是否需要发票,Y=是,N=否,默认 N"
},
{
"name": "deliveryOrder.enableExternalExpressCode",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否启用外部快递编码匹配,开启后将优先按传入的 logisticsCode 匹配快递设置表"
},
{
"name": "deliveryOrder.receiverInfo",
"type": "object",
"required": false,
"source": "body",
"description": "收件人信息对象"
},
{
"name": "deliveryOrder.receiverInfo.name",
"type": "string",
"required": true,
"source": "body",
"description": "收件人姓名"
},
{
"name": "deliveryOrder.receiverInfo.tel",
"type": "string",
"required": false,
"source": "body",
"description": "收件人固定电话"
},
{
"name": "deliveryOrder.receiverInfo.mobile",
"type": "string",
"required": true,
"source": "body",
"description": "收件人手机号码"
},
{
"name": "deliveryOrder.receiverInfo.email",
"type": "string",
"required": false,
"source": "body",
"description": "收件人邮箱"
},
{
"name": "deliveryOrder.receiverInfo.countryCode",
"type": "string",
"required": false,
"source": "body",
"description": "国家编码"
},
{
"name": "deliveryOrder.receiverInfo.province",
"type": "string",
"required": true,
"source": "body",
"description": "省份"
},
{
"name": "deliveryOrder.receiverInfo.city",
"type": "string",
"required": true,
"source": "body",
"description": "城市"
},
{
"name": "deliveryOrder.receiverInfo.area",
"type": "string",
"required": true,
"source": "body",
"description": "区县"
},
{
"name": "deliveryOrder.receiverInfo.town",
"type": "string",
"required": false,
"source": "body",
"description": "乡镇/街道"
},
{
"name": "deliveryOrder.receiverInfo.detailAddress",
"type": "string",
"required": true,
"source": "body",
"description": "详细地址"
},
{
"name": "deliveryOrder.receiverInfo.zipCode",
"type": "string",
"required": false,
"source": "body",
"description": "邮政编码"
},
{
"name": "orderLines",
"type": "object",
"required": true,
"source": "body",
"description": "订单明细对象,包含 orderLine 数组"
},
{
"name": "orderLines.orderLine",
"type": "array",
"required": true,
"source": "body",
"description": "订单明细列表,数组中每项为一个订单行对象"
},
{
"name": "[].orderLine.itemCode",
"type": "string",
"required": false,
"source": "body",
"description": "商品编码,与 itemId 二选一,用于匹配仓库中的商品"
},
{
"name": "[].orderLine.itemId",
"type": "number",
"required": false,
"source": "body",
"description": "仓库商品主键ID,与 itemCode 二选一"
},
{
"name": "[].orderLine.itemName",
"type": "string",
"required": false,
"source": "body",
"description": "商品名称,用于错误提示中的商品识别"
},
{
"name": "[].orderLine.planQty",
"type": "number",
"required": true,
"source": "body",
"description": "计划发货数量(必填),必须大于 0"
},
{
"name": "[].orderLine.actualPrice",
"type": "number",
"required": false,
"source": "body",
"description": "实际单价"
},
{
"name": "[].orderLine.retailPrice",
"type": "number",
"required": false,
"source": "body",
"description": "零售单价"
},
{
"name": "[].orderLine.extCode",
"type": "string",
"required": false,
"source": "body",
"description": "外部商品编码"
},
{
"name": "[].orderLine.inventoryType",
"type": "string",
"required": false,
"source": "body",
"description": "库存类型,如 ZP(正品)、CC(残次品)"
},
{
"name": "[].orderLine.orderLineNo",
"type": "string",
"required": false,
"source": "body",
"description": "订单行号,未传入时自动按序号生成(1、2、3...)"
},
{
"name": "[].orderLine.ownerCode",
"type": "string",
"required": false,
"source": "body",
"description": "货主编码"
},
{
"name": "[].orderLine.sourceOrderCode",
"type": "string",
"required": false,
"source": "body",
"description": "来源订单编码,用于关联上游订单"
},
{
"name": "[].orderLine.subSourceOrderCode",
"type": "string",
"required": false,
"source": "body",
"description": "子来源订单编码"
},
{
"name": "[].orderLine.extendProps",
"type": "string",
"required": false,
"source": "body",
"description": "扩展属性,JSON 字符串或对象,用于存储自定义字段"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "创建成功时返回 orderId、step、stats(items_count/item_total/items_weight/source_order_codes)等"
}
],
"errors": [
{
"code": 400,
"message": "订单信息不完整(deliveryOrder.deliveryOrderCode 缺失)"
},
{
"code": 400,
"message": "没有有效的订单明细数据(orderLines.orderLine 为空或数量 ≤0)"
},
{
"code": 400,
"message": "商品《xxx》编码《xxx》未同步推送到仓库"
},
{
"code": 409,
"message": "订单已存在(相同 deliveryOrderCode + store_id + warehouse_id)"
}
],
"notes": [
"模块:deliveryorder 模块",
"方法部署位置:openapiMethods/deliveryorder.create",
"创建渠道固定为 API,操作人未传入时自动按 API 应用名称回填",
"sourcePlatformCode 传入后优先匹配平台列表;匹配不到则使用货主默认平台",
"logisticsCode 传入后按快递设置表 → 快递列表 → 货主默认快递的优先级匹配",
"orderLines.orderLine 支持单对象或数组格式",
"同一订单中不允许重复的商品(按 itemId 去重)",
"返回的 data.orderId 为系统内部订单主键ID",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400",
"receiverInfo.name / mobile / province / city / area / detailAddress 为快递取号必填字段,请务必传入完整收件人信息",
"mobile 和 tel 二选一必填(快递取号需要至少一个联系电话)"
]
},
{
"method": "deliveryorder.query",
"description": "deliveryorder 模块 查询发货单接口,根据发货单编码返回订单详情",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "deliveryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "发货单编码(必填),要查询的订单号"
}
],
"requestBody": [
{
"name": "deliveryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "发货单编码(必填),要查询的订单号"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "查询成功时返回 totalLines、deliveryOrder(deliveryOrderCode/deliveryOrderId/warehouseCode/orderType/status/orderConfirmTime/operatorCode/operatorName/operateTime)、packages、orderLines"
}
],
"errors": [
{
"code": 400,
"message": "deliveryOrderCode 参数缺失"
},
{
"code": 404,
"message": "未找到订单"
}
],
"notes": [
"模块:deliveryorder 模块",
"方法部署位置:openapiMethods/deliveryorder.query",
"查询范围为当前 app_key 绑定的仓库,跨仓库订单无法查询",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
}
]
},
{
"groupName": "订单模块",
"module": "order",
"list": [
{
"method": "order.cancel",
"description": "order 模块 取消单据接口,按 orderType 分发:JYCK/HHCK/BFCK 取消发货单(wms_order_delivery,未拣货/未打印直接取消,已拣货/已打印改拦截);CK 组(PTCK/DBCK/B2BCK/QTCK/CGTH)按 orderCode 查出库单号取消出库单(wms_order_stockout,仅 CREATED/PENDING 可取消);RK 组(B2BRK/SCRK/LYRK/CCRK/CGRK/DBRK/QTRK)按 orderCode 查入库单号作废入库单(复用 ctx.service.systems.storage.entry.cancel,状态守卫 + 回退收货单占用 + 操作日志,不回传开放平台回调事件);其他类型返回暂不支持该订单类型的取消操作",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "orderCode",
"type": "string",
"required": true,
"source": "body",
"description": "单据编码(必填):JYCK/HHCK/BFCK 为发货单编码(delivery_order_code);CK 组(PTCK/DBCK/B2BCK/QTCK/CGTH)为出库单号(stockout_order_code);RK 组(B2BRK/SCRK/LYRK/CCRK/CGRK/DBRK/QTRK)为入库单号(entry_order_code)"
},
{
"name": "orderType",
"type": "string",
"required": false,
"source": "body",
"description": "订单类型,默认 JYCK(一般交易出库单);支持 JYCK(一般交易出库)/HHCK(换货出库)/BFCK(补发出库)+ CK 组 PTCK(普通出库单)/DBCK(调拨出库)/B2BCK(B2B出库)/QTCK(其他出库)/CGTH(采购退货出库单)+ RK 组 B2BRK(B2B入库)/SCRK(生产入库)/LYRK(领用入库)/CCRK(残次品入库)/CGRK(采购入库)/DBRK(调拨入库)/QTRK(其他入库);大小写不敏感(内部 trim 后转大写)"
}
],
"requestBody": [
{
"name": "orderCode",
"type": "string",
"required": true,
"source": "body",
"description": "单据编码(必填):JYCK/HHCK/BFCK 为发货单编码(delivery_order_code);CK 组(PTCK/DBCK/B2BCK/QTCK/CGTH)为出库单号(stockout_order_code);RK 组(B2BRK/SCRK/LYRK/CCRK/CGRK/DBRK/QTRK)为入库单号(entry_order_code)"
},
{
"name": "orderType",
"type": "string",
"required": false,
"source": "body",
"description": "订单类型,默认 JYCK(一般交易出库单);支持 JYCK(一般交易出库)/HHCK(换货出库)/BFCK(补发出库)+ CK 组 PTCK(普通出库单)/DBCK(调拨出库)/B2BCK(B2B出库)/QTCK(其他出库)/CGTH(采购退货出库单)+ RK 组 B2BRK(B2B入库)/SCRK(生产入库)/LYRK(领用入库)/CCRK(残次品入库)/CGRK(采购入库)/DBRK(调拨入库)/QTRK(其他入库);大小写不敏感(内部 trim 后转大写)"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "取消成功时可能包含订单状态信息;CK 组取消成功返回 id / stockout_order_code / order_status"
}
],
"errors": [
{
"code": 400,
"message": "orderCode 参数缺失"
},
{
"code": 400,
"message": "暂不支持该订单类型的取消操作"
},
{
"code": 404,
"message": "未找到对应的订单"
},
{
"code": 404,
"message": "未找到对应的出库单"
},
{
"code": 400,
"message": "出库单当前状态(xxx)不允许取消(仅 CREATED/PENDING 可取消)"
},
{
"code": 400,
"message": "取消失败:xxx(CK 组释放库存锁定等异常)"
},
{
"code": 409,
"message": "取消失败,已通知拦截执行(订单已拣货或已打印,改为拦截状态)"
},
{
"code": 0,
"message": "未找到对应的入库单"
},
{
"code": 0,
"message": "已完成入库单不允许作废"
},
{
"code": 0,
"message": "入库单已完成回传,不可取消"
}
],
"notes": [
"模块:order 模块",
"方法部署位置:openapiMethods/order.cancel",
"JYCK/HHCK/BFCK 取消逻辑:未拣货且未打印的订单直接取消(status=cancel, outbound_status=fin, step=4);已拣货或已打印的订单标记为拦截状态(intercept_status=intercepting),不直接取消",
"订单类型映射:JYCK/HHCK/BFCK → wms_order_delivery 发货单取消(行为与历史完全一致);PTCK/DBCK/B2BCK/QTCK/CGTH(CK 组)→ wms_order_stockout 出库单取消(按 orderCode 查出库单号);B2BRK/SCRK/LYRK/CCRK/CGRK/DBRK/QTRK(RK 组)→ 入库单作废(按 orderCode 查入库单号,复用 ctx.service.systems.storage.entry.cancel);其他类型返回暂不支持该订单类型的取消操作",
"CK 组委托 ctx.service.systems.stockoutOrder.cancel(单事务 + 行锁):仅 CREATED/PENDING 允许取消(COMPLETED/TRANSFERRED 拒绝),释放 QM_STOCKOUT 库存锁定,状态置 CANCELLED 并写 wms_operation_log(STOCKOUT_CANCEL);已 CANCELLED 幂等返回成功;取消成功不回传开放平台回调事件",
"RK 组委托 ctx.service.systems.storage.entry.cancel({ entryOrderCode }, { storeId, warehouseId, operatorLabel=openapi:xxx, skipExternalSync=true, idempotent=true, notFoundMessage=未找到对应的入库单 }):守卫 sync_status=SUCCESS(入库单已完成回传,不可取消)、order_status=COMPLETED(已完成入库单不允许作废);已 CANCELLED 幂等返回成功;作废动作 = 状态置 CANCELLED + 按台账回退关联收货单占用 + 写 ENTRY_ORDER_CANCEL 操作日志;skipExternalSync=true 不回传开放平台回调事件",
"复现口径:orderCode=RK_2、orderType=CGRK 现在可正常取消(此前返回暂不支持该订单类型的取消操作)",
"orderType 大小写不敏感:内部 trim 后转大写,jyck/Jyck/JYCK 等价",
"使用事务 + 行锁保证并发安全",
"取消操作为不可逆操作,请谨慎调用",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
}
]
},
{
"groupName": "商品模块",
"module": "singleitem",
"list": [
{
"method": "singleitem.synchronize",
"description": "singleitem 模块 商品同步接口,创建或更新商品信息(itemCode 唯一约束,已存在则更新)",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "item",
"type": "object",
"required": true,
"source": "body",
"description": "商品信息对象(必填)"
},
{
"name": "item.itemCode",
"type": "string",
"required": true,
"source": "body",
"description": "商品编码(必填),唯一标识商品"
},
{
"name": "item.goodsCode",
"type": "string",
"required": false,
"source": "body",
"description": "商品货号"
},
{
"name": "item.itemName",
"type": "string",
"required": false,
"source": "body",
"description": "商品名称"
},
{
"name": "item.skuProperty",
"type": "string",
"required": false,
"source": "body",
"description": "SKU 属性描述,如颜色:红色;尺码:XL"
},
{
"name": "item.stockUnit",
"type": "string",
"required": false,
"source": "body",
"description": "库存单位,如 件、箱、个"
},
{
"name": "item.length",
"type": "number",
"required": false,
"source": "body",
"description": "长(cm)"
},
{
"name": "item.width",
"type": "number",
"required": false,
"source": "body",
"description": "宽(cm)"
},
{
"name": "item.height",
"type": "number",
"required": false,
"source": "body",
"description": "高(cm)"
},
{
"name": "item.volume",
"type": "number",
"required": false,
"source": "body",
"description": "体积(cm³)"
},
{
"name": "item.grossWeight",
"type": "number",
"required": false,
"source": "body",
"description": "毛重(g)"
},
{
"name": "item.netWeight",
"type": "number",
"required": false,
"source": "body",
"description": "净重(g)"
},
{
"name": "item.categoryId",
"type": "number",
"required": false,
"source": "body",
"description": "商品分类 ID"
},
{
"name": "item.categoryName",
"type": "string",
"required": false,
"source": "body",
"description": "商品分类名称"
},
{
"name": "item.itemType",
"type": "string",
"required": false,
"source": "body",
"description": "商品类型,如 NORMAL(普通商品)、SUIT(套装)"
},
{
"name": "item.tagPrice",
"type": "number",
"required": false,
"source": "body",
"description": "吊牌价"
},
{
"name": "item.retailPrice",
"type": "number",
"required": false,
"source": "body",
"description": "零售价"
},
{
"name": "item.brandName",
"type": "string",
"required": false,
"source": "body",
"description": "品牌名称"
},
{
"name": "item.isSNMgmt",
"type": "string",
"required": false,
"source": "body",
"description": "是否 SN 序列号管理,Y=是,N=否,默认 N"
},
{
"name": "item.isShelfLifeMgmt",
"type": "string",
"required": false,
"source": "body",
"description": "是否保质期管理,Y=是,N=否,默认 N"
},
{
"name": "item.isBatchMgmt",
"type": "string",
"required": false,
"source": "body",
"description": "是否批次管理,Y=是,N=否,默认 N"
},
{
"name": "item.isAreaSale",
"type": "string",
"required": false,
"source": "body",
"description": "是否区域销售,Y=是,N=否,默认 N"
},
{
"name": "item.createTime",
"type": "string",
"required": false,
"source": "body",
"description": "创建时间,ISO 8601 格式"
},
{
"name": "item.isValid",
"type": "string",
"required": false,
"source": "body",
"description": "是否有效,Y=是,N=否,默认 Y"
},
{
"name": "item.barCode",
"type": "string",
"required": false,
"source": "body",
"description": "条形码"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "同步成功时返回 itemId(系统内部商品 ID)"
}
],
"errors": [
{
"code": 400,
"message": "参数缺失: item.itemCode"
}
],
"notes": [
"模块:singleitem 模块",
"方法部署位置:openapiMethods/singleitem.synchronize",
"同步策略:按 itemCode + app_key + warehouse_id + store_id 唯一约束判断,已存在则更新,不存在则创建",
"同步后会联动创建/更新库存表(StockWarehouse)记录",
"create_from 固定为 qimen(与奇门共用同一套底层逻辑)",
"warehouseCode 和 ownerCode 由 app_key 绑定的仓库/货主自动解析,不可通过请求参数覆盖",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
},
{
"method": "singleitem.query",
"description": "singleitem 模块 商品查询接口,按商品 ID 返回完整商品信息",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "itemId",
"type": "number",
"required": true,
"source": "body",
"description": "商品 ID(必填),系统内部商品主键"
}
],
"requestBody": [],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "查询成功时返回 item 对象,包含 itemId/itemCode/goodsCode/itemName/skuProperty/stockUnit/length/width/height/volume/grossWeight/netWeight/categoryId/categoryName/itemType/tagPrice/retailPrice/brandName/isSNMgmt/isShelfLifeMgmt/isBatchMgmt/isAreaSale/barCode/isValid/createTime 等全部商品字段"
}
],
"errors": [
{
"code": 400,
"message": "参数错误: itemId 不存在"
},
{
"code": 404,
"message": "wms 的 SKUID 为 xxx 未找到"
}
],
"notes": [
"模块:singleitem 模块",
"方法部署位置:openapiMethods/singleitem.query",
"返回格式与奇门 convertToQimenFormat 一致,字段名使用驼峰命名",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
}
]
},
{
"groupName": "库存模块",
"module": "inventory",
"list": [
{
"method": "inventory.query",
"description": "inventory 模块 库存查询接口,按商品 ID 批量查询库存量(可用量、锁定量)",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "itemIds",
"type": "array",
"required": true,
"source": "body",
"description": "商品 ID 列表(必填),如 [1000693, 1000694],支持单个或多个商品批量查询"
},
{
"name": "[].itemIds",
"type": "number",
"required": true,
"source": "body",
"description": "单个商品 ID,系统内部商品主键,可通过 singleitem.query 或 singleitem.synchronize 返回的 itemId 获取"
}
],
"requestBody": [],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "查询成功时返回 items 数组"
},
{
"name": "data.items",
"type": "array",
"required": false,
"description": "库存信息列表"
},
{
"name": "[].items.itemId",
"type": "number",
"required": false,
"description": "商品 ID"
},
{
"name": "[].items.itemCode",
"type": "string",
"required": false,
"description": "商品编码"
},
{
"name": "[].items.warehouseCode",
"type": "string",
"required": false,
"description": "仓库编码"
},
{
"name": "[].items.quantity",
"type": "number",
"required": false,
"description": "总库存量"
},
{
"name": "[].items.lockQuantity",
"type": "number",
"required": false,
"description": "锁定量(已被订单预占的库存)"
},
{
"name": "[].items.inventoryType",
"type": "string",
"required": false,
"description": "库存类型,固定返回 ZP(正品)"
}
],
"errors": [
{
"code": 400,
"message": "itemIds 参数缺失或为空"
},
{
"code": 404,
"message": "未查询到有效库存信息"
}
],
"notes": [
"模块:inventory 模块",
"方法部署位置:openapiMethods/inventory.query",
"支持批量查询多个商品的库存,减少请求次数",
"库存不足(可用量 ≤0)或商品未绑定库存记录时,该条商品不会出现在返回结果中",
"查询范围为当前 app_key 绑定的仓库",
"可用量 = quantity - lockQuantity",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
}
]
},
{
"groupName": "入库单模块",
"module": "entryorder",
"list": [
{
"method": "entryorder.create",
"description": "entryorder 模块 创建入库单接口,支持传入入库单主信息和商品明细。创建成功后返回的状态 status 为 CREATING(明细行未全部插入)或 CREATED(明细行已全部插入完成)。明细行商品匹配三级策略:itemId 主键直查 > itemCode 精确匹配 > itemCode 归一化条码匹配(取编码开头连续数字,剥离中文后缀)",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "entryOrder",
"type": "object",
"required": true,
"source": "body",
"description": "入库单主信息对象"
},
{
"name": "entryOrder.entryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "入库单号(必填),外部系统的唯一入库单号"
},
{
"name": "entryOrder.entryOrderType",
"type": "string",
"required": false,
"source": "body",
"description": "入库单类型,默认 SCRK(生产入库)"
},
{
"name": "entryOrder.warehouseCode",
"type": "string",
"required": false,
"source": "body",
"description": "仓库编码"
},
{
"name": "entryOrder.ownerCode",
"type": "string",
"required": false,
"source": "body",
"description": "货主编码"
},
{
"name": "entryOrder.expectedArriveTime",
"type": "string",
"required": false,
"source": "body",
"description": "预计到货时间,ISO 8601 格式"
},
{
"name": "entryOrder.totalOrderLines",
"type": "number",
"required": false,
"source": "body",
"description": "总行数"
},
{
"name": "entryOrder.operateTime",
"type": "string",
"required": false,
"source": "body",
"description": "操作时间,ISO 8601 格式"
},
{
"name": "entryOrder.operatorName",
"type": "string",
"required": false,
"source": "body",
"description": "操作人"
},
{
"name": "entryOrder.supplierCode",
"type": "string",
"required": false,
"source": "body",
"description": "供应商编码"
},
{
"name": "entryOrder.supplierName",
"type": "string",
"required": false,
"source": "body",
"description": "供应商名称"
},
{
"name": "entryOrder.remark",
"type": "string",
"required": false,
"source": "body",
"description": "备注"
},
{
"name": "orderLines",
"type": "object",
"required": true,
"source": "body",
"description": "订单明细对象,包含 orderLine 数组"
},
{
"name": "orderLines.orderLine",
"type": "array",
"required": true,
"source": "body",
"description": "商品明细列表,数组中每项为一个入库单行对象"
},
{
"name": "[].orderLine.itemCode",
"type": "string",
"required": false,
"source": "body",
"description": "商品编码,可含中文后缀(如 6934864201409-新品):精确匹配不到时取编码开头的连续数字作为归一化条码与商品主数据对齐匹配"
},
{
"name": "[].orderLine.itemId",
"type": "string|number",
"required": false,
"source": "body",
"description": "仓库商品主键 ID。纯数字且不超 BIGINT 范围时按 StockStore 主键直查(校验货主一致);非纯数字值(如带中文后缀的编码)视为未提供,降级按 itemCode 匹配。主键查不到或货主不一致时同样降级按 itemCode 匹配"
},
{
"name": "[].orderLine.itemName",
"type": "string",
"required": false,
"source": "body",
"description": "商品名称,用于错误提示中的商品识别"
},
{
"name": "[].orderLine.planQty",
"type": "number",
"required": true,
"source": "body",
"description": "计划入库数量(必填),必须大于 0"
},
{
"name": "[].orderLine.inventoryType",
"type": "string",
"required": false,
"source": "body",
"description": "库存类型,默认 ZP(正品)"
},
{
"name": "[].orderLine.orderLineNo",
"type": "string",
"required": false,
"source": "body",
"description": "行号"
}
],
"requestBody": [
{
"name": "entryOrder",
"type": "object",
"required": true,
"source": "body",
"description": "入库单主信息对象"
},
{
"name": "entryOrder.entryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "入库单号(必填),外部系统的唯一入库单号"
},
{
"name": "entryOrder.entryOrderType",
"type": "string",
"required": false,
"source": "body",
"description": "入库单类型,默认 SCRK(生产入库)"
},
{
"name": "entryOrder.warehouseCode",
"type": "string",
"required": false,
"source": "body",
"description": "仓库编码"
},
{
"name": "entryOrder.ownerCode",
"type": "string",
"required": false,
"source": "body",
"description": "货主编码"
},
{
"name": "entryOrder.expectedArriveTime",
"type": "string",
"required": false,
"source": "body",
"description": "预计到货时间,ISO 8601 格式"
},
{
"name": "entryOrder.totalOrderLines",
"type": "number",
"required": false,
"source": "body",
"description": "总行数"
},
{
"name": "entryOrder.operateTime",
"type": "string",
"required": false,
"source": "body",
"description": "操作时间,ISO 8601 格式"
},
{
"name": "entryOrder.operatorName",
"type": "string",
"required": false,
"source": "body",
"description": "操作人"
},
{
"name": "entryOrder.supplierCode",
"type": "string",
"required": false,
"source": "body",
"description": "供应商编码"
},
{
"name": "entryOrder.supplierName",
"type": "string",
"required": false,
"source": "body",
"description": "供应商名称"
},
{
"name": "entryOrder.remark",
"type": "string",
"required": false,
"source": "body",
"description": "备注"
},
{
"name": "orderLines",
"type": "object",
"required": true,
"source": "body",
"description": "订单明细对象,包含 orderLine 数组"
},
{
"name": "orderLines.orderLine",
"type": "array",
"required": true,
"source": "body",
"description": "商品明细列表,数组中每项为一个入库单行对象"
},
{
"name": "[].orderLine.itemCode",
"type": "string",
"required": false,
"source": "body",
"description": "商品编码,可含中文后缀(如 6934864201409-新品):精确匹配不到时取编码开头的连续数字作为归一化条码与商品主数据对齐匹配"
},
{
"name": "[].orderLine.itemId",
"type": "string|number",
"required": false,
"source": "body",
"description": "仓库商品主键 ID。纯数字且不超 BIGINT 范围时按 StockStore 主键直查(校验货主一致);非纯数字值(如带中文后缀的编码)视为未提供,降级按 itemCode 匹配。主键查不到或货主不一致时同样降级按 itemCode 匹配"
},
{
"name": "[].orderLine.itemName",
"type": "string",
"required": false,
"source": "body",
"description": "商品名称"
},
{
"name": "[].orderLine.planQty",
"type": "number",
"required": true,
"source": "body",
"description": "计划入库数量(必填),必须大于 0"
},
{
"name": "[].orderLine.inventoryType",
"type": "string",
"required": false,
"source": "body",
"description": "库存类型,默认 ZP(正品)"
},
{
"name": "[].orderLine.orderLineNo",
"type": "string",
"required": false,
"source": "body",
"description": "行号"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "创建成功时返回 entryOrderId、entryOrderCode、status(CREATING=创建中明细行未全部插入,CREATED=已创建完成)、createTime"
}
],
"errors": [
{
"code": 400,
"message": "entryOrder.entryOrderCode 参数缺失"
},
{
"code": 400,
"message": "orderLines.orderLine 参数缺失"
},
{
"code": 400,
"message": "创建入库单失败,失败原因:订单行N:SKU{itemId}商品《itemName》编码《itemCode》未同步推送到仓库"
},
{
"code": 400,
"message": "创建入库单失败,失败原因:订单行N:SKU{itemId}商品《itemName》编码《itemCode》wms无对应关系,请联系仓库关联创建商品"
},
{
"code": 400,
"message": "创建入库单失败,失败原因:订单行N:编码《itemCode》归一化条码《barcode》匹配到多个商品,请人工核对后重试"
}
],
"notes": [
"模块:entryorder 模块",
"方法部署位置:openapiMethods/entryorder.create",
"创建渠道固定为 API",
"orderLines.orderLine 支持单对象或数组格式",
"明细行商品匹配三级策略:itemId 主键直查(纯数字且不超 BIGINT 范围、货主一致)> itemCode 精确匹配 > itemCode 归一化条码匹配(取编码开头连续数字)",
"带中文后缀的编码(如 6934864201409-新品)精确匹配不到时按归一化条码对齐;归一化条码命中多个商品时报错,不静默取第一条",
"item_id 统一写入实际匹配到的 StockStore 数字主键 id,避免非数字值写入 BIGINT 列触发 MySQL 严格模式报错(Data truncated for column 'item_id')",
"失败信息回显真实 SKU/商品/编码并附订单行号;与奇门渠道共用 app/service/systems/entry_order.js addOrder 同一逻辑",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
},
{
"method": "entryorder.query",
"description": "entryorder 模块 查询入库单接口,根据入库单号返回入库单详情。返回的 status 字段可能为 CREATING/CREATED/PENDING/COMPLETED/CANCELLED。",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "entryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "入库单号(必填),要查询的入库单号"
}
],
"requestBody": [
{
"name": "entryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "入库单号(必填),要查询的入库单号"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "查询成功时返回 entryOrderCode、entryOrderId、status、entryOrderType、expectedArriveTime、supplierCode、supplierName、remark、createTime、operateTime、operatorName、warehouseCode、ownerCode、totalOrderLines、orderLines"
},
{
"name": "data.orderLines",
"type": "array",
"required": false,
"description": "商品明细列表"
},
{
"name": "[].orderLines.itemId",
"type": "number",
"required": false,
"description": "商品ID"
},
{
"name": "[].orderLines.itemCode",
"type": "string",
"required": false,
"description": "商品编码"
},
{
"name": "[].orderLines.itemName",
"type": "string",
"required": false,
"description": "商品名称"
},
{
"name": "[].orderLines.planQty",
"type": "number",
"required": false,
"description": "计划入库数量"
},
{
"name": "[].orderLines.actualQty",
"type": "number",
"required": false,
"description": "实际入库数量"
},
{
"name": "[].orderLines.inventoryType",
"type": "string",
"required": false,
"description": "库存类型"
},
{
"name": "[].orderLines.orderLineNo",
"type": "string",
"required": false,
"description": "行号"
}
],
"errors": [
{
"code": 400,
"message": "entryOrderCode 参数缺失"
},
{
"code": 404,
"message": "入库单未找到"
}
],
"notes": [
"模块:entryorder 模块",
"方法部署位置:openapiMethods/entryorder.query",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
}
]
},
{
"groupName": "出库单模块",
"module": "stockout",
"list": [
{
"method": "stockout.create",
"description": "stockout 模块 创建非订单出库单接口,支持传入出库单主信息、收件人信息和出库明细;创建时按计划数量锁定库存",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "deliveryOrder",
"type": "object",
"required": true,
"source": "body",
"description": "出库单主信息对象"
},
{
"name": "deliveryOrder.deliveryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "出库单号(必填),外部系统唯一单号,落库 wms_order_stockout.stockout_order_code"
},
{
"name": "deliveryOrder.orderType",
"type": "string",
"required": true,
"source": "body",
"description": "业务类型(必填):JYCK 一般交易出库 / HHCK 换货出库 / BFCK 补发出库 / QTCK 其他出库"
},
{
"name": "deliveryOrder.warehouseCode",
"type": "string",
"required": false,
"source": "body",
"description": "仓库编码,不传时使用 app_key 合约绑定的仓库编码"
},
{
"name": "deliveryOrder.createTime",
"type": "string",
"required": false,
"source": "body",
"description": "单据创建时间,落库 order_create_time"
},
{
"name": "deliveryOrder.totalOrderLines",
"type": "integer",
"required": false,
"source": "body",
"description": "单据总行数,不传时取明细行数"
},
{
"name": "deliveryOrder.remark",
"type": "string",
"required": false,
"source": "body",
"description": "备注"
},
{
"name": "deliveryOrder.logisticsCode",
"type": "string",
"required": false,
"source": "body",
"description": "外部快递编码;货主开启 enable_external_express_code 时按快递设置表 → 系统快递列表匹配,匹配不到使用出库单兜底快递编码(stockout_default_express_code,默认 ZT 自提)"
},
{
"name": "deliveryOrder.receiverInfo",
"type": "object",
"required": false,
"source": "body",
"description": "收件人信息对象,13 个标准字段落库 receiver_* 列,供转订单与确认回传使用"
},
{
"name": "deliveryOrder.receiverInfo.name",
"type": "string",
"required": false,
"source": "body",
"description": "收件人姓名(receiver_name)"
},
{
"name": "deliveryOrder.receiverInfo.company",
"type": "string",
"required": false,
"source": "body",
"description": "收件人公司名称(receiver_company)"
},
{
"name": "deliveryOrder.receiverInfo.zipCode",
"type": "string",
"required": false,
"source": "body",
"description": "收件人邮编(receiver_zip_code)"
},
{
"name": "deliveryOrder.receiverInfo.tel",
"type": "string",
"required": false,
"source": "body",
"description": "收件人固定电话(receiver_tel)"
},
{
"name": "deliveryOrder.receiverInfo.mobile",
"type": "string",
"required": false,
"source": "body",
"description": "收件人移动电话(receiver_mobile)"
},
{
"name": "deliveryOrder.receiverInfo.email",
"type": "string",
"required": false,
"source": "body",
"description": "收件人邮箱(receiver_email)"
},
{
"name": "deliveryOrder.receiverInfo.countryCode",
"type": "string",
"required": false,
"source": "body",
"description": "国家编码(receiver_country_code)"
},
{
"name": "deliveryOrder.receiverInfo.province",
"type": "string",
"required": false,
"source": "body",
"description": "省(receiver_province)"
},
{
"name": "deliveryOrder.receiverInfo.city",
"type": "string",
"required": false,
"source": "body",
"description": "市(receiver_city)"
},
{
"name": "deliveryOrder.receiverInfo.area",
"type": "string",
"required": false,
"source": "body",
"description": "区/县(receiver_area)"
},
{
"name": "deliveryOrder.receiverInfo.town",
"type": "string",
"required": false,
"source": "body",
"description": "镇/街道(receiver_town)"
},
{
"name": "deliveryOrder.receiverInfo.detailAddress",
"type": "string",
"required": false,
"source": "body",
"description": "详细地址(receiver_detail_address)"
},
{
"name": "deliveryOrder.receiverInfo.id",
"type": "string",
"required": false,
"source": "body",
"description": "收件人证件号(receiver_id)"
},
{
"name": "orderLines",
"type": "object",
"required": true,
"source": "body",
"description": "出库单明细对象"
},
{
"name": "orderLines.orderLine",
"type": "object/array",
"required": true,
"source": "body",
"description": "明细行(单条为对象,多条为数组)"
},
{
"name": "orderLines.orderLine.orderLineNo",
"type": "string",
"required": true,
"source": "body",
"description": "订单行号(必填)"
},
{
"name": "orderLines.orderLine.ownerCode",
"type": "string",
"required": false,
"source": "body",
"description": "货主编码,落库 qimen_owner_code(取首行)"
},
{
"name": "orderLines.orderLine.itemCode",
"type": "string",
"required": true,
"source": "body",
"description": "商品编码(必填),itemId 主键查不到时按此编码 + 仓库货主维度降级匹配"
},
{
"name": "orderLines.orderLine.itemId",
"type": "string",
"required": true,
"source": "body",
"description": "WMS 商品ID(必填),优先按 StockStore 主键直查(校验货主一致)"
},
{
"name": "orderLines.orderLine.itemName",
"type": "string",
"required": false,
"source": "body",
"description": "商品名称,仅用于错误提示与明细展示"
},
{
"name": "orderLines.orderLine.planQty",
"type": "integer",
"required": true,
"source": "body",
"description": "计划数量(必填,需大于 0),创建时按此数量锁定库存"
},
{
"name": "orderLines.orderLine.inventoryType",
"type": "string",
"required": false,
"source": "body",
"description": "库存类型(ZP 正品 / CC 残次等)"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "创建成功时返回 stockoutOrderId(出库单ID)、stockoutOrderCode(出库单号)"
}
],
"errors": [
{
"code": 400,
"message": "deliveryOrder 参数缺失或不完整 / orderLines 参数缺失"
},
{
"code": 400,
"message": "创建出库单失败,失败原因:没有有效的订单明细数据 / 商品未同步推送到仓库 / wms无对应关系 / 计划数量必须大于0 / 库存锁定失败"
}
],
"notes": [
"模块:出库单模块",
"方法部署位置:openapiMethods/stockout.create → systems/stockout_order.create",
"与奇门 stockout.create 共用同一份实现(systems/stockout_order.js),差异仅在来源:开放 API 落库 source_type=API,奇门落库 source_type=QM",
"出库单落库 wms_order_stockout + wms_order_stockout_items,创建时在事务内按 planQty 锁定库存(锁标记 QM_STOCKOUT,与取消/确认/转单释放口径一致)",
"商品匹配:itemId 按 StockStore 主键直查(校验货主一致),查不到或跨货主时按 itemCode + 仓库 + 货主降级匹配",
"快递解析:货主开启 enable_external_express_code 且传 logisticsCode 时按快递设置表 → 系统快递列表匹配;未传/未开启/匹配不到使用出库单兜底快递编码 stockout_default_express_code(默认 ZT 自提),不回退订单默认快递",
"orderLines.orderLine 支持单对象或数组格式",
"收货信息(name / tel|mobile / 省市区镇详细地址)在转订单或一键出库确认时校验必填,创建时不强制",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
},
{
"method": "stockout.query",
"description": "stockout 模块 查询非订单出库单接口,按出库单号返回主表信息与商品明细",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "deliveryOrderCode",
"type": "string",
"required": true,
"source": "body",
"description": "出库单号(必填),要查询的出库单 stockout_order_code;兼容 deliveryOrder.deliveryOrderCode 传法"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务码:1=成功,0=失败"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "提示消息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "查询成功时返回 totalLines、deliveryOrder(deliveryOrderCode/deliveryOrderId/warehouseCode/orderType/status/createTime/remark)、orderLines.orderLine[](orderLineNo/ownerCode/itemCode/itemId/itemName/planQty/inventoryType)"
}
],
"errors": [
{
"code": 400,
"message": "deliveryOrderCode 参数缺失"
},
{
"code": 404,
"message": "未找到出库单"
}
],
"notes": [
"模块:出库单模块",
"方法部署位置:openapiMethods/stockout.query → systems/stockout_order.query",
"与奇门 stockout.query 共用同一份实现(systems/stockout_order.js)",
"按 stockout_order_code 查 wms_order_stockout 主表,再按 order_id 关联 wms_order_stockout_items 明细(按 order_line_no 升序)",
"deliveryOrder.status 为出库单状态:CREATED 已创建 / PENDING 已审核 / COMPLETED 已完成 / CANCELLED 已作废 / TRANSFERRED 已转订单",
"timestamp 时间戳时效校验:与服务器时间差不得超过 ±10 分钟(600 秒),否则返回 400"
]
}
]
}
]
}
}