奇门白皮书

更新时间:2023-12-19 14:45:01 阅读量: 教育文库 文档下载

说明:文章内容仅供预览,部分内容可能不全。下载后的文档,内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的,是否完整无缺。

奇门ISV接入白皮书

奇门标准化协议白皮书

V2.4

阿里巴巴集团商家业务事业部

2015

1

奇门ISV接入白皮书

1 版本记录

Date 2015.03.27 Version 1.0 Description 1、奇门标准化协议v1.0发布 1、增加入库单更新,出库单更新,库存异动更新等32015.03.31 1.2 个接口 2、API名称区分了erp和wms 3、优化部分字段命名 2015.04.07 2015.04.09 1.3 1.4 1、将auditor相关的字段统一成operator 1、更新接口规范,新增“奇门与wms的通信协议”等相关内容 2、新增入库单,去掉一个重复的入库单编码 1、加入奇门项目服务商解决方案章节 2、增加通信协议里的反向协议标准 2015.04.14 1.5 3、更新个别字段名,如Quantity更新为Qty,stockSelectedQty等字段名中将stock去掉,变为selectedQty。 1、加入菜鸟仓业务接口支持 2015.5.6 2.0 2、接口整体改动较大,主要增加业务接口和原有接口内增加字段 1、出入库单据增加ERP行号的概念 2、出库单流水接口升级为订单流水接口 3、仓内加工单更名为storeprocess 2015.5.7 2.1 4、发货单确认接口的生产日期produceDate变更为productDate 5、退货入库单创建接口orderLine节点中增加ownerCode字段;入库单创建接口中ownerCode移到orderLine节点中 1、取消订单,订单类型变为非必填 2015.5.20 2.1 2、发货单创建,付款时间变为非必填 3、所有地址中的区域改为非必填 4、退货入库单确认接口,物流公司编码改为非必填 2015.6.5 2015.6.10 2.2 2.2 1、增加“出库单创建”,“出库单确认”接口 1、“出库单创建”增加货主编码字段 2

奇门ISV接入白皮书

2、增加“订单状态查询”和“库存查询”两个接口 3、规范“冻结库存”的使用范围 1、增加“组合商品接口” 2、入库单的收件人,发件人,物流公司信息为非必填 3、新增入库单类型:生产入库、领用入库、残次品入库。 2015.6.11 2.2 4、入库单新增字段,采购单号 5、盘点单新增字段,盘点时间 6、新增“库存异动接口” 7、“订单状态查询”不仅查当前状态,历史状态也可以 8、“普通出库单”增加发件人信息 1、“组合商品创建接口”和“订单流水查询接口“,去掉warehouseCode编码 2015.6.12 2.2 2、“订单流水查询接口”和“库存查询接口”response增加的flag,code,message这三个标准的应答。 2015.6.25 2.2 1、增加发货单查询接口 1、订单状态查询增加两个入库状态(PARTFULFILLED-2015.7.2 2.2 部分收货完成, FULFILLED-收货完成。) 2、库存查询接口增加货主编码ownerCode 1、退货入库创建接口:商品增加批次等信息 2、发货单创建接口,发票增加普通发票的类型 3、订单流水查询接口,删除NEW状态 2015.7.3 2.2 4、订单流水通知接口,删除NEW,CANCELEDFAIL状态 5、发货单创建和发货单缺货通知接口,在item节点下增加inventoryType等字段 1、商品同步接口的barcode可以填多个 2、发货单创建增加字段“deliveryType” 3、发货单创建返回值支持统仓统配的拆单 2015.7.6 2.2 4、发票内容格式化 5、增加B2B出库的出库类型 6、入库单确认接口的entryOrderId 改为条件必填 7、extendProps和remark统一定义了 3

奇门ISV接入白皮书

8、退货单创建和确认接口增加批次信息 9、订单流水查询删除CANCELFAILED状态 10、订单流水通知接口删除NEW,CANCELFAILED状态 11、发货单缺货通知接口item节点下增加inventoryType和批次信息 1、B2B入库和B2B出库单据状态多接口修订 2015.7.9 2.2 2、发货单SN通知借口,加上分页,并且将sns的节点去掉 2015.7.14 2.2 1、增加库存异动接口,单据类型增加ZZTZ=状态调整单 1、发货单 invoices下面的detail增加item节点 2、发货单发货类型的枚举值CWPS(常温配送)改为2015.7.16 2.2 PTPS(普通配送) 3、商品同步barcode的分隔符改为; 4、部分warehouseCode重新定义约束和说明 5、库存异动接口更名为库存异动通知接口 1、发货单创建的出参,response节点下增加2015.7.17 2.2 warehouseCode和logisticsCode两个字段,以适配以前的版本 1、库存异动接口,结构体变化,将warehouseCode,2015.7.20 2.2 ownerCode,orderCode,orderType,outbizCode等放到item节点下 2015.7.21 2015.7.22 2.2 2.2 1、快递编码中增加京东配送(JD),当当宅配(DD) 1、出库单创建和出库单确认接口增加logisticsCode字段 1、入库单创建、入库单确认、出库单创建、出库单确认2015.7.23 2015.7.30 2.2 2.2 等四个接口增加totalOrderLines,outBizCode这两个字段用于分批传输处理 1、发货单确认接口增加“包裹理论重量” 1、新增接口订单状态查询接口(批量),用于解决通过2015.8.14 2.2 订单最后操作时间的区间值等信息,去批量查询订单 2、发货单创建接口的orderLine下面增加batchCode等字段,用于解决指定批次发货的问题 4

奇门ISV接入白皮书

1、发货单创建接口的orderLine下面增加2015.8.20 2.2 productDate,expireDate等字段 2、渠道枚举字段调整,凡客由FK调整为VANCL 1、新增5个接口,支持用于各种订单在仓内操作结果的详情查询,包括入库单查询,出库单查询,退货入库单查询,发货单查询,发货单缺货查询。 2015/8/31 2.3 2、订单流水查询和订单流水确认接口的status,增加两个状态,PARTFULFILLED,FULFILLED两个状态。 3、入库单确认接口,出库单确认接口,增加单据状态字段status。 1、发货单确认接口,单价和数量字段类型修正 2015/9/6 2.3 2、所有正向接口,均补充warehouseCode,作为可能的一单分多仓的业务场景。 2015/9/7 2.3 1、新增接口,为菜鸟自动流转的业务新增的特殊业务接口。 1、新增盘点单查询接口 2、盘点单确认接口和盘点单查询接口均增加2015/9/14 2.3 checkOrderId 3、发货单查询接口,为了兼容,入参将deliveryOrderCode改为orderCode,deliveryOrderId改为orderId 2015/9/21 2015/9/22 2015/9/24 2015/10/10 2015/10/15 2.3 2.3 2.3 2.3 2.3 入库单确认,出库单确认,退货入库单确认,发货单确认,库存异动通知 新增心跳接口 1、订单流水查询接口增加orderType 2、发货单确认接口orderType增加枚举值QTCK。 1、库存盘点查询的接口名变更 1、在发货单确认,发货单查询,退货入库单确认,退货入库单查询等接口的orderline中增加商品二维码,用于对单个商品的管理。 2015/10/20 2015/10/27 2015/11/19 2.3 2.3 2.3 1、新增商品同步接口(批量),发货单创建接口(批量),发货单确认接口(批量) 1、发货单创建接口的orderline下增加payNo,用于解决合单后的支付宝交易号的传输。 1、出库单类型新增采购退货出库类型(CGTH) 5

