乐趣区

关于前端:快递100快递信息查询订阅推送跟踪API接口案例代码

jiezi

一、订阅接口

1.1 订阅申请地址

<p>https://poll.kuaidi100.com/poll</p>

1.2 订阅申请类型

post

1.3 订阅输出参数

申请参数（header）

名称 类型 默认值
Content-Type string application/x-www-form-urlencoded

申请参数（body）

名称 类型 是否必须 示例值 形容
schema String 是 json 返回的数据格式
Θparam param 是 ​ 由其余字段拼接
└ company String 是 ems 订阅的快递公司的编码，一律用小写字母
└ number String 是 1136281381675 订阅的快递单号，单号的最大长度是 32 个字符 <u> 下载编码表格 </u>
└ from String 否 广东省深圳市南山区 出发地城市，省 - 市 - 区，非必填，填了有助于晋升签收状态的判断的准确率，请尽量提供
└ to String 否 北京市朝阳区 目的地城市，省 - 市 - 区，非必填，填了有助于晋升签收状态的判断的准确率，且达到目的地后会加大监控频率，请尽量提供
└ key String 是 ​ 受权码，请申请企业版获取
Θparameters parameters 是 ​ 附加参数信息
└- callbackurl String 是 ​ 回调接口的地址
└- salt String 否 XXXXXXXXXX 签名用随机字符串
└- resultv2 String 否 1 增加此字段示意关上行政区域解析性能
└- autoCom String 否 1 增加此字段且将此值设为 1，则示意开始智能判断单号所属公司的性能，开启后，company 字段可为空, 即只传运单号（number 字段），我方收到后会依据单号判断出其所属的快递公司（即 company 字段）。倡议只有在无奈晓得单号对应的快递公司（即 company 的值）的状况下才开启此性能
└- interCom String 否 1 增加此字段示意开启国际版，开启后，若订阅的单号（即 number 字段）属于国内单号，会返回登程国与目标国两个国家的跟踪信息，本性能临时只反对邮政体系（国内类的邮政小包、EMS）内的快递公司，若单号我方辨认为非国内单，即便增加本字段，也不会返回 destResult 元素组
└- departureCountry String 否 CN 登程国家编码
└- departureCom String 否 ems 登程的快递公司的编码
└- destinationCountry String 否 JP 目标国家编码
└- destinationCom String 否 japanposten 目标的快递公司的编码
└- phone String 否 13488888888 收、寄件人的电话号码（手机和固定电话均可，只能填写一个，顺丰单号必填，其余快递公司选填。如座机号码有分机号，分机号无需上传。）

1.4 订阅申请参数示例 

    schema = json
    param = {
        "company": "ems",
        "number": "1136281381675",
        "from": "广东省深圳市南山区",
        "to": "北京市朝阳区",
        "key": "XXX",
        "parameters": {
            "callbackurl": "您的回调接口的地址，如 http://www. 您的域名.com/kuaidi?callbackid=...",
            "salt": "XXXXXXXXXX",
            "resultv2": "1",
            "autoCom": "1",
            "interCom"："1",
            "departureCountry": "CN",
            "departureCom": "ems",
            "destinationCountry": "JP",
            "destinationCom": "japanposten"
        }
    }

1.5 订阅返回信息代码含意

result: true 示意胜利，false 示意失败

信息代码 信息内容形容 起因及倡议解决形式
200 提交胜利 订阅提交胜利
500 服务器谬误 快递 100 的服务器出理间隙或临时性异样，有时如果因为不按标准提交申请，比方快递公司参数写错等，也会报此谬误
501 反复订阅 此单曾经订阅胜利且目前还在跟踪过程中。若要提交屡次订阅，请在收到单号的 status=abort 或 shutdown 后隔半小时再提交订阅
502 提交内容含有敏感关键字，被平安防护拦挡 回调地址、提交内容蕴含敏感词，请分割快递 100 工作人员
600 您不是非法的订阅者（即受权 Key 出错） 账号无可用单量，须要充值
601 POLL: KEY 已过期 账号无可用单量，须要充值
700 不反对的快递公司 回绝订阅的快递公司，查看快递公司编码是否有误
701 订阅方的订阅数据存在谬误（如不反对的快递公司、单号为空、单号超长等）或谬误的回调地址 请查看快递公司编码、对照技术文档查看参数、在后盾调试工具测试回调地址
702 POLL: 辨认不到该单号对应的快递公司 快递公司编码谬误或者无可用单量，须要充值

