API服务
即时查询API物流跟踪API预约取件API电子面单API单号识别API在途监控API代收货款API隐私快递API
物流跟踪API
申请API
物流追踪API提供物流订单监控服务,用户将订单内容订阅到快递鸟后,快递鸟对订单进行实时监控,当物流轨迹有更新时,实时获取数据,对数据进行格式化,计算运单预计到达时间、全流程的物流状态、当前所在城市等数据后,推送给用户。监控直到订单签收后结束。
免费
应用场景
(1)电商网站用户打开“我的订单”时调用此API显示物流信息详情。
(2)电商管理后台的物流系统,客服在对账前查询所有运单的签收状态,并追踪问题。
(3)适用于日查询量>3000次的网站和系统。
功能说明
使用流程
API参数
一、接口描述/说明
订阅接口
(1)此功能为专业定制,为特殊商户提供订阅服务,快递鸟系统会定时推送新的物流信息到商户系统。
(2)订阅快递号需指定相应的快递公司编码,格式不对或则编码错误都会返失败的信息。
如:EMS物流单号应选择快递公司编码(EMS)查看快递公司编码
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)接口地址: API测试地址:http://testapi.kdniao.cc:8081/api/dist
API正式地址:http://api.kdniao.cc/api/dist
请求系统级参数说明:
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。R
EBusinessIDString商户ID,请在我的服务页面查看。R
RequestTypeString请求指令类型:1008R
DataSignString数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。R
DataTypeString请求、返回数据类型:2-json;R
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
推送接口(商户实现)
(1)客户需要按快递鸟要求开发接口,保证信息的正常接收。
(2)快递鸟主动推送时,物流信息接收接口由客户提供。
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)运单物流信息全量推送(每次推送的运单物流信息包括运单当前所有的的物流信息)。
请求系统级参数说明:
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容只支持JSON格式。R
RequestTypeString101-轨迹查询结果, 107-货款状态R
DataSignString数据内容签名(把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码)R
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
二、接口参数
订阅接口
请求内容字段定义:
参数类型说明必须要求
CallBackString用户自定义回调信息O
MemberIDString会员标识(备用字段)O
CustomerNameString电子面单客户账号(与快递网点申请)O
CustomerPwdString电子面单密码O
SendSiteString收件网点标识O
ShipperCodeString快递公司编码R
LogisticCodeString快递单号R
OrderCodeString订单编号O
MonthCodeString月结编码O
PayTypeInt邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付O
ExpTypeString快递类型:1-标准快件O
CostDouble寄件费(运费)O
OtherCostDouble其他费用O
ReceiverCompanyString收件人公司O
NameString收件人O
TelString电话O
MobileString手机O
PostCodeString收件人邮编O
ProvinceNameString收件省(如广东省,不要缺少“省”)O
CityNameString收件市(如深圳市,不要缺少“市”)O
ExpAreaNameString收件区(如福田区,不要缺少“区”或“县”)O
AddressString收件人详细地址O
SenderCompanyString发件人公司O
NameString发件人O
TelString发件人电话O
MobileString发件人手机O
PostCodeString发件人邮编O
ProvinceNameString发件省(如广东省,不要缺少“省”)O
CityNameString发件市(如深圳市,不要缺少“市”)O
ExpAreaNameString发件区(如福田区,不要缺少“区”或“县”)O
AddressString发件人详细地址O
StartDateString上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同O
EndDateStringO
WeightDouble物品总重量kgO
QuantityInt件数/包裹数O
VolumeDouble物品总体积m3O
RemarkString备注O
IsNoticeInt是否分发到快递公司:1-不分发;0-分发.默认为0O
AddService(数组形式)
AddServiceNameString增值服务名称O
ValueString增值服务值O
CustomerIDString客户标识(选填)O
Commodity(数组形式)
CommodityGoodsNameString商品名称O
GoodsCodeString商品编码O
GoodsquantityInt件数O
GoodsPriceDouble商品价格O
GoodsWeightDouble商品重量kgO
GoodsDescString商品描述O
GoodsVolDouble商品体积m3O
返回参数定义:
参数名称类型说明必须要求
EBusinessIDString用户IDR
UpdateTimeString时间R
SuccessBool成功与否:true,falseR
ReasonString失败原因O
EstimatedDeliveryTimeString订单预计到货时间yyyy-mm-dd(即将上线)O
推送接口
应用级输入参数
参数名称类型说明必须要求
EBusinessIDString用户电商IDR
PushTimeString推送时间R
CountString推送物流单号轨迹个数R
DataString推送物流单号轨迹集合R
订阅查询结果(RequestType:101)
通过轨迹查询(订阅查询)接口订阅到快递鸟的数据,快递鸟推送时,会将推送的RequestType的值置为101,同时返回下列数据
请求内容字段定义:
参数类型说明必须要求
DataEBusinessIDString商户IDO
OrderCodeString订单编号O
ShipperCodeString快递公司编码R
LogisticCodeString快递单号R
SuccessBool成功与否:true,falseR
ReasonString失败原因O
StateString物流状态: 0-无轨迹,1-已揽收,2-在途中 201-到达派件城市,3-签收,4-问题件R
CallBackString订阅接口的Bk值O
Traces
TraceAcceptTimeString时间R
AcceptStationString描述R
RemarkString备注O
EstimatedDeliveryTimeString预计到达时间yyyy-mm-ddO
PickerInfoPersonNameString快递员姓名O
PersonTelString快递员电话O
PersonCodeString快递员工号O
StationNameString网点名称O
StationAddressString网点地址O
StationTelString网点电话O
SenderInfoPersonNameString派件员姓名O
PersonTelString派件员电话O
PersonCodeString派件员工号O
StationNameString派件网点名称O
StationAddressString派件网点地址O
StationTelString派件网点电话O
货款状态(RequestType:107)
用户通过电子面单使用快递鸟货到付款等金融服务时,快递鸟会将该订单的金融状态通过接口推送给用户。
请求内容字段定义:
参数名称类型说明必须要求
DataEBusinessIDString用户电商IDO
OrderCodeString订单编号O
ShipperCodeString快递公司编码R
LogisticCodeString物流运单号R
SuccessBool成功与否R
ReasonString失败原因O
StateString物流状态:0-无轨迹,1-已揽收, 2-在途中 201-到达派件城市,3-签收,4-问题件R
CallBackString订阅接口的Bk值O
OrderStateString订单货款状态:1-待出款;2-已出款;3-已收款O
AccountNameString返款银行卡开户人(例:**伟、*佳)O
AccountTelString返款银行卡手机末四位O
AccountNumString返款银行卡末四位O
返回参数定义
参数名称类型说明必须要求
EBusinessIDString用户IDR
UpdateTimeString时间R
SuccessBool成功与否:true,falseR
ReasonString失败原因O
三、示例
订阅接口
请求示例 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下载
在线咨询
商务合作群:
526574204
技术对接群:
340378554
400-9633321
免费获取API