快递鸟一次性对接2000+物流接口

API服务

预约取件API

首页 > API文档 > 物流跟踪API

物流跟踪API

申请API

物流追踪API提供物流订单监控服务，用户将订单内容订阅到快递鸟后，快递鸟对订单进行实时监控，当物流轨迹有更新时，实时获取数据，对数据进行格式化，计算运单预计到达时间、全流程的物流状态、当前所在城市等数据后，推送给用户。监控直到订单签收后结束。

应用场景功能说明使用流程 API参数接入流程 demo下载

应用场景

（1）电商网站用户打开“我的订单”时调用此API显示物流信息详情。
（2）电商管理后台的物流系统，客服在对账前查询所有运单的签收状态，并追踪问题。
（3）适用于日查询量>500次的网站和系统。

功能说明

使用流程

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一致。	是
EBusinessID	String	商户ID，请在我的服务页面查看。	是
RequestType	String	请求指令类型：1008	是
DataSign	String	数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后进行URL(utf-8)编码。详细过程请查看Demo。	是
DataType	String	请求、返回数据类型：2-json；	是

2.推送接口(商户实现)

（1）客户需要按快递鸟要求开发接口，保证信息的正常接收。
（2）快递鸟主动推送时，物流信息接收接口由客户提供。
（3）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（4）运单物流信息全量推送(每次推送的运单物流信息包括运单当前所有的的物流信息)。

请求系统级参数说明：

参数名称	类型	说明	必须要求
RequestData	String	请求内容需进行URL(utf-8)编码。请求内容只支持JSON格式。	是
RequestType	String	101-轨迹查询结果, 107-货款状态	是
DataSign	String	数据内容签名（把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码）	是

二、接口参数

1.订阅接口

请求内容字段定义：

参数		类型	说明	必须要求
Callback		String(50)	用户自定义回调信息	否
MemberID		String(50)	会员标识(备用字段)	否
WareHouseID		String(30)	仓库标识(备用字段)	否
CustomerName		String	电子面单客户账号(与快递网点申请)	否
CustomerPwd		String	电子面单密码	否
SendSite		String	收件网点标识(名称)	否
ShipperCode		String(10)	快递公司编码	是
LogisticCode		String(30)	快递单号	是
OrderCode		String(30)	订单编号	否
MonthCode		String(20)	月结编号	否
PayType		Int	邮费支付方式:1-现付，2-到付，3-月结，4-第三方支付	否
ExpType		String(2)	快递类型：1-标准快件	否
Cost		Double(5)	快递运费	否
OtherCost		Double(5)	其他费用	否
Receiver	Company	String(30)	收件人公司	否
	Name	String(30)	收件人	是
	Tel	String(20)	电话(电话与手机，必填一个)	是
	Mobile	String(20)	手机	是
	PostCode	String(10)	收件人邮编	否
	ProvinceName	String(20)	收件省（如广东省，不要缺少“省”）	是
	CityName	String(20)	收件市（如深圳市，不要缺少“市”）	是
	ExpAreaName	String(20)	收件区（如福田区，不要缺少“区”或“县”）	是
	Address	String(100)	收件人详细地址	是
Sender	Company	String(30)	发件人公司	否
	Name	String(30)	发件人	是
	Tel	String(20)	手机与电话必填一个	是
	Mobile	String(20)	发件人手机	是
	PostCode	String	发件人邮编	否
	ProvinceName	String(20)	发件省（如广东省，不要缺少“省”）	是
	CityName	String(20)	发件市（如深圳市，不要缺少“市”）	是
	ExpAreaName	String(20)	发件区（如福田区，不要缺少“区”或“县”）	是
	Address	String(100)	发件人详细地址	是
IsNotice		Int(1)	是否通知快递员上门揽件：0-通知;1-不通知;默认为1	否
StartDate		String	上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有时间格式相同	否
EndDate		String	上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有时间格式相同	否
Weight		Double	包裹总重量kg	否
Quantity		Int(2)	件数/包裹数	否
Volume		Double	物品总体积m3	否
Remark		String(60)	备注	否
IsSendMessage		Int(1)	是否订阅短信：0-不需要；1-需要	否
AddService(数组形式)
AddService	Name	String(20)	增值服务名称	否
	Value	String(30)	增值服务值	否
	CustomerID	String(30)	客户标识(选填)	否