1.6 订阅返回示例（JSON 格局）

{
    "result": true,
    "returnCode": "200",
    "message": "提交胜利"
}

二、推送接口

2.1 推送申请地址

由贵司在订阅申请中通过 callbackurl 字段提供

2.2 推送申请类型

post

2.3 推送输出参数

申请参数（header）

名称 类型 默认值
Content-Type string application/x-www-form-urlencoded

申请参数（body）

名称 类型 示例值 形容
sign String ​ 订阅参数 salt 值不为空时，推送数据将蕴含该加密签名，加密形式：md5(param+salt)
Θparam ​ ​ 由其余字段拼接
└ status String polling 监控状态:polling: 监控中，shutdown: 完结，abort: 停止，updateall：从新推送。其中当快递单为已签收时 status=shutdown，当 message 为“3 天查问无记录”或“60 天无变动时”status= abort，对于 status=abort 的状态，须要减少额定的解决逻辑
└ billstatus String got 包含 got、sending、check 三个状态，因为意义不大，已弃用，请疏忽
└ message String ​ 监控状态相干音讯，如:3 天查问无记录，60 天无变动
└ autoCheck String 1 快递公司编码是否出错，0 为本推送信息对应的是贵司提交的原始快递公司编码，1 为本推送信息对应的是我方纠正后的新的快递公司编码。一个单如果咱们间断 3 天都查不到后果，我方会（1）判断一次贵司提交的快递公司编码是否正确，如果正确，给贵司的回调接口（callbackurl）推送带有如下字段的信息：autoCheck=0、comOld 与 comNew 都为空；（2）如果贵司提交的快递公司编码出错，咱们会帮忙用正确的快递公司编码 + 原来的运单号从新提交订阅并开启监控（后续如果监控到单号有更新就给贵司的回调接口（callbackurl）推送带有如下字段的信息：autoCheck=1、comOld= 原来的公司编码、comNew= 新的公司编码）；并且给贵方的回调接口（callbackurl）推送一条含有如下字段的信息：status=abort、autoCheck=0、comOld 为空、comNew= 纠正后的快递公司编码。
└ comOld String yuantong 贵司提交的原始的快递公司编码。具体见 autoCheck 后阐明。若开启了国际版（即在订阅申请中减少字段 interCom=1），则回调申请中暂无此字段
└ comNew String ems 我司纠正后的新的快递公司编码。具体见 autoCheck 后阐明。若开启了国际版（即在订阅申请中减少字段 interCom=1），则回调申请中暂无此字段
ΘlastResult lastResult ​ 最新查问后果，若在订阅报文中通过 interCom 字段开明了国际版，则此 lastResult 示意登程国的查问后果，全量，倒序（即工夫最新的在最前）
└- message String ​ 音讯体，请疏忽
└- state String 0 快递单以后状态，包含 0 在途，1 揽收，2 疑难，3 签收，4 退签，5 派件，6 退回，7 转单，10 待清关，11 清关中，12 已清关，13 清关异样，14 收件人拒签等 13 个状态
└- status String 200 通信状态，请疏忽
└- condition String F00 快递单明细状态标记，暂未实现，请疏忽
└- ischeck String 0 是否签收标记
└- com String yuantong 快递公司编码, 一律用小写字母
└- nu String V030344422 单号
└- data Object ​ 数组，蕴含多个对象，每个对象字段如开展所示
└– context String 上海分拨核心 / 装件入车扫描 内容
└– time String 2012-08-28 16:33:19 工夫，原始格局
└– ftime String 2012-08-28 16:33:19 格式化后工夫
└– status String 在途 本数据元对应的签收状态。在订阅接口中提交 resultv2 = 1 字段后才会呈现
└– areaCode String 310000000000 本数据元对应的行政区域的编码，在订阅接口中提交 resultv2 = 1 字段后才会呈现
└– areaName String 上海市 本数据元对应的行政区域的名称，在订阅接口中提交 resultv2 = 1 字段后才会呈现
Θ destResult destResult ​ 示意最新的目标国家的查问后果，只有在订阅报文中通过 interCom= 1 字段开明了国际版才会显示此数据元，全量，倒序（即工夫最新的在最前）
└- message String ​ 音讯体，请疏忽
└- state String 0 快递单以后状态，包含 0 在途，1 揽收，2 疑难，3 签收，4 退签，5 派件，6 退回等 8 个状态
└- status String 200 通信状态，请疏忽
└- condition String F00 快递单明细状态标记，暂未实现，请疏忽
└- ischeck String 0 是否签收标记
└- com String yuantong 快递公司编码, 一律用小写字母
└- nu String V030344422 单号
Θ data data ​ 数组，蕴含多个对象，每个对象字段如开展所示
└– context String 上海分拨核心 / 装件入车扫描 内容
└– time String 2012-08-28 16:33:19 工夫，原始格局
└– ftime String 2012-08-28 16:33:19 格式化后工夫
└– status String 在途 本数据元对应的签收状态，在订阅接口中提交 resultv2 = 1 字段后才会呈现
└– areaCode String 310000000000 本数据元对应的行政区域的编码，在订阅接口中提交 resultv2 = 1 字段后才会呈现
└– areaName String 上海市 本数据元对应的行政区域的名称，在订阅接口中提交 resultv2 = 1 字段后才会呈现

