顺丰服务网点查询接口-速运类API
EXP_RECE_QUERY_GIS_DEPARTMENT
1. 功能描述
2. 接口定义
2.1. 公共参数
2.2. 公共请求参数
序号 |
参数列表 |
类型 |
是否必传 |
含义 |
1 |
已作废 |
String(64) |
是 |
|
2 |
requestID |
String(40) |
是 |
请求唯一号UUID |
3 |
serviceCode |
String(50) |
是 |
接口服务代码 |
4 |
timestamp |
long |
是 |
调用接口时间戳 |
5 |
已作废 |
String(128) |
条件 |
数字签名,使用数字签名方式认证时必填 签名方法参考:数字签名认证说明 |
6 |
expiresIn |
Number |
条件 |
已作废,使用OAuth2方式认证时必填 获取方法参考:OAuth2认证说明 |
7 |
msgData |
String |
是 |
业务数据报文 |
2.3. 请求参数\
# |
属性名 |
类型(约束) |
必填 |
默认值 |
描述 |
1 |
address |
String |
否 |
|
详细地址 |
2 |
x |
String |
否 |
|
经度 |
3 |
y |
String |
否 |
|
纬度 |
4 |
opt |
String |
否 |
|
dq0:显示所有接口返回原始信息;dq1:显示格式化后信息(默认) |
5 |
deptType |
String |
否 |
|
网点类型: 1自营服务点,2合作商家店,3嘿客店/顺丰优选 4顺丰站 5丰巢柜(允许多选,多个值之间用竖线隔开,如:1|2|5) |
6 |
servType |
String |
否 |
|
服务类型:1、自寄服务2、自取服务 3、寄、取件服务4、个人地址服务 5、便民服务6自寄自取优惠服务(允许多选,多个值之间用竖线隔开,如:1|2|5) |
7 |
count |
Integer |
否 |
|
数量 |
8 |
distance |
Integer |
否 |
|
查询范围,默认为1000米,单位:米 |
9 |
city |
String |
否 |
|
城市:调用香港,需输入city=香港 |
2.4. 公共响应参数
# |
属性名 |
类型(约束) |
必填 |
默认值 |
描述 |
1 |
success |
String |
是 |
|
true 请求成功,false 请求失败 |
2 |
errorCode |
String |
是 |
|
错误编码,S0000成功 |
3 |
errorMsg |
String |
是 |
|
错误描述 |
4 |
msgData |
String |
是 |
|
返回的详细数据 |
2.5. 响应参数\
# |
属性名 |
参数类型 |
必填 |
描述 |
1 |
total |
Integer |
是 |
总数 |
2 |
pageSize |
Integer |
是 |
页码 |
3 |
pageNo |
Integer |
是 |
每页显示记录数 |
4 |
content |
List |
是 |
分页数据 |
2.5.1 元素 content
# |
属性名 |
类型(约束) |
描述 |
1 |
status |
Integer |
状态 0成功 其他:失败 |
2 |
count |
Integer |
返回条数据 |
3 |
src |
String |
来源 |
4 |
msg |
String |
返回结果 |
5 |
result |
List |
网点信息结果 |
6 |
x |
Double |
经度 |
7 |
y |
Double |
纬度 |
8 |
splite_result |
String |
|
9 |
gl_level |
String |
|
10 |
standardization |
String |
|
11 |
flag |
Long |
|
2.6. 请求示例\应用场景(JSON)示例
请求报文:
{
"address": "广东省深圳市宝安区劳动路",
"x": "100",
"y": "60",
"opt": "dq0",
"deptType": "1|2|5",
"servType": "1|2|5",
"distance": 1000
}
2.7. 返回示例\应用场景(JSON)示例
响应报文:
{
"success": true,
"errorCode": "S0000",
"errorMsg": null,
"msgData": "{\"count\":1,\"result\":[{\"address\":\"广东省深圳市宝安区劳动村二队二巷3号山木居大门左侧丰巢智能柜\",\"distance\":153,\"id\":\"FC75517510\",\"latitude\":22,\"longitude\":113,\"name\":\"丰巢智能柜\",\"servertype\":\"2\"}],\"src\":\"tcp-geo-dp\",\"status\":0}"
}
{
"success": false,
"errorCode": "S0001",
"errorMsg": "非法的JSON格式",
"msgData": null
}
3.1. 错误代码
3.1 (API)平台结果代码列表
3.2 业务异常代码
# |
errorCode |
描述 |
1 |
S0000 |
成功 |
2 |
S0001 |
非法的JSON格式 |
3 |
S0002 |
必填参数%s为空 |
4 |
S0003 |
系统发生数据错误或运行时异常 |
5 |
S0004 |
参数%s超过最大长度%d |
6 |
S0005 |
参数超过最大值 |
7 |
S0006 |
参数%s不能小于%d |
8 |
S0007 |
参数%s数据类型错误 |