快递鸟物流接口技术完整版.docx
- 文档编号:11788984
- 上传时间:2023-04-01
- 格式:DOCX
- 页数:87
- 大小:45.04KB
快递鸟物流接口技术完整版.docx
《快递鸟物流接口技术完整版.docx》由会员分享,可在线阅读,更多相关《快递鸟物流接口技术完整版.docx(87页珍藏版)》请在冰豆网上搜索。
快递鸟物流接口技术完整版
Documentserialnumber【NL89WT-NY98YT-NC8CB-NNUUT-NUT108】
快递鸟物流接口技术
快递鸟接口(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
String
O
失败原因
2.3.3JSON请求示例
{
"ShipperCode":
"SF",
"Receiver":
{
"Company":
"LV",
"Name":
"张勇",
"ProvinceName":
"重庆市",
"CityName":
"重庆市",
"ExpAreaName":
"九龙坡",
"Address":
"九龙35号"
},
"Sender":
{
"Company":
"GCCUI",
"Name":
"张勇",
"ProvinceName":
"北京",
"CityName":
"北京",
"ExpAreaName":
"朝阳区",
"Address":
"三里屯街道雅秀大厦"
},
"HideType":
"3"
}'
2.3.4JSON请求返回示例
{
"EBusinessID":
"1261600",
"ShipperCode":
"SF",
"Success":
true,
"Reason":
"",
"ResultCode":
"100",
}
3轨迹查询
3.1物流轨迹(即时查询)
3.1.1功能说明
物流轨迹查询-使用的物流单号和快递单号即可实现查询物流信息。
3.1.2接口规则
(1)、查询接口支持按照运单号查询(单个查询,并发不超过10个/S)。
(2)、指定的物流运单号选择相应的快递公司编码,格式不对或则编码错误都会返失败的信息。
如EMS物流单号应选择快递公司编码(EMS)
(3)、返回的物流跟踪信息按照发生的时间升序排列。
(4)、接口指令1002。
(5)、请求地址:
3.1.3系统级和应用级输入参数
系统级输入参数
类型
应用级输入参数
必须要求
说明
RequestData
String
OrderCode
O
订单编号
请求内容,JSON格式,和DataType一致
ShipperCode
R
快递公司编码
LogisticCode
R
物流单号
EBusinessID
String
R
电商ID
RequestType
String
R
请求指令类型:
1002
DataSign
String
R
数据内容签名
DataType
String
R
请求、返回数据类型:
2-json;
3.1.4返回结果参数
参数名称
类型
必须要求
说明
EBusinessID
String
R
电商用户ID
OrderCode
String
O
订单编号
ShipperCode
String
R
快递公司编码
LogisticCode
String
R
物流运单号
CallBack
String
O
用户标识
Success
Bool
R
成功与否
Reason
String
O
失败原因
State
String
R
物流状态:
0-无轨迹2-在途中,3-签收,4-问题件
Traces/物流轨迹详情
AcceptTime
String
R
时间
AcceptStation
String
R
描述
Remark
String
O
备注
3.1.5JSON请求示例
{
"OrderCode":
"",
"ShipperCode":
"SF",
}
3.1.6JSON返回示例
没有物流轨迹的
{
"EBusinessID":
"1109259",
"Traces":
[],
"OrderCode":
"",
"ShipperCode":
"SF",
"Success":
true,
"Reason":
null
}
有物流轨迹的
{
"EBusinessID":
"1109259",
"OrderCode":
"",
"ShipperCode":
"SF",
"Success":
true,
"CallBack":
"",
"State":
3,
"Reason":
null,
"Traces":
[
{
"AcceptTime":
"2014/06/2508:
05:
37",
"Remark":
null
},
{
"AcceptTime":
"2014/06/2504:
01:
28",
"AcceptStation":
"快件在深圳集散中心,准备送往下一站深圳[深圳市]",
"Remark":
null
},
{
"AcceptTime":
"2014/06/2501:
41:
06",
"AcceptStation":
"快件在深圳集散中心[深圳市]",
"Remark":
null
},
{
"AcceptTime":
"2014/06/2420:
18:
58",
"AcceptStation":
"已收件[深圳市]",
"Remark":
null
},
{
"AcceptTime":
"2014/06/2420:
55:
28",
"AcceptStation":
"快件在深圳,准备送往下一站深圳集散中心[深圳市]",
"Remark":
null
},
{
"AcceptTime":
"2014/06/2510:
23:
03",
"AcceptStation":
"派件已签收[深圳市]",
"Remark":
null
},
{
"AcceptTime":
"2014/06/2510:
23:
03",
"AcceptStation":
"签收人是:
已签收[深圳市]",
"Remark":
null
}
]
}
3.2物流轨迹(订阅查询)
3.2.1功能说明
订阅查询接口是快递鸟为用户提供的定制化服务,用户可将订单信息通过快递鸟订阅给快递公司,快递公司更新轨迹后,快递鸟将实时转换成快递鸟标准接口形式,推送给用户,起到实时推送的作用,提高效率。
同时用户订阅的数据还能选择是否通知快递员上门,实现在线下单功能。
3.2.2接口规则
(1)、订单接收的信息(分给了的网点,业务员的信息),会通过推送接口推给客户(订阅并发不超过30次/S)客户需要按要求实现接口。
(2)、仅支持Json格式。
(3)、请求指令1008。
(4)、测试接口地址:
(5)、联调通过后请更换为正式地址:
(6)、分发及订阅接口需要客户方实现回调接口,回调RequestType(1008)
3.2.3系统级和应用级输入参数
系统级输入参数
应用级输入参数
类型
是否必须
描述
RequestData(必填参数,请求内容,JSON格式,须和DataType一致))
CallBack
String
O
用户自定义回调信息
MemberID
String
O
会员标识(备用字段)
WareHouseID
String
O
仓库标识(备用字段)
CustomerName
String
O
电子面单客户账号
(与快递网点申请)
CustomerPwd
String
O
电子面单密码
SendSite
String
O
收件网点标识
ShipperCode
String
R
快递公司编码
LogisticCode
String
R
快递单号
OrderCode
String
O
订单编号
MonthCode
String
O
月结编码
PayType
Int
O
邮费支付方式:
1-现付,2-到付,3-月结,4-第三方支付
ExpType
String
O
快递类型:
1-标准快件
Cost
Double
O
寄件费(运费)
OtherCost
Double
O
其他费用
Receiver
Company
String
O
收件人公司
Name
String
O
收件人
Tel
String
O
电话
Mobile
String
O
手机
PostCode
String
O
收件人邮编
ProvinceName
String
O
收件省(如广东省,不要缺少“省”)
CityName
String
O
收件市(如深圳市,不要缺少“市”)
ExpAreaName
String
O
收件区(如福田区,不要缺少“区”或“县”)
Address
String
O
收件人详细地址
Sender
Company
String
O
发件人公司
Name
String
O
发件人
Tel
String
O
发件人电话
Mobile
String
O
发件人手机
PostCode
String
O
发件人邮编
ProvinceName
String
O
发件省(如广东省,不要缺少“省”)
CityName
String
O
发件市(如深圳市,不要缺少“市”)
ExpAreaName
String
O
发件区(如福田区,不要缺少“区”或“县”)
Address
String
O
发件详细地址
StartDate
String
O
上门取货时间段:
"yyyy-MM-ddHH:
mm:
ss"格式化,本文中所有时间格式相同
EndDate
String
O
Weight
Double
O
物品总重量kg
Quantity
Int
O
件数/包裹数
Volume
Double
O
物品总体积m3
Remark
String
O
备注
IsNotice
Int
O
是否分发到快递公司:
1-不分发;0-分发.默认为0
IsSendMessage
Int
O
是否订阅短信
0-不需要;1-需要
AddService
Name
String
0
Value
String
0
增值服务值
CustomerID
String
0
客户标识(选填)
Commodity
GoodsName
String
O
商品名称
GoodsCode
String
O
商品编码
Goodsquantity
Int
O
件数
GoodsPrice
Double
O
商品价格
GoodsWeight
Double
O
商品重量kg
GoodsDesc
String
O
商品描述
GoodsVol
Double
O
商品体积m3
EBusinessID
String
R
商户ID
RequestType
String
R
请求指令类型:
1008
DataSign
String
R
数据内容签名
DataType
String
R
请求、返回数据类型:
2-json;
3.2.4返回结果参数
●同步返回
参数名称
类型
必须要求
说明
EBusinessID
String
R
电商用户ID
UpdateTime
String
R
时间
Success
Bool
R
成功与否:
true,false
Reason
String
O
失败原因
EstimatedDeliveryTime
String
O
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 快递 物流 接口 技术 完整版