中国邮政国内小包综合服务平台订单接口规范v100.docx
《中国邮政国内小包综合服务平台订单接口规范v100.docx》由会员分享,可在线阅读,更多相关《中国邮政国内小包综合服务平台订单接口规范v100.docx(20页珍藏版)》请在冰豆网上搜索。
![中国邮政国内小包综合服务平台订单接口规范v100.docx](https://file1.bdocx.com/fileroot1/2022-10/11/144b3fc0-ebf4-47c3-bc90-a5cb32cbb607/144b3fc0-ebf4-47c3-bc90-a5cb32cbb6071.gif)
中国邮政国内小包综合服务平台订单接口规范v100
文件类别:
技术规范密级:
协议发布
中国邮政国内小包综合服务平台(订单系统)
上游客户系统标准接口规范
版本号:
V1.0.0
文档编号:
YT-NPP-API-01
编制单位:
国内小包项目组
编制人:
黄春凤
编制日期:
2014年3月2日
审核人:
徐黎春
审核日期:
2014年3月3日
批准人:
李传波
批准日期:
2014年5月8日
©Copyright2001-2014,HLJPostYiTongInfo-netCo.,Ltd.
网址:
电话:
086-4
地址:
中国·哈尔滨市南岗区西大直街133号传真:
086-1
变更历史
日期
变更描述
变更者
2014-3-2
新建
黄春凤
2015-11-17
增加重量字段
1概述
1.1文档目的
本文档主要规范中国邮政国内小包综合服务平台与上游客户(如电商客户)系统的数据接口。
1.2技术支持
本接口开发由黑龙江邮政易通信息网络有限责任公司提供支持,如有疑问请联系易通公司。
3参数、安全及数据完整性
2.1参数定义
2.1.1上游客户系统发送给中国邮政的参数
参数名称
用途
logistics_interface
消息内容
data_digest
消息签名
msg_type
消息类型(无需区分大小写)
ecCompanyId
电商标识,如“TAOBAO”(无需区分大小写)
2.1.2中国邮政发送给上游客户系统的参数
参数名称
用途
logistics_interface
消息内容
logistic_provider_id
TP编号
msg_type
消息类型
data_digest
消息正文的摘要
msg_type的值固定:
属性值
说明
默认消息格式
ORDERCREATE
创建订单
XML
UPDATE
订单更新(更新面单号、取消订单、接单、不接单、不揽收)
XML
2.1.3消息格式
请求和响应的消息格式将全部是XML
2.2安全及数据完整性
1、以HTTPPOST方式发送,请求方法的编码格式:
“application/x-;charset=GBK”;
2、用“logistics_interface”字段表示要发送的XML内容;
3、用“data_digest”字段进行签名验证。
签名使用MD5方式,对logistics_interface的内容进行签名。
原理为:
通知内容xml+parternID,然后进行MD5,转换为Base64字符串。
详细解释如下:
◆假设xml内容为:
,partnered为123456
◆那么要签名的内容为123456,经过md5和base64后的内容就为LghTkEmsD2tbQ3fsIBRcBg==,方法如下:
MessageDigestmd5=MessageDigest.getInstance("MD5");
BASE64Encoderbase64en=newBASE64Encoder();
Ret=base64en.encode(md5.digest((str+partnered).getBytes("GBK")));
◆然后需要对xml内容()进行URL编码(字符集为GBK),为:
%3Corder%3E%3C%2Forder%3E
◆同样需要对签名的字符串进行URL编码,LghTkEmsD2tbQ3fsIBRcBg==的内容为:
LghTkEmsD2tbQ3fsIBRcBg%3D%3D
◆最终要发送的数据为:
logistics_interface=%3Corder%3E%3C%2Forder%3E&data_digest=LghTkEmsD2tbQ3fsIBRcBg%3D%3D&msg_type=?
4、收到消息后,一定要验证数据是否完整及正确;
5、传输通道安全(https),目前不要求实现。
6、内容不正确?
请检查字符集是否为GBK;所有的参数都是通过URL编码传送的,符合HTTP协议,注意客户端是否解码正确,有些控件已经自带URL解码功能,请开发人员注意。
2.3数据发送和接收处理流程
数据发送流程:
数字签名->发送;
数据接收流程:
接收->数字签名校验->处理;
3接口描述
3.1订单接口
3.1.1字段含义
字段名
含义
类型
长度
是否为空
ecCompanyId
电商标识(如:
TAOBAO)
String
64
N
logisticProviderID
物流公司ID
String
64
N
customerId
客户标识
String
64
Y
txLogisticID
物流订单号
String
64
N
tradeNo
业务交易号(新业务类型待定:
252国内小包)
String
64
Y
mailNo
物流运单号
String
64
N
orderType
订单类型(0-COD1-普通订单
3-退货单)
int
N
serviceType
服务类型(0-自己联系1-在线下单(上门揽收)4-限时物流8-快捷COD16-快递保障)
long
N
name
用户姓名
String
32
N
postCode
用户邮编
String
6
N
phone
用户电话,包括区号、电话号码及分机号,中间用“-”分隔;
String
32
Y
mobile
用户移动电话,手机和电话两者必需提供一个
String
32
Y
prov
用户所在省
String
32
N
city
用户所在市县(区),市区中间用“,”分隔;注意有些市下面是没有区
String
32
N
address
用户详细地址
String
256
N
sendStartTime
物流公司上门取货时间段,通过“yyyy-MM-ddHH:
mm:
ss”格式化,本文中所有时间格式相同。
timestamp
Y
sendEndTime
timestamp
Y
goodsValue
商品金额,包括优惠和运费,但无服务费
long
N
itemName
商品名称
String
256
N
number
商品数量
int
N
itemValue
商品单价(单位:
分两位小数)
long
N
special
商品类型(保留字段,暂时不用)
int
Y
remark
备注
String
512
Y
totalServiceFee
总服务费[COD]:
(单位:
分)
long
Y
buyServiceFee
买家服务费[COD]:
(单位:
分)
long
Y
codSplitFee
物流公司分润[COD]:
(单位:
分)
long
Y
weight
商品重量(单位:
克)
long
N
3.1.2请求格式
XML格式:
—订单基本信息-->
TAOBAO
POSTB
a92266073246b3ed2a2f0ff4d0b2bf5e
LP709
25709
124579546621
3200
2000
1000
1
0
—发货方信息-->
张三
310013
231234134
浙江
杭州,西湖区
华星科技大厦9层--收货方信息-->
李四
100000
231234134
北京
北京市
华星科技大厦9层--物流公司上门取货时间段-->
2005-08-2408:
00:
00
2005-08-2412:
00:
00
--商品信息-->
1900
NokiaN73
2
2
NokiaN72
1
2
0
易碎品
10
3.1.3参数描述
订单创建信息由电商物流平台发送给中国邮政,电商物流平台以HTTPPOST方式发送消息,参数格式如下:
参数名称
用途
logistics_interface
4.1.2节描述的XML字符串
data_digest
logistics_interface的MD5签名
msg_type
固定“ORDERCREATE”(不区分大小写)
ecCompanyId
固定为“TAOBAO”(不区分大小写)
3.1.4返回格式
返回标准的系统交互格式,详情见《4系统交互处理流程》
3.1.5补充信息
1、物流订单号在上游客户系统中要具有唯一性