小白接口

3721 快递鸟-快递查询API App.KdAPI.TrackExpress

接口地址:http://open.phalapi.net/?s=App.KdAPI.TrackExpress

接口描述: 快递查询API,供小程序、APP、需实时返回物流轨迹信息即查即走,快递查询将提供输入运单编号立即获取物流最新轨迹,无需快递编码,自动识别物流公司,返回物流轨迹。使用前请先配置快递鸟API支持大部分快递公司,需要开通快递鸟官方套餐后使用。

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试    添加收藏    直接访问接口    我要调整此接口


接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数 动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包
如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。 企业版支持专属签名算法定制。
uuid字符串可选最大:32公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。
token字符串可选最小:64;最大:64公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World"}
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}
ShipperCode字符串必须最小:1快递公司编码,如:EMS物流单号应选择快递公司编码(EMS),查看快递公司编码
LogisticCode字符串必须最小:1物流单号,按照运单号查询(单个查询)
OrderCode字符串可选订单编号
CustomerName字符串可选ShipperCode 为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字+字母+数字,9 位数字加一个字母,共10 位,举例:001K123450;ShipperCode 为SF,且快递单号非快递鸟渠道返回时,必填,对应收件人/寄件人手机号后四位;ShipperCode 为SF,且快递单号为快递鸟渠道返回时,不填;ShipperCode 为其他快递时,不填

在线测试

参数是否必填
s 必须
uuid 可选
token 可选
return_data 可选
ShipperCode 必须
LogisticCode 必须
OrderCode 可选
CustomerName 可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

// 请求
{你的接口域名}/?s=App.KdAPI.Track&return_data=0&ShipperCode=JD&LogisticCode=JD0027305472696

// 返回(有物流轨迹的)
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "KdAPI": {
            {
                "EBusinessID": "1109259",
                "OrderCode": "",
                "ShipperCode": "SF",
                "LogisticCode": "118461988807",
                "Success": true,
                "State": 3,
                "Reason": null,
                "Traces": [
                {
                    "AcceptTime": "2014/06/25 08:05:37",
                    "AcceptStation": "正在派件..(派件人:邓裕富,电话:18718866310)[深圳 市]",
                    "Remark": null
                },
                {
                    "AcceptTime": "2014/06/25 04:01:28",
                    "AcceptStation": "快件在 深圳集散中心 ,准备送往下一站 深圳 [深圳市]",
                    "Remark": null
                }
                ]
            }
        }
    }
    ,
    "msg": "V3.3.0 YesApi App.KdAPI.Track"
}


// 返回 异常
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "KdAPI": {
            "LogisticCode": "4308067010027",
            "ShipperCode": "YD",
            "Traces": [],
            "State": "0",
            "EBusinessID": "1684491",
            "Reason": "业务错误[不支持当前快递公司的查询]",
            "Success": false
        }
    },
    "msg": "V3.3.0 YesApi App.KdAPI.Track"
}

接口使用帮助说明

小白君正在拼命补充中……

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.KdAPI对象快递鸟API返回的结果
data.KdAPI.EBusinessID字符串用户ID
data.KdAPI.OrderCode字符串订单编号
data.KdAPI.ShipperCode字符串快递公司编码
data.KdAPI.LogisticCode字符串物流运单号
data.KdAPI.Successbool成功与否
data.KdAPI.Reason字符串失败原因
data.KdAPI.State字符串物流状态:2-在途中,3-签收,4-问题件
data.KdAPI.Traces字符串跟踪情况
data.KdAPI.Traces[].AcceptTime字符串时间
data.KdAPI.Traces[].AcceptStation字符串描述
data.KdAPI.Traces[].Remark字符串备注
msg字符串提示信息,面向技术人员的帮助或错误提示信息

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求非法请求,参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 404客户端非法请求接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 500小白接口异常如果出现此错误,请联系技术人员处理1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复
ret = 401客户端非法请求用户未登录,或登录凭证已过期1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口
ret = 406客户端非法请求非法app_key,请核对你所在的接口域名1、在我的套餐查看并核对接口域名
ret = 407客户端非法请求当前应用已过期1、进行续费或续约,延长应用有效期
ret = 408客户端非法请求当前应用存在异常,已被封号1、联系在线客服人工处理
ret = 409客户端非法请求签名错误1、使用在线测试,校正签名;2、关闭特定或全部签名设置;3、如果过期,可以进行续约/升级
ret = 410客户端非法请求权限不足,非系统管理员1、应用权限不足,可联系在线客服咨询沟通
ret = 411客户端非法请求权限不足,应用管理员未登录1、请提供应用管理员的admin_uuid和admin_token参数后重试
ret = 412客户端非法请求权限不足,非应用管理员1、请在果创云把会员设置为管理员
ret = 413客户端非法请求本月接口流量超出,已被临时冻结1、开通接口流量叠加包,或升级套餐
ret = 414客户端非法请求并发过高1、请降低请求频率,检测是否有死循环调用,或是否被他人恶意使用。如果流量确实很大,可联系在线客服进行定制化或私有云部署。
ret = 415客户端非法请求接口已被开发者关闭1、接口已被开发者关闭,请进入果创云接口开关重新开启
ret = 416客户端非法请求权限不足,个人免费版套餐无法使用专业版接口1、请先升级终身会员/标准版/旗舰版/企业版

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。