快递信息推送接口
POST
5.1 推送请求地址
由贵司在下单开启订阅功能中通过pollCallBackUrl字段提供
请求参数(body)
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
sign | String | 订阅参数salt值不为null时,推送数据将包含该加密签名,加密方式:md5(param+salt)。注意: salt值为空串时,推送的数据也会包含sign。 | |
Θ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派件,8清关,14拒签等10个基础物流状态,如需要返回高级物流状态,请参考 resultv2 传值 |
└- status | String | 200 | 通讯状态,请忽略 |
└- condition | String | F00 | 快递单明细状态标记,暂未实现,请忽略 |
└- ischeck | String | 0 | 是否签收标记,0未签收,1已签收 |
└- 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或者resultv2=4标记后才会出现 |
└-- statusCode | String | 1002 | 本数据元对应的高级物流状态值,提交resultv2=4标记后才会出现 |
└-- areaCode | String | 310000000000 | 本数据元对应的行政区域的编码,提交resultv2=1或者resultv2=4标记后才会出现 |
└-- areaName | String | 上海市 | 本数据元对应的行政区域的名称,提交resultv2=1或者resultv2=4标记后才会出现 |
└--areaCenter | String | 17.200983,39.084158 | 本数据元对应的行政区域经纬度,提交resultv2=4标记后才会出现 |
└--location | String | 深圳中心 | 本数据元对应的快件当前位置,提交resultv2=4标记后才会出现 |
└--areaPinYin | String | tianjin | 本数据元对应的行政区域拼音,提交resultv2=4标记后才会出现 |
Θ destResult | destResult | 表示最新的目的国家的查询结果,只有在订阅报文中通过interCom=1字段开通了国际版才会显示此数据元,全量,倒序(即时间最新的在最前) | |
└- message | String | 消息体,请忽略 | |
└- state | String | 0 | 快递单当前状态,默认为0在途,1揽收,2疑难,3签收,4退签,5派件,8清关,14拒签等10个基础物流状态,如需要返回高级物流状态,请参考 resultv2 传值 |
└- status | String | 200 | 通讯状态,请忽略 |
└- condition | String | F00 | 快递单明细状态标记,暂未实现,请忽略 |
└- ischeck | String | 0 | 是否签收标记,0未签收,1已签收 |
└- 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或者resultv2=4标记后才会出现 |
└-- areaCode | String | 310000000000 | 本数据元对应的行政区域的编码,提交resultv2=1或者resultv2=4标记后才会出现 |
└-- areaName | String | 上海市 | 本数据元对应的行政区域的名称,提交resultv2=1或者resultv2=4标记后才会出现 |
└--areaCenter | String | 17.200983,39.084158 | 本数据元对应的行政区域经纬度,提交resultv2=4标记后才会出现 |
└--location | String | 深圳中心 | 本数据元对应的快件当前位置,提交resultv2=4标记后才会出现 |
└--areaPinYin | String | tianjin | 本数据元对应的行政区域拼音,提交resultv2=4标记后才会出现 |
5.5 运单签收状态服务说明
物流状态值 | 物流状态名称 | 高级物流状态值 | 高级物流状态名称 | 含义 |
---|---|---|---|---|
1 | 揽收 | 1 | 揽收 | 快件揽件 |
---|---|---|---|---|
101 | 已下单 | 已经下快件单 | ||
102 | 待揽收 | 待快递公司揽收 | ||
103 | 已揽收 | 快递公司已经揽收 | ||
0 | 在途 | 0 | 在途 | 快件在途中 |
1001 | 到达派件城市 | 快件到达收件人城市 | ||
1002 | 干线 | 快件处于运输过程中 | ||
1003 | 转递 | 快件发往到新的收件地址 | ||
5 | 派件 | 5 | 派件 | 快件正在派件 |
501 | 投柜或驿站 | 快件已经投递到快递柜或者快递驿站 | ||
3 | 签收 | 3 | 签收 | 快件已签收 |
301 | 本人签收 | 收件人正常签收 | ||
302 | 派件异常后签收 | 快件显示派件异常,但后续正常签收 | ||
303 | 代签 | 快件已被代签 | ||
304 | 投柜或驿站签收 | 快件已由快递柜或者驿站签收 | ||
6 | 退回 | 6 | 退回 | 快件正处于返回发货人的途中 |
4 | 退签 | 4 | 退签 | 此快件单已退签 |
401 | 已销单 | 此快件单已撤销 | ||
14 | 拒签 | 收件人拒签快件 | ||
7 | 转投 | 7 | 转投 | 快件转给其他快递公司邮寄 |
2 | 疑难 | 2 | 疑难 | 快件存在疑难 |
201 | 超时未签收 | 快件长时间派件后未签收 | ||
202 | 超时未更新 | 快件长时间没有派件或签收 | ||
203 | 拒收 | 收件人发起拒收快递,待发货方确认 | ||
204 | 派件异常 | 快件派件时遇到异常情况 | ||
205 | 柜或驿站超时未取 | 快件在快递柜或者驿站长时间未取 | ||
206 | 无法联系 | 无法联系到收件人 | ||
207 | 超区 | 超出快递公司的服务区范围 | ||
208 | 滞留 | 快件滞留在网点,没有派送 | ||
209 | 破损 | 快件破损 | ||
8 | 清关 | 8 | 清关 | 快件清关 |
10 | 待清关 | 快件等待清关 | ||
11 | 清关中 | 快件正在清关流程中 | ||
12 | 已清关 | 快件已完成清关流程 | ||
13 | 清关异常 | 货物在清关过程中出现异常 | ||
14 | 拒签 | \ | \ | 收件人拒签快件 |
注:如需物流状态高级状态名称及状态值需要 resultv2 传 “4” 返回
5.6 推送响应报文及错误码解释
字段名称 | 字段含义 |
---|---|
result | true表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃 |
returnCode | 200: 提交成功 500: 服务器错误 其他错误请自行定义 |
message | 返回的提示 |
5.7 推送返回示例
当我方调用贵方的回调接口(pollCallBackUrl)时,贵方需要先将我方提交的数据保存至贵方的数据库,接着向我方返回是否成功接收的响应报文及代码,即贵公司直接在回调接口的地址的response中填写如下内容:
{
"result":true,
"returnCode":"200",
"message":"成功"
}
Copy
注意:对于status= abort(message中包含“3天查询无记录”或者“60天无变化”)的快递单,也需要返回成功接收的响应报文及代码。
六、快递公司编码
快递公司 | 编码 | 快递类型 |
---|---|---|
京东物流 | jd | 官方 |
德邦快递 | debangkuaidi | 官方 |
顺丰速运 | shunfeng | 官方 |
中通快递 | zhongtong | 官方 |
顺丰快运 | shunfengkuaiyun | 官方 |
顺心捷达 | sxjdfreight | 官方 |
顺丰冷运 | shunfenglengyun | 官方 |
百世快运 | baishiwuliu | 官方 |
请求参数
Body 参数application/x-www-form-urlencoded
sign
string
可选
订阅参数salt值不为null时,推送数据将包含该加密签名,加密方式:md5(param+salt)。注意: salt值为空串时,推送的数据也会包含sign。
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
result
boolean
必需
returnCode
string
必需
message
string
必需
示例
{
"result": true,
"returnCode": "200",
"message": "成功"
}
最后修改时间: 2 年前