小白接口

3710 快递100-实时快递查询 App.KuaiDi100.Query

接口地址:http://open.phalapi.net/?s=App.KuaiDi100.Query

接口描述: 客户主动请求接口,根据快递公司编码和快递单号实时请求快递公司单号查询接口,并将获取到的物流轨迹信息封装返回给调用者。依赖于 快递100-实时快递查询接口。使用前请先进行快递100配置

接口标签:免费(每月最高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,欢迎使用小白开放接口!"}
com字符串必须查询的快递公司的编码, 一律用小写字母,点击查看全部快递公司编码。常用快递公司编码有,圆通速递:yuantong、韵达快递:yunda、中通快递:zhongtong、申通快递:shentong、邮政快递包裹:youzhengguonei、百世快递:huitongkuaidi、顺丰速运:shunfeng、京东物流:jd、天天快递:tiantian、EMS:ems、邮政标准快递:youzhengbk、极兔速递:jtexpress、宅急送:zhaijisong、德邦:debangwuliu、德邦快递:debangkuaidi、中通快运:zhongtongkuaiyun、优速快递:youshuwuliu、百世快运:baishiwuliu、韵达快运:yundakuaiyun、安能快运:annengwuliu
num字符串必须最大:32查询的快递单号, 单号的最大长度是32个字符
phone字符串可选收件人或寄件人的手机号或固话(顺丰单号必填,也可以填写后四位,如果是固话,请不要上传分机号)。例如:13800138000
from字符串可选出发地城市,省-市-区,例如:广东省广州市黄埔区
to字符串可选目的地城市,省-市-区,例如:北京市朝阳区
resultv2枚举类型可选1范围:0/1/2添加此字段表示开通行政区域解析功能。0:关闭(默认),1:开通行政区域解析功能,2:开通行政解析功能并且返回出发、目的及当前城市信息
order枚举类型可选范围:asc/desc返回结果排序方式。desc:降序(默认),asc:升序

在线测试

参数是否必填
s 必须
uuid 可选
token 可选
return_data 可选
com 必须
num 必须
phone 可选
from 可选
to 可选
resultv2 可选
order 可选

客户端请求示例

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

请求:
{你的接口域名}/?s=App.KuaiDi100.Query&com=jd&num=JD0019529000000&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "kuaidi": {
            "message": "ok",
            "nu": "JD0019529000000",
            "ischeck": "1",
            "com": "jd",
            "status": "200",
            "data": [
            {
                "time": "2020-06-22 19:06:25",
                "context": "您的快件已签收,感谢您使用京东物流,期待再次为您服务。",
                "ftime": "2020-06-22 19:06:25",
                "areaCode": null,
                "areaName": null,
                "status": "签收"
            },
            {
                "time": "2020-06-22 16:43:27",
                "context": "您的快件正在派送中,请您准备签收(快递员:张三,联系电话:13800138000)",
                "ftime": "2020-06-22 16:43:27",
                "areaCode": null,
                "areaName": null,
                "status": "派件"
            },
            {
                "time": "2020-06-20 12:08:37",
                "context": "货物已交付京东物流",
                "ftime": "2020-06-20 12:08:37",
                "areaCode": null,
                "areaName": null,
                "status": "在途"
            },
            {
                "time": "2020-06-20 12:08:37",
                "context": "尊敬的客户您好,大促期间购物高峰,您的快递可能会延迟配送,我们将全力为您服务,请您耐心等待;",
                "ftime": "2020-06-20 12:08:37",
                "areaCode": null,
                "areaName": null,
                "status": "在途"
            }
            ],
            "state": "3",
            "condition": "F00"
        }
    },
    "msg": "V2.5.1 YesApi App.KuaiDi100.Query"
}

接口使用帮助说明

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

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.kuaidi对象快递查询结果,失败时为null
data.kuaidi.state整型快递单当前状态,包括0在途,1揽收,2疑难,3签收,4退签,5派件,6退回,7转投,10待清关,11清关中,12已清关,13清关异常,14拒签 等13个状态
data.kuaidi.ischeck整型是否签收标记
data.kuaidi.com字符串快递公司编码,一律用小写字母,点击查看快递公司编码
data.kuaidi.nu字符串快递单号
data.kuaidi.data字符串数组,包含多个对象,每个对象字段如展开所示
data.kuaidi.data[].context字符串物流轨迹节点内容
data.kuaidi.data[].time字符串时间,原始格式,如:2012-08-28 16:33:19
data.kuaidi.data[].ftime字符串格式化后时间,如:2012-08-28 16:33:19
data.kuaidi.data[].status字符串本数据元对应的签收状态。
data.kuaidi.data[].areaName字符串本数据元对应的行政区域的名称
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链接里面去掉。