一、快递预估价格查询接口文档
该接口提供通过收寄件地址和重量查询预估快递公司运费的功能。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://api.kuaidi100.com/label/order
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:price) |
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在企业管理后台查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
kuaidicom | 是 | string | 快递公司的编码,一律用小写字母,请查看参数字典 |
recAddr | 是 | string | 收件地址,如”广东深圳南山区” |
sendAddr | 是 | string | 寄件地址,如”北京海淀区” |
weight | 是 | double | 重量,默认单位为kg,参数无需带单位,如1.0 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
success | boolean | 提交结果 | true提交成功,false失败 |
code | string | 返回编码 | |
message | string | 返回报文描述 | |
data | Object | 相应数据 |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
kuaidicom | string | 快递公司的编码,一律用小写字母,请查看参数字典 | |
combos | array | 价格详情 |
combos 中数据项的数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
price | string | 预估运费价格,单位:元 | |
expType | list | 业务或产品类型 |
1.4 请求参数示例
param: { "sendAddr": "深圳南山区", "recAddr": "北京海淀区", "kuaidicom": "jd", "weight": "12" }
method: price
key: 123
sign: 3B8153C7258758B5FDAD0E4AFB9A1284
t: 1724725439371
1.5 返回结果示例
成功示例:
{
"code": 200,
"data": {
"kuaidicom": "jd",
"combos": [
{
"price": 83.0,
"productName": "京东标快"
}
]
},
"message": "success",
"time": 0,
"success": true
}
错误示例:
{
"code": 30001,
"message": "weight不能为空",
"time": 0,
"success": false
}
1.6 返回信息代码含义:
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
-1 | 服务器错误 | 快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
200 | 提交成功 | 提交成功 |
30001 | 参数错误 | 检查参数传参是否正确 |
30002 | 验证签名失败 | 检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号 |
30004 | 账号单量不足需要充值 | 账号单量不足需要充值 |
30005 | 无快递产品或该地未开通查询业务 | 查询价格没有结果,或者请求快递公司异常都可能返回该异常 |
二、支持的快递公司列表
快递公司名称 | 编码 |
---|---|
顺丰 | shunfeng |
京东 | jd |
德邦快递 | debangkuaidi |
圆通 | yuantong |
中通 | zhongtong |
申通 | shentong |
韵达 | yunda |
EMS | ems |