零售电商平台及ISV商家对物流api接口的需求有很多,今天我们主要分享的就是快递鸟快递单号查询接口的对接指南,快递单号查询接口对接的应用场景有很多,很多场景会遇到,最主要的就是电商网站用户打开“我的订单”时调用此API显示物流信息详情,电商管理后台的物流系统,客服在对账前查询所有运单的签收状态,并追踪问题,电商平台对商家物流管控,要求必须在多久快递必须发出要看到揽件状态,多久必须收到货物看到签收状态,根据这些状态对商家管控从而提高用户的整体满意度。
调用快递鸟快递单号查询API接口,就能查询到1600多家以上快递公司单号从收件、运输,到转运中心,派送到签收等各个环节的物流发货状态。快递鸟api接口不区分开发语言,支持Java,C#,PHP,Python,ObjectC等开发语言的程序调用。下面具体讲解实现过程:
对接使用流程
1、将快递单号和快递公司编码发送給快递鸟
2、快递鸟根据单号和快递公司查询到物流轨迹状态
3、快递鸟将查询到的物流轨迹状态反馈給电商平台或ISV服务商
4、电商平台或ISV服务商接收数据并实时处理做数据展示或应用
接口描述说明
(1)查询接口支持按照运单号查询(单个查询)。 (2)接口需要指定快递单号的快递公司编码,格式不对或则编码错误都会返失败的信息。 如:EMS物流单号应选择快递公司编码(EMS)查看下载快递鸟快递公司编码(快递鸟官网联系我们的在线客服)(3)返回的物流跟踪信息按照发生的时间升序排列。 (4)接口指令1002。 (5)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"
application/x-www-form-urlencoded;charset=utf-8"。 (6)测试调用地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json (7)正式调用地址:http://api.kdniao.com/api/dist(8)快递鸟官网地址:【快递鸟API】-快递单号查询接口-快递电子面单-全球物流数据服务商
(9)返回类型:JSON
(10)调试页面:
http://kdniao.com/UserCenter/v2/SandBox/TrackQuery.aspx
(11)调试工具:去调试(使用快递鸟账号登录)
请求系统级参数说明:
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
【接口参数】
请求内容字段定义:
返回参数定义:
示例
请求示例 JSON
{
“OrderCode”: “”,
“ShipperCode”: “SF”,
“LogisticCode”: “118650888018”
}
返回示例 JSON
没有物流轨迹的
{
“EBusinessID”: “1109259”,
“Traces”: [],
“OrderCode”: “”,
“ShipperCode”: “SF”,
“LogisticCode”: “118461988807”,
“Success”: false,
“Reason”: null
}
有物流轨迹的
{
“EBusinessID”: “1109259”,
“OrderCode”: “”,
“ShipperCode”: “SF”,
“LogisticCode”: “118461988807”,
“Success”: true,
“State”: 3,
“Reason”: null,
“Traces”: [
{
“AcceptTime”: “2021/06/25 08:05:37”,
“AcceptStation”: “正在派件…(派件人:邓裕富,电话:18718866310)[深圳 市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/25 04:01:28”,
“AcceptStation”: “快件在 深圳集散中心 ,准备送往下一站 深圳 [深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/25 01:41:06”,
“AcceptStation”: “快件在 深圳集散中心 [深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/24 20:18:58”,
“AcceptStation”: “已收件[深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/24 20:55:28”,
“AcceptStation”: “快件在 深圳 ,准备送往下一站 深圳集散中心 [深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/25 10:23:03”,
“AcceptStation”: “派件已签收[深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/25 10:23:03”,
“AcceptStation”: “签收人是:已签收[深圳市]”,
“Remark”: null
}
]
}
前期准备工作
去快递鸟官网免费注册一个账号,免费获得一个apiKey(接口权限验证需要),完成实名认证流程,订购一个免费或付费套餐(也可找快递鸟工作人员免费申请付费的接口测试联调):快递单号查询接口_电子面单_APIKey授权申请–快递鸟账号注册
快递鸟技术开发文档下载快递鸟DEMO下载
注:登录快递鸟用户管理后台后获得用户ID和APIKey对应各demo中的EBusinessID、AppKey。
小知识:EBusinessID跟APIKey是什么?EBusinessID跟APIKey您在快递鸟网站注册之后快递鸟分配的密钥(对应官网上的用户ID和API key),用于保证应用来源的可靠性,避免应用伪造,被不法使用。
请求完整报文(示例)
RequestData=%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27JTSD%27%2c%27LogisticCode%27%3a%27jt0000052600488%27%7d&
EBusinessID=1264783&RequestType=1002&DataSign=MTYyMDU4NWQ2NmU1ZDI2MDEzNGE5YmVlM2YxYzEzMTM%3d&DataType=2
成功返回报文(示例)
{
“LogisticCode”: “JT0000052600488”,
“ShipperCode”: “JTSD”,
“Traces”: [
{
“AcceptStation”: “【芜湖市】【芜湖镜湖网点】的邓拥军 17855364213已取件”,
“AcceptTime”: “2020-03-16 16:26:13”
},
{
“AcceptStation”: “【芜湖市】【芜湖镜湖网点】的邓拥军 17855364213已取件”,
“AcceptTime”: “2020-03-16 16:41:33”
},
{
“AcceptStation”: “【芜湖市】【芜湖镜湖网点】已收件”,
“AcceptTime”: “2020-03-16 17:39:21”
},
{
“AcceptStation”: “【芜湖市】快件离开【芜湖镜湖网点】已发往【芜湖转运中心】”,
“AcceptTime”: “2020-03-16 17:40:27”
},
{
“AcceptStation”: “【芜湖市】快件到达【芜湖转运中心】”,
“AcceptTime”: “2020-03-16 19:36:32”
},
{
“AcceptStation”: “【芜湖市】快件离开【芜湖转运中心】已发往【合肥转运中心】”,
“AcceptTime”: “2020-03-16 20:47:03”
},
{
“AcceptStation”: “【合肥市】快件到达【合肥转运中心】”,
“AcceptTime”: “2020-03-16 23:40:10”
},
{
“AcceptStation”: “【合肥市】快件离开【合肥转运中心】已发往【广州花都转运中心】”,
“AcceptTime”: “2020-03-17 00:10:48”
},
{
“AcceptStation”: “【广州市】快件到达【广州花都转运中心】”,
“AcceptTime”: “2020-03-17 20:45:00”
},
{
“AcceptStation”: “【广州市】快件离开【广州花都转运中心】已发往【深圳宝安转运中心】”,
“AcceptTime”: “2020-03-18 00:17:55”
},
{
“AcceptStation”: “【深圳市】快件到达【深圳宝安转运中心】”,
“AcceptTime”: “2020-03-18 03:00:17”
},
{
“AcceptStation”: “【深圳市】快件离开【深圳宝安转运中心】已发往【深圳福田网点】”,
“AcceptTime”: “2020-03-18 04:44:39”
},
{
“AcceptStation”: “【深圳市】【深圳福田网点】的邹俊林 17679495647正在派件”,
“AcceptTime”: “2020-03-18 08:10:09”
},
{
“AcceptStation”: “【深圳市】【深圳福田网点】的赵凯 15919817730正在派件”,
“AcceptTime”: “2020-03-18 09:55:19”
},
{
“AcceptStation”: “【深圳市】快件已签收,签收人是【代收】,如有疑问请联系:15919817730,期待再次为您服务”,
“AcceptTime”: “2020-03-18 14:53:54”
}
],
“State”: “3”,
“EBusinessID”: “1264783”,
“Success”: true
}
失败返回报文(示例)
{
“LogisticCode”: “JT0000052600488”,
“ShipperCode”: “JTSD”,
“Traces”: [],
“State”: “0”,
“EBusinessID”: “1264783”,
“Reason”: “业务错误[没有可用套餐]”,
“Success”: false
}
说明:未实名认证,未订购套餐,套餐可用查询量已经用完 都会返回此报文信息去实名认证/ 了解套餐详情
无轨迹返回报文(示例)
{
“LogisticCode”: “JT0000052600488”,
“ShipperCode”: “JTSD”,
“Traces”: [],
“State”: “0”,
“EBusinessID”: “1264783”,
“Reason”: “暂无轨迹信息”,
“Success”: true
}