1、奇门接入白皮书 1 奇门标准化协议白皮书 V3.9.5 阿里巴巴集团 2019 奇门接入白皮书 2 1 版本记录 Date Version Description 2015.03.27 1.0 1、奇门标准化协议 v1.0 发布 2015.03.31 1.2 1、增加入库单更新，出库单更新，库存异动更新等 3 个接口 2、API 名称区分了 erp 和 wms 3、优化部分字段命名 2015.04.07 1.3 1、将 auditor 相关的字段统一成 operator 2015.04.09 1.4 1、更新接口规范，新增“奇门与 wms 的通信协议”等相关内容 2、新增入库单，去掉一个重复的
2、入库单编码 2015.04.14 1.5 1、加入奇门项目服务商解决方案章节 2、增加通信协议里的反向协议标准 3、更新个别字段名，如 Quantity 更新为 Qty，stockSelectedQty 等字段名中将 stock 去掉，变为selectedQty。 2015.5.6 2.0 1、加入菜鸟仓业务接口支持 2、接口整体改动较大，主要增加业务接口和原有接口内增加字段 2015.5.7 2.1 1、出入库单据增加 ERP 行号的概念 2、出库单流水接口升级为订单流水接口 3、仓内加工单更名为 storeprocess 4、发货单确认接口的生产日期 produceDate 变更为prod
3、uctDate 5 、 退 货 入 库 单 创 建 接 口 orderLine 节 点 中 增 加ownerCode 字段；入库单创建接口中 ownerCode 移到orderLine 节点中 2015.5.20 2.1 1、取消订单，订单类型变为非必填 2、发货单创建，付款时间变为非必填 3、所有地址中的区域改为非必填 4、退货入库单确认接口，物流公司编码改为非必填 2015.6.5 2.2 1、增加“出库单创建”，“出库单确认”接口 2015.6.10 2.2 1、“出库单创建”增加货主编码字段 奇门接入白皮书 3 2、增加“订单状态查询”和“库存查询”两个接口 3、规范“冻结库存”的使用
4、范围 2015.6.11 2.2 1、增加“组合商品接口” 2、入库单的收件人，发件人，物流公司信息为非必填 3、新增入库单类型：生产入库、领用入库、残次品入库。 4、入库单新增字段，采购单号 5、盘点单新增字段，盘点时间 6、新增“库存异动接口” 7、“订单状态查询”不仅查当前状态，历史状态也可以 8、“普通出库单”增加发件人信息 2015.6.12 2.2 1、“组合商品创建接口”和“订单流水查询接口“，去掉 warehouseCode 编码 2 、“ 订单 流水查 询接 口” 和“ 库存 查询 接口 ”response 增加的 flag，code，message 这三个标准的应答。 20
5、15.6.25 2.2 1、增加发货单查询接口 2015.7.2 2.2 1、订单状态查询增加两个入库状态（PARTFULFILLED-部分收货完成, FULFILLED-收货完成。） 2、库存查询接口增加货主编码 ownerCode 2015.7.3 2.2 1、退货入库创建接口：商品增加批次等信息 2、发货单创建接口，发票增加普通发票的类型 3、订单流水查询接口，删除 NEW 状态 4、订单流水通知接口，删除NEW，CANCELEDFAIL状态 5、发货单创建和发货单缺货通知接口，在 item 节点下增加 inventoryType 等字段 2015.7.6 2.2 1、商品同步接口的 b
6、arcode 可以填多个 2、发货单创建增加字段“deliveryType” 3、发货单创建返回值支持统仓统配的拆单 4、发票内容格式化 5、增加 B2B 出库的出库类型 6、入库单确认接口的 entryOrderId 改为条件必填 7、extendProps 和 remark 统一定义了 奇门接入白皮书 4 8、退货单创建和确认接口增加批次信息 9、订单流水查询删除 CANCELFAILED 状态 10、订单流水通知接口删除 NEW,CANCELFAILED 状态 11 、 发 货 单 缺 货 通 知 接 口item节 点 下 增 加inventoryType 和批次信息 2015.7.9
7、2.2 1、B2B 入库和 B2B 出库单据状态多接口修订 2、发货单 SN 通知借口，加上分页，并且将 sns 的节点去掉 2015.7.14 2.2 1、增加库存异动接口，单据类型增加 ZZTZ=状态调整单 2015.7.16 2.2 1、发货单 invoices 下面的 detail 增加 item 节点 2、发货单发货类型的枚举值 CWPS（常温配送）改为PTPS（普通配送） 3、商品同步 barcode 的分隔符改为； 4、部分warehouseCode重新定义约束和说明 5、库存异动接口更名为库存异动通知接口 2015.7.17 2.2 1 、 发 货 单 创 建 的 出 参 ，
8、response 节 点 下 增 加warehouseCode和logisticsCode 两个字段，以适配以前的版本 2015.7.20 2.2 1、库存异动接口，结构体变化，将 warehouseCode，ownerCode，orderCode，orderType，outbizCode等放到 item 节点下 2015.7.21 2.2 1、快递编码中增加京东配送（JD），当当宅配（DD） 2015.7.22 2.2 1、出库单创建和出库单确认接口增加 logisticsCode 字段 2015.7.23 2.2 1、入库单创建、入库单确认、出库单创建、出库单确认等四个接口增加 total
9、OrderLines，outBizCode 这两个字段用于分批传输处理 2015.7.30 2.2 1、发货单确认接口增加“包裹理论重量” 2015.8.14 2.2 1、新增接口订单状态查询接口（批量），用于解决通过订单最后操作时间的区间值等信息，去批量查询订单 2、发货单创建接口的 orderLine 下面增加 batchCode等字段，用于解决指定批次发货的问题 奇门接入白皮书 5 2015.8.20 2.2 1 、 发 货 单 创 建 接 口 的orderLine下 面 增 加productDate,expireDate 等字段 2、渠道枚举字段调整，凡客由 FK 调整为 VANCL
10、2015/8/31 2.3 1、新增 5 个接口，支持用于各种订单在仓内操作结果的详情查询，包括入库单查询，出库单查询，退货入库单查询，发货单查询，发货单缺货查询。 2、订单流水查询和订单流水确认接口的status，增加两个状态，PARTFULFILLED，FULFILLED 两个状态。 3、入库单确认接口，出库单确认接口，增加单据状态字段 status。 2015/9/6 2.3 1、发货单确认接口，单价和数量字段类型修正 2、所有正向接口，均补充 warehouseCode，作为可能的一单分多仓的业务场景。 2015/9/7 2.3 1、新增接口，为菜鸟自动流转的业务新增的特殊业务接口。
11、2015/9/14 2.3 1、新增盘点单查询接口 2 、 盘 点 单 确 认 接 口 和 盘 点 单 查 询 接 口 均 增 加checkOrderId 3、发货单查询接口，为了兼容，入参将deliveryOrderCode 改为 orderCode,deliveryOrderId改为 orderId 2015/9/21 2.3 入库单确认，出库单确认，退货入库单确认，发货单确认，库存异动通知 2015/9/22 2.3 新增心跳接口 2015/9/24 2.3 1、订单流水查询接口增加 orderType 2、发货单确认接口 orderType 增加枚举值 QTCK。 2015/10/10
12、 2.3 1、库存盘点查询的接口名变更 2015/10/15 2.3 1、在发货单确认，发货单查询，退货入库单确认，退货入库单查询等接口的orderline中增加商品二维码，用于对单个商品的管理。 2015/10/20 2.3 1、新增商品同步接口（批量），发货单创建接口（批量），发货单确认接口（批量） 2015/10/27 2.3 1、发货单创建接口的 orderline 下增加 payNo，用于解决合单后的支付宝交易号的传输。 2015/11/19 2.3 1、出库单类型新增采购退货出库类型（CGTH） 奇门接入白皮书 6 2015/11/23 2.3 1、发货单创建接口，出参 respo
13、nse 下增加createTime。 2015/11/25 2.4 新增 4 个接口，主要用来注册奇门的仓库编码，奇门的用户号，包括奇门仓库注册接口，奇门仓库查询接口，奇门仓库更新接口，奇门用户注册接口 2015/12/3 2.4 1、新增店铺同步接口 2015/12/8 2.4 1、新增库存查询接口（多条件） 2015/12/21 2.4 1、新增挂起（恢复）接口 2、取消和挂起接口的订单类型增加 THRK=退货入库 2015/12/28 2.4 1、组合商品增加 itemId 字段 2015/12/30 2.4 1、出库单确认接口，orderline 节点下增加货主编码这个字段 2、单据取
14、消接口，单据类型增加采购退货出库 2015/12/31 2.4 1、商品同步接口，商品同步接口（批量）新增字段goodsCode 2016/1/11 2.4 1. 发货单查询接口增加使用交易单查询 2. 订单状态查询返回结果增加交易单号 3. 仓库加工单创建接口增加货主信息和商品配比信息 4. 仓库加工单确认接口增加货主信息 2016/1/27 2.4 1. 新增数据字典获取接口 2. 新增数据字典更新接口 2016/2/17 2.4 1. 为发货单创建新增异步化的结果返回接口发货单创建结果通知接口（批量） 2016/2/18 2.4 1. 入库单创建、出库单创建接口单据类型增加虚拟入库、虚拟
15、出库 2. 入库单创建、出库单创建接口增加关联单据节点，以满足调拨、虚入虚出的业务场景的需求 2016/2/19 2.4 1. 新增发货单波次通知接口，用来给 ERP 或者 OMS回传波次号及对应的发货单号，以支持商家货票同行、波次内包裹的处理等需求。 2016/3/8 2/4 1. sourcePlatformCode 字段添加 MIA=蜜芽 2. 出库单创建接口入参添加字段：供应商编码和供应商名称 3. 异动通知接口添加异动时间字段 changeTime 奇门接入白皮书 7 2016/3/21 2.4 物流公司编码中，增加枚举值：AMAZON=亚马逊物流、DBWL=德邦物流、DBKD=德邦
16、快递、DBKY=德邦快运 2016/4/11 2.4 6.13 发货单创建接口 & 6.14 发货单创建接口 （批量） 两个接口，在 receiverInfo 中新增两个字段： 收件人证件类型，string (50)， 1-身份证 2-军官证 3-护照 4-其他 收件人证件号码，string (50) 6.16 发货单确认接口 & 6.17 发货单确认接口（批量）中，新增一个字段： 仓储费用，double (18, 2) 2016/4/28 2.4 6.13 6.14 两个接口中，字段增加枚举值：HBP(环保配), 2016/5/19 2.5 订单流水通知接口（taobao.qimen.ord
17、erprocess.report）& 订单流水查询接口（taobao.qimen.orderprocess.query）的processStatus 字段，新增枚举值（TMSCANCELFAILED=快递拦截失败），对应菜鸟特有接口配送拦截接口（taobao.qimen.order.callback），用于异步返回拦截结果 2016/5/27 2.6 发货单查询接口(taobao.qimen.deliveryorder.query), 新增枚举值：SIGN=签收(菜鸟仓可以返回签收的状态) 2016/6/6 2.6 所有包括 sourcePlatformCode 字段的接口，sourcePla
18、tformCode 字段添加 GW=商家官网，CT=村淘 枚举值 2016/7/7 2.6 添加一些接口和字段的说明，方便 ISV 理解接口 2016/7/14 2.7 删除接口 6.38-6.43。如果需要查看可参考 V2.6 43 个接口封存版。 删除接口 6.34 菜鸟自动流转查询接口 （扩展），移至菜鸟专有接口白皮书中。 奇门接入白皮书 8 6.13 发货单创建接口新增字段：生产批号，string(50) 2016/9/10 2.8 6.13 发货单创建接口(taobao.qimen.deliveryorder.create)、 6.14 发货单创建接口（批量）(taobao.qime
19、n.deliveryorder.batchcreate)新增服务编码字段：服务编码, string (50)， NCWLJH=集包, 条件必填，条件为集包订单发货 2016/11/22 2.9 1. 新增 6.19 订单 SN 通知接口 2. 物流公司编码中新增：DBWL=德邦物流、DBKD=德邦快递、DBKY=德邦快运 2017/4/28 3.0 添加调拨单创建、调拨单查询和调拨单通知接口（菜鸟） 2017/5/3 3.0 添加承运商 RRS=日日顺 2017/5/16 3.1 库存盘点查询通知接口添加商品总量字段：盘点商品总量，int 2017/6/16 3.1 订单来源平台编码 OTHE
20、R=其他 修改为 OTHERS=其他，和电子面单编码一致 2017/6/20 3.1 入库单确认增加邮费字段，帮助商家分摊成本，快递费用 (元) , double (18, 2) 2017/6/29 3.1 发货单创建和发货单创建批量接口增加税号字段税号,string(50) 2017/9/19 3.1 taobao.qimen.orderprocess.report 增加expressCode(运单号) 2018/1/23 3.1 订单来源平台编码添加 YJWD=云集微店 2018/2/5 3.1 添加仓库信息查询接口taobao.qimen.warehouseinfo.query 2018
21、/3/5 3.2 入库单创建、退货入库单创建、入库单确认、退货入库单确认、出库单确认、发货单确认接口增加商品序列号, string(50)节点 2018/5/15 3.2 出库单创建添加 purchasePrice、retailPrice 、actualPrice 字段 2018/5/30 3.3 升级出库单创建接口支持唯品会调拨场景 2018/6/13 3.4 添加商品查询接口 taobao.qimen.singleitem.query 奇门接入白皮书 9 2018/9/17 3.5 在出库单创建环节增加唯品会 JIT 业务送仓单关联，添加生产批号和批次编号的解释。 2019/1/7 3.5
22、 在出库单确认接口的 package 字段下增加logisticsCode 字段 2019/2/19 3.6 添加新接口退货包裹状态通知接口 2019/8/15 3.7 更新退货入库单创建接口，增加来源平台和卖家信息 2019/8/16 3.7 添加订单异常通知接口 2019/9/16 3.7.1 发货接口增加区域零售的订单标识 2019/9/24 3.7.2 订单流水通知接口增加枚举类型 2019/12/10 3.7.3 添加配送公司信息查询接口 2020/03/02 3.7.4 出入库确认接口增加其他出入库子类型和费用承担部门 2020/09/03 3.7.5 发货单创建接口增加最晚发货时
23、间和最晚揽收时间 2020/09/14 3.7.6 发货单创建接口增加 PRESELLCONSIGN=预售极速达订单 2021/01/26 3.7.7 发货单创建接口增加 PRESELESPACKAGE=预售预包预售预包订单订单 2021/01/27 3.8 发货单创建接口添加订单收件人 ID 字段 OAID 2021/03/04 3.9 增加 taobao.qimen.order.query 和taobao.qimen.receiverinfo.query 接口 2021/03/16 3.9.1 增加商品单仓批次库存查询接口 2021/05/16 3.9.2 taobao.qimen.del
24、iveryorder.confirm 接口增加订单部分出库信息回传相关字段 2021/05/24 3.9.3 OAID 收件人信息解密接口增加货主 ID 字段 2021/07/16 3.9.4 taobao.qimen.deliveryorder.create 接口中渠道枚举值增加 taobao.qimen.entryorder.confirm 接口中增加分批次入库整单数据回传结构体(totalorders) 2021/09/02 3.9.5 taobao.qimen.returnorder.create 接口中 orderFlag 字段增加枚举值 FETCH_RETURN 用于菜鸟大件上门取
25、退业务 奇门接入白皮书 10 2 目录 1 版本记录 . 2 2 目录 . 10 3 前言 . 20 3.1 业务背景 . 20 3.2 名词解释 . 20 4 奇门对接方案. 21 4.1 奇门对接方式 . 21 4.2 奇门标准化对接构架 . 22 4.3 系统调用流程 . 23 4.4 联调、测试方式 . 23 4.4.1 ERP 端 . 24 4.4.2 WMS 端 . 25 5 接口规范 . 26 5.1 ERP 与奇门的通信协议 . 26 5.1.1 协议描述 . 26 5.1.2 访问授权 . 26 5.1.3 请求参数说明 . 27 5.1.4 响应参数 . 27 5.2 奇门
26、与 WMS 的通信协议 . 27 5.2.1 协议描述 . 27 5.2.2 请求参数 . 28 5.2.3 响应参数 . 29 6 接口说明 . 29 6.1 商品查询接口 . 29 奇门接入白皮书 11 6.1.1 接口介绍 . 29 6.1.2 入参规范 . 29 6.1.3 出参规范 . 30 6.2 商品同步接口 . 32 6.2.1 接口介绍 . 32 6.2.2 入参规范 . 32 6.2.3 出参规范 . 34 6.3 商品同步接口 (批量) . 35 6.3.1 接口介绍 . 35 6.3.2 入参规范 . 35 6.3.3 出参规范 . 37 6.4 组合商品接口 . 38
27、 6.4.1 接口介绍 . 38 6.4.2 入参规范 . 38 6.4.3 出参规范 . 38 6.5 创建前后端商品映射接口 . 39 6.5.1 接口介绍 . 39 6.5.2 入参规范 . 39 6.5.3 出参规范 . 39 6.6 前后端商品映射查询接口 . 39 6.6.1 接口介绍 . 39 6.6.2 入参规范 . 40 6.6.3 出参规范 . 40 6.7 入库单创建接口 . 40 6.7.1 接口介绍 . 40 6.7.2 入参规范 . 41 6.7.3 出参规范 . 44 6.8 入库单确认接口 . 44 奇门接入白皮书 12 6.8.1 接口介绍 . 44 6.8.
28、2 入参规范 . 44 6.8.3 出参规范 . 47 6.9 入库单查询接口 . 48 6.9.1 接口介绍 . 48 6.9.2 入参规范 . 48 6.9.3 出参规范 . 48 6.10 退货入库单创建接口 . 49 6.10.1 接口介绍 . 49 6.10.2 入参规范 . 50 6.10.3 出参规范 . 52 6.11 退货入库单确认接口 . 52 6.11.1 接口介绍 . 52 6.11.2 入参规范 . 52 6.11.3 出参规范 . 55 6.12 退货入库单查询接口 . 55 6.12.1 接口介绍 . 55 6.12.2 入参规范 . 55 6.12.3 出参规范
29、 . 55 6.13 出库单创建接口 . 57 6.13.1 接口介绍 . 57 6.13.2 入参规范 . 57 6.13.3 出参规范 . 61 6.14 出库单确认接口 . 61 6.14.1 接口介绍 . 61 6.14.2 入参规范 . 62 6.14.3 出参规范 . 65 6.15 出库单查询接口 . 65 奇门接入白皮书 13 6.15.1 接口介绍 . 65 6.15.2 入参规范 . 65 6.15.3 出参规范 . 65 6.16 发货单创建接口 . 67 6.16.1 接口介绍 . 67 6.16.2 入参规范 . 68 6.16.3 出参规范 . 72 6.17 发货
30、单创建接口 （批量） . 73 6.17.1 接口介绍 . 73 6.17.2 入参规范 . 73 6.17.3 出参规范 . 78 6.18 发货单创建结果通知接口 （批量） . 79 6.18.1 接口介绍 . 79 6.18.2 入参规范 . 79 6.18.3 出参规范 . 80 6.19 发货单确认接口 . 80 6.19.1 接口介绍 . 80 6.19.2 入参规范 . 81 6.19.3 出参规范 . 84 6.20 发货单确认接口 (批量) . 85 6.20.1 接口介绍 . 85 6.20.2 入参规范 . 85 6.20.3 出参规范 . 89 6.21 发货单查询接口
31、 . 89 6.21.1 接口介绍 . 89 6.21.2 入参规范 . 89 6.21.3 出参规范 . 89 6.22 订单 SN 通知接口. 93 奇门接入白皮书 14 6.22.1 接口介绍 . 93 6.22.2 入参规范 . 93 6.22.3 出参规范 . 94 6.23 发货单 SN 通知接口 . 94 6.23.1 接口介绍 . 94 6.23.2 入参规范 . 94 6.23.3 出参规范 . 95 6.24 订单流水查询接口 . 95 6.24.1 接口介绍 . 95 6.24.2 入参规范 . 95 6.24.3 出参规范 . 96 6.25 订单状态查询接口 （批量）
32、 . 97 6.25.1 接口介绍 . 97 6.25.2 入参规范 . 97 6.25.3 出参规范 . 98 6.26 订单流水通知接口 . 99 6.26.1 接口介绍 . 99 6.26.2 入参规范 . 99 6.26.3 出参规范 . 100 6.27 订单异常通知接口 . 100 6.27.1 接口介绍 . 100 6.27.2 入参规范 . 100 6.27.3 出参规范 . 101 6.28 退货异常包裹单通知接口 . 102 6.28.1 接口介绍 . 102 6.28.2 入参规范 . 102 6.28.3 出参规范 . 103 6.29 退货包裹状态通知接口 . 104
33、 奇门接入白皮书 15 6.29.1 接口介绍 . 104 6.29.2 入参规范 . 104 6.29.1 出参规范 . 105 6.30 发货单缺货通知接口 . 105 6.30.1 接口介绍 . 105 6.30.2 入参规范 . 105 6.30.3 出参规范 . 106 6.31 发货单缺货查询接口 . 106 6.31.1 接口介绍 . 106 6.31.2 入参规范 . 106 6.31.3 出参规范 . 107 6.32 单据取消接口 . 108 6.32.1 接口介绍 . 108 6.32.2 入参规范 . 108 6.32.3 出参规范 . 108 6.33 单据挂起（恢复
34、）接口 . 109 6.33.1 接口介绍 . 109 6.33.2 入参规范 . 109 6.33.3 出参规范 . 109 6.34 库存查询接口（多商品） . 110 6.34.1 接口介绍 . 110 6.34.2 入参规范 . 110 6.34.3 出参规范 . 110 6.35 库存查询接口（多条件） . 111 6.35.1 接口介绍 . 111 6.35.2 入参规范 . 111 6.35.3 出参规范 . 112 6.36 仓库查询接口 . 113 奇门接入白皮书 16 6.36.1 接口介绍 . 113 6.36.2 入参规范 . 113 6.36.3 出参规范 . 113
35、 6.37 仓库同步接口 . 114 6.37.1 接口介绍 . 114 6.37.2 入参规范 . 114 6.37.3 出参规范 . 115 6.38 库存盘点通知接口 . 115 6.38.1 接口介绍 . 115 6.38.2 入参规范 . 115 6.38.3 出参规范 . 116 6.39 库存盘点查询接口 . 117 6.39.1 接口介绍 . 117 6.39.2 入参规范 . 117 6.39.3 出参规范 . 117 6.40 仓内加工单创建接口 . 118 6.40.1 接口介绍 . 118 6.40.2 入参规范 . 118 6.40.3 出参规范 . 120 6.41
36、 仓内加工单确认接口 . 120 6.41.1 接口介绍 . 120 6.41.2 入参规范 . 120 6.41.3 出参规范 . 121 6.42 库存异动通知接口 . 122 6.42.1 接口介绍 . 122 6.42.2 入参规范 . 122 6.42.3 出参规范 . 123 6.43 店铺同步接口 . 124 奇门接入白皮书 17 6.43.1 接口介绍 . 124 6.43.2 入参规范 . 124 6.43.3 出参规范 . 125 6.44 发货单波次通知接口 . 125 6.44.1 接口介绍 . 125 6.44.2 入参规范 . 125 6.44.3 出参规范 . 1
37、26 6.45 调拨单创建接口 . 126 6.45.1 接口介绍 . 126 6.45.2 入参规范 . 126 6.45.3 出参规范 . 127 6.46 调拨单查询接口 . 127 6.46.1 接口介绍 . 127 6.46.2 入参规范 . 127 6.46.3 出参规范 . 127 6.47 调拨单通知接口 . 128 6.47.1 接口介绍 . 128 6.47.2 入参规范 . 128 6.47.3 出参规范 . 129 6.48 渠道间库存规则设置接口 . 129 6.48.1 接口介绍 . 129 6.48.2 入参规范 . 129 6.48.3 出参规范 . 130 6
38、.49 库存汇总报表查询接口 . 130 6.49.1 接口介绍 . 130 6.49.2 入参规范 . 130 6.49.3 出参规范 . 131 6.50 订单出库统计查询接口 . 131 奇门接入白皮书 18 6.50.1 接口介绍 . 131 6.50.2 入参规范 . 132 6.50.3 出参规范 . 132 6.51 心跳接口 . 133 6.51.1 接口介绍 . 133 6.51.2 入参规范 . 133 6.51.3 出参规范 . 133 6.52 供应商信息同步接口 . 133 6.52.1 入参规范 . 134 6.52.2 出参规范 . 134 6.53 配送公司信息
39、查询 . 134 6.53.1 接口使用说明 . 134 6.53.2 接口介绍 . 135 6.53.3 入参规范 . 135 6.53.4 出参规范 . 135 6.54 根据收件人信息查询交易单号接口 . 135 6.54.1 接口使用说明 . 135 6.54.2 接口介绍 . 136 6.54.3 入参规范 . 136 6.54.4 出参规范 . 136 6.55 OAID 收件人信息解密接口 . 136 6.55.1 接口使用说明 . 136 6.55.2 接口介绍 . 136 6.55.3 入参规范 . 137 6.55.4 出参规范 . 137 7 附录 . 139 7.1 s
40、ign 签名算法： . 139 7.1.1 输入参数为 . 139 奇门接入白皮书 19 7.1.2 按首字母升序排列 . 139 7.1.3 连接字符串 . 140 7.1.4 生成签名 sign . 140 7.1.5 拼装 URL 请求 . 140 奇门接入白皮书 20 3 前言 3.1 业务背景 随着电子商务发展，商家所使用到的各类软件越来越多，各个软件之间没有相互打通，形成一个个信息孤岛，给商家的使用带来种种不便，商家要求各个系统之间的对接需求已经越来越迫切； 目前在行业内已经有部分系统直接由服务商之间完成了系统软件的对接，但是由于没有统一的接入标准，导致接入较混乱，对接接口的版本也
41、参差不齐，往往这样的系统对接不具有可复制性，多个系统之间的对接，需要多次开发，给商家的使用和功能迭代升级带来了诸多的不便，同时也给服务商带来额外的维护、开发成本；为了满足商家需求，让商家能够突破各个业务系统之间的信息孤岛，提升商家在各个系统之间的操作效率，解决各个系统之间标准化对接的痛点，我们推出了奇门项目； 奇门项目一期支持 ERP、WMS 之间的系统标准化对接，通过构建 ERP、WMS 系统之间标准通信协议来实现不同系统之间的打通；对商家来说，省去了更换系统软件所带来的额外开发成本；对 ISV 来说，省去了与多家 ERP、WMS 系统对接难的问题，ERP 通过一次对接奇门项目，打通与所有
42、WMS 之间的通信，WMS 通过一次对接奇门项目，可以适配所有 ERP 软件；后期我们也将加入更多系统的支持，例如 CRM 与 ERP 的标准化对接，CRM 与在线订购类营销工具的标准化对接；敬请期待！ 3.2 名词解释 序号 名词 解释 1 奇门项目 阿里巴巴商家业务系统标准化对接平台 2 OMS Order Management System 订单管理系统 3 TMS Transportation Management System 物流管理系统 4 WMS Warehouse Management System 仓库管理系统 5 ERP ERP Enterprise Resource P
43、lanning 企业资源计划 6 正向调用 由 ERP 发起调用到奇门，奇门处理后将请求转发至 WMS 端 7 反向调用 由 WMS 发起调用到奇门，奇门处理后将请求转发至 ERP 端 奇门接入白皮书 21 4 奇门对接方案 4.1 奇门对接方式 目前商家使用的各个业务系统之间依靠 ISV 帮助实现 ERP 到 WMS 的对接，如果有多仓需求的商家还需要使用到 2 套以上的第三方仓储服务所提供的WMS 软件，ERP、WMS 各自对接，对接的总工作量为 N*N 倍，不但给 ISV的开发带来了极大的成本，对于后期维护，也将是一项艰巨的任务，如下图所示： 通过奇门项目后可使原有的网状对接结构变为一对
44、一的对接方式，ERP、WMS 只需要与奇门数据总线对接一次即可完成所有系统的适配（特殊场景可能采用扩展字段的方式给与支持），如下图： 奇门接入白皮书 22 奇门项目后继接口升级方式将采用字段升级方式，在原有基础上加入更多的业务字段，同时业务接口向下兼容，开发过一次，后继如需更多的业务字段只需在原有接口层面加入业务字段即可，无需重新开发业务逻辑； 4.2 奇门标准化对接构架 前端 ERP 系统通过 TOP 平台与奇门应用进行对接，ERP 系统通过标准化通信协议、字段访问奇门系统，ERP 在此需要进行改造； 奇门应用主要提供字段映射、数据翻译、数据路由、账号权限、流控、数据打点等功能，能够让双方的
45、请求通过奇门进行正常的传输，奇门还提供商家自定义扩展字段，通过奇门项目的通用数据通道进行传输，在标准协议不能完全支持的情况下，可以采用扩展字段的方式进行补充； 后端 WMS 系统通过 TOP 平台与奇门应用进行对接，WMS 系统通过标准化通信协议、字段调用奇门系统，WMS 在此也需要进行改造； （可选）WMS 系统需要提供出能够在系统中新建用户、查询用户的 API，以供奇门项目应用调用，新商家接入时，奇门项目可以直接调用该 API 创建新的用户； 奇门接入白皮书 23 4.3 系统调用流程 正向调用：前端 ERP 系统通过 TOP 接口与奇门项目应用进行交互，对于想要发送到 WMS 的请求首先
46、发送到奇门应用，由奇门负责数据的解析、字段映射、数据翻译，再将处理后的数据通过 ERP 系统所请求的目的地发送至 WMS系统；WMS 系统收到请求后，将返回结果送回至奇门应用，由奇门应用统一返回至 ERP 系统； 反向调用：WMS 系统主动向 ERP 系统发出状态更新请求也是类似以上的访问步骤； 以下是简版软件流程图： 奇门ERPWMS正向发起业务请求HTTP返回WMS响应结果正向发起WMS业务请求HTTP返回响应结果反向发起业务请求HTTP反向发起ERP业务请求HTTP返回响应结果返回ERP响应结果正向流程反向流程 4.4 联调、测试方式 奇门项目支持 ERP 系统的正向调用以及 WMS 系
47、统的反向调用，所以对于ERP 系统以及 WMS 系统的测试方法并不一致，以下分别介绍 ERP 系统以及WMS 系统的联调、测试方法： 奇门接入白皮书 24 4.4.1 ERP 端 配置信息确认阶段：提前与 WMS 厂商进行沟通，根据商家的在 WMS 端的用户信息获取以下配置信息，并提供给奇门项目组，由奇门项目组完成在奇门当中的配置： 奇门标准字段 字段含义 备注 测试环境配置值 appkey appkey 由开放平台分配，对应 ERP 软件的编码 customerid 用户 id 访问 WMS 系统的账号 secretkey 用户密码 该账号访问 WMS 系统的密码 开发接口阶段：奇门项目当中
48、 ERP 端支持正向调用也支持反向调用，正向调用的 API 接口由 TOP 平台提供，ERP 端直接发起对沙箱环境的调用即可完成接口的测试工作，沙箱环境调用地址如下 (只需修改红色标示的 method 方法字段和 test_type 字段，test_type 值可以取 normal 和 error，normal 会返回该请求成功的应答，error 会返回该请求失败的应答) ： http:/ 反向调用的 API 接口由 ERP 端提供，奇门会直接向 ERP 端发起调用，在此类型的 API 接口测试的过程当中，需要由服务商使用一个 Http Restful 接口的客户端向奇门发起反向调用；（推荐使
49、用 Chrome 浏览器下的 REST Console插件） 系统联调阶段：依次完成正向请求的开发与反向接口的工作后，与奇门项目组共同进行联调，在测试环境当中依次测试之前开发接口的业务逻辑； 系统发布阶段：与 WMS 端服务商共同确认正式环境的配置值，ERP 端直接发起对奇门正式环境的调用，需要将原有访问地址与具体配置地址切换成正式环境地址。 奇门接入白皮书 25 4.4.2 WMS 端 配置信息确认阶段：WMS 厂商需提前提供商家的在 WMS 端的用户信息以及如下的配置信息，提供给奇门项目组以及 ERP 端进行配置： 奇门标准字段 字段含义 备注 测试环境配置值 warehouseCode
50、仓库 id 仓储服务商分配给商家的仓库编码 customerid 用户 id 访问 WMS 系统的账号 开发接口阶段：奇门项目当中 WMS 端支持正向调用也支持反向调用，反向调用的 API 接口由 TOP 平台提供，WMS 端直接发起对沙箱环境的调用即可完成接口的测试工作，沙箱环境调用地址如下 (只需修改红色标示的 method方法字段和 test_type 字段，test_type 值可以取 normal 和 error，normal 会返回该请求成功的应答，error 会返回该请求失败的应答) ： http:/ method=taobao.qimen.itemlack.report&tim
sgpjbg002
工作日 8:30 - 17:30
会员动态：
报告分类
新质生产力
ChatGPT
新能源汽车
大模型
Sora
机器人
微短剧
芯片
薪酬
白皮书
低空经济
数据要素
创新药
人工智能
AI产业
信息科技
互联网
消费经济
汽车交通
电商零售
传媒娱乐
医药健康
投资金融
能源环境
地产开发
传统产业
全球化
其它
扫码登录
手机快捷登录
账号登录
