1-顺丰服务网点查询接口

顺丰服务网点查询接口-速运类API

EXP_RECE_QUERY_GIS_DEPARTMENT

---

1. 功能描述

• 客户可通过经纬度，查询附近的10个网点信息。

2. 接口定义

2.1. 公共参数

名称	值
接口服务代码	EXP_RECE_QUERY_GIS_DEPARTMENT
生产环境地址	https://sz-mix.sf-express.com/backend/std/service/{hnCustomerCode} 生产{hnCustomerCode}请向大客获取。
香港生产环境	https://sfapi-hk.sf-express.com/std/service
沙箱环境地址	https://sz-mix.sit.sf-express.com/backend/std/service/{hnCustomerCode} 测试{hnCustomerCode}统一为11aeea6bdd7fbae1
批量交易	不支持
接口类型	接入
报文类型	JSON

2.2. 公共请求参数

序号	参数列表	类型	是否必传	含义
1	已作废	String(64)	是
2	requestID	String(40)	是	请求唯一号UUID
3	serviceCode	String(50)	是	接口服务代码
4	timestamp	long	是	调用接口时间戳
5	已作废	String(128)	条件	数字签名,使用数字签名方式认证时必填 签名方法参考：数字签名认证说明
6	已作废	String	条件	已作废,使用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	纬度

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）平台结果代码列表

标识	说明	解决方法
A1000	统一接入平台校验成功，调用后端服务成功;注意：不代表后端业务处理成功，实际业务处理结果，需要查看响应属性apiResultData中的详细结果	表示接口调用正常
A1001	必传参数不可为空	请做以下几点检查：1、参数列表必传字段未填写2、请求报文头，未配置Content-type：application/x-www-form-urlencoded 3、参数key存在空格问题4、http请求参数都通过http URL编码传送5、业务数据报文（msgData）为json报文数据格式6、接口整体报文为form表单
A1002	请求时效已过期	使用OAuth2认证会产生该提示请检查业务接口的已作废参数是否超过2小时，2小时口令会更新，请调用OAuth2认证接口重新获取
A1003	IP无效	顾客编码（已作废）配置了需校验IP，请解除校验或按绑定IP调用接口
A1004	无对应服务权限	可能存在的原因：1、顾客编码（已作废）没有配置（关联）对应接口的业务接口，请在【开发者对接】-【API列表】中关联；2、接口请求数据与实际环境不一致，请先查看【开发者对接】-【API列表】接口状态：a、【测试中】请使用沙箱环境b、【已上线】请使用正式环境；3、后台配置没有生效，可等待2分钟后在试试，如果还是无法操作，请报障人工处理
A1005	流量受控	丰桥为接口功能联调环境，接口整体都有限流管控，单客户编码对应的每个接口限流规则：1、单接口调用30次/s 2、单接口调用3000次/天请尽量只操作功能联调，切勿进行接口压测，谢谢！
A1006	数字签名无效	请做以下几点检查：1、确认checkword是否配置正确2、确认verifyCode、已作废是否加密加签正确3、确认参数是否有特殊字符，如：&4、参数整体式form表单格式5、非java类语言，需注意特殊字符，目前支持的特殊字符“*”，“空格”，“-”请优先使用6、如果数字签名操作不便，可改为OAuth2认证，Token交互即可，具体参见【开发规范】【鉴权方式说明】
A1007	重复请求	接口层暂未启用，业务层主要是针对下单接口，客户请求参数msgData中的orderId请不要重复使用，修改后在调用接口
A1008	数据解密失败	在特殊场景中使用，如有出现请报障人工处理
A1009	目标服务异常或不可达	接口下游服务异常，如有出现请报障人工处理
A1010	状态为沙箱测试	该问题在老客户中会有此类问题，新客户不会出现，如有出现请报障人工处理
A1099	系统异常	接口服务异常，如有出现请报障人工处理

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数据类型错误