奇门ISV接入白皮书

2015/11/23 2.3 1、发货单创建接口,出参response下增加createTime。 新增4个接口,主要用来注册奇门的仓库编码,奇门的用户号,包括奇门仓库注册接口,奇门仓库查询接口,奇门仓库更新接口,奇门用户注册接口 1、新增店铺同步接口 1、新增库存查询接口(多条件) 1、新增挂起(恢复)接口 2、取消和挂起接口的订单类型增加THRK=退货入库 1、组合商品增加itemId字段 1、出库单确认接口,orderline节点下增加货主编码这个字段 2、单据取消接口,单据类型增加采购退货出库 1、商品同步接口,商品同步接口(批量)新增字段goodsCode 2015/11/25 2015/12/3 2015/12/8 2015/12/21 2015/12/28 2015/12/30 2.4 2.4 2.4 2.4 2.4 2.4 2015/12/31 2.4

6

奇门ISV接入白皮书

2 目录

1 2 3

版本记录 ................................................................................................ 2 目录 ....................................................................................................... 7 前言 ..................................................................................................... 13

业务背景 .................................................................................................. 13 名词解释 .................................................................................................. 13

3.1 3.2

4 奇门对接方案 ....................................................................................... 14

奇门对接方式 .......................................................................................... 14 奇门标准化对接构架 ............................................................................... 15 系统调用流程 .......................................................................................... 16 联调、测试方式 ....................................................................................... 16

4.1 4.2 4.3 4.4

4.4.1 ERP端 .......................................................................................................... 17 4.4.2 WMS端 ....................................................................................................... 17

5 接口规范 .............................................................................................. 19

ERP与奇门的通信协议 ............................................................................. 19

协议描述 .................................................................................................... 19 访问授权 .................................................................................................... 19 请求参数说明 ............................................................................................ 20 响应参数 .................................................................................................... 20

5.1

5.1.1 5.1.2 5.1.3 5.1.4 5.2

奇门与WMS的通信协议 ......................................................................... 20 协议描述 .................................................................................................... 20 请求参数 .................................................................................................... 21 响应参数 .................................................................................................... 22

5.2.1 5.2.2 5.2.3

6 接口说明 .............................................................................................. 22

商品同步接口 .......................................................................................... 22

7

6.1

奇门ISV接入白皮书

6.1.1 6.1.2 6.1.3 6.2

接口介绍 .................................................................................................... 22 入参规范 .................................................................................................... 22 出参规范 .................................................................................................... 25

组合商品接口 .......................................................................................... 28 接口介绍 .................................................................................................... 28 入参规范 .................................................................................................... 28 出参规范 .................................................................................................... 28

6.2.1 6.2.2 6.2.3 6.3

入库单创建接口 ....................................................................................... 29 接口介绍 .................................................................................................... 29 入参规范 .................................................................................................... 29 出参规范 .................................................................................................... 32

6.3.1 6.3.2 6.3.3 6.4

入库单确认接口 ....................................................................................... 32 接口介绍 .................................................................................................... 32 入参规范 .................................................................................................... 32 出参规范 .................................................................................................... 34

6.4.1 6.4.2 6.4.3 6.5

入库单查询接口 ....................................................................................... 34 接口介绍 .................................................................................................... 34 入参规范 .................................................................................................... 34 出参规范 .................................................................................................... 35

6.5.1 6.5.2 6.5.3 6.6

退货入库单创建接口 ............................................................................... 36 接口介绍 .................................................................................................... 36 入参规范 .................................................................................................... 36 出参规范 .................................................................................................... 38

6.6.1 6.6.2 6.6.3 6.7

退货入库单确认接口 ............................................................................... 38 接口介绍 .................................................................................................... 38 入参规范 .................................................................................................... 38 出参规范 .................................................................................................... 40

6.7.1 6.7.2 6.7.3 6.8

退货入库单查询接口 ............................................................................... 41

8

奇门ISV接入白皮书

6.8.1 6.8.2 6.8.3 6.9

接口介绍 .................................................................................................... 41 入参规范 .................................................................................................... 41 出参规范 .................................................................................................... 41

出库单创建接口 ....................................................................................... 43 接口介绍 .................................................................................................... 43 入参规范 .................................................................................................... 43 出参规范 .................................................................................................... 46 出库单确认接口 ..................................................................................... 46 接口介绍 .................................................................................................. 46 入参规范 .................................................................................................. 46 出参规范 .................................................................................................. 49

6.9.1 6.9.2 6.9.3 6.10

6.10.1 6.10.2 6.10.3 6.11

出库单查询接口 ..................................................................................... 49 接口介绍 .................................................................................................. 49 入参规范 .................................................................................................. 49 出参规范 .................................................................................................. 50

6.11.1 6.11.2 6.11.3 6.12

发货单创建接口 ..................................................................................... 52 接口介绍 .................................................................................................. 52 入参规范 .................................................................................................. 52 出参规范 .................................................................................................. 56

6.12.1 6.12.2 6.12.3 6.13

发货单确认接口 ..................................................................................... 62 接口介绍 .................................................................................................. 62 入参规范 .................................................................................................. 62 出参规范 .................................................................................................. 66

6.13.1 6.13.2 6.13.3 6.14

发货单查询接口 ..................................................................................... 70 接口介绍 .................................................................................................. 70 入参规范 .................................................................................................. 70 出参规范 .................................................................................................. 71

6.14.1 6.14.2 6.14.3 6.15

发货单SN通知接口 ............................................................................... 74

9

奇门ISV接入白皮书

6.15.1 6.15.2 6.15.3 6.16

接口介绍 .................................................................................................. 74 入参规范 .................................................................................................. 74 出参规范 .................................................................................................. 75

订单流水查询接口 ................................................................................. 75 接口介绍 .................................................................................................. 75 入参规范 .................................................................................................. 75 出参规范 .................................................................................................. 75

6.16.1 6.16.2 6.16.3 6.17

订单状态查询接口(批量) .................................................................. 77 接口介绍 .................................................................................................. 77 入参规范 .................................................................................................. 77 出参规范 .................................................................................................. 77

6.17.1 6.17.2 6.17.3 6.18

订单流水通知接口 ................................................................................. 78 接口介绍 .................................................................................................. 78 入参规范 .................................................................................................. 78 出参规范 .................................................................................................. 79

6.18.1 6.18.2 6.18.3 6.19

发货单缺货通知接口 ............................................................................. 80 接口介绍 .................................................................................................. 80 入参规范 .................................................................................................. 80 出参规范 .................................................................................................. 81

6.19.1 6.19.2 6.19.3 6.20

发货单缺货查询接口 ............................................................................. 81 接口介绍 .................................................................................................. 81 入参规范 .................................................................................................. 81 出参规范 .................................................................................................. 81

6.20.1 6.20.2 6.20.3 6.21

单据取消接口 ........................................................................................ 82 接口介绍 .................................................................................................. 82 入参规范 .................................................................................................. 82 出参规范 .................................................................................................. 83

6.21.1 6.21.2 6.21.3 6.22

库存查询接口 ........................................................................................ 84

10

奇门ISV接入白皮书

6.22.1 6.22.2 6.22.3 6.23

接口介绍 .................................................................................................. 84 入参规范 .................................................................................................. 84 出参规范 .................................................................................................. 85

