物流快递商家寄件运力查询接口API代码实例
一、 商家寄件运力接口
查询全国快递公司运力覆盖情况。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:querymkt) |
key | 是 | string | 授权码,请到快递100页面申请企业版接口获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号 secret可在企业管理后台查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
sendAddr | 是 | string | 寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
province | string | 省 | |
city | string | 市 | |
district | string | 区 | |
addr | string | 地址 | |
latitude | string | 经度 | |
longitude | string | 纬度 | |
mktInfo | mktInfo | 覆盖运力快递公司列表 |
mktInfo数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
serviceType | string | 业务服务类型 | |
mktId | string | 内部属性忽略 | |
kuaidiCom | string | 支持的快递公司编码 | |
bigCustPriceDOList | string | 内部属性忽略 |
1.4 提供数据内容
{"data": {"province": "广东","city": "深圳市","district": "南山区","latitude": "22.465335763306832","mktInfo": [{"serviceType": ["快递包裹"],"mktId": 98959397,"kuaidiCom": "youzhengguonei","bigCustPriceDOList": null},{"serviceType": null,"mktId": 98959397,"kuaidiCom": "zhaijisong","bigCustPriceDOList": null}],"addr": "海运大厦","longitude": "113.88346197876328"},"message": "成功","result": true,"returnCode": "200"
}
1.5 信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
201 | 无法获取运力 | 该地址没有快递公司运力,需联系快递100工作人员添加 |
400 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填。 |
400 | 非法IP | 请联系快递100工作人员添加白名单 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
500 | 没法识别到寄件地址/地址缺失市区/地址缺失区信息/没有填入寄件人地址 | 地址错误,请填写完整的地址信息 |
503 | 签名认证失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 |
600 | 您不是合法的用户(即授权Key出错) | 账号无可用单量,需要充值 |
601 | KEY已过期 | 账号无可用单量,需要充值 |
物流快递商家寄件运力查询接口API代码实例
一、 商家寄件运力接口
查询全国快递公司运力覆盖情况。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:querymkt) |
key | 是 | string | 授权码,请到快递100页面申请企业版接口获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号 secret可在企业管理后台查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
sendAddr | 是 | string | 寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
province | string | 省 | |
city | string | 市 | |
district | string | 区 | |
addr | string | 地址 | |
latitude | string | 经度 | |
longitude | string | 纬度 | |
mktInfo | mktInfo | 覆盖运力快递公司列表 |
mktInfo数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
serviceType | string | 业务服务类型 | |
mktId | string | 内部属性忽略 | |
kuaidiCom | string | 支持的快递公司编码 | |
bigCustPriceDOList | string | 内部属性忽略 |
1.4 提供数据内容
{"data": {"province": "广东","city": "深圳市","district": "南山区","latitude": "22.465335763306832","mktInfo": [{"serviceType": ["快递包裹"],"mktId": 98959397,"kuaidiCom": "youzhengguonei","bigCustPriceDOList": null},{"serviceType": null,"mktId": 98959397,"kuaidiCom": "zhaijisong","bigCustPriceDOList": null}],"addr": "海运大厦","longitude": "113.88346197876328"},"message": "成功","result": true,"returnCode": "200"
}
1.5 信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
201 | 无法获取运力 | 该地址没有快递公司运力,需联系快递100工作人员添加 |
400 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填。 |
400 | 非法IP | 请联系快递100工作人员添加白名单 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
500 | 没法识别到寄件地址/地址缺失市区/地址缺失区信息/没有填入寄件人地址 | 地址错误,请填写完整的地址信息 |
503 | 签名认证失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 |
600 | 您不是合法的用户(即授权Key出错) | 账号无可用单量,需要充值 |
601 | KEY已过期 | 账号无可用单量,需要充值 |