logo资料库

中国邮政E邮宝、e包裹、e特快 EMS API.pdf

第1页 / 共29页
第2页 / 共29页
第3页 / 共29页
第4页 / 共29页
第5页 / 共29页
第6页 / 共29页
第7页 / 共29页
第8页 / 共29页
资料共29页,剩余部分请下载后查看
1 E 邮宝、e 包裹、e 特快、国际EMS API 综述
1.1 业务简介
1.2 适用范围
1.3 API 功能域分类
1.4 API 开发说明
2 E 邮宝、e 包裹、e 特快、国际EMS API 规范
2.1 SHIP(发运服务)
2.1.1 运单信息接收服务
E 邮宝、E 包裹、E 特快、国际EMS传送内容:XML 格式的 订单信息,示例:
2.1.2 SHIP (发运服务,带邮件号)
订单信息,示例:
2.1.2.1.1 申报币值对照规范
2.1.3 运单信息验证服务
2.1.4 运单信息取消服务
2.1.5 运单信息查询服务
2.2 TRACK(跟踪信息服务)
2.2.1 实时跟踪信息查询
2.3 RATE(费率服务)
2.3.1 国际 E 邮宝费率计算
2.4 Address(地址服务)
2.4.1 国内地址行政区划查询
2.5 LABEL(标签服务)
2.5.1 标签静态文件下载服务
2.5.2 批量获取标签服务
2.5.3 批量获取标签服务(增强版)
2.6 邮件相关信息查询
2.6.1 资费信息查询
2.6.2 分拣码查询
3 附录
3.1 附录一:集成及用户权限验证方法
3.2 附录二:业务通达国家和地区名称以及邮编规则
3.3 附录三:版本信息更新记录
国际在线产品-新版 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
441402 Teamsun Lotus Street mail@team.com Tom.k 10005 1111111 212-222-0111 UNITED STATES OF AMERICA LA San Francisco St. Lotus Street 王大琳 100067 123456-908-098 1233333333333 CN 441402 441402 441402 莲花池东路 126 号 bin@team.com 盒子 box 1 0.1 1 CN 12345678 电脑 computer 2 3
unit 0.23 20.34 CN Computer Machine 12345678 http://www.baidu.com 4
返回值:XML 格式文档,示例: LN334458969CN 入参规范说明: 订单主体信息 orderid string 4-32 operationtype integer 0|1|2|3 producttype integer 1|2| customercode string 4-64 vipcode string 14 订单标识,此标识由使用者提供,应为 订单在使用者系统中的唯一标识。如使 用者订单需拆分多个邮包(包裹),时, 此标识可重复。 业务类型(默认 0,如果不填或者没有该 节点就取默认值) 0:e 邮宝 1:e 包裹 2:e 特快 4: 国际 EMS 产品种类(默认 0) 2:国际包裹签收 如果选择 e 包裹业务:必填 2 使用者系统中的客户编码。即实际提交 此订单的用户在使用者系统中的身份标 识。中邮物流平台会依据此信息项对客 户进行区分,此项不能为空,但使用者 可提供加密或者编码后的客户身份标 识。 使用者如果拥有 EMS 大客户代码, 应 填入此字段 clcttype integer 0|1 pod boolean false|true 揽收类型,1 上门揽收或 0 用户自送 电子签收(目前默认为 false) 5
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
分享到:
收藏