库存盘点通知接口 ................................................................................. 88 接口介绍 .................................................................................................. 88 入参规范 .................................................................................................. 88 出参规范 .................................................................................................. 89

6.23.1 6.23.2 6.23.3 6.24

库存盘点查询接口 ................................................................................. 89 接口介绍 .................................................................................................. 89 入参规范 .................................................................................................. 89 出参规范 .................................................................................................. 89

6.24.1 6.24.2 6.24.3 6.25

仓内加工单创建接口 ............................................................................. 90 接口介绍 .................................................................................................. 90 入参规范 .................................................................................................. 91 出参规范 .................................................................................................. 92

6.25.1 6.25.2 6.25.3 6.26

仓内加工单确认接口 ............................................................................. 92 接口介绍 .................................................................................................. 92 入参规范 .................................................................................................. 92 出参规范 .................................................................................................. 94

6.26.1 6.26.2 6.26.3 6.27

库存异动通知接口 ................................................................................. 94 接口介绍 .................................................................................................. 94 入参规范 .................................................................................................. 94 出参规范 .................................................................................................. 95

6.27.1 6.27.2 6.27.3 6.28

菜鸟自动流转查询接口(扩展) ........................................................... 96 接口介绍 .................................................................................................. 96 入参规范 .................................................................................................. 96 出参规范 .................................................................................................. 96

6.28.1 6.28.2 6.28.3 6.29

心跳接口 ................................................................................................ 98

11

奇门ISV接入白皮书

6.29.1 6.29.2 6.29.3

接口介绍 .................................................................................................. 98 入参规范 .................................................................................................. 98 出参规范 .................................................................................................. 98

7 附录 ................................................................................................... 103

sign签名算法: ...................................................................................... 103

输入参数为 .............................................................................................. 103 按首字母升序排列 .................................................................................. 104 连接字符串 .............................................................................................. 104 生成签名 sign........................................................................................... 104 拼装URL请求 ......................................................................................... 104

7.1

7.1.1 7.1.2 7.1.3 7.1.4 7.1.5

12

奇门ISV接入白皮书

3 前言

3.1

业务背景

随着电子商务发展,商家所使用到的各类软件越来越多,各个软件之间没有相互打通,形成一个个信息孤岛,给商家的使用带来种种不便,商家要求各个系统之间的对接需求已经越来越迫切;

目前在行业内已经有部分系统直接由服务商之间完成了系统软件的对接,但是由于没有统一的接入标准,导致接入较混乱,对接接口的版本也参差不齐,往往这样的系统对接不具有可复制性,多个系统之间的对接,需要多次开发,给商家的使用和功能迭代升级带来了诸多的不便,同时也给服务商带来额外的维护、开发成本;为了满足商家需求,让商家能够突破各个业务系统之间的信息孤岛,提升商家在各个系统之间的操作效率,解决各个系统之间标准化对接的痛点,我们推出了奇门项目;

奇门项目一期支持ERP、WMS之间的系统标准化对接,通过构建ERP、WMS系统之间标准通信协议来实现不同系统之间的打通;对商家来说,省去了更换系统软件所带来的额外开发成本;对ISV来说,省去了与多家ERP、WMS系统对接难的问题,ERP通过一次对接奇门项目,打通与所有WMS之间的通信,WMS通过一次对接奇门项目,可以适配所有ERP软件;后期我们也将加入更多系统的支持,例如CRM与ERP的标准化对接,CRM与在线订购类营销工具的标准化对接;敬请期待!

3.2

序号 1 2 3 4 5 6 7 名词解释

名词 奇门项目 OMS TMS WMS ERP 正向调用 反向调用 解释 阿里巴巴商家业务系统标准化对接平台 Order Management System 订单管理系统 Transportation Management System 物流管理系统 Warehouse Management System 仓库管理系统 ERP Enterprise Resource Planning 企业资源计划 由ERP发起调用到奇门,奇门处理后将请求转发至WMS端 由WMS发起调用到奇门,奇门处理后将请求转发至ERP端 13

奇门ISV接入白皮书

4 奇门对接方案

4.1

奇门对接方式

目前商家使用的各个业务系统之间依靠ISV帮助实现ERP到WMS的对接,如果有多仓需求的商家还需要使用到2套以上的第三方仓储服务所提供的WMS软件,ERP、WMS各自对接,对接的总工作量为N*N倍,不但给ISV的开发带来了极大的成本,对于后期维护,也将是一项艰巨的任务,如下图所示:

通过奇门项目后可使原有的网状对接结构变为一对一的对接方式,ERP、WMS只需要与奇门数据总线对接一次即可完成所有系统的适配(特殊场景可能采用扩展字段的方式给与支持),如下图:

14

奇门ISV接入白皮书

奇门项目后继接口升级方式将采用字段升级方式,在原有基础上加入更多的业务字段,同时业务接口向下兼容,开发过一次,后继如需更多的业务字段只需在原有接口层面加入业务字段即可,无需重新开发业务逻辑;

4.2 奇门标准化对接构架

前端ERP系统通过TOP平台与奇门应用进行对接,ERP系统通过标准化通信协议、字段访问奇门系统,ERP在此需要进行改造;

奇门应用主要提供字段映射、数据翻译、数据路由、账号权限、流控、数据打点等功能,能够让双方的请求通过奇门进行正常的传输,奇门还提供商家自定义扩展字段,通过奇门项目的通用数据通道进行传输,在标准协议不能完全支持的情况下,可以采用扩展字段的方式进行补充;

后端WMS系统通过TOP平台与奇门应用进行对接,WMS系统通过标准化通信协议、字段调用奇门系统,WMS在此也需要进行改造;

(可选)WMS系统需要提供出能够在系统中新建用户、查询用户的API,以供奇门项目应用调用,新商家接入时,奇门项目可以直接调用该API创建新的用户;

15

奇门ISV接入白皮书

4.3 系统调用流程

正向调用:前端ERP系统通过TOP接口与奇门项目应用进行交互,对于想要发送到WMS的请求首先发送到奇门应用,由奇门负责数据的解析、字段映射、数据翻译,再将处理后的数据通过ERP系统所请求的目的地发送至WMS系统;WMS系统收到请求后,将返回结果送回至奇门应用,由奇门应用统一返回至ERP系统;

反向调用:WMS系统主动向ERP系统发出状态更新请求也是类似以上的访问步骤; 以下是简版软件流程图:

ERP奇门WMS①正向发起业务请求HTTP②正向发起WMS业务请求HTTP正向流程④返回WMS响应结果③返回响应结果⑥反向发起ERP业务请求HTTP⑤反向发起业务请求HTTP反向流程⑦返回响应结果⑧返回ERP响应结果

4.4 联调、测试方式

奇门项目支持ERP系统的正向调用以及WMS系统的反向调用,所以对于ERP系统以及WMS系统的测试方法并不一致,以下分别介绍ERP系统以及WMS系统的联调、测试方法:

16

奇门ISV接入白皮书

4.4.1 ERP端

配置信息确认阶段:提前与WMS厂商进行沟通,根据商家的在WMS端的用户信息获取以下配置信息,并提供给奇门项目组,由奇门项目组完成在奇门当中的配置: 奇门标准字段 appkey customerid secretkey 字段含义 appkey 用户id 备注 由开放平台分配,对应ERP软件的编码 访问WMS系统的账号 测试环境配置值 用户密码 该账号访问WMS系统的密码 开发接口阶段:奇门项目当中ERP端支持正向调用也支持反向调用,正向调用的API接口由TOP平台提供,ERP端直接发起对沙箱环境的调用即可完成接口的测试工作,沙箱环境调用地址如下 (只需修改红色标示的method方法字段和test_type字段,test_type值可以取normal和error,normal会返回该请求成功的应答,error会返回该请求失败的应答) :

