一、智能时效预估接口
通过收寄件地址、下单时间和业务/产品类型来预估快递可送达的时间,以及过程需要花费的时间,分为全程模式和在途模式。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://api.kuaidi100.com/label/order
1.3 请求参数
请求参数(header)
| 名称 | 类型 | 默认值 |
|---|---|---|
| Content-Type | string | application/x-www-form-urlencoded |
请求参数(body)
| 参数名称 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| method | string | 是 | 业务类型(默认:time) |
| key | string | 是 | 授权码,请申请企业版获取 |
| sign | string | 是 | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret可在企业管理后台中企业信息查看 |
| t | string | 是 | 时间戳如:1576123932000 |
| param | param | 是 | 由其他字段拼接 |
param数据结构:
| 参数名称 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| kuaidicom | string | 是 | 快递公司编码 |
| from | string | 是 | 出发地(地址需包含3级及以上),例如:广东深圳南山区 |
| to | string | 是 | 目的地(地址需包含3级及以上),例如:北京海淀区 |
| orderTime | string | 是 | 下单时间,格式要求yyyy-MM-dd HH:mm:ss, 例如:2023-08-08 08:08:08 |
| expType | string | 否 | 业务或产品类型 |
| logistics | object arrey | 否 | 物流轨迹信息 |
logistics内部object数据结构:
| 参数名称 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| time | string | 否 | 物流轨迹发生时间,例如"2025-05-09 13:15:26" |
| context | string | 否 | 物流轨迹信息,例如"您的快件离开【吉林省吉林市桦甸市】,已发往【长春转运中心】" |
1.4 请求参数示例
全程智能时效预估入参示例:
method = time
key = kytRsteof
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1470304729724
param = {
"from": "深圳南山区金蝶软件园",
"to": "北京海淀区",
"orderTime": "2023-09-14 08:08:08",
"kuaidicom": "shunfeng",
"expType": "标准快递"
}
在途智能时效预估入参示例:
method = time
key = kytRsteof
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1470304729724
param = {
"from": "深圳南山区金蝶软件园",
"to": "北京海淀区",
"orderTime": "2023-09-14 08:08:08",
"kuaidicom": "shunfeng",
"logistics": [
{
"time": "2025-05-09 13:15:26",
"context": "您的快件离开【吉林省吉林市桦甸市】,已发往【长春转运中心】"
},
{
"time": "2025-05-09 12:09:38",
"context": "您的快件在【吉林省吉林市桦甸市】已揽收"
}
]
}
1.5 返回结果
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| success | boolean | 提交结果 | true提交成功,false失败 |
| code | Int | 返回编码 | |
| message | string | 返回报文描述 | |
| data | Object | 响应数据 |
data数据结构:
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| fromName | string | 出发地名称(快递100实际解析的地址) | |
| fromNum | string | 出发地编码 | |
| toName | string | 目的地名称(快递100实际解析的地址) | |
| toNum | string | 目的地编码 | |
| arrivalTime | string | 预计到达时间,格式yyyy-MM-dd HH:mm:ss, 例如:2023-08-08 08:08:08 | |
| deliveryExpendTime | string | 到达需要花费的时间,单位天 | |
| taskId | string | 任务id,建议记录用于后期排查问题 | |
| expType | string | 业务或产品类型 | |
| totalTime | string | 预计到达需要花费的总时间,单位小时 | |
| remainTime | string | 预计到达需要花费的剩余时间,单位小时 | 全程模式预测下和总时间一致,在途模式下返回预测剩余时间 |
| predictedRoute | object arrey | 预估路线 | 包含实际线路和快递100预测的线路节点信息 |
predictedRoute中object数据结构:
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| arriveTime | string | 到达节点时间,例如"2025-05-06 12:03:23" | |
| leaveTime | string | 离开节点时间,例如"2025-05-06 12:33:23" | |
| province | string | 节点所在省,例如"湖北" | |
| city | string | 节点所在市,例如"武汉市" | |
| district | string | 节点所在区,例如"洪山区" | |
| name | string | 节点名称,例如"武汉转运中心" | |
| state | string | 当前节点状态:已经过节点、当前停留节点、预估途径节点 | |
| type | string | 当前节点类型:转运中心、网点 |
1.6 返回结果示例
全程智能时效预估成功返回示例:
{
"code": 200,
"data": {
"fromName": "广东,深圳市,南山区,金蝶软件园",
"fromNum": "440305000000",
"toName": "北京,北京,海淀区,",
"toNum": "110108000000",
"arrivalTime": "2023-09-15 18:00:00",
"deliveryExpendTime": "2",
"taskId": "D9F5EBF5EA114794B681C812304E5CDD",
"totalTime": "67",
"remainTime": "67"
},
"message": "success",
"time": 0,
"success": true
}
在途智能时效预估成功返回示例:
{
"code": 200,
"data": {
"arrivalTime": "2025-05-18 07:18:03",
"deliveryExpendTime": "3",
"fromName": "陕西,商洛市,洛南县,皇城广场",
"fromNum": "611021000000",
"predictedRoutes": [
{
"arriveTime": "2025-05-15 22:14:52",
"city": "商洛市",
"district": "洛南县",
"leaveTime": "2025-05-16 08:51:03",
"name": "陕西省商洛市洛南县",
"province": "陕西",
"state": "已经过节点",
"type": "网点"
},
{
"arriveTime": "2025-05-16 12:09:03",
"city": "咸阳市",
"district": "渭城区",
"leaveTime": "2025-05-16 18:18:03",
"name": "西安转运中心",
"province": "陕西",
"state": "预估途径节点",
"type": "转运中心"
},
{
"arriveTime": "2025-05-18 03:42:03",
"city": "绍兴市",
"district": "上虞区",
"leaveTime": "2025-05-18 04:26:03",
"name": "上虞转运中心",
"province": "浙江",
"state": "预估途径节点",
"type": "转运中心"
},
{
"arriveTime": "2025-05-18 07:40:03",
"city": "绍兴市",
"district": "越城区",
"leaveTime": "2025-05-18 08:22:03",
"name": "浙江省绍兴市城南",
"province": "浙江",
"state": "预估途径节点",
"type": "网点"
}
],
"taskId": "68BBD959F99443F2BEA3618D25942F91",
"toName": "浙江,绍兴市,越城区,灵芝街道境界府4幢1单元1803退货组送门口",
"toNum": "330602000000"
},
"message": "success",
"success": True,
"time": 0
}
错误示例:
{
"code": 30001,
"message": "不支持该快递公司",
"time": 0,
"success": false
}
1.7 信息代码含义
| 信息代码 | 信息内容描述 | 原因及建议处理方式 |
|---|---|---|
| -1 | 服务器错误 | 快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
| 200 | 成功 | 成功 |
| 30001 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填。 |
| 30002 | 验证签名失败 | 检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号 |
| 30003 | 账号信息不正确 | 检查key是否正确 |
| 30005 | 快递公司返回异常 | 按照描述可以自行检查参数的数据类型是否正确 |
二、支持的快递公司列表及业务/产品类型
2.1 全程时效预估支持的快递公司及业务类型
| 快递公司名称 | 快递公司编码 | 业务/产品类型 |
|---|
| 京东 | jd | 京东标快 |
| 京东特快 | ||
| 生鲜标快 | ||
| 跨越 | kuayue | 当天达 |
| 次日达 | ||
| 隔日达 | ||
| 陆运件 | ||
| 同城次日 | ||
| 同城即日 | ||
| 省内次日 | ||
| 省内即日 | ||
| 空运 | ||
| 专运 | ||
| 顺丰 | shunfeng | 顺丰特快 |
| 顺丰标快 | ||
| 陆运包裹 | ||
| 顺丰快运 | shunfengkuaiyun | |
| 中通 | zhongtong | |
| 德邦快递 | debangkuaidi | |
| EMS | ems | |
| EMS-国际件 | emsguoji | |
| 邮政国内 | youzhengguonei | |
| 国际包裹 | youzhengguoji | |
| 申通 | shentong | |
| 圆通 | yuantong | |
| 韵达 | yunda | |
| 宅急送 | zhaijisong | |
| 芝麻开门 | zhimakaimen | |
| 联邦快递 | lianbangkuaidi | |
| 天地华宇 | tiandihuayu | |
| 安能快运 | annengwuliu | |
| 京广速递 | jinguangsudikuaijian | |
| 加运美 | jiayunmeiwuliu | |
| 极兔速递 | jtexpress |
2.2 在途时效预估支持的快递公司
| 快递公司 | 快递公司编码 |
|---|---|
| 中通快递 | zhongtong |
| 圆通速递 | yuantong |
| 韵达快递 | yunda |
| 申通快递 | shentong |
| 极兔速递 | jtexpress |
| 京东物流 | jd |
| 德邦快递 | debangkuaidi |
| 德邦物流 | debangwuliu |
| 顺丰速运 | shunfeng |
| EMS | ems |