快递100企业物流API支持接入国际快递顺丰API接口,而且我们的快递单号查询API接口,供小程序、APP、需实时返回物流轨迹信息即查即走,快递查询将提供输入运单编号立即获取物流最新轨迹,无需快递编码,自动识别物流公司,返回物流轨迹。
一、功能说明
实时查询:实时查询物流轨迹,获取最新状态
实时格式化数据:接口实时格式化数据,并计算当前运单的物流状态
覆盖全部主流快递公司:支持1600+国内外物流公司,主流公司全覆盖,轨迹信息全面、涵盖范围广
查询增长:系统日新增查询订单过千万,日查询次数过亿次,稳定可靠,服务能力强。
支持自动识别单号:支持主流40家快递公司无需传输快递编码自动识别物流公司,返回物流轨迹。
二、物流寄件API支持快递公司说明
支持的快递公司:商家寄件接口支持德邦、京东、顺丰、极兔、圆通、申通和中通寄件。
运力及运费问题:可以保证全国地址的运力,运费是官方寄件价格的折扣价,具体运费价格请登录后台查询。
三、国际快递顺丰API下订单接口接入流程
寄件接口基础信息
选择快递公司进行寄件。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://poll.kuaidi100.com/order/borderapi.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:bOrder) |
key | 是 | string | 授权码,请到快递100页面<a href="https://api.kuaidi100.com/register/enterprise" target="_blank" rel="nofollow noopener noreferrer" style="color: #017eff;">申请企业版</a>接口获取 |
sign | 是 | string | 32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在<a href="https://api.kuaidi100.com/manager/v2/myinfo/enterprise" target="_blank" rel="nofollow noopener noreferrer" style="color: #017eff;">企业管理后台</a>获取 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
kuaidicom | 是 | string | 快递公司的编码,一律用小写字母,见《快递公司编码》 |
recManName | 是 | string | 收件人姓名 |
recManMobile | 是 | string | 收件人的手机号,手机号和电话号二者其一必填 |
recManPrintAddr | 是 | string | 收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园 |
sendManName | 是 | string | 寄件人姓名 |
sendManMobile | 是 | string | 寄件人的手机号,手机号和电话号二者其一必填 |
sendManPrintAddr | 是 | string | 寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10 |
callBackUrl | 是 | string | callBackUrl订单信息回调地址 |
cargo | 否 | string | 物品名称,例:文件。当kuaidicom=jd,yuantong时,必填 |
payment | 否 | string | 支付方式,SHIPPER: 寄付(默认)。不支持到付 |
serviceType | 否 | string | 业务类型,默认为标准快递,各快递公司业务类型对照参考:七、业务类型参数表 |
weight | 否 | string | 物品总重量KG,不需带单位,例:1.5 |
remark | 否 | string | 备注 |
salt | 否 | string | 签名用随机字符串,用于验证签名sign。salt值不为null时,推送数据将包含该加密签名,加密方式:md5(param+salt)。注意: salt值为空串时,推送的数据也会包含sign,此时可忽略sign的校验。 |
dayType | 否 | string | 预约日期,例如:今天/明天/后天 |
pickupStartTime | 否 | string | 预约起始时间(HH:mm),例如:09:00,顺丰必填 |
pickupEndTime | 否 | string | 预约截止时间(HH:mm),例如:10:00,顺丰必填 |
valinsPay | 否 | string | 保价额度,单位:元 |
passwordSigning | 否 | string | 是否口令签收,Y:需要 N: 不需要,默认值为N(德邦快递专属参数) |
op | 否 | string | 是否开启订阅功能 0:不开启(默认) 1:开启 说明开启订阅功能时:pollCallBackUrl必须填入 此功能只针对有快递单号的单 |
pollCallBackUrl | 否 | string | 如果op设置为1时,pollCallBackUrl必须填入,用于跟踪回调 |
resultv2 | 否 | string | 添加此字段表示开通行政区域解析功能 。<br> 0:关闭(默认)<br>1:开通行政区域解析功能以及物流轨迹增加物流状态名称 <br>4:开通行政解析功能以及物流轨迹增加物流高级状态名称、状态值并且返回出发、目的及当前城市信息(详见:<a href="https://api.kuaidi100.com/document/5f0ffa8f2977d50a94e1023c.html#title_1" target="_blank">快递信息推送接口文档</a>) |
returnType | 否 | string | 面单返回类型,默认为空,不返回面单内容。10:设备打印,20:生成图片短链回调。 |
siid | 否 | string | 设备码,returnType为10时必填 |
tempid | 否 | string | 模板编码,通过管理后台的<a href="https://api.kuaidi100.com/manager/v2/shipping-label/template-shipping-label" target="_blank">电子面单模板</a>信息获取 ,returnType不为空时必填 |
printCallBackUrl | 否 | string | 打印状态回调地址,returnType为10时必填 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
orderId | string | 订单ID | |
kuaidinum | string | 快递单号 | |
eOrder | string | 快递面单附属属性,根据各个快递公司返回属性 |
eOrder数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
bulkpen | string | 大头笔 | 用于显示于电子面单上规定位置,非必需,是否有值取决于快递公司 |
orgCode | string | 始发地区域编码 | |
orgName | string | 始发地/始发网点名称 | |
destCode | string | 目的地区域编码 | |
destName | string | 目的地/到达网点 | |
orgSortingCode | string | 始发分拣编码 | |
orgSortingName | string | 始发分拣名称 | |
destSortingCode | string | 目的分栋编码 | |
destSortingName | string | 目的分栋中心名称 | |
orgExtra | string | 始发其他信息 | |
destExtra | string | 目的其他信息 | |
pkgCode | string | 集包编码 | |
pkgName | string | 集包地名称 | |
road | string | 路区 | |
qrCode | string | 二维码 | |
kdComOrderNum | string | 快递公司订单号 | |
expressCode | string | 快递业务类型编码 | |
expressName | string | 快递业务类型名称 | |
waterMark | string | 水印 | |
agingName | string | 时效 | |
abFlag | string | 电子产品类型图标 | |
proCode | string | 时效产品图标 | |
codingMapping | string | 进港映射码 | |
codingMappingOut | string | 出港信息 | |
printIcon | string | 图标名称 | |
destRouteLabel | string | 目的地(路由信息) | |
twoDimensionCode | string | 二维码信息 | |
xbFlag | string | 顺丰面单标识,快运必填,xbFlag=1,打印SX标;xbFlag=2,打印融通标 |
注意:eOrder实际返回的字段各家快递公司不同,以实际返回为准
1.4 提供数据内容
请求参数示例
method = bOrder
key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
"kuaidicom": "yuantong",
"recManName": "王超",
"recManMobile": "13842569988",
"recManPrintAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园",
"sendManName": "王大",
"sendManMobile": "13842569988",
"sendManPrintAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10",
"cargo": "文件",
"callBackUrl": "http: //www.baidu.com",
"payment": "SHIPPER",
"serviceType": "标准快递",
"weight": "1",
"remark": "",
"salt": "",
"dayType": "",
"pickupStartTime": "",
"pickupEndTime": "",
"passwordSigning": "Y",
"valinsPay": "",
"op": "0",
"pollCallBackUrl": "",
"resultv2": "0",
"returnType": "",
"siid": "",
"tempid": "",
"printCallBackUrl": ""
}
返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {
"taskId": "", // 任务ID
"orderId": "" // 订单ID
"kuaidinum": "" // 快递单号
"eOrder": "[\"destName\":null,\"orgName\":null,\"pkgCode\":null,\"pkgName\":null,\"bulkpen\":\"上海-S33-K27-P\",\"orgExtra\":null}]"
}
}
说明:
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
400 | 参数错误等 | 请根据技术文档请求,注意参数类型及是否必填 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
501 | 重复提交 | 重复提交了请求 |
503 | 验证签名失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 |
600 | 您不是合法的用户(即授权Key出错) | 账号无可用余额,需要充值 |
601 | KEY已过期 | 账号无可用余额,需要充值 |
700 | 错误的回调地址 | 检查回调地址,或者联系快递100工作人员 |
订单有状态变更是会触发回调,回调后如果没有得到合作方正确返回,会重复回调多2次,即最多回调3次。间隔30分钟。
寄件回调接口
2.1 接口格式
提供统一格式的HTTP POST,并返回统一格式JSON数据。
请求报头:Content-Type=application/x-www-form-urlencoded;charset=UTF-8
2.2 请求地址
请求参数:
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
sign | string | 签名 | 32位大写签名,MD5 (param +salt) |
param | param | 参数主体 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
kuaidicom | 是 | string | 快递公司的编码,一律用小写字母,见《快递公司编码》,选填。 |
kuaidinum | 是 | string | 快递单号,单号的最大长度是32个字符。 |
status | 是 | string | 状态码 |
message | 是 | string | 状态描述 |
data | 是 | data | 订单内容 |
data数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
orderId | 是 | string | 平台订单ID |
status | 是 | int | 订单状态: 0:’成功’; 1:’已接单’; 2:’收件中’; 9:’用户主动取消’; 10:’已取件’; 11:’揽货失败’; 12:’已退回’; 13:’已签收’; 14:’异常签收’;15:’已结算’ ;99:’订单已取消’;101:’运输中’;200:’已出单’;201:’出单失败’ |
courierName | 否 | string | 快递员姓名 |
courierMobile | 否 | string | 快递员电话 |
weight | 否 | string | 计费重量,单位:kg |
defPrice | 否 | string | 标准运费,单位:元 |
freight | 否 | string | 折后运费,单位:元 |
volume | 否 | string | 体积,单位:cm³ |
actualWeight | 否 | string | 称重重量,单位:kg |
ΘfeeDetails | 否 | list | 费用明细,明细项目请展开 |
└ feeType | 否 | string | 费用类型,参考八、费用类型(feeType)说明 |
└ feeDesc | 否 | string | 费用名称 |
└ amount | 否 | string | 费用明细金额,单位:元 |
└ payStatus | 否 | string | 支付状态,支付失败:-1;未支付:0;已支付:1 ;无需支付:2;已退款:3 |
printTaskId | 否 | string | 打印任务ID |
label | 否 | string | 面单短链,请求中returnType为20时返回 |
2.3 返回结果
字段 | 说明 | 备注 |
---|---|---|
result | 提交结果 | true提交成功,false失败 |
returnCode | 返回编码 | |
message | 返回报文描述 |
2.4 提供数据内容
请求参数示例
taskId = ** ** **
sign = ** ** **
param = {
"kuaidicom": "yuantong",
"kuaidinum": "1234567890",
"status": "200",
"message": "成功",
"data": {
"orderId": "*****",
"status": "0",
"courierName": "王大",
"courierMobile": "13842569988",
"weight": "1",
"defPrice": "15.0",
"freight": "5.1",
"volume": "120",
"actualWeight": "1",
"feeDetails": [{
"feeType": "PACKAGINGFEE",
"feeDesc": "包装费",
"amount": "0.8",
"payStatus": 1
}],
"printTaskId": "*****",
"imgBase64": "*****"
}
}
返回结果示例
{
"result":true,
"returnCode":"200",
"message":"成功"
}
2.4 回调响应报文及错误码解释
字段名称 | 字段含义 |
---|---|
result | true表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃 |
returnCode | 200: 提交成功 500: 服务器错误 其他错误请自行定义 |
message | 返回的提示 |
寄件取消接口
对下完单进行取消操作
3.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
3.2 请求地址
https://poll.kuaidi100.com/order/borderapi.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:cancel) |
key | 是 | string | 授权码,请到快递100页面<a href="https://api.kuaidi100.com/register/enterprise" target="_blank" rel="nofollow noopener noreferrer" style="color: #017eff;">申请企业版</a>接口获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
taskId | 是 | string | 任务ID |
orderId | 是 | string | 订单ID |
cancelMsg | 是 | string | 取消原因,例:暂时不寄件了 |
3.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data | 这里默认为空 |
3.4 提供数据内容
请求参数示例
method = cancel
key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
"taskId": "*****",
"orderId": "*****",
"cancelMsg": "暂时不寄件了"
}
返回结果示例
{
"result":true,
"returnCode":"200",
"message":"取消成功",
"data":{}
}
说明:
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
400 | 参数错误等 | 请根据技术文档请求,注意参数类型及是否必填 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,或者对已取消的订单重复操作取消,也会报此错误 |
501 | 重复提交 | 重复提交了请求 |
503 | 验证签名失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 |
600 | 您不是合法的用户(即授权Key出错) | 账号无可用余额,需要充值 |
601 | KEY已过期 | 账号无可用余额,需要充值 |
700 | 错误的回调地址 | 检查回调地址,或者联系快递100工作人员 |
寄件价格接口
查看从出发地到目的地的价格
4.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
4.2 请求地址
https://poll.kuaidi100.com/order/borderapi.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:price) |
key | 是 | string | 授权码,请到快递100页面<a href="https://api.kuaidi100.com/register/enterprise" target="_blank" rel="nofollow noopener noreferrer" style="color: #017eff;">申请企业版</a>接口获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
kuaidiCom | 是 | string | 快递公司编码 |
sendManPrintAddr | 是 | string | 出发地地址,最小颗粒到市级,例如:广东省深圳市 |
recManPrintAddr | 是 | string | 目的地地址,最小颗粒到市级,例如:广东省深圳市 |
weight | 否 | string | 重量,单位:kg |
serviceType | 否 | string | 业务类型 |
4.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data | 运力对象 |
data数据结构:
参数名 | 类型 | 说明 |
---|---|---|
defFirstPrice | string | 标准首重价格,单位:元 |
defOverPrice | string | 标准续重价格,单位:元 |
defPrice | string | 标准总价,单位:元 |
firstPrice | string | 折后首重价格,单位:元 |
overPrice | string | 折后续重价格,单位:元 |
price | string | 折后总价,单位:元 |
serviceType | string | 业务类型 |
4.4 提供数据内容
请求参数示例
method = price
key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
"kuaidicom": "yuantong",
"sendManPrintAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园",
"recManPrintAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10",
"weight": "1",
"serviceType": "标准快递"
}
返回结果示例
{
"data": {
"firstPrice": "8.0",
"defPrice": "8.0",
"defFirstPrice": "8.0",
"price": "8.0",
"serviceType": "标准快递",
"overPrice": "0",
"defOverPrice": "0",
"kuaidiCom": "zhongtong"
},
"message": "成功",
"result": true,
"returnCode": "200"
}
说明:
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
400 | 参数错误等 | 请根据技术文档请求,注意参数类型及是否必填 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
503 | 验证签名失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 |
600 | 您不是合法的用户(即授权Key出错) | 账号无可用余额,需要充值 |
601 | KEY已过期 | 账号无可用余额,需要充值 |
快递信息推送接口
5.1 推送请求地址
由贵司在开启订阅功能中通过pollCallBackUrl字段提供
5.2 推送请求类型
post
5.3 推送输入参数
请求参数(header)
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | application/x-www-form-urlencoded |
请求参数(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.4 推送输入参数示例
{
"status": "polling",
"billstatus": "got",
"message": "寄件",
"lastResult": {
"message": "ok",
"nu": "YT6186594166532",
"ischeck": "0",
"com": "yuantong",
"status": "200",
"data": [{
"time": "2021-12-15 20:15:14",
"context": "【苏州转运中心】 已发出 下一站 【无锡转运中心公司】",
"ftime": "2021-12-15 20:15:14",
"areaCode": "CN320500000000",
"areaName": "江苏,苏州市",
"status": "干线",
"location": "",
"areaCenter": "120.585315,31.298886",
"areaPinYin": "su zhou shi",
"statusCode": "1002"
},
{
"time": "2021-12-15 20:11:25",
"context": "【苏州转运中心公司】 已收入",
"ftime": "2021-12-15 20:11:25",
"areaCode": "CN320500000000",
"areaName": "江苏,苏州市",
"status": "干线",
"location": "",
"areaCenter": "120.585315,31.298886",
"areaPinYin": "su zhou shi",
"statusCode": "1002"
},
{
"time": "2021-12-15 19:18:27",
"context": "【江苏省无锡市锡新开发区公司】 已收入",
"ftime": "2021-12-15 19:18:27",
"areaCode": "CN320200000000",
"areaName": "江苏,无锡市",
"status": "在途",
"location": "",
"areaCenter": "120.31191,31.491169",
"areaPinYin": "wu xi shi",
"statusCode": "0"
},
{
"time": "2021-12-15 17:10:09",
"context": "【江苏省苏州市北桥公司】 已揽收",
"ftime": "2021-12-15 17:10:09",
"areaCode": "CN320507004000",
"areaName": "江苏,苏州市,相城区,北桥",
"status": "揽收",
"location": "",
"areaCenter": "120.606531,31.505825",
"areaPinYin": "bei qiao jie dao",
"statusCode": "1"
}
],
"state": "0",
"condition": "F00",
"routeInfo": {
"from": {
"number": "CN320507004000",
"name": "江苏,苏州市,相城区,北桥"
},
"cur": {
"number": "CN320200000000",
"name": "江苏,无锡市"
},
"to": null
},
"isLoop": false
}
}
5.5 运单签收状态服务说明
<div class="table-head">
<table>
<colgroup>
<col style="width: 15%;" />
<col style="width: 15%;" />
<col style="width: 15%;" />
<col style="width: 15%;" />
<col style="width: 40%;" />
</colgroup>
<thead>
<tr>
<th>物流状态值</th>
<th>物流状态名称</th>
<th>高级物流状态值</th>
<th>高级物流状态名称</th>
<th>含义</th>
</tr>
</thead>
</table>
</div>
<div class="table-body">
<table>
<colgroup>
<col style="width: 15%;" />
<col style="width: 15%;" />
<col style="width: 15%;" />
<col style="width: 15%;" />
<col style="width: 40%;" />
</colgroup>
<tbody>
<tr>
<td rowspan="4">1</td>
<td rowspan="4">揽收</td>
<td>1</td>
<td>揽收</td>
<td>快件揽件</td>
</tr>
<tr>
<td>101</td>
<td>已下订单</td>
<td>已经下快件单</td>
</tr>
<tr>
<td>102</td>
<td>待揽收</td>
<td>待快递公司揽收</td>
</tr>
<tr>
<td>103</td>
<td>已揽收</td>
<td>快递公司已经揽收</td>
</tr>
<tr>
<td rowspan="4">0</td>
<td rowspan="4">在途</td>
<td>0</td>
<td>在途</td>
<td>快件在途中</td>
</tr>
<tr>
<td>1001</td>
<td>到达派件城市</td>
<td>快件到达收件人城市</td>
</tr>
<tr>
<td>1002</td>
<td>干线</td>
<td>快件处于运输过程中</td>
</tr>
<tr>
<td>1003</td>
<td>转递</td>
<td>快件发往到新的收件地址</td>
</tr>
<tr>
<td rowspan="2">5</td>
<td rowspan="2">派件</td>
<td>5</td>
<td>派件</td>
<td>快件正在派件</td>
</tr>
<tr>
<td>501</td>
<td>投柜或驿站</td>
<td>快件已经投递到快递柜或者快递驿站</td>
</tr>
<tr>
<td rowspan="5">3</td>
<td rowspan="5">签收</td>
<td>3</td>
<td>签收</td>
<td>快件已签收</td>
</tr>
<tr>
<td>301</td>
<td>本人签收</td>
<td>收件人正常签收</td>
</tr>
<tr>
<td>302</td>
<td>派件异常后签收</td>
<td>快件显示派件异常,但后续正常签收</td>
</tr>
<tr>
<td>303</td>
<td>代签</td>
<td>快件已被代签</td>
</tr>
<tr>
<td>304</td>
<td>投柜或驿站签收</td>
<td>快件已由快递柜或者驿站签收</td>
</tr>
<tr>
<td rowspan="1">6</td>
<td rowspan="1">退回</td>
<td>6</td>
<td>退回</td>
<td>快件正处于返回发货人的途中</td>
</tr>
<tr>
<td rowspan="3">4</td>
<td rowspan="3">退签</td>
<td>4</td>
<td>退签</td>
<td>此快件单已退签</td>
</tr>
<tr>
<td>401</td>
<td>已销单</td>
<td>此快件单已撤销</td>
</tr>
<tr>
<td>14</td>
<td>拒签</td>
<td>收件人拒签快件</td>
</tr>
<tr>
<td rowspan="1">7</td>
<td rowspan="1">转投</td>
<td>7</td>
<td>转投</td>
<td>快件转给其他快递公司邮寄</td>
</tr>
<tr>
<td rowspan="10">2</td>
<td rowspan="10">疑难</td>
<td>2</td>
<td>疑难</td>
<td>快件存在疑难</td>
</tr>
<tr>
<td>201</td>
<td>超时未签收</td>
<td>快件长时间派件后未签收</td>
</tr>
<tr>
<td>202</td>
<td>超时未更新</td>
<td>快件长时间没有派件或签收</td>
</tr>
<tr>
<td>203</td>
<td>拒收</td>
<td>收件人发起拒收快递,待发货方确认</td>
</tr>
<tr>
<td>204</td>
<td>派件异常</td>
<td>快件派件时遇到异常情况</td>
</tr>
<tr>
<td>205</td>
<td>柜或驿站超时未取</td>
<td>快件在快递柜或者驿站长时间未取</td>
</tr>
<tr>
<td>206</td>
<td>无法联系</td>
<td>无法联系到收件人</td>
</tr>
<tr>
<td>207</td>
<td>超区</td>
<td>超出快递公司的服务区范围</td>
</tr>
<tr>
<td>208</td>
<td>滞留</td>
<td>快件滞留在网点,没有派送</td>
</tr>
<tr>
<td>209</td>
<td>破损</td>
<td>快件破损</td>
</tr>
<tr>
<td rowspan="5">8</td>
<td rowspan="5">清关</td>
<td>8</td>
<td>清关</td>
<td>快件清关</td>
</tr>
<tr>
<td>10</td>
<td>待清关</td>
<td>快件等待清关</td>
</tr>
<tr>
<td>11</td>
<td>清关中</td>
<td>快件正在清关流程中</td>
</tr>
<tr>
<td>12</td>
<td>已清关</td>
<td>快件已完成清关流程</td>
</tr>
<tr>
<td>13</td>
<td>清关异常</td>
<td>货物在清关过程中出现异常</td>
</tr>
<tr>
<td rowspan="1">14</td>
<td rowspan="1">拒签</td>
<td style="context">\</td>
<td>\</td>
<td>收件人拒签快件</td>
</tr>
</tbody>
</table>
</div>
注:如需物流状态高级状态名称及状态值需要 resultv2 传 “4” 返回
5.6 推送响应报文及错误码解释
字段名称 | 字段含义 |
---|---|
result | true表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃 |
returnCode | 200: 提交成功 500: 服务器错误 其他错误请自行定义 |
message | 返回的提示 |
5.7 推送返回示例
当我方调用贵方的回调接口(pollCallBackUrl)时,贵方需要先将我方提交的数据保存至贵方的数据库,接着向我方返回是否成功接收的响应报文及代码,即贵公司直接在回调接口的地址的response中填写如下内容:
{
"result":true,
"returnCode":"200",
"message":"成功"
}
注意:对于status= abort(message中包含“3天查询无记录”或者“60天无变化”)的快递单,也需要返回成功接收的响应报文及代码。