当前位置：首页 > article >正文

快递鸟快递查询API接口参数代码

article 2024/11/14 19:28:17

快递查询API，供小程序、APP、需实时返回物流轨迹信息即查即走，快递查询将提供输入运单编号立即获取物流最新轨迹，无需快递编码，自动识别物流公司，返回物流轨迹。

应用场景

（1）在移动端APP、小程序上输入框与查询按钮，实现即时物流信息查询。
（2）在网页上使用输入框与查询按钮，实现即时物流信息查询。
（3）主流快递公司，无需传快递编码，自动识别物流公司返回物流轨迹。

功能说明

使用流程

API参数

一、接口描述/说明

（1）查询接口支持按照运单号查询(单个查询)。
（2）接口需要指定快递单号，格式不对或则编码错误都会返失败的信息。主流13家不需要选择快递公司编码，其他需要选择快递公司编码，查看快递公司编码。
（3）返回的物流跟踪信息按照发生的时间升序排列。
（4）接口指令8002。
（5）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（6）测试地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
（7）正式地址：https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx

请求系统级参数说明：

参数名称	类型	说明	必须要求
RequestData	String	请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。	是
EBusinessID	String	商户ID，请在我的服务页面查看。	是
RequestType	String	请求指令类型：8002	是
DataSign	String	数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后进行URL(utf-8)编码。详细过程请查看Demo。	是
DataType	String	请求、返回数据类型：2-json；	否

二、接口参数

请求内容字段定义：

参数名称	类型	说明	必须要求
OrderCode	String	订单编号	否
CustomerName	String	ShipperCode 为JD，必填，对应京东的青龙配送编码，也叫商家编码，格式：数字＋字母＋数字，9 位数字加一个字母，共10 位，举例：001K123450；ShipperCode 为SF，且快递单号非快递鸟渠道返回时，必填，对应收件人/寄件人手机号后四位；ShipperCode 为SF，且快递单号为快递鸟渠道返回时，不填；ShipperCode 为其他快递时，不填	可选
ShipperCode	String	快递公司编码	否
LogisticCode	String	物流单号	是

返回参数定义：

参数名称	类型	说明	必须要求
EBusinessID	String	用户ID	是
OrderCode	String	订单编号	否
ShipperCode	String	快递公司编码	是
LogisticCode	String	物流运单号	否
Success	Bool	成功与否	是
Reason	String	失败原因	否
State	String	物流状态：0-暂无轨迹信息,1-已揽收,2-在途中,3-签收,4-问题件	是
StateEx	String	增值物流状态： 0-暂无轨迹信息 1-已揽收 2-在途中 201-到达派件城市, 202-派件中, 211-已放入快递柜或驿站, 3-已签收 301-正常签收, 302-派件异常后最终签收, 304-代收签收, 311-快递柜或驿站签收, 4-问题件 401-发货无信息, 402-超时未签收, 403-超时未更新, 404-拒收(退件), 405-派件异常, 406-退货签收, 407-退货未签收, 412-快递柜或驿站超时未取	是
Location	String	所在城市	是
Traces.AcceptTime	String	时间	是
Traces.AcceptStation	String	描述	是
Traces.Action	String	当前状态(同StateEx)	是
Traces.Location	String	所在城市	是
Traces.Remark	String	备注	否

三、示例

请求示例 JSON

{
    "LogisticCode":"772004651594875"
}

返回示例 JSON

没有物流轨迹的
{
    "LogisticCode":"7720046515948751",
    "Traces":[

    ],
    "State":"0",
    "EBusinessID":"1470400",
    "Reason":"暂无轨迹信息",
    "Success":true
}
        有物流轨迹的
{
    "StateEx":"2",
    "LogisticCode":"3103630045838",
    "ShipperCode":"YD",
    "Traces":[
        {
            "Action":"1",
            "AcceptStation":"【深圳市】广东深圳公司中心分拨分部 已揽收",
            "AcceptTime":"2020-06-17 03:31:04",
            "Location":"深圳市"
        },
        {
            "Action":"2",
            "AcceptStation":"【深圳市】已离开 广东深圳公司中心分拨分部；发往 上海分拨中心",
            "AcceptTime":"2020-06-17 03:34:08",
            "Location":"深圳市"
        },
        {
            "Action":"2",
            "AcceptStation":"【深圳市】广东深圳公司 已揽收",
            "AcceptTime":"2020-06-17 03:37:46",
            "Location":"深圳市"
        },
        {
            "Action":"2",
            "AcceptStation":"【深圳市】已到达 广东深圳公司",
            "AcceptTime":"2020-06-17 08:02:33",
            "Location":"深圳市"
        },
        {
            "Action":"2",
            "AcceptStation":"【深圳市】已离开 广东深圳公司；发往 上海分拨中心",
            "AcceptTime":"2020-06-17 08:11:33",
            "Location":"深圳市"
        },
        {
            "Action":"2",
            "AcceptStation":"【深圳市】广东深圳公司福田区水围站分部 已揽收",
            "AcceptTime":"2020-06-17 09:22:25",
            "Location":"深圳市"
        }
    ],
    "State":"2",
    "EBusinessID":"1470400",
    "Success":true,
    "Location":"深圳市"
}