奇门白皮书V22Word文档下载推荐.docx
- 文档编号:22382145
- 上传时间:2023-02-03
- 格式:DOCX
- 页数:72
- 大小:346.78KB
奇门白皮书V22Word文档下载推荐.docx
《奇门白皮书V22Word文档下载推荐.docx》由会员分享,可在线阅读,更多相关《奇门白皮书V22Word文档下载推荐.docx(72页珍藏版)》请在冰豆网上搜索。
5、退货入库单创建接口orderLine节点中增加ownerCode字段;
入库单创建接口中ownerCode移到orderLine节点中
2015.5.20
1、取消订单,订单类型变为非必填
2、发货单创建,付款时间变为非必填
3、所有地址中的区域改为非必填
4、退货入库单确认接口,物流公司编码改为非必填
2015.6.5
2.2
1、增加“出库单创建”,“出库单确认”接口
2015.6.10
1、“出库单创建”增加货主编码字段
2、增加“订单状态查询”和“库存查询”两个接口
3、规范“冻结库存”的使用范围
2015.6.11
1、增加“组合商品接口”
2、入库单的收件人,发件人,物流公司信息为非必填
3、新增入库单类型:
生产入库、领用入库、残次品入库。
4、入库单新增字段,采购单号
5、盘点单新增字段,盘点时间
6、新增“库存异动接口”
7、“订单状态查询”不仅查当前状态,历史状态也可以
8、“普通出库单”增加发件人信息
2015.6.12
1、“组合商品创建接口”和“订单流水查询接口“,去掉warehouseCode编码
2、“订单流水查询接口”和“库存查询接口”response增加的flag,code,message这三个标准的应答。
2015.6.25
1、增加发货单查询接口
2目录
1版本记录2
2目录4
3前言9
3.1业务背景9
3.2名词解释9
4奇门对接方案10
4.1奇门对接方式10
4.2奇门标准化对接构架11
4.3系统调用流程12
4.4联调、测试方式12
4.4.1ERP端13
4.4.2WMS端14
5接口规范15
5.1ERP与奇门的通信协议15
5.1.1协议描述15
5.1.2访问授权15
5.1.3请求参数说明16
5.1.4响应参数16
5.2奇门与WMS的通信协议16
5.2.1协议描述16
5.2.2请求参数17
5.2.3响应参数18
6接口说明18
6.1商品同步接口18
6.1.1接口介绍18
6.1.2入参规范18
6.1.3出参规范20
6.2商品组合接口21
6.2.1接口介绍21
6.2.2入参规范21
6.2.3出参规范21
6.3入库单创建接口21
6.3.1接口介绍21
6.3.2入参规范22
6.3.3出参规范24
6.4入库单确认接口24
6.4.1接口介绍24
6.4.2入参规范25
6.4.3出参规范26
6.5退货入库单创建接口26
6.5.1接口介绍26
6.5.2入参规范26
6.5.3出参规范28
6.6退货入库单确认接口28
6.6.1接口介绍28
6.6.2入参规范28
6.6.3出参规范30
6.7出库单创建接口30
6.7.1接口介绍30
6.7.2入参规范30
6.7.3出参规范32
6.8出库单确认接口33
6.8.1接口介绍33
6.8.2入参规范33
6.8.3出参规范35
6.9发货单创建接口35
6.9.1接口介绍35
6.9.2入参规范35
6.9.3出参规范39
6.10发货单确认接口39
6.10.1接口介绍39
6.10.2入参规范39
6.10.3出参规范42
6.11发货单查询接口42
6.11.1接口介绍42
6.11.2入参规范42
6.11.3出参规范42
6.12订单流水查询接口45
6.12.1接口介绍45
6.12.2入参规范45
6.12.3出参规范45
6.13订单流水通知接口46
6.13.1接口介绍46
6.13.2入参规范47
6.13.3出参规范47
6.14发货单缺货通知接口48
6.14.1接口介绍48
6.14.2入参规范48
6.14.3出参规范49
6.15单据取消接口49
6.15.1接口介绍49
6.15.2入参规范49
6.15.3出参规范49
6.16库存查询接口50
6.16.1接口介绍50
6.16.2入参规范50
6.16.3出参规范50
6.17库存盘点通知接口51
6.17.1接口介绍51
6.17.2入参规范51
6.17.3出参规范52
6.18仓内加工单创建接口53
6.18.1接口介绍53
6.18.2入参规范53
6.18.3出参规范54
6.19仓内加工单确认接口54
6.19.1接口介绍54
6.19.2入参规范55
6.19.3出参规范56
6.20库存异动接口56
6.20.1接口介绍56
6.20.2入参规范56
6.20.3出参规范57
7附录58
7.1sign签名算法:
58
7.1.1输入参数为58
7.1.2按首字母升序排列58
7.1.3连接字符串59
7.1.4生成签名sign59
7.1.5拼装URL请求59
3前言
业务背景
随着电子商务发展,商家所使用到的各类软件越来越多,各个软件之间没有相互打通,形成一个个信息孤岛,给商家的使用带来种种不便,商家要求各个系统之间的对接需求已经越来越迫切;
目前在行业内已经有部分系统直接由服务商之间完成了系统软件的对接,但是由于没有统一的接入标准,导致接入较混乱,对接接口的版本也参差不齐,往往这样的系统对接不具有可复制性,多个系统之间的对接,需要多次开发,给商家的使用和功能迭代升级带来了诸多的不便,同时也给服务商带来额外的维护、开发成本;
为了满足商家需求,让商家能够突破各个业务系统之间的信息孤岛,提升商家在各个系统之间的操作效率,解决各个系统之间标准化对接的痛点,我们推出了奇门项目;
奇门项目一期支持ERP、WMS之间的系统标准化对接,通过构建ERP、WMS系统之间标准通信协议来实现不同系统之间的打通;
对商家来说,省去了更换系统软件所带来的额外开发成本;
对ISV来说,省去了与多家ERP、WMS系统对接难的问题,ERP通过一次对接奇门项目,打通与所有WMS之间的通信,WMS通过一次对接奇门项目,可以适配所有ERP软件;
后期我们也将加入更多系统的支持,例如CRM与ERP的标准化对接,CRM与在线订购类营销工具的标准化对接;
敬请期待!
名词解释
序号
名词
解释
1
奇门项目
阿里巴巴商家业务系统标准化对接平台
2
OMS
OrderManagementSystem订单管理系统
3
TMS
TransportationManagementSystem物流管理系统
4
WMS
WarehouseManagementSystem仓库管理系统
5
ERP
ERP
EnterpriseResourcePlanning企业资源计划
6
正向调用
由ERP发起调用到奇门,奇门处理后将请求转发至WMS端
7
反向调用
由WMS发起调用到奇门,奇门处理后将请求转发至ERP端
4奇门对接方案
奇门对接方式
目前商家使用的各个业务系统之间依靠ISV帮助实现ERP到WMS的对接,如果有多仓需求的商家还需要使用到2套以上的第三方仓储服务所提供的WMS软件,ERP、WMS各自对接,对接的总工作量为N*N倍,不但给ISV的开发带来了极大的成本,对于后期维护,也将是一项艰巨的任务,如下图所示:
通过奇门项目后可使原有的网状对接结构变为一对一的对接方式,ERP、WMS只需要与奇门数据总线对接一次即可完成所有系统的适配(特殊场景可能采用扩展字段的方式给与支持),如下图:
奇门项目后继接口升级方式将采用字段升级方式,在原有基础上加入更多的业务字段,同时业务接口向下兼容,开发过一次,后继如需更多的业务字段只需在原有接口层面加入业务字段即可,无需重新开发业务逻辑;
奇门标准化对接构架
前端ERP系统通过TOP平台与奇门应用进行对接,ERP系统通过标准化通信协议、字段访问奇门系统,ERP在此需要进行改造;
奇门应用主要提供字段映射、数据翻译、数据路由、账号权限、流控、数据打点等功能,能够让双方的请求通过奇门进行正常的传输,奇门还提供商家自定义扩展字段,通过奇门项目的通用数据通道进行传输,在标准协议不能完全支持的情况下,可以采用扩展字段的方式进行补充;
后端WMS系统通过TOP平台与奇门应用进行对接,WMS系统通过标准化通信协议、字段调用奇门系统,WMS在此也需要进行改造;
(可选)WMS系统需要提供出能够在系统中新建用户、查询用户的API,以供奇门项目应用调用,新商家接入时,奇门项目可以直接调用该API创建新的用户;
系统调用流程
正向调用:
前端ERP系统通过TOP接口与奇门项目应用进行交互,对于想要发送到WMS的请求首先发送到奇门应用,由奇门负责数据的解析、字段映射、数据翻译,再将处理后的数据通过ERP系统所请求的目的地发送至WMS系统;
WMS系统收到请求后,将返回结果送回至奇门应用,由奇门应用统一返回至ERP系统;
反向调用:
WMS系统主动向ERP系统发出状态更新请求也是类似以上的访问步骤;
以下是简版软件流程图:
联调、测试方式
奇门项目支持ERP系统的正向调用以及WMS系统的反向调用,所以对于ERP系统以及WMS系统的测试方法并不一致,以下分别介绍ERP系统以及WMS系统的联调、测试方法:
4.1.1ERP端
配置信息确认阶段:
提前与WMS厂商进行沟通,根据商家的在WMS端的用户信息获取以下配置信息,并提供给奇门项目组,由奇门项目组完成在奇门当中的配置:
奇门标准字段
字段含义
备注
测试环境配置值
appkey
由开放平台分配,对应ERP软件的编码
customerid
用户id
访问WMS系统的账号
secretkey
用户密码
该账号访问WMS系统的密码
开发接口阶段:
奇门项目当中ERP端支持正向调用也支持反向调用,正向调用的API接口由TOP平台提供,ERP端直接发起对沙箱环境的调用即可完成接口的测试工作,沙箱环境调用地址如下(只需修改红色标示的method方法字段和test_type字段,test_type值可以取normal和error,normal会返回该请求成功的应答,error会返回该请求失败的应答):
反向调用的API接口由ERP端提供,奇门会直接向ERP端发起调用,在此类型的API接口测试的过程当中,需要由服务商使用一个HttpRestful接口的客户端向奇门发起反向调用;
(推荐使用Chrome浏览器下的RESTConsole插件)
系统联调阶段:
依次完成正向请求的开发与反向接口的工作后,与奇门项目组共同进行联调,在测试环境当中依次测试之前开发接口的业务逻辑;
系统发布阶段:
与WMS端服务商共同确认正式环境的配置值,ERP端直接发起对奇门正式环境的调用,需要将原有访问地址与具体配置地址切换成正式环境地址,奇门项目正式环境地址如下:
4.1.2WMS端
WMS厂商需提前提供商家的在WMS端的用户信息以及如下的配置信息,提供给奇门项目组以及ERP端进行配置:
warehouseCode
仓库id
仓储服务商分配给商家的仓库编码
奇门项目当中WMS端支持正向调用也支持反向调用,反向调用的API接口由TOP平台提供,WMS端直接发起对沙箱环境的调用即可完成接口的测试工作,沙箱环境调用地址如下(只需修改红色标示的method方法字段和test_type字段,test_type值可以取normal和error,normal会返回该请求成功的应答,error会返回该请求失败的应答):
正向调用的API接口由WMS端提供,奇门会直接向WMS端发起调用,在此类型的API接口测试的过程当中,需要由服务商使用一个HttpRestful接口的客户端向奇门发起正向调用;
WMS服务商与奇门共同确认正式环境的配置值,WMS端直接发起对奇门正式环境的调用,需要将原有访问地址与具体配置地址切换成正式环境地址,奇门项目正式环境地址如下:
5接口规范
ERP与奇门的通信协议
5.1.1协议描述
接口遵循REST规范,使用HTTPPOST方式进行通讯。
标准协议的HTTP入口地址为:
ERP发给奇门:
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]&
timestamp=[2015-02-0100:
app_key=[wms_appkey]&
注:
1.[]中需要根据具体业务进行填写。
qimen_API,erp_API具体见下方的API名称。
2.URL需要做URLEncoding处理。
3.请求和响应的消息主体使用XML格式。
5.1.2访问授权
需要商家提供TOP的sessionkey(session)以及该商家在对应wms系统的客户ID(customerID)和密钥(用于计算sign)。
5.1.3请求参数说明
请求参数包含URL中带的系统参数和BODY中带的相关业务参数,系统参数如下:
参数
参数说明
类型
约束
session
session,TOP颁发给商家的
string
method
ERP相关的业务接口名称,如商品信息同步的请求,method=taobao.qimen.item.synchronize
必须
timestamp
时间戳,格式为yyyy-mm-ddHH:
mm:
ss
format
content格式
目前支持XML
app_key
应用接入时申请的appkey
ERP的appkey
v
协议版本号,1.0或者2.0
sign
根据url和密钥计算的结果。
具体算法参看附录1
sign_method
参数加密方法,md5
WMS颁发给用户的ID
5.1.4响应参数
响应参数包含系统参数和业务参数,系统参数如下:
flag
success|failure
string(50)
code
返回状态码
message
返回状态描述
string(200)
奇门与WMS的通信协议
5.1.5协议描述
奇门发给WMS:
//[wms_webservice_url]?
method=[wms_API]&
app_key=[erp_appkey]&
WMS发给奇门:
qimen_API,wms_API具体见下方的API名称。
5.1.6请求参数
请求参数包含URL中带的系统参数和BODY中带的相关业务参数,以下是系统参数:
WMS相关的业务接口名称,如商品信息同步的请求,method=item.synchronize
WMS的appkey
5.1.7响应参数
响应参数包含系统参数和业务参数。
以下是系统参数:
6接口说明
商品同步接口
6.1.1接口介绍
ERP调用的奇门API名称:
taobao.qimen.singleitem.synchronize
奇门调用WMS的API名称:
singleitem.synchronize
6.1.2入参规范
<
?
xmlversion="
1.0"
encoding="
utf-8"
>
request>
actionType>
add|update,必填<
/actionType>
warehouseCode>
仓库编码,string(50)<
/warehouseCode>
ownerCode>
货主编码,string(50),必填<
/ownerCode>
supplierCode>
供应商编码,string(50)<
/supplierCode>
supplierName>
供应商名称,string(200)<
/supplierName>
item>
itemCode>
商品编码,string(50),必填<
/itemCode>
itemId>
仓储系统商品编码,string(50),条件必填,条件为商品同步接口,出参itemId不为空<
/itemId>
itemName>
商品名称,string(200),必填<
/itemName>
shortName>
商品简称,string(200)<
/shortName>
englishName>
英文名,string(200)<
/englishName>
barCode>
条形码,string(50),必填<
/barCode>
skuProperty>
商品属性(如红色,XXL),string(200)<
/skuProperty>
stockUnit>
商品计量单位,string(50)<
/stockUnit>
length>
长(厘米),
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 奇门 白皮书 V22