http://qimenapi.tbsandbox.com/top/router/qimen/service?method=taobao.qimen.itemlack.report×tamp=2015-04-26 00:00:07&format=xml&test_type=normal&app_key=testerp_appkey&v=1.0&sign=abc&sign_method=md5&customerId=stub-cust-code&uid=123456789

反向调用的API接口由ERP端提供,奇门会直接向ERP端发起调用,在此类型的API接口测试的过程当中,需要由服务商使用一个Http Restful接口的客户端向奇门发起反向调用;(推荐使用Chrome浏览器下的REST Console插件)

系统联调阶段:依次完成正向请求的开发与反向接口的工作后,与奇门项目组共同进行联调,在测试环境当中依次测试之前开发接口的业务逻辑;

系统发布阶段:与WMS端服务商共同确认正式环境的配置值,ERP端直接发起对奇门正式环境的调用,需要将原有访问地址与具体配置地址切换成正式环境地址。

4.4.2 WMS端

配置信息确认阶段:WMS厂商需提前提供商家的在WMS端的用户信息以及如下的配置信息,提供给奇门项目组以及ERP端进行配置:

17

奇门ISV接入白皮书

奇门标准字段 warehouseCode customerid 字段含义 仓库id 用户id 备注 仓储服务商分配给商家的仓库编码 访问WMS系统的账号 测试环境配置值 开发接口阶段:奇门项目当中WMS端支持正向调用也支持反向调用,反向调用的API接口由TOP平台提供,WMS端直接发起对沙箱环境的调用即可完成接口的测试工作,沙箱环境调用地址如下 (只需修改红色标示的method方法字段和test_type字段,test_type值可以取normal和error,normal会返回该请求成功的应答,error会返回该请求失败的应答) :

http://qimenapi.tbsandbox.com/router/qimen/service?method=taobao.qimen.itemlack.report×tamp=2015-04-26 00:00:07&format=xml&test_type=normal&app_key=【奇门沙箱Appkey】&v=1.0&sign=abc&sign_method=md5&customerId=【奇门分配】&uid=123456789

正向调用的API接口由WMS端提供,奇门会直接向WMS端发起调用,在此类型的API接口测试的过程当中,需要由服务商使用一个Http Restful接口的客户端向奇门发起正向调用;(推荐使用Chrome浏览器下的REST Console插件)

系统联调阶段:依次完成正向请求的开发与反向接口的工作后,与奇门项目组共同进行联调,在测试环境当中依次测试之前开发接口的业务逻辑;

系统发布阶段:WMS服务商与奇门共同确认正式环境的配置值,WMS端直接发起对奇门正式环境的调用,需要将原有访问地址与具体配置地址切换成正式环境地址。

18

奇门ISV接入白皮书

5 接口规范

5.1

ERP与奇门的通信协议

5.1.1 协议描述

接口遵循REST规范,使用HTTP POST方式进行通讯。 标准协议的HTTP入口地址为: ERP发给奇门:

http://qimen.api.taobao.com/router/qimen/service?method=[qimen_API]&session=[1000]×tamp=[2015-02-01 00:00:00]&format=xml&app_key=[erp_appkey]&v=1.0&sign=[xxxxxxxxxxxxxxxxxxxxxx]&sign_method=md5&customerId=[QIMENUSR1]

奇门发给ERP:

http://[erp_webservice_url]?method=[erp_API]×tamp=[2015-02-01 00:00:00]&format=xml&app_key=[wms_appkey]&v=1.0&sign=[xxxxxxxxxxxxxxxxxxxxxx]&sign_method=md5&customerId=[QIMENUSR1]

注: 1. 2. 3.

[]中需要根据具体业务进行填写。qimen_API,erp_API具体见下方的API名称。 URL需要做URL Encoding处理。 请求和响应的消息主体使用XML格式。 5.1.2 访问授权

需要商家提供TOP的sessionkey(session)以及该商家在对应wms系统的客户ID(customerID)和密钥(用于计算sign)。

19

奇门ISV接入白皮书

5.1.3 请求参数说明

请求参数包含URL中带的系统参数和BODY中带的相关业务参数,系统参数如下: 参数 session method timestamp format app_key v sign sign_method customerid 5.1.4 响应参数

响应参数包含系统参数和业务参数,系统参数如下: 参数 flag code message 参数说明 success|failure 返回状态码 返回状态描述 类型 string(50) string(50) string(200) 必须 必须 必须 约束 参数说明 session,TOP颁发给商家的 ERP相关的业务接口名称,如商品信息同步的请求,method= taobao.qimen.item.synchronize 时间戳,格式为yyyy-mm-dd HH:mm:ss content格式 应用接入时申请的appkey 协议版本号,1.0或者2.0 根据url和密钥计算的结果。具体算法参看附录1 参数加密方法,md5 WMS颁发给用户的ID 类型 string string 必须 string 必须 string string 目前支持XML ERP的appkey 约束 string 必须 string 必须 string 必须 5.2 奇门与WMS的通信协议

5.2.1 协议描述

接口遵循REST规范,使用HTTP POST方式进行通讯。 标准协议的HTTP入口地址为:

20

奇门ISV接入白皮书

奇门发给WMS:

http://[wms_webservice_url]?method=[wms_API]&format=xml&app_key=[erp _appkey]&v=1.0&sign=[xxxxxxxxxxxxxxxxxxxxxx]&sign_method=md5&customerId

=[QIMENUSR1]

WMS发给奇门:

http://qimen.api.taobao.com/router/qimen/service?method=[qimen_API]×tamp=[2015-02-01 00:00:00]&format=xml&app_key=[wms_appkey]&v=1.0&sign=[xxxxxxxxxxxxxxxxxxxxxx]&sign_method=md5&customerId=[QIMENUSR1]

注: 1.

[]中需要根据具体业务进行填写。qimen_API,wms_API具体见下方的API名称。 2. 3.

URL需要做URL Encoding处理。 请求和响应的消息主体使用XML格式。 5.2.2 请求参数

请求参数包含URL中带的系统参数和BODY中带的相关业务参数,以下是系统参数: 参数 method format 参数说明 WMS相关的业务接口名称,如商品信息同步的请求,method= item.synchronize content格式 类型 约束 string 必须 string 目前支持XML WMSapp_key v sign 应用接入时申请的appkey 协议版本号,1.0或者2.0 根据url和密钥计算的结果。具体算法参看附录1 21

string 的appkey string 必须 string 必须

奇门ISV接入白皮书

sign_method customerid 参数加密方法,md5 WMS颁发给用户的ID string 必须 5.2.3 响应参数

响应参数包含系统参数和业务参数。以下是系统参数: 参数 flag code message 参数说明 success|failure 返回状态码 返回状态描述 类型 string(50) string(50) string(200) 必须 必须 必须 约束 6 接口说明

注:所有非叶子节点下都可以增加remark和extendProps ? ?

remark

备注,string(500) extendProps使用key-value结构, 扩展属性 value1 value2

6.1 商品同步接口(iwms)

