POST
/shop/queryShopPage管理后台Shop-分页查询
商户·店铺·基础数据 / 店铺
基本信息
- 接口状态前端在用
- 接口URLPOST
https://dscp-dev.hn12301.net/manage-api/shop/queryShopPage - 请求方式
POST - Content-Type
application/json - 暴露渠道管理后台 前缀
/manage-api - 名称来源源码注释
- 调用方已确认在用 · 管理后台(1 个前端)
- 需求上下文
- 维护人 / 最后改动AsiQue 2023-11-24
- 读写数据表
shop反查该表全部接口 → - 控制器
com.jxxx.dscp.api.controller.shop.ShopController#queryShopPage - 源码位置
jxxx-dscp/dscp-service-business/src/main/java/com/jxxx/dscp/api/controller/shop/ShopController.java:207 - 判定依据
请求参数
Header 请求参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无(渠道统一鉴权头见《认证方式》) | ||||
Query 请求参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无 | ||||
路径参数及说明
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无 | ||||
Body 请求参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| pageNo | … | 否 | Integer | 当前页面 |
| pageSize | … | 否 | Integer | 每页记录数 |
| orderBy | … | 否 | String | 排序语句 |
| merchantId | … | 否 | Long | 所属商户id → shop.merchant_id |
| shopId | … | 否 | Long | 所属商铺id |
| name | … | 否 | String | 商铺名称 → shop.name |
| logo | … | 否 | String | 商铺LOGO图片url地址 → shop.logo |
| typeId | … | 否 | Long | 商铺大类 → shop.type_id |
| subTypeId | … | 否 | Long | 商铺小类ID → shop.sub_type_id |
| status | … | 否 | ShopStatus | 商铺状态,1正常运营,2审核中,3暂停运营,4已关店 → shop.status 1=正常运营 2=审核中 3=暂停运营 4=已关店 |
| provinceId | … | 否 | String | 省id → shop.province_id |
| cityId | … | 否 | String | 市id → shop.city_id |
| districtId | … | 否 | String | 区县id → shop.district_id |
| address | … | 否 | String | 商铺地址 → shop.address |
| linkman | … | 否 | String | 商户联系人 → shop.linkman |
| linkphone | … | 否 | String | 商户联系人手机 → shop.linkphone |
| manager | … | 否 | String | 专属客户经理 → shop.manager |
| level | … | 否 | String | 等级 → shop.level |
| lng | … | 否 | String | 经度 → shop.lng |
| lat | … | 否 | String | 纬度 → shop.lat |
| introduction | … | 否 | String | 简介 → shop.introduction |
| businessTime | … | 否 | String | 营业时间 → shop.business_time |
| tags | … | 否 | String | 商铺标签 → shop.tags |
| mainPic | … | 否 | String | 景区主图url地址 → shop.main_pic |
| propagatePic | … | 否 | String | 宣传图片url地址 → shop.propagate_pic |
| video | … | 否 | String | 景区视频url地址 → shop.video |
| poster | … | 否 | String | 分享海报url地址 → shop.poster |
| propagateContent | … | 否 | String | 宣传语 → shop.propagate_content |
| description | … | 否 | String | 图文详情 → shop.description |
| idList | … | 否 | List<Long> | id列表 |
| keywords | … | 否 | String | 关键字 |
| resourceFlag | … | 否 | Boolean | 单位/资源筛选:null=全部,true=资源(在card_resource_rule中有shop_id记录),false=单位(无记录) |
认证方式
响应参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| list | … | 否 | List<T><ShopResponse> | 分页数据集合(元素结构见下一行) |
| id | … | 否 | Long | 商铺id,主键 → shop.id |
| merchantId | … | 否 | Long | 所属商户id,关联merchant表id → shop.merchant_id |
| merchantType | … | 否 | MerchantType | 商户类型 → shop.merchant_type 1=供应商 2=分销商 3=发卡商 4=其他 5=酒店 6=第三方 |
| name | … | 否 | String | 商铺名称 → shop.name |
| logo | … | 否 | String | 商铺LOGO图片url地址 → shop.logo |
| typeId | … | 否 | Long | 商铺大类 → shop.type_id |
| subTypeId | … | 否 | Long | 商铺小类ID → shop.sub_type_id |
| status | … | 否 | ShopStatus | 商铺状态,1正常运营,2审核中,3暂停运营,4已关店 → shop.status 1=正常运营 2=审核中 3=暂停运营 4=已关店 |
| provinceId | … | 否 | Long | 省id → shop.province_id |
| cityId | … | 否 | Long | 市id → shop.city_id |
| districtId | … | 否 | Long | 区县id → shop.district_id |
| address | … | 否 | String | 商铺地址 → shop.address |
| mobile | … | 否 | String | 客服电话 → shop.mobile |
| linkman | … | 否 | String | 商户联系人 → shop.linkman |
| linkphone | … | 否 | String | 商户联系人手机 → shop.linkphone |
| manager | … | 否 | String | 专属客户经理 → shop.manager |
| level | … | 否 | String | 等级 → shop.level |
| lng | … | 否 | String | 经度 → shop.lng |
| lat | … | 否 | String | 纬度 → shop.lat |
| introduction | … | 否 | String | 简介 → shop.introduction |
| businessTime | … | 否 | String | 营业时间 → shop.business_time |
| tags | … | 否 | String | 商铺标签 → shop.tags |
| mainPic | … | 否 | String | 景区主图url地址 → shop.main_pic |
| propagatePic | … | 否 | String | 宣传图片url地址 → shop.propagate_pic |
| video | … | 否 | String | 景区视频url地址 → shop.video |
| poster | … | 否 | String | 分享海报url地址 → shop.poster |
| propagateContent | … | 否 | String | 宣传语 → shop.propagate_content |
| description | … | 否 | String | 图文详情 → shop.description |
| ticketInfo | … | 否 | String | 门票信息 → shop.ticket_info |
| trafficInfo | … | 否 | String | 交通信息 → shop.traffic_info |
| tips | … | 否 | String | 温馨提示 → shop.tips |
| merchantName | … | 否 | String | 所属商户名称 |
| createdTime | … | 否 | Date | 创建时间 → shop.created_time |
| thirdId | … | 否 | String | → shop.third_id |
| thirdName | … | 否 | String | → shop.third_name |
| relationList | … | 否 | List<ShopRelationResponse> | |
| id | … | 否 | Long | id → shop.id |
| shopId | … | 否 | Long | shopId |
| channelType | … | 否 | ChannelType | 类型 |
| thirdId | … | 否 | String | 第三方id → shop.third_id |
| thirdName | … | 否 | String | 第三方名称 → shop.third_name |
| remark | … | 否 | String | xuchao: 第三方备注 |
| createdTime | … | 否 | Date | 创建时间 → shop.created_time |
| updatedTime | … | 否 | Date | 修改时间 → shop.updated_time |
| total | … | 否 | Long | 数据总数 |
响应示例
成功响应示例
{
"errcode": 0,
"errmsg": "",
"data": {
"list": "[]",
"id": "1",
"merchantId": "1",
"merchantType": "1",
"name": "\"string\"",
"logo": "\"string\"",
"typeId": "1",
"subTypeId": "1",
"status": "1",
"provinceId": "1",
"cityId": "1",
"districtId": "1"
}
}附录 · 实现细节
调用链 / 数据表 / 调用点证据 / 源码注释 / 逻辑摘要
涉及数据表:shop 反查全部引用接口 →
- ShopController#queryShopPage
- SessionUserService#isMerchant
- SessionUserService#getSessionUser
- ShopService#queryPage(ShopServiceImpl)
- ShopMapper#queryPage
- BeanUtils.map → ShopQuery
- BeanUtils.mapPage → ShopResponse
其它依赖:MerchantCache.get、RegionCache.get
逻辑摘要:分页查询(shopService.queryPage);入参与返回值经 BeanUtils 做对象/分页映射
源码内联注释(旧站解析结果)
- 所在地区
旧站环境备注:pro:(仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
调用点证据
dscp-html-manage/src/api/shop/index.ts:8管理后台 · request