商户列表 #
描述 #
使用此接口获取CPS商户列表。
接口说明 #
授权对象 APP
请求地址 GET /open/cps/merchantList
请求规则 请查阅开发必读
请求参数 #
参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
---|---|---|---|---|
页码 | page | int64 | 否 | query默认为1,最小为1 示例值:1 |
每页数量 | limit | int64 | 否 | query默认为20,最大为100 示例值:20 |
品牌类型 | brand | int32 | 是 | query品牌类型枚举值 示例值:1 |
关键词 | keyword | string | 否 | query搜索关键词 示例值:商户名称 |
经度 | lng | double | 否 | query用户位置经度 示例值:116.397428 |
纬度 | lat | double | 否 | query用户位置纬度 示例值:39.909187 |
请求示例 #
{
"page": 1,
"limit": 20,
"brand": 1,
"keyword": "商户名称",
"lng": 116.397428,
"lat": 39.909187
}
响应参数 #
参数名称 | 变量名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|---|
商户列表 | list | object[] | 是 | 商户信息列表 |
总数量 | total | int64 | 是 | 示例值:100 |
商户信息 list #
参数名称 | 变量名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|---|
商户ID | id | uint32 | 是 | 示例值:12345 |
商户名称 | title | string | 否 | 示例值:示例商户 |
商户地址 | address | string | 否 | 示例值:北京市朝阳区xxx |
距离 | distance | double | 否 | 单位:米 示例值:1000 |
经度 | lng | double | 否 | 示例值:116.397428 |
纬度 | lat | double | 否 | 示例值:39.909187 |
营业时间 | work_at | map[string]string | 否 | 营业时间配置 示例值:{"1": "09:00-22:00"} |
备注 | remark | string | 否 | 示例值:商户备注 |
缩略图 | thumb | string | 否 | 示例值:https://example.com/thumb.jpg |
品牌类型 | brand | int32 | 否 | 品牌枚举:1:肯德基 2:麦当劳 等 示例值:1 |
城市 | city | string | 否 | 示例值:北京市 |
营业状态 | status | int32 | 是 | 1:营业中 2:休息中 示例值:1 |
响应示例 #
{
"code": 200,
"msg": "success",
"data": {
"list": [
{
"id": 1001,
"title": "不二云微(总店)",
"address": "浙江省杭州市西湖区文三路478号",
"distance": 0.8,
"lng": 120.15507,
"lat": 30.28521,
"work_at": "09:00-22:00",
"remark": "不二云微总店,提供专业的咖啡和轻食服务",
"thumb": "https://bool.dev/images/store/bool-main.jpg",
"brand": "不二云微",
"city": "杭州市"
},
{
"id": 1002,
"title": "BOOL COFFEE(滨江店)",
"address": "浙江省杭州市滨江区江南大道3880号",
"distance": 2.5,
"lng": 120.21182,
"lat": 30.20916,
"work_at": "08:30-21:30",
"remark": "BOOL COFFEE滨江旗舰店,环境优雅,服务贴心",
"thumb": "https://bool.dev/images/store/bool-binjiang.jpg",
"brand": "BOOL COFFEE",
"city": "杭州市"
}
],
"total": 2,
"page": 1,
"limit": 10
}
}