POST/merchantContract/queryMerchantContractPage管理后台

合同协议-分页查询

商户·店铺·基础数据 / 合同· MerchantContractController#queryMerchantContractPage

基本信息

接口状态前端在用置信度高
接口URLPOSThttps://dscp-dev.hn12301.net/manage-api/merchantContract/queryMerchantContractPage
请求方式POST
Content-Typeapplication/json
暴露渠道管理后台　前缀 /manage-api
名称来源源码注释
调用方已确认在用 · 管理后台（1 个前端）
需求上下文feat:增加商户财务&合同模块服务
维护人 / 最后改动AsiQue　2023-11-30　最近提交：feat:增加商户财务&合同模块服务
读写数据表merchant_contract　反查该表全部接口 →
控制器com.jxxx.dscp.api.controller.merchant.MerchantContractController#queryMerchantContractPage
源码位置jxxx-dscp/dscp-service-business/src/main/java/com/jxxx/dscp/api/controller/merchant/MerchantContractController.java:83
判定依据1 个调用点：dscp-html-manage/src/api/contract/index.ts

请求参数

分页字段来自 AbstractPageRequest：pageNo（不是 pageNum）· pageSize · orderBy

Header 请求参数

参数名	参数值	是否必填	参数类型	描述说明
无（渠道统一鉴权头见《认证方式》）

Query 请求参数

参数名	参数值	是否必填	参数类型	描述说明
无

路径参数及说明

参数名	参数值	是否必填	参数类型	描述说明
无

Body 请求参数

Body 类型 MerchantContractPageRequest

参数名	参数值	是否必填	参数类型	描述说明
pageNo	…	否	Integer	当前页面
pageSize	…	否	Integer	每页记录数
orderBy	…	否	String	排序语句
merchantId	…	否	Long	所属商户id → merchant_contract.merchant_id
shopId	…	否	Long	所属商铺id → merchant_contract.shop_id
contractType	…	否	ContractType	合同类型(merchant.ContractType)，1平台协议、2分销商协议、3旅游卡协议 → merchant_contract.contract_type 1＝平台协议 2＝分销商协议 3＝旅游卡协议
signTime	…	否	Date	签约时间 → merchant_contract.sign_time
beginDate	…	否	Date	合同开始日期 → merchant_contract.begin_date
endDate	…	否	Date	合同结束日期 → merchant_contract.end_date
idList	…	否	List<Long>	id列表
keywords	…	否	String	关键字

认证方式

需登录态：Authorization: Bearer <token>（多租户另带 tenant-id）；30002 会话失效需重登。详见全局公共参数。

响应参数

data 类型 PageInfo<MerchantContractResponse>

参数名	参数值	是否必填	参数类型	描述说明
list	…	否	List<T><MerchantContractResponse>	分页数据集合（元素结构见下一行）
id	…	否	Long	主键，合同ID → merchant_contract.id
merchantId	…	否	Long	所属商户ID，关联merchant表id → merchant_contract.merchant_id
shopId	…	否	Long	所属商铺ID，关联shop表id → merchant_contract.shop_id
contractType	…	否	ContractType	合同类型(merchant.ContractType)，1平台协议、2分销商协议、3旅游卡协议 → merchant_contract.contract_type 1＝平台协议 2＝分销商协议 3＝旅游卡协议
merchantA	…	否	String	甲方商户 → merchant_contract.merchant_a
merchantAName	…	否	String	甲方商户名称
shopA	…	否	String	甲方商铺 → merchant_contract.shop_a
shopAName	…	否	String	甲方商铺名称
merchantB	…	否	String	乙方商户 → merchant_contract.merchant_b
merchantBName	…	否	String	乙方商户名称
shopB	…	否	String	乙方商铺 → merchant_contract.shop_b
shopBName	…	否	String	乙方商铺名称
signTime	…	否	Date	签约时间 → merchant_contract.sign_time
beginDate	…	否	Date	合同开始日期 → merchant_contract.begin_date
endDate	…	否	Date	合同结束日期 → merchant_contract.end_date
party	…	否	Integer	判断当前登录用户属于甲方还是乙方
total	…	否	Long	数据总数

响应示例

成功响应示例 code=0

{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "list": "[]",
    "id": "1",
    "merchantId": "1",
    "shopId": "1",
    "contractType": "1",
    "merchantA": "\"string\"",
    "merchantAName": "\"string\"",
    "shopA": "\"string\"",
    "shopAName": "\"string\"",
    "merchantB": "\"string\"",
    "merchantBName": "\"string\"",
    "shopB": "\"string\""
  }
}

示例来自源码/导出内容，仅结构参考，非线上真实数据。

附录 · 实现细节

调用链 / 数据表 / 调用点证据 / 源码注释 / 逻辑摘要

涉及数据表：merchant_contract　反查全部引用接口 →

MerchantContractController#queryMerchantContractPage
MerchantContractService#queryPage（MerchantContractServiceImpl）
MerchantContractMapper#queryPage
BeanUtils.mapPage → MerchantContractQuery

逻辑摘要：分页查询（merchantService.queryPage）；入参与返回值经 BeanUtils 做对象/分页映射

旧站环境备注：pro：（仓库 .env.pro 指向 uat；生产域名未确认，此处沿用 uat 主机示意）

调用点证据

dscp-html-manage/src/api/contract/index.ts:8　管理后台 · request