店铺 shop

模块 shop:共 16 个接口 —— 14 个被前端调用(在用),2 个未被调用(含 0 个开放/回调/内部)。用下方筛选可只看“在用/未使用”,或在右栏目录按名称过滤。

ShopController 9/9 在用

POST /shop/addShop 在用管理后台 #
Shop-新增 · ShopController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopController#addShop
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shopsystem_deptsystem_usersystem_user_relationsystem_user_deptsystem_user_role
ControllerShopController#addShop
转换BeanUtils.map → Shop ⇒ 表 shop
ServiceShopService#addShop (ShopServiceImpl)
转换BeanUtils.map → Shop ⇒ 表 shop
ServiceShopService#add (ShopServiceImpl)
MapperShopMapper#insert ⇒ 表 shop
ServiceShopService#createInitDept (ShopServiceImpl)
ServiceDeptService#add (DeptServiceImpl)
MapperDeptMapper#insert ⇒ 表 system_dept
ServiceShopService#createInitUser (ShopServiceImpl)
ServiceUserService#add (UserServiceImpl)
MapperUserMapper#insert ⇒ 表 system_user
ServiceUserRelationService#add (UserRelationServiceImpl)
MapperUserRelationMapper#insert ⇒ 表 system_user_relation
ServiceUserDeptService#add (UserDeptServiceImpl)
MapperUserDeptMapper#insert ⇒ 表 system_user_dept
ServiceUserRoleService#add (UserRoleServiceImpl)
MapperUserRoleMapper#insert ⇒ 表 system_user_role
其它依赖(权限 / 会话 / 缓存 / 校验等,不直接读写业务表)· 6
ChaosTransactionTemplate.executeMerchantCache.getChaosTransactionTemplate.executeMerchantCache.getPasswordEncoder.encodeRoleService.mustGet

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/addShop
uathttps://dscp-uat.hn12301.net/manage-api/shop/addShop
prohttps://dscp-uat.hn12301.net/manage-api/shop/addShop (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body ShopAddRequest
字段类型必填取值/校验表 / 列说明
merchantIdLong必填shop.merchant_id所属商户id,关联merchant表id
nameString必填shop.name商铺名称
logoStringshop.logo商铺LOGO图片url地址
typeIdLongshop.type_id商铺大类
subTypeIdLongshop.sub_type_id商铺小类ID
statusShopStatus1正常运营2审核中3暂停运营4已关店shop.status商铺状态
provinceIdStringshop.province_id省id
cityIdStringshop.city_id市id
districtIdStringshop.district_id区县id
addressStringshop.address商铺地址
mobileStringshop.mobile客服电话
linkmanStringshop.linkman商户联系人
linkphoneStringshop.linkphone商户联系人手机
managerStringshop.manager专属客户经理
levelStringshop.level等级
lngStringshop.lng经度
latStringshop.lat纬度
introductionStringshop.introduction简介
businessTimeStringshop.business_time营业时间
tagsStringshop.tags商铺标签
mainPicStringshop.main_pic景区主图url地址
propagatePicStringshop.propagate_pic宣传图片url地址
videoStringshop.video景区视频url地址
posterStringshop.poster分享海报url地址
propagateContentStringshop.propagate_content宣传语
descriptionStringshop.description图文详情
ticketInfoStringshop.ticket_info门票信息
trafficInfoStringshop.traffic_info交通信息
tipsStringshop.tips温馨提示
thirdIdStringshop.third_id
thirdNameStringshop.third_name
relationListList<ShopRelationAddRequest>
relationList[].thirdNameStringshop.third_name名称
relationList[].thirdIdStringshop.third_id
relationList[].channelTypeChannelType1北京卡管理系统2三省卡系统3数字平台4质惠游5支付宝6兴业银行7湘工惠8湘约码+8
relationList[].remarkStringsystem_user.remarkxuchao: 第三方备注
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /shop/addShop
{
  "body": {
    "merchantId": 1,
    "name": "",
    "logo": "",
    "typeId": 1,
    "subTypeId": 1,
    "status": "1",
    "provinceId": "",
    "cityId": "",
    "districtId": "",
    "address": "",
    "mobile": "13800000000",
    "linkman": "",
    "linkphone": "13800000000",
    "manager": "",
    "level": "",
    "lng": "",
    "lat": "",
    "introduction": "",
    "businessTime": "2026-01-01 12:00:00",
    "tags": "",
    "mainPic": "https://example.com/x.png",
    "propagatePic": "https://example.com/x.png",
    "video": "",
    "poster": "",
    "propagateContent": "",
    "description": "",
    "ticketInfo": "",
    "trafficInfo": "",
    "tips": "",
    "thirdId": "",
    "thirdName": "",
    "relationList": [
      {
        "thirdName": "",
        "thirdId": "",
        "channelType": "1",
        "remark": ""
      }
    ]
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志shop / 新增商铺
逻辑摘要新增(shopService.addShop);调用 execute(newTransactionTemplate.execute);新增(shopService.add);入参与返回值经 BeanUtils 做对象/分页映射
内联注释
  • 新增商户
  • 创建商铺顶级部门
  • 创建商户默认用户
  • 新增关联
  • 回滚事务
  • 处理异常
POST /shop/deleteShop 在用管理后台 #
Shop-删除 · ShopController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopController#deleteShop
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop
ControllerShopController#deleteShop
ServiceShopService#delete (ShopServiceImpl)
MapperShopMapper#deleteById ⇒ 表 shop

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/deleteShop
uathttps://dscp-uat.hn12301.net/manage-api/shop/deleteShop
prohttps://dscp-uat.hn12301.net/manage-api/shop/deleteShop (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填shop.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /shop/deleteShop
{
  "body": {
    "id": 1
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志shop / 删除商铺
逻辑摘要删除(shopService.delete)
POST /shop/getMapAddrSuggestions 在用管理后台 #
(无摘要) · ShopController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopController#getMapAddrSuggestions
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表(未解析到业务表:可能为纯校验/转发/缓存/外部接口)
调用链路(控制器方法内未解析到 Service/Mapper 调用,可能为接口声明或简单转发)
方法内调用TecentMapUtil.getSuggestions
环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/getMapAddrSuggestions
uathttps://dscp-uat.hn12301.net/manage-api/shop/getMapAddrSuggestions
prohttps://dscp-uat.hn12301.net/manage-api/shop/getMapAddrSuggestions (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path
位置名称类型必填取值/校验表 / 列说明
queryaddressString
请求参数 · Body

请求体类型:(未在仓库索引到该 DTO 源码,无法展开字段;可能位于依赖 jar 或为 Map/基础类型)

响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 List<MapInfo> (list)
字段类型必填取值/校验表 / 列说明
[ ]array列表,元素结构见下
idString
titleString
addressString
categoryString
typeInteger
locationMapLocation
location.latDouble
location.lngDouble
adcodeInteger
provinceString
cityString
districtString
示例
请求示例 (自动生成,仅结构参考)
POST /shop/getMapAddrSuggestions?address=…
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "",
      "title": "",
      "address": "",
      "category": "",
      "type": 0,
      "location": {
        "lat": 0,
        "lng": 0
      },
      "adcode": 0,
      "province": "",
      "city": "",
      "district": ""
    }
  ]
}
处理逻辑
逻辑摘要查询详情(TecentMapUtil.getSuggestions)
POST /shop/getShop 在用开放/回调 #
Shop-详情 · ShopController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopController#getShop
所属模块店铺 shop
暴露渠道开放/回调 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shopshop_relation
ControllerShopController#getShop
ServiceShopService#get (ShopServiceImpl)
MapperShopMapper#selectById ⇒ 表 shop
ServiceShopRelationService#queryList (ShopRelationServiceImpl)
MapperShopRelationMapper#selectList ⇒ 表 shop_relation

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/open-api/shop/getShop
uathttps://dscp-uat.hn12301.net/open-api/shop/getShop
prohttps://dscp-uat.hn12301.net/open-api/shop/getShop (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填shop.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 ShopResponse (object)
字段类型必填取值/校验表 / 列说明
idLongshop.id商铺id,主键
merchantIdLongshop.merchant_id所属商户id,关联merchant表id
merchantTypeMerchantType1供应商2分销商3发卡商4其他5酒店6第三方shop.merchant_type商户类型(枚举:merchant.MerchantType)
nameStringshop.name商铺名称
logoStringshop.logo商铺LOGO图片url地址
typeIdLongshop.type_id商铺大类
subTypeIdLongshop.sub_type_id商铺小类ID
statusShopStatus1正常运营2审核中3暂停运营4已关店shop.status商铺状态(枚举:ShopStatus),1正常运营,2审核中,3暂停运营,4已关店
provinceIdLongshop.province_id省id
cityIdLongshop.city_id市id
districtIdLongshop.district_id区县id
addressStringshop.address商铺地址
mobileStringshop.mobile客服电话
linkmanStringshop.linkman商户联系人
linkphoneStringshop.linkphone商户联系人手机
managerStringshop.manager专属客户经理
levelStringshop.level等级
lngStringshop.lng经度
latStringshop.lat纬度
introductionStringshop.introduction简介
businessTimeStringshop.business_time营业时间
tagsStringshop.tags商铺标签
mainPicStringshop.main_pic景区主图url地址
propagatePicStringshop.propagate_pic宣传图片url地址
videoStringshop.video景区视频url地址
posterStringshop.poster分享海报url地址
propagateContentStringshop.propagate_content宣传语
descriptionStringshop.description图文详情
ticketInfoStringshop.ticket_info门票信息
trafficInfoStringshop.traffic_info交通信息
tipsStringshop.tips温馨提示
merchantNameString所属商户名称
createdTimeDateshop.created_time创建时间
thirdIdStringshop.third_id
thirdNameStringshop.third_name
relationListList<ShopRelationResponse>
relationList[].idLongshop.idid
relationList[].shopIdLongshop_relation.shop_idshopId
relationList[].channelTypeChannelType1北京卡管理系统2三省卡系统3数字平台4质惠游5支付宝6兴业银行7湘工惠8湘约码+8shop_relation.channel_type类型(枚举:checker.ChannelType)
relationList[].thirdIdStringshop.third_id第三方id
relationList[].thirdNameStringshop.third_name第三方名称
relationList[].remarkStringshop_relation.remarkxuchao: 第三方备注
relationList[].createdTimeDateshop.created_time创建时间
relationList[].updatedTimeDateshop.updated_time修改时间
示例
请求示例 (自动生成,仅结构参考)
POST /shop/getShop
{
  "body": {
    "id": 1
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "id": 1,
    "merchantId": 1,
    "merchantType": "1",
    "name": "",
    "logo": "",
    "typeId": 1,
    "subTypeId": 1,
    "status": "1",
    "provinceId": 1,
    "cityId": 1,
    "districtId": 1,
    "address": "",
    "mobile": "13800000000",
    "linkman": "",
    "linkphone": "13800000000",
    "manager": "",
    "level": "",
    "lng": "",
    "lat": "",
    "introduction": "",
    "businessTime": "2026-01-01 12:00:00",
    "tags": "",
    "mainPic": "https://example.com/x.png",
    "propagatePic": "https://example.com/x.png",
    "video": "",
    "poster": "",
    "propagateContent": "",
    "description": "",
    "ticketInfo": "",
    "trafficInfo": "",
    "tips": "",
    "merchantName": "",
    "createdTime": "2026-01-01 12:00:00",
    "thirdId": "",
    "thirdName": "",
    "relationList": [
      {
        "id": 1,
        "shopId": 1,
        "channelType": "1",
        "thirdId": "",
        "thirdName": "",
        "remark": "",
        "createdTime": "2026-01-01 12:00:00",
        "updatedTime": "2026-01-01 12:00:00"
      }
    ]
  }
}
处理逻辑
逻辑摘要查询详情(shopService.get);列表查询(shopRelationService.queryList);入参与返回值经 BeanUtils 做对象/分页映射
内联注释
  • 查询relation
POST /shop/queryShopList 在用开放/回调 #
Shop-列表查询 · ShopController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopController#queryShopList
所属模块店铺 shop
暴露渠道开放/回调 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop
ControllerShopController#queryShopList
转换BeanUtils.map → ShopQuery
ServiceShopService#queryList (ShopServiceImpl)
MapperShopMapper#selectList ⇒ 表 shop

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/open-api/shop/queryShopList
uathttps://dscp-uat.hn12301.net/open-api/shop/queryShopList
prohttps://dscp-uat.hn12301.net/open-api/shop/queryShopList (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body ShopListRequest
字段类型必填取值/校验表 / 列说明
merchantIdLongshop.merchant_id@MvcInject(nullable = true)
idLongshop.id@MvcInject(nullable = true)
nameString可选(@MvcOptional)shop.name商铺名称
logoString可选(@MvcOptional)shop.logo商铺LOGO图片url地址
typeIdLong可选(@MvcOptional)shop.type_id商铺大类
subTypeIdLong可选(@MvcOptional)shop.sub_type_id商铺小类ID
statusShopStatus1正常运营2审核中3暂停运营4已关店shop.status商铺状态(枚举:ShopStatus),1正常运营,2审核中,3暂停运营,4已关店
provinceIdString可选(@MvcOptional)shop.province_id省id
cityIdString可选(@MvcOptional)shop.city_id市id
districtIdString可选(@MvcOptional)shop.district_id区县id
addressString可选(@MvcOptional)shop.address商铺地址
linkmanString可选(@MvcOptional)shop.linkman商户联系人
linkphoneString可选(@MvcOptional)shop.linkphone商户联系人手机
managerString可选(@MvcOptional)shop.manager专属客户经理
levelString可选(@MvcOptional)shop.level等级
lngString可选(@MvcOptional)shop.lng经度
latString可选(@MvcOptional)shop.lat纬度
introductionString可选(@MvcOptional)shop.introduction简介
businessTimeString可选(@MvcOptional)shop.business_time营业时间
tagsString可选(@MvcOptional)shop.tags商铺标签
mainPicString可选(@MvcOptional)shop.main_pic景区主图url地址
propagatePicString可选(@MvcOptional)shop.propagate_pic宣传图片url地址
videoString可选(@MvcOptional)shop.video景区视频url地址
posterString可选(@MvcOptional)shop.poster分享海报url地址
propagateContentString可选(@MvcOptional)shop.propagate_content宣传语
descriptionString可选(@MvcOptional)shop.description图文详情
idListList<Long>可选(@MvcOptional)id列表
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 List<ShopResponse> (list)
字段类型必填取值/校验表 / 列说明
[ ]array列表,元素结构见下
idLongshop.id商铺id,主键
merchantIdLongshop.merchant_id所属商户id,关联merchant表id
merchantTypeMerchantType1供应商2分销商3发卡商4其他5酒店6第三方shop.merchant_type商户类型(枚举:merchant.MerchantType)
nameStringshop.name商铺名称
logoStringshop.logo商铺LOGO图片url地址
typeIdLongshop.type_id商铺大类
subTypeIdLongshop.sub_type_id商铺小类ID
statusShopStatus1正常运营2审核中3暂停运营4已关店shop.status商铺状态(枚举:ShopStatus),1正常运营,2审核中,3暂停运营,4已关店
provinceIdLongshop.province_id省id
cityIdLongshop.city_id市id
districtIdLongshop.district_id区县id
addressStringshop.address商铺地址
mobileStringshop.mobile客服电话
linkmanStringshop.linkman商户联系人
linkphoneStringshop.linkphone商户联系人手机
managerStringshop.manager专属客户经理
levelStringshop.level等级
lngStringshop.lng经度
latStringshop.lat纬度
introductionStringshop.introduction简介
businessTimeStringshop.business_time营业时间
tagsStringshop.tags商铺标签
mainPicStringshop.main_pic景区主图url地址
propagatePicStringshop.propagate_pic宣传图片url地址
videoStringshop.video景区视频url地址
posterStringshop.poster分享海报url地址
propagateContentStringshop.propagate_content宣传语
descriptionStringshop.description图文详情
ticketInfoStringshop.ticket_info门票信息
trafficInfoStringshop.traffic_info交通信息
tipsStringshop.tips温馨提示
merchantNameString所属商户名称
createdTimeDateshop.created_time创建时间
thirdIdStringshop.third_id
thirdNameStringshop.third_name
relationListList<ShopRelationResponse>
relationList[].idLongshop.idid
relationList[].shopIdLongshopId
relationList[].channelTypeChannelType1北京卡管理系统2三省卡系统3数字平台4质惠游5支付宝6兴业银行7湘工惠8湘约码+8类型(枚举:checker.ChannelType)
relationList[].thirdIdStringshop.third_id第三方id
relationList[].thirdNameStringshop.third_name第三方名称
relationList[].remarkStringxuchao: 第三方备注
relationList[].createdTimeDateshop.created_time创建时间
relationList[].updatedTimeDateshop.updated_time修改时间
示例
请求示例 (自动生成,仅结构参考)
POST /shop/queryShopList
{
  "body": {
    "merchantId": 1,
    "id": 1,
    "name": "",
    "logo": "",
    "typeId": 1,
    "subTypeId": 1,
    "status": "1",
    "provinceId": "",
    "cityId": "",
    "districtId": "",
    "address": "",
    "linkman": "",
    "linkphone": "13800000000",
    "manager": "",
    "level": "",
    "lng": "",
    "lat": "",
    "introduction": "",
    "businessTime": "2026-01-01 12:00:00",
    "tags": "",
    "mainPic": "https://example.com/x.png",
    "propagatePic": "https://example.com/x.png",
    "video": "",
    "poster": "",
    "propagateContent": "",
    "description": "",
    "idList": "",
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": 1,
      "merchantId": 1,
      "merchantType": "1",
      "name": "",
      "logo": "",
      "typeId": 1,
      "subTypeId": 1,
      "status": "1",
      "provinceId": 1,
      "cityId": 1,
      "districtId": 1,
      "address": "",
      "mobile": "13800000000",
      "linkman": "",
      "linkphone": "13800000000",
      "manager": "",
      "level": "",
      "lng": "",
      "lat": "",
      "introduction": "",
      "businessTime": "2026-01-01 12:00:00",
      "tags": "",
      "mainPic": "https://example.com/x.png",
      "propagatePic": "https://example.com/x.png",
      "video": "",
      "poster": "",
      "propagateContent": "",
      "description": "",
      "ticketInfo": "",
      "trafficInfo": "",
      "tips": "",
      "merchantName": "",
      "createdTime": "2026-01-01 12:00:00",
      "thirdId": "",
      "thirdName": "",
      "relationList": [
        {
          "id": 1,
          "shopId": 1,
          "channelType": "1",
          "thirdId": "",
          "thirdName": "",
          "remark": "",
          "createdTime": "2026-01-01 12:00:00",
          "updatedTime": "2026-01-01 12:00:00"
        }
      ]
    }
  ]
}
处理逻辑
逻辑摘要列表查询(shopService.queryList);入参与返回值经 BeanUtils 做对象/分页映射
POST /shop/queryShopPage 在用管理后台 #
Shop-分页查询 · ShopController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopController#queryShopPage
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop
ControllerShopController#queryShopPage
转换BeanUtils.map → ShopQuery
ServiceShopService#queryPage (ShopServiceImpl)
MapperShopMapper#selectPage ⇒ 表 shop
其它依赖(权限 / 会话 / 缓存 / 校验等,不直接读写业务表)· 2
MerchantCache.getRegionCache.get

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/queryShopPage
uathttps://dscp-uat.hn12301.net/manage-api/shop/queryShopPage
prohttps://dscp-uat.hn12301.net/manage-api/shop/queryShopPage (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body ShopPageRequest
字段类型必填取值/校验表 / 列说明
pageNumInteger页码(继承自框架分页基类 AbstractPageRequest)
pageSizeInteger每页条数(继承自框架分页基类 AbstractPageRequest)
merchantIdLongshop.merchant_id所属商户id
shopIdLong所属商铺id
nameString可选(@MvcOptional)shop.name商铺名称
logoString可选(@MvcOptional)shop.logo商铺LOGO图片url地址
typeIdLong可选(@MvcOptional)shop.type_id商铺大类
subTypeIdLong可选(@MvcOptional)shop.sub_type_id商铺小类ID
statusShopStatus1正常运营2审核中3暂停运营4已关店shop.status商铺状态(枚举:ShopStatus),1正常运营,2审核中,3暂停运营,4已关店
provinceIdString可选(@MvcOptional)shop.province_id省id
cityIdString可选(@MvcOptional)shop.city_id市id
districtIdString可选(@MvcOptional)shop.district_id区县id
addressString可选(@MvcOptional)shop.address商铺地址
linkmanString可选(@MvcOptional)shop.linkman商户联系人
linkphoneString可选(@MvcOptional)shop.linkphone商户联系人手机
managerString可选(@MvcOptional)shop.manager专属客户经理
levelString可选(@MvcOptional)shop.level等级
lngString可选(@MvcOptional)shop.lng经度
latString可选(@MvcOptional)shop.lat纬度
introductionString可选(@MvcOptional)shop.introduction简介
businessTimeString可选(@MvcOptional)shop.business_time营业时间
tagsString可选(@MvcOptional)shop.tags商铺标签
mainPicString可选(@MvcOptional)shop.main_pic景区主图url地址
propagatePicString可选(@MvcOptional)shop.propagate_pic宣传图片url地址
videoString可选(@MvcOptional)shop.video景区视频url地址
posterString可选(@MvcOptional)shop.poster分享海报url地址
propagateContentString可选(@MvcOptional)shop.propagate_content宣传语
descriptionString可选(@MvcOptional)shop.description图文详情
idListList<Long>可选(@MvcOptional)id列表
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 PageInfo<ShopResponse> (page)
字段类型必填取值/校验表 / 列说明
list / recordsarray分页列表,元素结构见下
totallong总条数(PageInfo)
idLongshop.id商铺id,主键
merchantIdLongshop.merchant_id所属商户id,关联merchant表id
merchantTypeMerchantType1供应商2分销商3发卡商4其他5酒店6第三方shop.merchant_type商户类型(枚举:merchant.MerchantType)
nameStringshop.name商铺名称
logoStringshop.logo商铺LOGO图片url地址
typeIdLongshop.type_id商铺大类
subTypeIdLongshop.sub_type_id商铺小类ID
statusShopStatus1正常运营2审核中3暂停运营4已关店shop.status商铺状态(枚举:ShopStatus),1正常运营,2审核中,3暂停运营,4已关店
provinceIdLongshop.province_id省id
cityIdLongshop.city_id市id
districtIdLongshop.district_id区县id
addressStringshop.address商铺地址
mobileStringshop.mobile客服电话
linkmanStringshop.linkman商户联系人
linkphoneStringshop.linkphone商户联系人手机
managerStringshop.manager专属客户经理
levelStringshop.level等级
lngStringshop.lng经度
latStringshop.lat纬度
introductionStringshop.introduction简介
businessTimeStringshop.business_time营业时间
tagsStringshop.tags商铺标签
mainPicStringshop.main_pic景区主图url地址
propagatePicStringshop.propagate_pic宣传图片url地址
videoStringshop.video景区视频url地址
posterStringshop.poster分享海报url地址
propagateContentStringshop.propagate_content宣传语
descriptionStringshop.description图文详情
ticketInfoStringshop.ticket_info门票信息
trafficInfoStringshop.traffic_info交通信息
tipsStringshop.tips温馨提示
merchantNameString所属商户名称
createdTimeDateshop.created_time创建时间
thirdIdStringshop.third_id
thirdNameStringshop.third_name
relationListList<ShopRelationResponse>
relationList[].idLongshop.idid
relationList[].shopIdLongshopId
relationList[].channelTypeChannelType1北京卡管理系统2三省卡系统3数字平台4质惠游5支付宝6兴业银行7湘工惠8湘约码+8类型(枚举:checker.ChannelType)
relationList[].thirdIdStringshop.third_id第三方id
relationList[].thirdNameStringshop.third_name第三方名称
relationList[].remarkStringxuchao: 第三方备注
relationList[].createdTimeDateshop.created_time创建时间
relationList[].updatedTimeDateshop.updated_time修改时间
示例
请求示例 (自动生成,仅结构参考)
POST /shop/queryShopPage
{
  "body": {
    "pageNum": 0,
    "pageSize": 0,
    "merchantId": 1,
    "shopId": 1,
    "name": "",
    "logo": "",
    "typeId": 1,
    "subTypeId": 1,
    "status": "1",
    "provinceId": "",
    "cityId": "",
    "districtId": "",
    "address": "",
    "linkman": "",
    "linkphone": "13800000000",
    "manager": "",
    "level": "",
    "lng": "",
    "lat": "",
    "introduction": "",
    "businessTime": "2026-01-01 12:00:00",
    "tags": "",
    "mainPic": "https://example.com/x.png",
    "propagatePic": "https://example.com/x.png",
    "video": "",
    "poster": "",
    "propagateContent": "",
    "description": "",
    "idList": "",
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "records": [
      {
        "id": 1,
        "merchantId": 1,
        "merchantType": "1",
        "name": "",
        "logo": "",
        "typeId": 1,
        "subTypeId": 1,
        "status": "1",
        "provinceId": 1,
        "cityId": 1,
        "districtId": 1,
        "address": "",
        "mobile": "13800000000",
        "linkman": "",
        "linkphone": "13800000000",
        "manager": "",
        "level": "",
        "lng": "",
        "lat": "",
        "introduction": "",
        "businessTime": "2026-01-01 12:00:00",
        "tags": "",
        "mainPic": "https://example.com/x.png",
        "propagatePic": "https://example.com/x.png",
        "video": "",
        "poster": "",
        "propagateContent": "",
        "description": "",
        "ticketInfo": "",
        "trafficInfo": "",
        "tips": "",
        "merchantName": "",
        "createdTime": "2026-01-01 12:00:00",
        "thirdId": "",
        "thirdName": "",
        "relationList": [
          {
            "id": 1,
            "shopId": 1,
            "channelType": "1",
            "thirdId": "",
            "thirdName": "",
            "remark": "",
            "createdTime": "2026-01-01 12:00:00",
            "updatedTime": "2026-01-01 12:00:00"
          }
        ]
      }
    ],
    "total": 0
  }
}
处理逻辑
逻辑摘要分页查询(shopService.queryPage);入参与返回值经 BeanUtils 做对象/分页映射
内联注释
  • 所在地区
