1.功能描述
用于实时查询快递单号的物流信息;补充"物流信息推送"接口;
2.接口信息
请求地址 | b.kuaidi100.com/v7/open/api… |
通信协议 | HTTPS |
请求方式 | POST |
字符集 | UTF-8 |
请求Conent-Type | application/x-www-form-urlencoded |
3.接口规则
1.在快递管家官网——API服务中购买了“推送服务”才能调用此接口;
2.第一次查询后,当物流信息有更新时,系统将自动推送全量信息到回调URL;
3.请求次数不超过100次/分钟;
4.请求参数
名称 | 类型(字符长度) | 是否必填 | 描述 |
---|---|---|---|
app_key | String | 是 | 由快递100提供,接入应用的唯一标识 ([快递管家官网API服务],管理中的App Key) |
access_token | String | 是 | 授权注册时获取的access_token(访问令牌) |
timestamp | long | 是 | 时间戳,自1970年01月01日起到现在的秒数, 例: 1502963129 |
sign | String | 否 | 签名,签名算法参照【签名说明】 |
data | String | 是 | Json字符串 |
└kuaidi_com | String(30) | 是 | 快递公司编码 |
└kuaidi_num | String(30) | 是 | 快递单号 |
└mobile | String(20) | 否 | 收/寄件人手机号码,kuaidi_com为shunfeng 时必填,为其他时选填; |
└addr | String(100) | 否 | 收件人详细地址 |
└api_pay_mode | String(10) | 否 | API的扣费模式,默认:SINGLE 直接使用者付费(如入驻商家): SINGLE 对接服务商统一付费(如电商平台):STANDARD |
示例:
app_key=LeWFeuaGwdf&access_token=uoKbfafdfafcCce×tamp=1502963129&sign=3CF35D130E8B197553ADE1BAEA2615F0&data={
"kuaidi_com": "yuantong",
"kuaidi_num": "YT1234588888888"
}
5.返回参数
名称 | 类型(字符长度) | 是否必填 | 描述 |
---|---|---|---|
status | String(5) | 是 | 200:成功 |
message | String(30) | 是 | 成功 |
data | String | 是 | |
└status | String(30) | 是 | 监控状态: 监控中:polling 结束:shutdown 中止:abort 重新推送:updateall 其中当快递单为已签收时status=shutdown, 当message为“3天查询无记录”或“60天无变 化时”status= abort |
└message | String(30) | 否 | 监控状态相关消息,如:3天查询无记录, 60天无变化 |
└last_result | Object | 是 | 最新查询结果,全量,倒序(即时间最新的在最前) |
└-state | String(30) | 是 | 快递单当前签收状态,包括 0:在途中 1:已揽收 2:疑难 3:已签收 4:退签 5:同城派送中 6:退回 7:转单 |
└-is_check | String(30) | 是 | 是否签收,0:未签收,1:签收 |
└-company_code | String(30) | 是 | 快递公司编码 |
└-com_name | String(30) | 是 | 快递公司名称 |
└-kuaidi_num | String(30) | 是 | 快递单号 |
└-data | Array | 是 | 详细物流信息 |
└--context | String(30) | 是 | 操作说明 |
└--time | String(30) | 是 | 操作时间,原始格式 |
└--f_time | String(30) | 是 | 操作时间,格式化后时间 |
└--status | String(30) | 是 | 本数据元对应的签收状态,包括 0:在途中 1:已揽收 2:疑难 3:已签收 4:退签 5:同城派送中 6:退回 7:转单 |
└--area_code | String(30) | 是 | 本数据元对应的行政区域的编码 |
└--area_name | String(30) | 是 | 本数据元对应的行政区域的名称 |
示例:
{
"status": 200,
"message": "success",
"data":{
"last_result":{
"com_name":"",
"company_code":"yuantong",
"data":[
{
"area_code":null,
"area_name":null,
"context":"客户签收人: 李君 已签收 感谢使用圆通速递,期待再次为您服务 如有疑问请联系:15567291563,投诉电话:0438-6895639",
"f_time":"2020-08-24 13:35:15",
"status":"签收",
"time":"2020-08-24 13:35:15"
},
{
"area_code":"CN220100000000",
"area_name":"吉林,长春市",
"context":"【长春转运中心】 已发出 下一站 【吉林省松原市公司】",
"f_time":"2020-08-23 07:52:16",
"status":"在途",
"time":"2020-08-23 07:52:16"
},
{
"area_code":"CN220100000000",
"area_name":"吉林,长春市",
"context":"【长春转运中心公司】 已收入",
"f_time":"2020-08-23 07:25:47",
"status":"在途",
"time":"2020-08-23 07:25:47"
}
],
"is_check":"1",
"kuaidi_num":"DD2653121064",
"state":"3"
},
"message":"",
"status":"shutdown"
},
"message":"success",
"status":200
}