快递鸟物流接口技术文档.docx
《快递鸟物流接口技术文档.docx》由会员分享，可在线阅读，更多相关《快递鸟物流接口技术文档.docx（91页珍藏版）》请在冰豆网上搜索。
快递鸟物流接口技术文档
快递鸟接口（API）技术文档
版本
日期
版本
说明
作者
2014-12-01
重新整理，根据功能分类，部分有调整
杨文胜
2014-01-11
对接口的说明进行了注释，提高可读性
杨汉汶
2014-01-13
新增推送接口
杨汉汶
2015-03-11
新增批量订阅推送接口，删除版本推送接口
杨文胜
2015-10-12
新增订单分发接口，整理电子面单接口
曹强
2016-01-19
重新调整在线下单接口
曹强
2016-03-01
增加智选物流接口
曹强
2016-03-01
分发及订阅接口更新
任海洋
2016-04-07
推送接口更新
任海洋
2016-05-11
电子面单新增通知快递员上门字段，推送接口新增货款状态推送
詹益伟
2016-07-01
全新接口，新增单号识别接口、智选物流接口、更新物流轨迹接口（订阅查询）
詹益伟
2016-9-26
推送接口新增DataSign字段、订阅新增仓库标识ID、智选物流接口新增字段
胡蕾蕾
2016-11-03
新增在途监控（增值服务）
曹强
2016-12-13
电子面单新增第三方订单号ThrOrderCode
胡蕾蕾
2017-1-10
新增隐私快递
胡蕾蕾
2017-2-16
新增代收货款业务
胡蕾蕾
2017-4-13
1、即时查询接口中轨迹状态新增0-无轨迹
2、普通回调接口中删除201状态
3、修改智选物流接口文档
4、电子面单接口添加特殊字符提示
陈爱
2017-4-25
1、新增申请电子面单客户号接口
2、新增电子面单余额查询接口
3、新增电子面单单号回收接口
4、新增申请客户号信息推送接口
陈爱
2017-6-22
新增短信接口
李旭安
2017-7-14
电子面单接口新增支持邮政快递包裹
吴明
名词定义
必须要求
说明
R
必填（Required）。
O
可选（Optional）
C
报文中该参数在一定条件下可选（Conditional）
1
前言
快递鸟API旨在为电商、电商平台、物流工具、仓储系统等等系统提供专业、稳定、优质的物流服务，为不同的用户量身定做了专业的API接口服务，供不同的用户各取所需。
本文档就各个API接口进行详细的说明，方便快递鸟的用户快速对接，方便快捷使用快递鸟服务。
2概述
2.1用户使用流程图
快递鸟API全流程服务（电商）流程图
基于电商现有的服务流程，快递鸟为电商、电商平台、ERP系统、仓储系统等系统在用户下单、选择物流、下单、打单、轨迹跟踪等关键节点，均提供了专业、高效的API接口，方便各个平台实现一次接入，便可使用国内外主流物理公司的服务。
快递鸟API全流程服务（工具）流程图
对于物流工具，基于用户的操作习惯，只需要输入单号，快递鸟即可完成后续的物流公司识别、查询轨迹等工作，为工具类用户提供一站式的服务。
2.2接口规范及说明
2.2.1报文及报文编码
Json格式。
编码格式：
UTF-8
交互协议上统一用UTF-8，避免传递中文数据出现乱码。
2.2.2接入步骤
注册成为快递鸟用户（注：
注册成功后进行实名认证，申请开通接口，后续会再对用户的注册信息进行审批）。
注册成功后，登录用户管理后台就可以查看到用户所属唯一的商户ID和APIkey。
按照快递鸟官网提示进行注册申请，注册成功后登录用户管理后台，您将得到由快递鸟提供的一组商户ID和APIKey。
商户ID是调用接口服务的身份证明，不可更改、不可转用，APIKey是应用访问API的签名附加密钥，必须妥善保存。
两者关系类似于登录帐号和密码，两者都会在签名和业务参数中使用。
注册成功登录用户管理后台可以查看商户ID和APIKey，需实名认证后才能申请开通接口。
（1）开发服务
开发自身业务的服务，服务需遵循接口的定义规则。
（2）查看接口调用的DEMO
快递鸟物流技术接口提供调用快递鸟物流接口的DEMO（.Net版本，Java版本，PHP版本），包括网上在线订单下单、物流轨迹查询等物流行业标准化的下单操作流程与数据查询格式。
提交接入处理的相关代码如有不明白的地方可与快递鸟物流技术接口人协作开发。
DEMO下载地址：
（如链接无法打开，请打开浏览器，在浏览器中输入）
2.2.3接口数据包结构
图例-数据包结构（系统级{数据}）
2.2.4JSON范例
stringuserID="1109259";
2.2.5stringkeyValue="56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17";
2.2.6
2.2.7
2.2.8
2.2.9
2.2.10
2.2.11
2.2.12
2.2.13
2.2.14
2.2.15
2.2.16
2.2.17
2.2.18
2.2.19
2.2.20
2.2.21
2.2.22
2.2.23
2.2.24
2.2.25
2.3
2.3.1
身发件人信息，3.同时隐藏收件人，发件人信息）
EBusinessID
String
R
商户ID
RequestType
String
R
请求指令类型：
3001
DataSign
String
R
数据内容签名
DataType
String
R
请求、返回数据类型：
2-json；
2.3.2返回结果参数
参数名称
类型
必填
说明
OrderCode
String
R
订单编号
ExpCode
String
R
快递公司编码
ExpNo
String
R
快递单号
ReceiverSafePhone
String
O
收件人安全电话
ReceiverPhone
String
O
收件人电话
SenderSafePhone
String
0
寄件人安全电话
SenderPhone
String
0
寄件人电话
DialPage
String
R
拨号页面网址（转换成二维码可扫描拨号）
Success
Bool
R
成功与否
ResultCode
String
R
错误编码
Reason
升级会员 