6.1.1 接口介绍

ERP调用的奇门API名称:taobao.qimen.singleitem.synchronize 奇门调用WMS的API名称:singleitem.synchronize

6.1.2 入参规范

22

奇门ISV接入白皮书

add|update, 必填

仓库编码, string (50),必填,统仓统配等无需ERP指定仓储编码的情况填OTHER

货主编码, string (50) , 必填 供应商编码, string (50) 供应商名称, string (200)

商品编码, string (50) , 必填

仓储系统商品编码, string (50) , 条件必填, 条件为商品同步接口, 出参itemId不为空

货号,string(50) 商品名称, string (200) , 必填 商品简称, string (200)

英文名, string (200)

条形码, string (500) , 可多个,用分号(;)隔开,必填 商品属性 (如红色, XXL) , string (200) 商品计量单位, string (50) 长 (厘米) , double (18, 2) 宽 (厘米) , double (18, 2) 高 (厘米) , double (18, 2) 体积 (升) , double (18, 3)

毛重 (千克) , double (18, 3) 净重 (千克) , double (18, 3) 颜色, string (50) 尺寸, string (50)

渠道中的商品标题, string (200) 商品类别ID, string (50)

商品类别名称, string (200) 计价货类, string (200) 安全库存, int

商品类型 (ZC=正常商品, FX=分销商品, ZH=组合商品, ZP=赠品, BC=包材, HC=耗材, FL=辅料, XN=虚拟品, FS=附属品, CC=残次品, OTHER=其它) , string (10) , 必填, (只传英文编码)

吊牌价, double (18, 2)

23

奇门ISV接入白皮书

零售价, double (18, 2) 成本价, double (18, 2)

采购价, double (18, 2) 季节编码, string (50) 季节名称, string (50) 品牌代码, string (50) 品牌名称, string (50)

是否需要串号管理, Y/N (默认为N) 生产日期, string (10) , YYYY-MM-DD 过期日期, string (10) , YYYY-MM-DD

是否需要保质期管理, Y/N (默认为N) 保质期 (小时) , int

保质期禁收天数, int 保质期禁售天数, int 保质期临期预警天数, int 是否需要批次管理, Y/N (默认为N) 批次代码, string (50) 批次备注, string (200) 包装代码, string (50) 箱规, string(50)

商品的原产地, string (50) 批准文号, string (50) 是否易碎品, Y/N, (默认为N) 是否危险品, Y/N, (默认为N) 备注, string (500)

创建时间, string (19) , YYYY-MM-DD HH:MM:SS 更新时间, string (19) , YYYY-MM-DD HH:MM:SS 是否有效, Y/N (默认为Y) 是否sku, Y/N, (默认为Y)

商品包装材料类型, string (200) 扩展属性 value1 value2

24

奇门ISV接入白皮书

6.1.3 出参规范

success|failure 响应码

响应信息

仓储系统商品Id, string (50) ,条件必填,当这个字段不为空的时候, 所有erp传输的时候都碰到itemid必传

6.2 商品同步接口 (批量)(iwms)

6.2.1 接口介绍

ERP调用的奇门API名称:taobao.qimen.items.synchronize 奇门调用WMS的API名称:items.synchronize

6.2.2 入参规范

add|update, 必填

仓库编码, string (50),必填 ,统仓统配等无需ERP指定仓储编码的情况填OTHER

货主编码, string (50) , 必填

供应商编码, string (50) 供应商名称, string (200) 商品编码, string (50) , 必填

仓储系统商品编码, string (50) , 条件必填, 条件为商品同步接口, 出参itemId不为空

25

奇门ISV接入白皮书

货号,string(50) 商品名称, string (200) , 必填 商品简称, string (200)

英文名, string (200)

条形码, string (500) , 可多个,用分号(;)隔开,必填 商品属性 (如红色, XXL) , string (200) 商品计量单位, string (50) 长 (厘米) , double (18, 2) 宽 (厘米) , double (18, 2) 高 (厘米) , double (18, 2) 体积 (升) , double (18, 3)

毛重 (千克) , double (18, 3) 净重 (千克) , double (18, 3) 颜色, string (50) 尺寸, string (50)

渠道中的商品标题, string (200) 商品类别ID, string (50)

商品类别名称, string (200) 计价货类, string (200) 安全库存, int

商品类型 (ZC=正常商品, FX=分销商品, ZH=组合商品, ZP=赠品, BC=包材, HC=耗材, FL=辅料, XN=虚拟品, FS=附属品, CC=残次品, OTHER=其它) , string (10) , 必填, (只传英文编码)

吊牌价, double (18, 2) 零售价, double (18, 2) 成本价, double (18, 2)

采购价, double (18, 2) 季节编码, string (50) 季节名称, string (50) 品牌代码, string (50) 品牌名称, string (50)

是否需要串号管理, Y/N (默认为N) 生产日期, string (10) , YYYY-MM-DD 过期日期, string (10) , YYYY-MM-DD

是否需要保质期管理, Y/N (默认为N)

26

奇门ISV接入白皮书

保质期 (小时) , int

保质期禁收天数, int 保质期禁售天数, int 保质期临期预警天数, int 是否需要批次管理, Y/N (默认为N) 批次代码, string (50) 批次备注, string (200) 包装代码, string (50) 箱规, string(50)

商品的原产地, string (50) 批准文号, string (50) 是否易碎品, Y/N, (默认为N) 是否危险品, Y/N, (默认为N) 备注, string (500)

创建时间, string (19) , YYYY-MM-DD HH:MM:SS 更新时间, string (19) , YYYY-MM-DD HH:MM:SS 是否有效, Y/N (默认为Y) 是否sku, Y/N, (默认为Y)

商品包装材料类型, string (200) 扩展属性 value1 value2

6.2.3 出参规范

success|failure,只要有一个失败flag就置为failure,如果是success,就忽略下面的items节点 响应码

响应信息

27

奇门ISV接入白皮书

没有同步成功的商品的编码,必填 出错信息

6.3 组合商品接口(iwms)

6.3.1 接口介绍

ERP调用的奇门API名称:taobao.qimen.combineitem.synchronize 奇门调用WMS的API名称:combineitem.synchronize

6.3.2 入参规范

组合商品的ERP编码, string (50) , 必填 货主编码, string (50) , 必填 仓库编码, string (50)

商品编码, string (50) , 必填 后端商品编码,string(50),必填 组合商品中的该商品个数,int,必填

6.3.3 出参规范

success|failure 响应码

28

奇门ISV接入白皮书

响应信息

6.4 入库单创建接口(iwms)

6.4.1 接口介绍

ERP调用的奇门API名称:taobao.qimen.entryorder.create 奇门调用WMS的API名称:entryorder.create

6.4.2 入参规范

单据总行数,int,当单据需要分多个请求发送时,发送方需要将totalOrderLines填入,接收方收到后,根据实际接收到的条数和totalOrderLines进行比对,如果小于,则继续等待接收请求。如果等于,则表示该单据的所有请求发送完成。

入库单号, string (50) , 必填 货主编码, string (50) , 必填

采购单号,string(50),当orderType=CGRK时,使用

仓库编码, string (50),必填 ,统仓统配等无需ERP指定仓储编码的情况填OTHER

订单创建时间, string (19) , YYYY-MM-DD HH:MM:SS