2.4 推送输出参数示例 

param = {
    "status": "polling",
    "billstatus": "got",
    "message": "",
    "autoCheck": "1",
    "comOld": "yuantong",
    "comNew": "ems",
    "lastResult": {
        "message": "ok",
        "state": "0",
        "status": "200",
        "condition": "F00",
        "ischeck": "0",
        "com": "yuantong",
        "nu": "V030344422",
        "data": [
        {
                "context": "上海分拨核心 / 装件入车扫描",
                "time": "2012-08-28 16:33:19",
                "ftime": "2012-08-28 16:33:19",
                "status": "在途",
                "areaCode": "310000000000",
                "areaName": "上海市"
            },
            {
                "context": "上海分拨核心 / 下车扫描",
                "time": "2012-08-27 23:22:42",
                "ftime": "2012-08-27 23:22:42",
                "status": "在途",
                "areaCode": "310000000000",
                "areaName": "上海市"
            }
        ]
    },
    "destResult": {
        "message": "ok",
        "state": "0",
        "status": "200",
        "condition": "F00",
        "ischeck": "0"     ,
        "com": "speedpost",
        "nu": "EX015142583SG",
        "data": [
        {
                "context": "[01000]Final delivery Delivered to: SLOVESNOV",
                "time": "2016-05-24 14:00:00",
                "ftime": "2016-05-24 14:00:00",
                "status": "签收",
                "areaCode": null,
                "areaName": null
            }
        ]
    }
}

2.5 运单签收状态服务阐明

状态值 名称 含意
0 在途 快件处于运输过程中
1 揽收 快件已由快递公司揽收
2 疑难 快递 100 无奈解析的状态，或者是须要人工染指的状态，比方说收件人电话谬误。
3 签收 失常签收
4 退签 货物退回发货人并签收
5 派件 货物正在进行派件
6 退回 货物正处于返回发货人的途中
7 转投 货物转给其余快递公司邮寄
10 待清关 货物期待清关
11 清关中 货物正在清关流程中
12 已清关 货物已实现清关流程
13 清关异样 货物在清关过程中出现异常
14 拒签 收件人明确拒收

