一、运单附件查询接口
该接口提供运单附件(如回单)查询功能,可在运单签收之后查询。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://api.kuaidi100.com/label/order
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:backOrder) |
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在企业管理后台查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
kuaidicom | 是 | string | 快递公司的编码,一律用小写字母,请查看参数字典 |
kuaidinum | 是 | string | 快递单号 |
imgType | 否 | int | 快递100附件类型,默认1。1:回单;2:货物照片(目前只支持查询跨越速运的货物照片) |
partnerId | 是 | string | 电子面单客户账户或月结账号,需贵司向当地快递公司网点申请(参考电子面单申请指南); 是否必填该属性,请查看参数字典 |
partnerKey | 否 | string | 电子面单密码,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典 |
phone | 否 | string | 寄件人手机号。顺丰、德邦必填 |
注意:目前顺丰的快递单号,同个单号第一次请求接口是去订阅,间隔10秒钟后再去请求获取运单附件文件
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
success | boolean | 提交结果 | true提交成功,false失败 |
code | string | 返回编码 | |
message | string | 返回报文描述 | |
time | string | 时间 | 可忽略 |
data | Object | 相应数据 |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
files | list | 附件列表 |
files中数据项的数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
fileType | string | 三方附件类型编码 | |
fileName | string | 三方附件类型名称 | |
fileUrl | string | 附件下载地址 | 附件下载地址有效期是40天 |
1.4 请求参数示例
method = backOrder
key = kytRstexx
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1470304729724
param = {
"kuaidicom": "shunfeng",
"kuaidinum": "SF1234567",
"partnerId": "1234567",
"partnerKey": "",
"phone": "13888888888",
"imgType": 1
}
1.5 返回结果示例
成功示例:
{
"code": 200,
"data": {
"files": [
{
"fileType": "40",
"fileName": "完整性照片",
"fileUrl": "http://elec.kuaidi100.com/waybill/att/sf/2024-02-19/SF1234567-BE6618B393DA06ACC380BD476CC89980.png"
}
]
},
"message": "success",
"time": 0,
"success": true
}
错误示例:
{
"code": 10005,
"message": "数据为空",
"time": 0,
"success": false
}
1.6 返回信息代码含义:
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
-1 | 服务器错误 | 快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
200 | 提交成功 | 提交成功 |
30001 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填 |
30002 | 验证签名失败 | 检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号 |
30003 | 账号信息不正确 | 检查key是否正确 |
30004 | 账户单量不足 | 单量不足需要充值 |
30005 | 快递公司返回异常 | 按照描述可以自行检查参数的数据类型是否正确 |
二、支持的快递公司列表
快递公司名称 | 编码 |
---|---|
顺丰 | shunfeng |
京东 | jd |
德邦物流 | debangwuliu |
德邦快递 | debangkuaidi |
跨越速运 | kuayue |