业务类型 (SCRK=生产入库,LYRK=领用入库,CCRK=残次品入库,CGRK=采购入库,DBRK=调拨入库, QTRK=其他入库,B2BRK=B2B入库, string (50) , (只传英文编码)

预期到货时间, string (19) , YYYY-MM-DD HH:MM:SS

最迟预期到货时间, string (19) , YYYY-MM-DD HH:MM:SS

29

奇门ISV接入白皮书

物流公司编码, string (50) , SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通 、ZTO=中通 (ZTO) 、HTKY=百世汇通、UC=优速、STO=申通、TTKDEX=天天快递 、QFKD=全峰、FAST=快捷、POSTB=邮政小包 、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、OTHER=其他(只传英文编码)

物流公司名称, string (200) 运单号, string (50) 供应商编码 string (50) 供应商名称 string (200) 操作员编码, string (50) 操作员名称, string (50)

操作时间, string (19) , YYYY-MM-DD HH:MM:SS

公司名称, string (200) 姓名, string (50) 邮编, string (50) 固定电话, string (50)

移动电话, string (50) 电子邮箱, string (50)

国家二字码,string(50) 省份, string (50) 城市, string (50) 区域, string (50) 村镇, string (50)

详细地址, string (200)

公司名称, string (200) 姓名, string (50) 邮编, string (50) 固定电话, string (50)

移动电话, string (50) 电子邮箱, string (50)

国家二字码,string(50) 省份, string (50)

30

奇门ISV接入白皮书

城市, string (50) 区域, string (50) 村镇, string (50)

详细地址, string (200)

备注, string (500) 扩展属性 value1 value2

外部业务编码, 消息ID, 用于去重,当单据需要分批次发送时使用

入库单的行号,string(50) 货主编码, string (50) , 必填 商品编码, string (50) , 必填 仓储系统商品ID,string(50),条件必填 商品名称, string (200) 应收商品数量, int, 必填 商品属性, string (200) 采购价, double (18, 2) 零售价, double (18, 2)

库存类型,string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱损,默认为ZP

商品生产日期 YYYY-MM-DD 商品过期日期YYYY-MM-DD 生产批号, string (50) 批次编码, string (50) 扩展属性 value1 value2

31

奇门ISV接入白皮书

6.4.3 出参规范

success|failure 响应码

响应信息

仓储系统入库单编码, string (50)

6.5 入库单确认接口

6.5.1 接口介绍

WMS调用的奇门API名称:taobao.qimen.entryorder.confirm 奇门调用ERP的API名称:entryorder.confirm

6.5.2 入参规范

单据总行数,int,当单据需要分多个请求发送时,发送方需要将totalOrderLines填入,接收方收到后,根据实际接收到的条数和totalOrderLines进行比对,如果小于,则继续等待接收请求。如果等于,则表示该单据的所有请求发送完成。

入库单编码, string (50) , 必填 货主编码, string (50)

仓库编码, string (50),必填 仓储系统入库单ID, string (50) , 条件必填

入库单类型,SCRK=生产入库,LYRK=领用入库,CCRK=残次品入库,CGRK=采购入库, DBRK=调拨入库, QTRK=其他入库,B2BRK=B2B入库

32

奇门ISV接入白皮书

外部业务编码, 消息ID, 用于去重, ISV对于同一请求,分配一个唯一性的编码。用来保证因为网络等原因导致重复传输,请求不会被重复处理, ,必填 支持出入库单多次收货, int, 多次收货后确认时

0 表示入库单最终状态确认; 1 表示入库单中间状态确认;

每次入库传入的数量为增量,特殊情况,同一入库单,如果先收到0,后又收到1,允许修改收货的数量。

入库单状态, string (50) , 必填 (NEW-未开始处理, ACCEPT-仓库接单 , PARTFULFILLED-部分收货完成, FULFILLED-收货完成, EXCEPTION-异常, CANCELED-取消, CLOSED-关闭, REJECT-拒单, CANCELEDFAIL-取消失败) , (只传英文编码)

操作时间, string (19) , YYYY-MM-DD HH:MM:SS,(当status=FULFILLED, operateTime为入库时间) 备注, string (500)

外部业务编码, 消息ID, 用于去重,当单据需要分批次发送时使用

单据行号,string(50) 货主编码, string (50) 商品编码, string (50) , 必填 仓储系统商品ID, string (50) , 条件必填

商品名称, string (200)

库存类型,string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱损,默认为ZP, (收到商品总数=正品数+残品数+机损数+箱损数)

应收数量, int 实收数量, int,必填 批次编码, string (50)

商品生产日期,string(10), YYYY-MM-DD 商品过期日期,string(10),YYYY-MM-DD

生产批号, string (50)

33

奇门ISV接入白皮书

批次编号,string(50)

生产日期,string(10),YYYY-MM-DD 过期日期,string(10),YYYY-MM-DD 生产批号,string(50),

库存类型,string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱损,默认为ZP, (收到商品总数=正品数+残品数+机损数+箱损数)

实收数量, int,要求batchs节点下所有的实收数量之和等于orderline中的实收数量

备注, string (500)

6.5.3 出参规范

success|failure 响应码

响应信息

6.6 入库单查询接口(iwms)

6.6.1 接口介绍

ERP调用的奇门API名称:taobao.qimen.entryorder.query 奇门调用WMS的API名称:entryorder.query

6.6.2 入参规范

34

奇门ISV接入白皮书

货主编码, string (50) 仓库编码, string (50)

入库单编码, string (50) , 必填 仓储系统入库单ID, string (50) , 条件必填 当前页,从1开始,必填

每页orderLine条数(最多100条),必填

6.6.3 出参规范

success|failure 响应码

响应信息

orderLines总条数,int,必填

入库单编码, string (50) , 必填 货主编码, string (50)

仓库编码, string (50),必填 仓储系统入库单ID, string (50) , 条件必填

入库单类型 ,SCRK=生产入库,LYRK=领用入库,CCRK=残次品入库,CGRK=采购入库, DBRK=调拨入库, QTRK=其他入库,B2BRK=B2B入库

入库单状态, string (50) , 必填 (NEW-未开始处理, ACCEPT-仓库接单 , PARTFULFILLED-部分收货完成, FULFILLED-收货完成, EXCEPTION-异常, CANCELED-取消, CLOSED-关闭, REJECT-拒单, CANCELEDFAIL-取消失败) , (只传英文编码)

操作时间, string (19) , YYYY-MM-DD HH:MM:SS,(当status=FULFILLED, operateTime为入库时间)

单据行号,string(50) 商品编码, string (50) , 必填 仓储系统商品ID, string (50) , 条件必填

35

奇门ISV接入白皮书

商品名称, string (200)

库存类型,string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱损,默认为ZP, (收到商品总数=正品数+残品数+机损数+箱损数)

应收数量, int 实收数量, int,必填 批次编码, string (50)

商品生产日期,string(10), YYYY-MM-DD 商品过期日期,string(10),YYYY-MM-DD 生产批号, string (50) 备注, string (500)

6.7 退货入库单创建接口(iwms)

6.7.1 接口介绍

ERP调用的奇门API名称:taobao.qimen.returnorder.create 奇门调用WMS的API名称:returnorder.create

6.7.2 入参规范

ERP的退货入库单编码, string (50) , 必填 仓库编码, string (50),必填 ,统仓统配等无需ERP指定仓储编码的情况填OTHER

单据类型, string (50),THRK=退货入库,HHRK=换货入库 (只传英文编码)

用字符串格式来表示订单标记列表:比如VISIT^

SELLER_AFFORD^SYNC_RETURN_BILL 等, 中间用“^”来隔开 订单标记list (所有字母

36

奇门ISV接入白皮书

全部大写) : VISIT=上门;SELLER_AFFORD=是否卖家承担运费 (默认是) ;SYNC_RETURN_BILL=同时退回发票;

原出库单号(ERP分配), string(50) ,必填

原出库单号(WMS分配), string (50),条件必填

物流公司编码, string (50) , SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通 、ZTO=中通 (ZTO) 、HTKY=百世汇通、UC=优速、STO=申通、TTKDEX=天天快递 、QFKD=全峰、FAST=快捷、POSTB=邮政小包 、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、OTHER=其他,必填, (只传英文编码)

物流公司名称, string (200) 运单号, string (50) 退货原因, string (200) 买家昵称, string (50)

公司名称, string (200) 姓名, string (50) , 必填 邮编, string (50) 固定电话, string (50)

移动电话, string (50) , 必填 电子邮箱, string (50)

国家二字码,string(50) 省份, string (50) , 必填 城市, string (50) , 必填 区域, string (50) 村镇, string (50)

详细地址, string (200) , 必填

备注, string (500)

单据行号,string(50)

交易平台订单, string (50)

37

奇门ISV接入白皮书

交易平台子订单编码, string (50) 货主编码, string (50) , 必填 商品编码, string (50) , 必填

仓储系统商品编码, string (50) , 条件必填,条件为提供后端(仓储系统)商品编码的仓储系统

库存类型, string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱损, 默认为ZP,

应收商品数量, int, 必填 批次编码, string (50)

生产日期, string (10) , YYYY-MM-DD 过期日期, string (10) , YYYY-MM-DD

生产批号, string (50)

6.7.3 出参规范

success|failure 响应码

响应信息

仓储系统退货单编码, string (50)

6.8 退货入库单确认接口

6.8.1 接口介绍

WMS调用的奇门API名称:taobao.qimen.returnorder.confirm 奇门调用ERP的API名称:returnorder.confirm

6.8.2 入参规范

38

奇门ISV接入白皮书

退货单编码, string (50) , 必填 仓库系统订单编码, string (50) ,条件必填 仓库编码, string (50),必填

外部业务编码, 消息ID, 用于去重, ISV对于同一请求,分配一个唯一性的编码。用来保证因为网络等原因导致重复传输,请求不会被重复处理 单据类型, string(50),THRK=退货入库单,HHRK=换货入库

确认入库时间, string (19) ,YYYY-MM-DD HH:MM:SS

退货原因, string (200)

物流公司编码, string (50) , SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通 、ZTO=中通 (ZTO) 、HTKY=百世汇通、UC=优速、STO=申通、TTKDEX=天天快递 、QFKD=全峰、FAST=快捷、POSTB=邮政小包 、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、OTHER=其他, (只传英文编码)

物流公司名称, string (200) 运单号, string (50)

公司名称, string (200) 姓名, string (50) , 必填 邮编, string (50) 固定电话, string (50)

移动电话, string (50) , 必填 电子邮箱, string (50)

国家二字码,string(50) 省份, string (50) , 必填 城市, string (50) , 必填 区域, string (50) 村镇, string (50)

详细地址, string (200) , 必填

备注, string (500)

39

奇门ISV接入白皮书

单据行号,string(50)

交易平台订单, string (50)

交易平台子订单编码, string (50) 商品编码, string (50) , 必填

仓储系统商品编码, string (50) , 条件必填 (条件为菜鸟仓)

库存类型, string (50) , ZP=正品, CC=残次, JS=机损, XS=箱损, 默认为ZP

应收商品数量, int 实收商品数量, int, 必填 批次编码, string (50)

生产日期, string (10) , YYYY-MM-DD 过期日期, string (10) , YYYY-MM-DD

生产批号, string (50)

批次编号,string(50)

生产日期,string(10),YYYY-MM-DD 过期日期,string(10),YYYY-MM-DD 生产批号,string(50),

库存类型, string (50) , ZP=正品, CC=残次, JS=机损, XS=箱损, 默认为ZP

实收数量, int,要求batchs节点下所有的实收数量之和等于orderline中的实收数量

商品的二维码(类似电子产品的SN码),用来进行商品的溯源,多个二维码之间用分号(;)隔开

6.8.3 出参规范

40

奇门ISV接入白皮书

success|failure 响应码

响应信息

6.9 退货入库单查询接口(iwms)

6.9.1 接口介绍

ERP调用的奇门API名称:taobao.qimen.returnorder.query 奇门调用WMS的API名称:returnorder.query

6.9.2 入参规范

货主编码, string (50) 仓库编码, string (50)

退货单编码, string (50) , 必填 仓库系统订单编码, string (50) ,条件必填 当前页,从1开始,必填

每页orderLine条数(最多100条),必填

6.9.3 出参规范

success|failure 响应码

响应信息

orderLines总条数,int,必填

退货单编码, string (50) , 必填 仓库系统订单编码, string (50) ,条件必填

41

奇门ISV接入白皮书

仓库编码, string (50),必填 单据类型, string(50),THRK=退货入库单,HHRK=换货入库

确认入库时间, string (19) ,YYYY-MM-DD HH:MM:SS

退货原因, string (200)

物流公司编码, string (50) , SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通 、ZTO=中通 (ZTO) 、HTKY=百世汇通、UC=优速、STO=申通、TTKDEX=天天快递 、QFKD=全峰、FAST=快捷、POSTB=邮政小包 、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、OTHER=其他, (只传英文编码)

物流公司名称, string (200) 运单号, string (50)

公司名称, string (200) 姓名, string (50) , 必填 邮编, string (50) 固定电话, string (50)

移动电话, string (50) , 必填 电子邮箱, string (50)

国家二字码,string(50) 省份, string (50) , 必填 城市, string (50) , 必填 区域, string (50) 村镇, string (50)

详细地址, string (200) , 必填

备注, string (500)

单据行号,string(50)

交易平台订单, string (50)

交易平台子订单编码, string (50) 商品编码, string (50) , 必填

42

奇门ISV接入白皮书

仓储系统商品编码, string (50) , 条件必填 (条件为菜鸟仓)

库存类型, string (50) , ZP=正品, CC=残次, JS=机损, XS=箱损, 默认为ZP

应收商品数量, int 实收商品数量, int, 必填 批次编码, string (50)

生产日期, string (10) , YYYY-MM-DD 过期日期, string (10) , YYYY-MM-DD

生产批号, string (50)

商品的二维码(类似电子产品的SN码),用来进行商品的溯源,多个二维码之间用分号(;)隔开

6.10 出库单创建接口(iwms)

6.10.1 接口介绍

ERP调用的奇门API名称:taobao.qimen.stockout.create 奇门调用WMS的API名称:stockout.create

6.10.2 入参规范

单据总行数,int,当单据需要分多个请求发送时,发送方需要将totalOrderLines填入,接收方收到后,根据实际接收到的条数和totalOrderLines进行比对,如果小于,则继续等待接收请求。如果等于,则表示该单据的所有请求发送完成。

出库单号(ERP分配), string (50) , 必填

43

奇门ISV接入白皮书

出库单类型, string (50) , 必填,PTCK=普通出库单,DBCK=调拨出库 ,B2BCK=B2B出库,QTCK=其他出库,CGTH=采购退货出库单

仓库编码, string (50),必填 ,统仓统配等无需ERP指定仓储编码的情况填OTHER

出库单创建时间, string (19) , YYYY-MM-DD HH:MM:SS, 必填

要求出库时间, string (10) , YYYY-MM-DD 物流公司编码, string (50) , SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通 、ZTO=中通 (ZTO) 、HTKY=百世汇通、UC=优速、STO=申通、TTKDEX=天天快递 、QFKD=全峰、FAST=快捷、POSTB=邮政小包 、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、OTHER=其他,(只传英文编码)

物流公司名称(包括干线物流公司等), string (200) 提货方式(到仓自提,快递,干线物流)

公司名称, string (200) 姓名, string (50) 固定电话, string (50)

移动电话, string (50)

证件号,string(50) 车牌号,string(50)

公司名称, string (200) 姓名, string (50) , 邮编, string (50) 固定电话, string (50)

移动电话, string (50) , 电子邮箱, string (50)

国家二字码,string(50) 省份, string (50) , 城市, string (50) , 区域, string (50) 村镇, string (50)

详细地址, string (200)

44

奇门ISV接入白皮书

证件号,string(50)

公司名称, string (200)

姓名(注:当出库为调拨出库时,这里填写为目标仓库编码), string (50) , 必填

邮编, string (50) 固定电话, string (50)

移动电话, string (50) , 必填 电子邮箱, string (50)

国家二字码,string(50) 省份, string (50) , 必填 城市, string (50) , 必填 区域, string (50) 村镇, string (50)

详细地址, string (200) , 必填 证件号,string(50)

备注, string (500)

外部业务编码, 消息ID, 用于去重,当单据需要分批次发送时使用

单据行号,string(50) 货主编码, string (50) , 必填 商品编码, string (50) , 必填 仓储系统商品编码, string (50) ,条件必填 商品名称, string (200)

库存类型,string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱损,默认为ZP

应发商品数量, int, 必填 批次编码, string (50)

商品生产日期 YYYY-MM-DD 商品过期日期YYYY-MM-DD

45

奇门ISV接入白皮书

生产批号, string (50)

6.10.3 出参规范

success|failure 响应码

响应信息

出库单仓储系统编码, string (50)

订单创建时间, string (19) , YYYY-MM-DD HH:MM:SS

6.11 出库单确认接口

6.11.1 接口介绍

WMS调用的奇门API名称:taobao.qimen.stockout.confirm 奇门调用ERP 的API名称:stockout.confirm

6.11.2 入参规范

单据总行数,int,当单据需要分多个请求发送时,发送方需要将totalOrderLines填入,接收方收到后,根据实际接收到的条数和totalOrderLines进行比对,如果小于,则继续等待接收请求。如果等于,则表示该单据的所有请求发送完成。

出库单号, string (50) , 必填 仓储系统出库单号, string (50) ,条件必填 仓库编码, string (50),必填

46

奇门ISV接入白皮书

出库单类型, string (50),PTCK=普通出库单,DBCK=调拨出库 ,B2BCK=B2B出库,QTCK=其他出库,,CGTH=采购退货出库单,必填 出库单状态, string (50) (NEW-未开始处理, ACCEPT-仓库接单 , PARTDELIVERED-部分发货完成, DELIVERED-发货完成, EXCEPTION-异常,

CANCELED-取消, CLOSED-关闭, REJECT-拒单, CANCELEDFAIL-取消失败) , (只传英文编码)

string (50) , 外部业务编码, 外部业务编码, 同一请求的唯一性标示编码。ISV对于同一请求,分配一个唯一性的编码。用来保证因为网络等原因导致重复传输,请求不会被重复处理,条件必填,条件为一单需要多次确认时 支持出库单多次发货, int, 多次发货后确认时

0 表示发货单最终状态确认; 1 表示发货单中间状态确认;

物流公司编码, string (50) , SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通 、ZTO=中通 (ZTO) 、HTKY=百世汇通、UC=优速、STO=申通、TTKDEX=天天快递 、QFKD=全峰、FAST=快捷、POSTB=邮政小包 、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、OTHER=其他,(只传英文编码)

物流公司名称, string (200) 运单号, string (50)

订单完成时间, string (19) , YYYY-MM-DD HH:MM:SS

物流公司名称, string (200) 运单号, string (50) 包裹编号, string (50) 包裹长度 (厘米) , double (18, 2) 包裹宽度 (厘米) , double (18, 2) 包裹高度 (厘米) , double (18, 2) 包裹重量 (千克) , double (18, 3) 包裹体积 (升, L) , double (18, 3)

47

奇门ISV接入白皮书

包材型号, string (50) 包材的数量, int

商品编码, string (50) , 必填 商品仓储系统编码, string (50) 包裹内该商品的数量, int, 必填

外部业务编码, 消息ID, 用于去重,当单据需要分批次发送时使用

单据行号,string(50) 商品编码, string (50) ,必填 商品仓储系统编码, string (50) 商品名称, string (200)

库存类型,string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱损,默认为ZP

实发商品数量, int,必填 批次编号,string(50),

生产日期,string(10),YYYY-MM-DD 过期日期,string(10),YYYY-MM-DD 生产批号,string(50),

批次编号,string(50)

生产日期,string(10),YYYY-MM-DD 过期日期,string(10),YYYY-MM-DD 生产批号,string(50),

48

奇门ISV接入白皮书

库存类型,string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱损,默认为ZP

实发数量, int,要求batchs节点下所有的实发数量之和等于orderline中的实发数量

6.11.3 出参规范

success|failure 响应码

响应信息

6.12 出库单查询接口(iwms)

6.12.1 接口介绍

ERP调用的奇门API名称:taobao.qimen.stockout.query 奇门调用WMS的API名称:stockout.query

6.12.2 入参规范

货主编码, string (50) 仓库编码, string (50)

出库单号, string (50) , 必填 仓储系统出库单号, string (50) ,条件必填 当前页,从1开始,必填

每页orderLine条数(最多100条),必填

49

奇门ISV接入白皮书

6.12.3 出参规范

success|failure 响应码

响应信息

orderLines总条数,int,必填

出库单号, string (50) , 必填 仓储系统出库单号, string (50) ,条件必填 仓库编码, string (50),必填

出库单类型, string (50),PTCK=普通出库单,DBCK=调拨出库 ,B2BCK=B2B出库,QTCK=其他出库,CGTH=采购退货出库单,必填 出库单状态, string (50) , 必填 (NEW-未开始处理, ACCEPT-仓库接单 , PARTDELIVERED-部分发货完成, DELIVERED-发货完成, EXCEPTION-异常,

CANCELED-取消, CLOSED-关闭, REJECT-拒单, CANCELEDFAIL-取消失败) , (只传英文编码)

物流公司编码, string (50) , SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通 、ZTO=中通 (ZTO) 、HTKY=百世汇通、UC=优速、STO=申通、TTKDEX=天天快递 、QFKD=全峰、FAST=快捷、POSTB=邮政小包 、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、OTHER=其他,(只传英文编码)

物流公司名称, string (200) 运单号, string (50)

订单完成时间, string (19) , YYYY-MM-DD HH:MM:SS

物流公司名称, string (200) 运单号, string (50) 包裹编号, string (50) 包裹长度 (厘米) , double (18, 2)

50

本文来源:https://www.bwwdw.com/article/jax5.html

Top