2.6 推送响应报文及错误码解释

字段名称 字段含意
result true 示意胜利，false 示意失败。如果提交回调接口的地址失败，30 分钟后从新回调，3 次仍旧失败的，主动放弃
returnCode 200: 提交胜利 500: 服务器谬误 其余谬误请自行定义
message 返回的提醒

2.7 推送返回示例

当我方调用贵方的回调接口（callbackurl）时，贵方须要先将我方提交的数据保留至贵方的数据库，接着向我方返回是否胜利接管的响应报文及代码，即贵公司间接在回调接口的地址的 response 中填写如下内容：

{
    "result":true,
    "returnCode":"200",
    "message":"胜利"
}

留神：对于 status= abort（message 中蕴含“3 天查问无记录”或者“60 天无变动”）的快递单，也须要返回胜利接管的响应报文及代码。

三、快递公司编码

<u> 下载表格 </u>

四、demo 下载

<u>JAVA 示例代码 </u>    <u>PHP 示例代码 </u>    <u>PYTHON 示例代码 </u>    <u>.NET 示例代码 </u>

一、快递信息推送 API 产品介绍

快递 100 信息推送服务提供运单查问、追踪的性能，用于企业对寄出的物品进行物流追踪。

信息推送服务是企业提交快递单号，快递 100 接管到后便对这些运单进行跟踪，当运单状态发生变化的时候，快递 100 便通过调用回调接口将运单的跟踪信息推送给贵公司，直到这些运单号的生命周期完结（个别以“已签收”为准）。对于某个单号，当贵方正确提交订阅了后，咱们个别会在 15 分钟左右后进行第一次监控，如果监控到单号自身有了跟踪信息，即进行第一次推送，否则期待下一次监控。尔后咱们个别每 4 小时进行一次监控，并会依据单号的状态等因素作调整。

二、快递信息推送 API 利用场景

  1. 让顾客登录您的网站、APP、小程序后，间接在“我的订单”页面内就能看到订单的物流状态。
  2. 能开发主动的、批量查单功能，主动筛选出“已签收”、“疑难件”等状态的单号，加重跟单人员的压力。
  3. 扭转订单的状态与交易流程，例如只有运单号变为“已签收”，就能让订单变更为能够确认退换货等。
  4. 核销销售人员，依据“已签收”的运复数，就能算出销售人员的业绩。
  5. 评估与抉择快递公司，可取得快递理论在途工夫，评估快递公司的时效，优化快递抉择；
  6. 助结算运费，找出“已签收”的单及签收工夫，便能轻松应答货到付款的结算与对账。

三、系统结构与流程

<img src=”https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/129503f13de14bf68893fc7527827a89~tplv-k3u1fbpfcp-zoom-1.image” alt=”img” style=”zoom: 67%;” />

四、快递信息推送 API 费用结算

1. 免费形式

快递信息推送接口属于查问类接口，企业注册快递 100 账号后能够在企业治理后盾查看查问类接口套餐查看查问类接口套餐并购买。

2. 免费价格

查问类接口预充值免费套餐：充值即可开明应用，无需合同流程。

价格 / 元 单量 赠送 / 单 单价 / 元
2000 20000 5000 0.08
1000 10000 2000 约 0.083
500 5000 500 约 0.09

查问类接口按单免费，一个天然月内同一个运单屡次查问只收一次费用。

官网源文档：

https://api.kuaidi100.com/document/5f0ffa7f2977d50a94e1023b.html

https://api.kuaidi100.com/document/5eb9f79186b0df4188313a0d.html

https://api.kuaidi100.com/document/5f0ffa8f2977d50a94e1023c.html

退出移动版