1、 快递鸟接口 (API)技术文档 快递鸟 快递接口技术文档 1 / 90 版本 日期 版本 说明 作者 2014-12-01 3.0 重新整理,根据功能分类,部分有调整 杨文胜 2014-01-11 3.1 对接口的说明进行了注释,提高可读性 杨汉汶 2014-01-13 3.2 新增推送接口 杨汉汶 2015-03-11 3.3 新增批量订阅推送接口,删除 3.2 版本推送接口 杨文胜 2015-10-12 3.4 新增订单分发接口,整理电子面单接口 曹强 2016-01-19 3.5 重新调整在线下单接口 曹强 2016-03-01 3.6 增加智选物流接口 曹强 2016-03-01 3
2、.7 分发及订阅接口更新 任海洋 2016-04-07 3.7.1 推送接口更新 任海洋 2016-05-11 3.7.2 电子面单新增通知快递员上门字段,推送接口新增货款状态推送 詹益伟 2016-07-01 4.0 全新 4.0 接口,新增单号识别接口、智选物流接口、更新物流轨迹接口(订阅查询) 詹益伟 2016-9-26 4.0.1 推送接口 新增 DataSign 字段 、订阅 2.0 新增仓库标识 ID、 智选物流接口新增字段 胡蕾蕾 2016-11-03 4.1 新增在途监控(增值服务) 曹强 2016-12-13 4.1.1 电子面单新增第三方订单号 ThrOrderCode 胡
3、蕾蕾 2017-1-10 4.2 新增隐私快递 胡蕾蕾 2017-2-16 4.2.1 新增代收货款业务 胡蕾蕾 2017-4-13 4.3 1、即时查询接口中轨迹状态新增 0-无轨迹 2、普通回调接口中删除 201 状态 3、修改智选物流接口文档 4、电子面单接口添加特殊字符提示 陈爱 2017-4-25 4.4 1、 新增申请电子面单客户号 接口 2、 新增电子面单余额查询接口 3、 新增电子面单单号回收接口 4、 新增申请客户号信息推送接口 陈爱 2017-6-22 4.5 新增短信接口 李旭安 2017-7-14 4.6 电子面单接口新增支持邮政快递包裹 吴明 名词定义 必须要求 说明
4、 R 必填( Required)。 O 可选( Optional) C 报文中该参数在一定条件下可选( Conditional) 快递鸟 快递接口技术文档 2 / 90 1 前言 . 7 2 概述 . 8 2.1 用户使用流程图 . 8 2.2 接口规范及说明 . 9 2.2.1 报文及报文编码 . 9 2.2.2 接入步骤 . 10 2.2.3 接口数据包结构 . 11 2.2.4 JSON 范例 . 11 2.2.5 流程示意图 . 12 2.2.6 网关地址 . 12 2.3 签名说明 . 12 2.3.1 关于签名 . 12 2.3.2 (C#)DataSign 签名加密代码 . 13
5、 3 下单 . 15 3.1 预约取件接口 . 15 3.1.1 功能说明 . 15 3.1.2 接口规则 . 15 3.1.3 系统级和应用级输入参数 . 15 3.1.4 返回结果参数 . 18 3.1.5 Json 请求示例 . 18 3.1.6 Json 请求返回示例 . 19 3.2 电子面单 . 20 3.2.1 功能说明 . 20 3.2.2 接口规则 . 20 3.2.3 系统级和应用级输入参数 . 21 3.2.4 返回结果参数 . 24 3.3 电子面单余量查询接口 . 25 3.3.1 功能说明 . 25 3.3.2 接口规则 . 25 3.3.3 系统级和应用级输入参数
6、 . 25 3.3.4 返回结果参数 . 26 快递鸟 快递接口技术文档 3 / 90 3.3.5 JSON 请求示例 . 26 3.3.6 JSON 返回示例 . 26 3.4 电子面单单号 取消 . 27 3.4.1 功能说明 . 27 3.4.2 接口规则 . 27 3.4.3 系统级和应用级输入参数 . 27 3.4.4 返回结果参数 . 28 3.4.5 Json 请求示例 . 28 3.4.6 Json 请求返回示例 . 28 3.5 申请电子面单客户号 . 29 3.5.1 功能说明 . 29 3.5.2 接口规则 . 29 3.5.3 系统级和应用级输入参数 . 29 3.5.
7、4 返回结果参数 . 30 3.5.5 Json 请求示例 . 30 3.5.6 Json 请求返回示例 . 31 3.6 申请客户号信息推送 . 31 3.6.1 功能说明 . 31 3.6.2 接口规则 . 31 3.6.3 系统级和应用级输入参数 . 31 3.6.4 返回结果参数 . 32 3.6.5 Json 请求示例 . 32 3.6.6 Json 请求返回示例 . 32 3.7 增值服务列表 . 32 3.8 安全号码接口 . 33 3.8.1 功能说明 . 33 3.8.2 接口规则 . 33 3.8.3 系统级和应用级输入参数 . 33 3.8.4 返回结果 参数 . 35
8、3.8.5 JSON 请求示例 . 35 3.8.6 JSON 请求返回示例 . 36 快递鸟 快递接口技术文档 4 / 90 4 轨迹查询 . 37 4.1 物流轨迹(即时查询) . 37 4.1.1 功能说明 . 37 4.1.2 接口规则 . 37 4.1.3 系统级和应用级输入参数 . 37 4.1.4 返回结果参数 . 38 4.1.5 JSON 请求示例 . 38 4.1.6 JSON 返回示例 . 38 4.2 物流轨迹(订阅查询) . 40 4.2.1 功能说明 . 40 4.2.2 接口规则 . 40 4.2.3 系统级和应用级输入参数 . 40 4.2.4 返回结果参数 .
9、 43 4.2.5 JSON 请求示例 . 44 4.2.6 JSON 返回示例 . 44 5 异步推送(回调)接口 . 45 5.1 功能说明 . 45 5.2 接口规则 . 45 5.3 系统级和应用级输入参数 . 45 5.3.1 订阅查询结果( RequestType: 101) . 46 5.3.2 订阅查询(增值版)结果( RequestType: 102) . 47 5.3.3 货款状态( RequestType: 107) . 48 5.4 返回结果参数 . 49 5.5 JSON 请求示例 . 49 5.6 JSON 返回示例 . 53 6 智能服务 . 53 6.1 智选物
10、流 . 53 6.1.1.功能说明 . 53 6.1.2.接口规则 . 53 6.1.3.应用级输入参数 . 54 6.1.4.返回结果参数 . 56 6.1.5.JSON 请求示例 . 57 6.1.6.JSON 返回示例 . 59 快递鸟 快递接口技术文档 5 / 90 6.2 运费模板导入接口 . 61 6.2.1.功能说明 . 61 6.2.2.接口规则 . 61 6.2.3.系统级输入参数 . 61 6.2.4.应用级输入参数 . 62 6.2.5.返回结果参数 . 63 6.2.6.JSON 请求示例 . 63 6.2.7.JSON 返回示例 . 64 6.3 单号识别 . 65
11、6.3.1.功能说明 . 65 6.3.2.接口规则 . 65 6.3.3.系统级和应用级输入参数 . 65 6.3.4.返回结果参数 . 66 7 在途监控(增值版) . 66 7.1 物流轨迹(即时查询增值版) . 66 7.1.1 功能说明 . 66 7.1.2 接口规则 . 66 7.1.3 系统级和应用级输入参数 . 67 7.1.4 返回结果参数 . 67 7.1.5 JSON 请求示例 . 68 7.1.6 JSON 返回示例 . 68 7.2 物流轨迹(订阅查询增值版) . 70 7.2.1 功能说明 . 70 7.2.2 接口规则 . 71 7.2.3 系统级和应用级输入参数 . 71 7.2.4 返回结果参数 . 74 7.2.5 JSON 请求示例 . 74 7.2.6 JSON 返回示例 . 75 8 短信 . 75 8.1 短信发送 . 75 8.1.1 功能说明 . 75 快递鸟 快递接口技术文档 6 / 90 8.1.2 接口规则 .