Commodity(数组形式)
Commodity	GoodsName	String(100)	商品名称	否
	GoodsCode	String(20)	商品编码	否
	Goodsquantity	Int(5)	件数	否
	GoodsPrice	Double(10)	商品价格	否
	GoodsWeight	Double	商品重量kg	否
	GoodsDesc	String(50)	商品描述	否
	GoodsVol	Double	商品体积m3	否

返回参数定义：

参数名称	类型	说明	必须要求
EBusinessID	String	用户ID	是
UpdateTime	String	更新时间 YYYY-MM-DD HH24:MM:SS	是
Success	Bool	成功与否：true，false	是
Reason	String(50)	失败原因	否
EstimatedDeliveryTime	String	订单预计到货时间yyyy-mm-dd（即将上线）	否

2.推送接口

应用级输入参数

参数名称	类型	说明	必须要求
EBusinessID	String	用户电商ID	是
PushTime	String	推送时间	是
Count	String	推送物流单号轨迹个数	是
Data	String	推送物流单号轨迹集合	是

订阅查询结果（RequestType：101）

通过轨迹查询（订阅查询）接口订阅到快递鸟的数据，快递鸟推送时，会将推送的RequestType的值置为101，同时返回下列数据

请求内容字段定义:

参数			类型	说明	必须要求
Data	EBusinessID		String	商户ID	否
	ShipperCode		String	快递公司编码	是
	LogisticCode		String	快递单号	R
	Success		Bool	成功与否：true,false	是
	Reason		String	失败原因	否
	State		String	物流状态: 0-无轨迹，1-已揽收，2-在途中，3-签收,4-问题件	是
	CallBack		String	订阅接口的Bk值	否
	Traces
	Traces	AcceptTime	String	时间	是
		AcceptStation	String	描述	是
		Remark	String	备注	否
	EstimatedDeliveryTime		String	预计到达时间yyyy-mm-dd	否

货款状态（RequestType：107）

用户通过电子面单使用快递鸟货到付款等金融服务时，快递鸟会将该订单的金融状态通过接口推送给用户。

请求内容字段定义:

参数名称		类型	说明	必须要求
Data	EBusinessID	String	用户电商ID	否
	OrderCode	String	订单编号	否
	ShipperCode	String	快递公司编码	是
	LogisticCode	String	物流运单号	是
	Success	Bool	成功与否	是
	Reason	String	失败原因	否
	State	String	物流状态:0-无轨迹,1-已揽收, 2-在途中 201-到达派件城市，3-签收,4-问题件	是
	CallBack	String	订阅接口的Bk值	否
	OrderState	String	订单货款状态：1-待出款；2-已出款；3-已收款	否
	AccountName	String	返款银行卡开户人（例：*伟、佳）	否
	AccountTel	String	返款银行卡手机末四位	否
	AccountNum	String	返款银行卡末四位	否

返回参数定义

参数名称	类型	说明	必须要求
EBusinessID	String	用户ID	是
UpdateTime	String	时间	是
Success	Bool	成功与否：true，false	是
Reason	String	失败原因	否

三、示例

订阅接口

请求示例 JSON

{
    "ShipperCode":"SF",
    "OrderCode":"SF201608081055208281",
    "LogisticCode":"3100707578976",
    "PayType":"1",
    "ExpType":"1",
    "CustomerName":"",
    "CustomerPwd":"",
    "MonthCode":"",
    "IsNotice":"0",
    "Sender":{
        "Name":"1255760",
        "Tel":"",
        "Mobile":"13700000000",
        "ProvinceName":"广东省",
        "CityName":"深圳市",
        "ExpAreaName":"福田区",
        "Address":"测试地址"
    },
    "Receiver":{
        "Name":"1255760",
        "Tel":"",
        "Mobile":"13800000000",
        "ProvinceName":"广东省",
        "CityName":"深圳市",
        "ExpAreaName":"龙华新区",
        "Address":"测试地址2"
    },
    "Commodity":[
        {
            "GoodsName":"书本"
        }
    ]
}

返回示例 JSON

{
        "EBusinessID": "1151847",
        "UpdateTime": "2016-08-09 16:42:38",
        "Success": true,
        "Reason": ""
        }

