YesApi 接口文档

3720 快递鸟-即时查询API

接口路径(新)：http://api.yesapi.cn/api/App/KdAPI/Track

接口路径(旧)：http://api.yesapi.cn/?s=App.KdAPI.Track

接口描述： 快递鸟API，物流查询API提供实时查询物流轨迹的服务，用户提供运单号和快递公司，即可查询当前时刻的最新物流轨迹。使用前请先配置快递鸟API。支持部分快递公司，可免费查询500次。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
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","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
ShipperCode字符串必须最小：1快递公司编码，如：EMS物流单号应选择快递公司编码（EMS），查看快递公司编码。注意：主流快递仅支持申通快递、圆通速递、百世快递、天天快递 4 家，不支持 EMS、邮政 快递包裹、顺丰速运、韵达速递、京东快递、中通快递。
LogisticCode字符串必须最小：1物流单号，按照运单号查询(单个查询)
OrderCode字符串可选订单编号

客户端请求示例

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

HTTP通用示例 
// 请求
{你的接口域名}/?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表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
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字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

3721 快递鸟-快递查询API

接口路径(新)：http://api.yesapi.cn/api/App/KdAPI/TrackExpress

接口路径(旧)：http://api.yesapi.cn/?s=App.KdAPI.TrackExpress

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

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
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","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • 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 为其他快递时，不填

客户端请求示例

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

HTTP通用示例 
// 请求
{你的接口域名}/?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表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
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字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

特别注意：当前 api.yesapi.cn 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次