应用场景
(1)电商网站用户打开“我的订单”时调用此API显示物流信息详情。
(2)电商管理后台的物流系统,客服在对账前查询所有运单的签收状态,并追踪问题。
(3)适用于日查询量>500次的网站和系统。
注册快递鸟&申请Key
快递查询Api接口
接口文档及各开发语言Demo
查询Api接口定义
一、接口描述/说明
1.订阅接口
(1)此功能为专业定制,为特殊商户提供订阅服务,快递鸟系统会定时推送新的物流信息到商户系统。
(2)订阅快递号需指定相应的快递公司编码,格式不对或则编码错误都会返失败的信息。
如:EMS物流单号应选择快递公司编码(EMS)查看快递公司编码
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)接口地址: API测试地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址:https://api.kdniao.com/api/dist
请求系统级参数说明:
参数名称 | 类型 | 说明 | 必须要求 |
---|---|---|---|
RequestData | String | 请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。 | R |
EBusinessID | String | 商户ID,请在我的服务页面查看。 | R |
RequestType | String | 请求指令类型:1008 | R |
DataSign | String | 数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。 | R |
DataType | String | 请求、返回数据类型:2-json; | R |
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
2.推送接口(商户实现)
(1)客户需要按快递鸟要求开发接口,保证信息的正常接收。
(2)快递鸟主动推送时,物流信息接收接口由客户提供。
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)运单物流信息全量推送(每次推送的运单物流信息包括运单当前所有的的物流信息)。
请求系统级参数说明:
参数名称 | 类型 | 说明 | 必须要求 |
---|---|---|---|
RequestData | String | 请求内容需进行URL(utf-8)编码。请求内容只支持JSON格式。 | R |
RequestType | String | 101-轨迹查询结果, 107-货款状态 | R |
DataSign | String | 数据内容签名(把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码) | R |
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
二、接口参数
1.订阅接口
请求内容字段定义:
参数 | 类型 | 说明 | 必须要求 | |
---|---|---|---|---|
Callback | String(50) | 用户自定义回调信息 | O | |
MemberID | String(50) | 会员标识(备用字段) | O | |
WareHouseID | String(30) | 仓库标识(备用字段) | O | |
CustomerName | String | 电子面单客户账号(与快递网点申请) | O | |
CustomerPwd | String | 电子面单密码 | O | |
SendSite | String | 收件网点标识(名称) | O | |
ShipperCode | String(10) | 快递公司编码 | R | |
LogisticCode | String(30) | 快递单号 | R | |
OrderCode | String(30) | 订单编号 | O | |
MonthCode | String(20) | 月结编号 | O | |
PayType | Int | 邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付 | O | |
ExpType | String(2) | 快递类型:1-标准快件 | O | |
Cost | Double(5) | 快递运费 | O | |
OtherCost | Double(5) | 其他费用 | O | |
Receiver | Company | String(30) | 收件人公司 | O |
Name | String(30) | 收件人 | R | |
Tel | String(20) | 电话(电话与手机,必填一个) | R | |
Mobile | String(20) | 手机 | R | |
PostCode | String(10) | 收件人邮编 | O | |
ProvinceName | String(20) | 收件省(如广东省,不要缺少“省”) | R | |
CityName | String(20) | 收件市(如深圳市,不要缺少“市”) | R | |
ExpAreaName | String(20) | 收件区(如福田区,不要缺少“区”或“县”) | R | |
Address | String(100) | 收件人详细地址 | R | |
Sender | Company | String(30) | 发件人公司 | O |
Name | String(30) | 发件人 | R | |
Tel | String(20) | 手机与电话必填一个 | R | |
Mobile | String(20) | 发件人手机 | R | |
PostCode | String | 发件人邮编 | O | |
ProvinceName | String(20) | 发件省(如广东省,不要缺少“省”) | R | |
CityName | String(20) | 发件市(如深圳市,不要缺少“市”) | R | |
ExpAreaName | String(20) | 发件区(如福田区,不要缺少“区”或“县”) | R | |
Address | String(100) | 发件人详细地址 | R | |
IsNotice | Int(1) | 是否通知快递员上门揽件:0-通知;1-不通知;默认为1 | O | |
StartDate | String | 上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同 | O | |
EndDate | String | O | ||
Weight | Double | 包裹总重量kg | O | |