推送接口(商户实现)

请求示例 JSON (订阅查询结果)

{
        "EBusinessID": "1109259",
        "Count": "2",
        "PushTime": "2015-3-11 16:21:06",
        "Data": [
            {
                "EBusinessID": "1109259",
                "OrderCode": "",
                "ShipperCode": "EMS",
                "LogisticCode": "5042260908504",
                "Success": true,
                "Reason": "",
                "State": "2",
                "CallBack": "0",
                "Traces": [
                    {
                        "AcceptTime": "2015-03-06 21:16:58",
                        "AcceptStation": "深圳市横岗速递营销部已收件，（揽投员姓名：钟定基;联系电话：）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-07 14:25:00",
                        "AcceptStation": "离开深圳市 发往广州市",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-08 00:17:00",
                        "AcceptStation": "到达广东速递物流公司广航中心处理中心（经转）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-08 01:15:00",
                        "AcceptStation": "离开广州市 发往北京市（经转）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-09 09:01:00",
                        "AcceptStation": "到达北京黄村转运站处理中心（经转）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-09 18:39:00",
                        "AcceptStation": "离开北京市 发往呼和浩特市（经转）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-10 18:06:00",
                        "AcceptStation": "到达  呼和浩特市 处理中心",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-11 09:53:48",
                        "AcceptStation": "呼和浩特市邮政速递物流分公司金川揽投部安排投递（投递员姓名：安长虹;联系电话：18047140142）",
                        "Remark": ""
                    }
                ]
            },
            {
                "EBusinessID": "1109259",
                "OrderCode": "",
                "ShipperCode": "EMS",
                "LogisticCode": "5042260943004",
                "Success": true,
                "Reason": "",
                "State": "2",
                "CallBack": "0",
                "Traces": [
                    {
                        "AcceptTime": "2015-03-07 15:26:09",
                        "AcceptStation": "深圳市横岗速递营销部已收件，（揽投员姓名：周宏彪;联系电话：13689537568）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-08 16:32:00",
                        "AcceptStation": "离开深圳市 发往广州市",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-09 00:58:00",
                        "AcceptStation": "到达广东速递物流公司广航中心处理中心（经转）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-09 01:15:00",
                        "AcceptStation": "离开广州市 发往北京市（经转）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-10 05:20:00",
                        "AcceptStation": "到达北京黄村转运站处理中心（经转）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-10 11:59:00",
                        "AcceptStation": "离开北京市 发往廊坊市（经转）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-10 14:23:00",
                        "AcceptStation": "到达廊坊市处理中心（经转）",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-11 08:55:00",
                        "AcceptStation": "离开廊坊市 发往保定市（经转）",
                        "Remark": ""
                    }
                ]
            }
        ]
    }

请求示例 JSON格式 (货款状态)

{
              "EBusinessID": "1109259",
              "Count": "2",
              "PushTime": "2015-3-11 16:21:06",
              "Data": [
                  {
                      "EBusinessID": "1109259",
                      "OrderCode": "",
                      "ShipperCode": "EMS",
                      "LogisticCode": "5042260908504",
                      "Success": true,
                      "Reason": "",
                      "State": "2",
                      "CallBack": "0",
                      "OrderState":"1",
                      "AccountName":"张三",
                      "AccountTel":"13800000000",
                      "AccountNum":"0321"
                  },
                  {
                      "EBusinessID": "1109259",
                      "OrderCode": "",
                      "ShipperCode": "EMS",
                      "LogisticCode": "5042260908522",
                      "Success": true,
                      "Reason": "",
                      "State": "2",
                      "CallBack": "0",
                      "OrderState":"1",
                      "AccountName":"张三",
                      "AccountTel":"13800000011",
                      "AccountNum":"0321"
                  }
              ]
          }

返回示例 JSON

{
        "EBusinessID": "1151847",
        "UpdateTime": "2016-08-09 16:42:38",
        "Success": true,
        "Reason": ""
        }

接入流程

demo下载

接口接入技术文档
物流跟踪接口Demo工具.NET版

物流跟踪接口Demo工具.NODE.JS版

快递鸟一次性对接2000+物流接口

相关文档与更多帮助？

热门产品

解决方案

接口API

关于我们

友情链接