POST /shop/setShopStatus 在用管理后台 #
设置状态 · ShopController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopController#setShopStatus
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop
ControllerShopController#setShopStatus
ServiceShopService#get (ShopServiceImpl)
MapperShopMapper#selectById ⇒ 表 shop
ServiceShopService#update (ShopServiceImpl)
MapperShopMapper#updateById ⇒ 表 shop

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/setShopStatus
uathttps://dscp-uat.hn12301.net/manage-api/shop/setShopStatus
prohttps://dscp-uat.hn12301.net/manage-api/shop/setShopStatus (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填shop.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /shop/setShopStatus
{
  "body": {
    "id": 1
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志shop / 设置商铺状态
逻辑摘要查询详情(shopService.get);更新(shopService.update)
内联注释
  • 禁用
  • 启用
POST /shop/updateShop 在用管理后台 #
Shop-更新 · ShopController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopController#updateShop
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shopsystem_usersystem_user_deptsystem_user_relationsystem_user_roleshop_relationgoodsskuchecker_relationsystem_operate_log
ControllerShopController#updateShop
转换BeanUtils.map → Shop ⇒ 表 shop
MapperUserService.getMapper#selectBatchIds ⇒ 表 system_user
ServiceShopService#get (ShopServiceImpl)
MapperShopMapper#selectById ⇒ 表 shop
ServiceUserDeptService#queryList (UserDeptServiceImpl)
MapperUserDeptMapper#selectList ⇒ 表 system_user_dept
ServiceUserRelationService#queryList (UserRelationServiceImpl)
MapperUserRelationMapper#selectList ⇒ 表 system_user_relation
ServiceUserRoleService#queryList (UserRoleServiceImpl)
MapperUserRoleMapper#selectList ⇒ 表 system_user_role
ServiceShopService#update (ShopServiceImpl)
MapperShopMapper#updateById ⇒ 表 shop
ServiceShopRelationService#queryList (ShopRelationServiceImpl)
MapperShopRelationMapper#selectList ⇒ 表 shop_relation
ServiceShopRelationService#delete (ShopRelationServiceImpl)
MapperShopRelationMapper#deleteById ⇒ 表 shop_relation
ServiceGoodsService#queryList (GoodsServiceImpl)
MapperGoodsMapper#selectList ⇒ 表 goods
ServiceSkuService#queryList (SkuServiceImpl)
MapperSkuMapper#selectList ⇒ 表 sku
ServiceCheckerRelationService#queryList (CheckerRelationServiceImpl)
MapperCheckerRelationMapper#selectList ⇒ 表 checker_relation
ServiceSystemOperateLogService#add (SystemOperateLogServiceImpl)
MapperSystemOperateLogMapper#insert ⇒ 表 system_operate_log
其它依赖(权限 / 会话 / 缓存 / 校验等,不直接读写业务表)· 9
ChaosTransactionTemplate.executeUserDeptService.updateListUserRelationService.updateListUserService.updateListUserRoleService.updateListGoodsService.updateListSkuService.updateListCheckerRelationService.updateListSessionUserService.getSessionUser

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/updateShop
uathttps://dscp-uat.hn12301.net/manage-api/shop/updateShop
prohttps://dscp-uat.hn12301.net/manage-api/shop/updateShop (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body ShopUpdateRequest
字段类型必填取值/校验表 / 列说明
idLong必填shop.id商铺id,主键
merchantIdLong必填shop.merchant_id所属商户id,关联merchant表id
nameString必填shop.name商铺名称
logoStringshop.logo商铺LOGO图片url地址
typeIdLongshop.type_id商铺大类
subTypeIdLongshop.sub_type_id商铺小类ID
statusShopStatus1正常运营2审核中3暂停运营4已关店shop.status商铺状态(枚举:ShopStatus),1正常运营,2审核中,3暂停运营,4已关店
provinceIdStringshop.province_id省id
cityIdStringshop.city_id市id
districtIdStringshop.district_id区县id
addressStringshop.address商铺地址
mobileStringshop.mobile客服电话
linkmanStringshop.linkman商户联系人
linkphoneStringshop.linkphone商户联系人手机
managerStringshop.manager专属客户经理
levelStringshop.level等级
lngStringshop.lng经度
latStringshop.lat纬度
introductionStringshop.introduction简介
businessTimeStringshop.business_time营业时间
tagsStringshop.tags商铺标签
mainPicStringshop.main_pic景区主图url地址
propagatePicStringshop.propagate_pic宣传图片url地址
videoStringshop.video景区视频url地址
posterStringshop.poster分享海报url地址
propagateContentStringshop.propagate_content宣传语
descriptionStringshop.description图文详情
ticketInfoStringshop.ticket_info门票信息
trafficInfoStringshop.traffic_info交通信息
tipsStringshop.tips温馨提示
thirdIdStringshop.third_id
thirdNameStringshop.third_name
relationListList<ShopRelationUpdateRequest>
relationList[].idLongshop.idid
relationList[].thirdNameStringshop.third_name
relationList[].thirdIdStringshop.third_id
relationList[].channelTypeChannelType1北京卡管理系统2三省卡系统3数字平台4质惠游5支付宝6兴业银行7湘工惠8湘约码+8shop_relation.channel_type
relationList[].remarkStringsystem_user.remarkxuchao: 第三方备注
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /shop/updateShop
{
  "body": {
    "id": 1,
    "merchantId": 1,
    "name": "",
    "logo": "",
    "typeId": 1,
    "subTypeId": 1,
    "status": "1",
    "provinceId": "",
    "cityId": "",
    "districtId": "",
    "address": "",
    "mobile": "13800000000",
    "linkman": "",
    "linkphone": "13800000000",
    "manager": "",
    "level": "",
    "lng": "",
    "lat": "",
    "introduction": "",
    "businessTime": "2026-01-01 12:00:00",
    "tags": "",
    "mainPic": "https://example.com/x.png",
    "propagatePic": "https://example.com/x.png",
    "video": "",
    "poster": "",
    "propagateContent": "",
    "description": "",
    "ticketInfo": "",
    "trafficInfo": "",
    "tips": "",
    "thirdId": "",
    "thirdName": "",
    "relationList": [
      {
        "id": 1,
        "thirdName": "",
        "thirdId": "",
        "channelType": "1",
        "remark": ""
      }
    ]
  }
}
响应示例
(void,无响应体)
处理逻辑
逻辑摘要调用 execute(newTransactionTemplate.execute);查询详情(shopService.get);列表查询(userDeptService.queryList);入参与返回值经 BeanUtils 做对象/分页映射
内联注释
  • 修改用户部门关系
  • 修改用户组织关系
  • 修改用户信息的昵称
  • 合并去重
  • 更新shop
  • 处理第三方
  • 查询现有数据
  • 处理删除数据
POST /shop/importShop 在用管理后台 #
Shop-批量导入(仅超级管理员;逐行部分成功,返回行错误报告) · ShopController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopController#importShop
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;免登录 auth=false;auth=false 但代码内校验仅超级管理员)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop
ControllerShopController#importShop
ServiceshopService#handlerImportData

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/importShop
uathttps://dscp-uat.hn12301.net/manage-api/shop/importShop
prohttps://dscp-uat.hn12301.net/manage-api/shop/importShop (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path
位置类型名称注解
QueryMultipartFilefile"file"
请求参数 · Body

无 JSON Body(multipart 文件参数见上)

响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 ShopImportResponse (object)
字段类型必填取值/校验表 / 列说明
correctNumInteger成功个数
errorNumInteger错误个数
errorResultList<ShopImportErrorResult>错误集合列表
示例
请求示例
(multipart/form-data 文件上传)
响应示例
{
  "correctNum": 0,
  "errorNum": 0,
  "errorResult": []
}
处理逻辑
操作日志shop / 批量导入商铺
逻辑摘要sessionService.isSuperAdmin;shopService.handlerImportData(辅助:sessionService.isSuperAdmin);完整实现见源码 ShopController#importShop
内联注释
  • 每行导入都会连带开默认账号/部门/角色,限制单次行数防止误传巨量数据

ShopNoticeController 5/7 在用

POST /shop/addShopNotice 在用管理后台 #
商铺公告-新增 · ShopNoticeController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopNoticeController#addShopNotice
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop_notice
ControllerShopNoticeController#addShopNotice
转换BeanUtils.map → ShopNotice ⇒ 表 shop_notice
ServiceShopNoticeService#add (ShopNoticeServiceImpl)
MapperShopNoticeMapper#insert ⇒ 表 shop_notice

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/addShopNotice
uathttps://dscp-uat.hn12301.net/manage-api/shop/addShopNotice
prohttps://dscp-uat.hn12301.net/manage-api/shop/addShopNotice (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body ShopNoticeAddRequest
字段类型必填取值/校验表 / 列说明
shopIdLong必填shop_notice.shop_id商铺id
titleString必填shop_notice.title公告标题
contentString必填shop_notice.content公告内容
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /shop/addShopNotice
{
  "body": {
    "shopId": 1,
    "title": "",
    "content": ""
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志shop / 新增商铺公告
逻辑摘要新增(shopNoticeService.add);入参与返回值经 BeanUtils 做对象/分页映射
POST /shop/deleteShopNotice 未使用管理后台 #
商铺公告-删除 · ShopNoticeController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopNoticeController#deleteShopNotice
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop_notice
ControllerShopNoticeController#deleteShopNotice
ServiceShopNoticeService#delete (ShopNoticeServiceImpl)
MapperShopNoticeMapper#deleteById ⇒ 表 shop_notice

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/deleteShopNotice
uathttps://dscp-uat.hn12301.net/manage-api/shop/deleteShopNotice
prohttps://dscp-uat.hn12301.net/manage-api/shop/deleteShopNotice (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填shop_notice.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /shop/deleteShopNotice
{
  "body": {
    "id": 1
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志shop / 删除商铺公告
逻辑摘要删除(shopNoticeService.delete)
前端调用方

源码扫描未发现 7 个前端对该接口的调用(可能为开放回调/内部/未上线/管理端动态调用)

POST /shop/getShopNotice 在用管理后台 #
商铺公告-详情 · ShopNoticeController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopNoticeController#getShopNotice
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop_notice
ControllerShopNoticeController#getShopNotice
ServiceShopNoticeService#get (ShopNoticeServiceImpl)
MapperShopNoticeMapper#selectById ⇒ 表 shop_notice

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/getShopNotice
uathttps://dscp-uat.hn12301.net/manage-api/shop/getShopNotice
prohttps://dscp-uat.hn12301.net/manage-api/shop/getShopNotice (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填shop_notice.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 ShopNoticeResponse (object)
字段类型必填取值/校验表 / 列说明
idLongshop_notice.idid
shopIdLongshop_notice.shop_id商铺id
shopNameString商铺id
titleStringshop_notice.title标题
contentStringshop_notice.content内容
isDisplayBooleanshop_notice.is_display是否显示,0:否,1:是
createdTimeDateshop_notice.created_time创建时间
示例
请求示例 (自动生成,仅结构参考)
POST /shop/getShopNotice
{
  "body": {
    "id": 1
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "id": 1,
    "shopId": 1,
    "shopName": "",
    "title": "",
    "content": "",
    "isDisplay": false,
    "createdTime": "2026-01-01 12:00:00"
  }
}
处理逻辑
逻辑摘要查询详情(shopNoticeService.get);入参与返回值经 BeanUtils 做对象/分页映射
POST /shop/queryShopNoticeList 未使用管理后台 #
商铺公告-列表查询 · ShopNoticeController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopNoticeController#queryShopNoticeList
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop_notice
ControllerShopNoticeController#queryShopNoticeList
转换BeanUtils.map → ShopNoticeQuery
ServiceShopNoticeService#queryList (ShopNoticeServiceImpl)
MapperShopNoticeMapper#selectList ⇒ 表 shop_notice

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/queryShopNoticeList
uathttps://dscp-uat.hn12301.net/manage-api/shop/queryShopNoticeList
prohttps://dscp-uat.hn12301.net/manage-api/shop/queryShopNoticeList (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body ShopNoticeListRequest
字段类型必填取值/校验表 / 列说明
shopIdLong必填shop_notice.shop_id商铺id
isDisplayBoolean可选(@MvcOptional)shop_notice.is_display是否显示,0:否,1:是
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 List<ShopNoticeResponse> (list)
字段类型必填取值/校验表 / 列说明
[ ]array列表,元素结构见下
idLongshop_notice.idid
shopIdLongshop_notice.shop_id商铺id
shopNameString商铺id
titleStringshop_notice.title标题
contentStringshop_notice.content内容
isDisplayBooleanshop_notice.is_display是否显示,0:否,1:是
createdTimeDateshop_notice.created_time创建时间
示例
请求示例 (自动生成,仅结构参考)
POST /shop/queryShopNoticeList
{
  "body": {
    "shopId": 1,
    "isDisplay": false,
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": 1,
      "shopId": 1,
      "shopName": "",
      "title": "",
      "content": "",
      "isDisplay": false,
      "createdTime": "2026-01-01 12:00:00"
    }
  ]
}
处理逻辑
逻辑摘要列表查询(shopNoticeService.queryList);入参与返回值经 BeanUtils 做对象/分页映射
内联注释
  • 设置其他查询条件
前端调用方

源码扫描未发现 7 个前端对该接口的调用(可能为开放回调/内部/未上线/管理端动态调用)

POST /shop/queryShopNoticePage 在用管理后台 #
商铺公告-分页查询 · ShopNoticeController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopNoticeController#queryShopNoticePage
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop_notice
ControllerShopNoticeController#queryShopNoticePage
转换BeanUtils.map → ShopNoticeQuery
ServiceShopNoticeService#queryPage (ShopNoticeServiceImpl)
MapperShopNoticeMapper#selectPage ⇒ 表 shop_notice

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/queryShopNoticePage
uathttps://dscp-uat.hn12301.net/manage-api/shop/queryShopNoticePage
prohttps://dscp-uat.hn12301.net/manage-api/shop/queryShopNoticePage (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body ShopNoticePageRequest
字段类型必填取值/校验表 / 列说明
pageNumInteger页码(继承自框架分页基类 AbstractPageRequest)
pageSizeInteger每页条数(继承自框架分页基类 AbstractPageRequest)
shopIdLong必填shop_notice.shop_id商铺id
isDisplayBoolean可选(@MvcOptional)shop_notice.is_display是否显示,0:否,1:是
createdTimeRangeDate[]可选(@MvcOptional)创建时间
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 PageInfo<ShopNoticeResponse> (page)
字段类型必填取值/校验表 / 列说明
list / recordsarray分页列表,元素结构见下
totallong总条数(PageInfo)
idLongshop_notice.idid
shopIdLongshop_notice.shop_id商铺id
shopNameString商铺id
titleStringshop_notice.title标题
contentStringshop_notice.content内容
isDisplayBooleanshop_notice.is_display是否显示,0:否,1:是
createdTimeDateshop_notice.created_time创建时间
示例
请求示例 (自动生成,仅结构参考)
POST /shop/queryShopNoticePage
{
  "body": {
    "pageNum": 0,
    "pageSize": 0,
    "shopId": 1,
    "isDisplay": false,
    "createdTimeRange": "2026-01-01 12:00:00",
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "records": [
      {
        "id": 1,
        "shopId": 1,
        "shopName": "",
        "title": "",
        "content": "",
        "isDisplay": false,
        "createdTime": "2026-01-01 12:00:00"
      }
    ],
    "total": 0
  }
}
处理逻辑
逻辑摘要分页查询(shopNoticeService.queryPage);入参与返回值经 BeanUtils 做对象/分页映射
内联注释
  • 设置其他查询条件
POST /shop/setShopNoticeDisplayStatus 在用管理后台 #
商铺公告-修改显示状态 · ShopNoticeController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopNoticeController#setShopNoticeDisplayStatus
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop_notice
ControllerShopNoticeController#setShopNoticeDisplayStatus
ServiceShopNoticeService#update (ShopNoticeServiceImpl)
MapperShopNoticeMapper#updateById ⇒ 表 shop_notice

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/setShopNoticeDisplayStatus
uathttps://dscp-uat.hn12301.net/manage-api/shop/setShopNoticeDisplayStatus
prohttps://dscp-uat.hn12301.net/manage-api/shop/setShopNoticeDisplayStatus (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body ShopNoticeDisplaySetRequest
字段类型必填取值/校验表 / 列说明
idLong必填shop_notice.idid
isDisplayBoolean必填shop_notice.is_display是否显示,0:否,1:是
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /shop/setShopNoticeDisplayStatus
{
  "body": {
    "id": 1,
    "isDisplay": false
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志shop / 设置商铺公告显示状态
逻辑摘要更新(shopNoticeService.update)
POST /shop/updateShopNotice 在用管理后台 #
商铺公告-更新 · ShopNoticeController
基本信息
控制器com.jxxx.dscp.api.controller.shop.ShopNoticeController#updateShopNotice
所属模块店铺 shop
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表shop_notice
ControllerShopNoticeController#updateShopNotice
转换BeanUtils.map → ShopNotice ⇒ 表 shop_notice
ServiceShopNoticeService#update (ShopNoticeServiceImpl)
MapperShopNoticeMapper#updateById ⇒ 表 shop_notice

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/shop/updateShopNotice
uathttps://dscp-uat.hn12301.net/manage-api/shop/updateShopNotice
prohttps://dscp-uat.hn12301.net/manage-api/shop/updateShopNotice (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body ShopNoticeUpdateRequest
字段类型必填取值/校验表 / 列说明
idLong必填shop_notice.idid
titleString必填shop_notice.title公告标题
contentString必填shop_notice.content公告内容
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /shop/updateShopNotice
{
  "body": {
    "id": 1,
    "title": "",
    "content": ""
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志shop / 更新商铺公告
逻辑摘要更新(shopNoticeService.update);入参与返回值经 BeanUtils 做对象/分页映射