国际在线产品-新版 API 规范
发版日期:2017-07-01
修订人:黎明
1
2
1
E 邮宝、e 包裹、e 特快、国际 EMS API 综述 ............................................................................ 1
1.1 业务简介 .............................................................................................................................. 1
1.2 适用范围 .............................................................................................................................. 1
1.3 API 功能域分类 .................................................................................................................. 1
1.4 API 开发说明 ...................................................................................................................... 1
E 邮宝、e 包裹、e 特快、国际 EMS API 规范 ............................................................................ 1
2.1 SHIP(发运服务) ............................................................................................................. 1
2.1.1 运单信息接收服务 ............................................................................................................ 2
E 邮宝、E 包裹、E 特快、国际 EMS 传送内容:XML 格式的 订单信息,示例:. 2
2.1.2 SHIP (发运服务,带邮件号) ...................................................................................... 8
订单信息,示例: ...................................................... 8
2.1.2.1.1 申报币值对照规范............................................ 14
2.1.3 运单信息验证服务 .......................................................................................................... 16
2.1.4 运单信息取消服务 .......................................................................................................... 16
2.1.5 运单信息查询服务 .......................................................................................................... 16
2.2 TRACK(跟踪信息服务)............................................................................................... 17
2.2.1 实时跟踪信息查询 .......................................................................................................... 17
2.3 RATE(费率服务) ............................................................................................................... 17
2.3.1 国际 E 邮宝费率计算 ...................................................................................................... 18
2.4 Address(地址服务) ........................................................................................................... 19
2.4.1 国内地址行政区划查询 .................................................................................................. 19
2.5 LABEL(标签服务) ............................................................................................................. 20
2.5.1 标签静态文件下载服务 .................................................................................................. 20
2.5.2 批量获取标签服务 .......................................................................................................... 20
2.5.3 批量获取标签服务(增强版) ...................................................................................... 21
2.6 邮件相关信息查询 ............................................................................................................ 22
2.6.1 资费信息查询 .................................................................................................................. 22
2.6.2 分拣码查询 ...................................................................................................................... 23
3 附录........................................................................................................................................... 23
3.1 附录一:集成及用户权限验证方法 ................................................................................ 23
3.2 附录二:业务通达国家和地区名称以及邮编规则 ........................................................ 23
3.3 附录三:版本信息更新记录 ............................................................................................ 27
2
1 E 邮宝、e 包裹、e 特快、国际 EMS API 综
述
1.1 业务简介
E 邮宝、E 包裹、E 特快、国际 EMS API 提供在线的运单生成、标签打印、全程跟踪等
信 息服务,覆盖运单的完整生命周期。
1.2 适用范围
具备一定软件开发能力并拥有自建订单系统的大中小型 B2C、C2C 商家,可根据自身
情况,进行个性化的开发,以达到 API 系统对接的目的。API 基于 HTTP 协议实现,需要双
方系统能够通过 internet 互联,并使用 http 方式进行通讯。本文档描述不涉及具体的开发语
言,集成过程可使用合适的编程技术,实现基于 http 的数据交换方式。
1.3 API 功能域分类
API 数量较多,在后续建设过程中可能不断增加,但总体可划分几个域进行完善和扩充:
SHIP(发运服务)、TRACK(跟踪信息服务)、RATE(费率服务)、ADDRESS(地址服务)、
LABEL(标签服务)。
1.4 API 开发说明
接口入网参数 version(版本号)和 authenticate(授权码)在一些接口是必填项,具体
请参照附录一:集成及用户权限验证方法
如果您在开发中出现:商品名称填写中文,但返回错误还是提示“商品中文名称不能为
空,且必须包含至少 2 个汉字”时,请检查在调用 api 接口时所用的编码方式必须为 UTF-8。
2 E 邮宝、e 包裹、e 特快、国际 EMS API 规
范
2.1 SHIP(发运服务)
发运服务域包含与运单信息相关的服务,主要包括运单信息接收服务、运单信息验证服
务、运单信息取消服务、运单信息查询服务。
1
2.1.1 运单信息接收服务
资源地址:http://shipping.ems.com.cn/partner/api/public/p/order/
HTTP 方法:POST
E 邮宝、E 包裹、E 特快、国际 EMS 传送内容:XML 格式的 订单
信息,示例:
SO1231231
sadad
0
0
deve360
00000000000001
1
false
Abandoned
123
2011-03-01T22:22:22
2011-03-11T02:22:11
01
Wang Lin
100055
2131231
1123333333313
CN
441402
441402
2
untread
volweight
Integer
Abandoned|AND
I
退回类型,默认为 Returned
ASSURE TO PAY
Abandoned: 丢弃
string
FOR THE CHARGE
AND I ASSURE TO PAY FOR THE CHAR
OF
GE OF RETURN: 保证支付退回的邮件
RETURN|Returned
Returned: 退回
体积重量=长(单位:厘米)×宽(单位:
厘米)×高(单位:厘米)/6000,客户
6