myblog

Appearance

顾客积分历史控制器文档 ​

接口信息 ​

  • 控制器类: CustomerPointHistoryController
  • 包路径: com.qisheng.customer.web
  • 功能描述: 负责处理顾客积分历史记录的查询操作

类图 ​

uml diagram

接口列表 ​

1. 获取积分历史列表 ​

  • 请求方式: GET
  • URL: /{merchantId}/customer_point_history
  • 功能: 获取顾客积分历史记录列表
  • 参数:
    • merchantId: 商户ID (路径参数)
    • req: 顾客积分历史查询请求对象 (查询参数)
  • 返回: ObjectResponse
  • 示例:
http
GET /82/customer_point_history?customerId=236&startTime=2023-01-01T00:00:00&endTime=2023-12-31T23:59:59

2. 按门店获取积分历史 ​

  • 请求方式: GET
  • URL: /{merchantId}/customer_point_history/shop
  • 功能: 按门店获取顾客积分历史记录
  • 参数:
    • merchantId: 商户ID (路径参数)
    • req: 顾客积分历史查询请求对象 (查询参数)
  • 返回: ObjectResponse
  • 示例:
http
GET /82/customer_point_history/shop?shopIds=1,2,3&startTime=2023-01-01T00:00:00&endTime=2023-12-31T23:59:59

3. 按门店分页获取积分历史 ​

  • 请求方式: GET
  • URL: /{merchantId}/customer_point_history/page
  • 功能: 按门店分页获取顾客积分历史记录
  • 参数:
    • merchantId: 商户ID (路径参数)
    • req: 顾客积分历史查询请求对象 (查询参数)
  • 返回: ObjectResponse
  • 示例:
http
GET /82/customer_point_history/page?shopIds=1,2,3&pageNum=1&pageSize=20&startTime=2023-01-01T00:00:00&endTime=2023-12-31T23:59:59

调用流程 ​

1. 获取积分历史列表流程 ​

uml diagram

2. 按门店获取积分历史流程 ​

uml diagram

3. 按门店分页获取积分历史流程 ​

uml diagram

主要功能说明 ​

积分历史查询功能 ​

  • getHistoryList: 获取积分历史列表，支持待入账和已入账记录查询
  • getPointHistoryByShop: 按门店获取积分历史
  • getPointHistoryByPage: 按门店分页获取积分历史

积分类型 (CustomerPointHistoryTypeEnum) ​

  • PURCHASE: 购买项目/卖品获得(邀客)
  • CARD_PURCHASE: 开卡(邀客)
  • CARD_RECHARGE: 充值(邀客)
  • SERVICE: 线下抵扣(配置)
  • MALL_SERVICE: 兑换
  • MALL_SERVICE_USE: 积分抵扣(配置)
  • FREE_PRESENT: 免费领取礼包(邀客)
  • BUY_PRESENT: 购买礼包(邀客)
  • BONUS: 手动赠送
  • WRITEOFF: 手动核销
  • CASH_ITEM: 现金购买项目(配置)
  • CARD_ITEM: 卡金购买项目(配置)
  • CASH_GOODS: 现金购买卖品(配置)
  • CARD_GOODS: 卡金购买卖品(配置)
  • SERVICE_GET: 消耗获得(配置)
  • SERVICE_CASH_GET: 现金消耗获得(配置)
  • SERVICE_CARD_GET: 卡金消耗获得(配置)
  • CARD_PURCHASE_CONFIG: 开卡(配置)
  • CARD_RECHARGE_CONFIG: 充值(配置)
  • SHARE_ITEM: 分享商品
  • SHARE_USER: 分享员工
  • INIT: 期初导入
  • CASHIER_CONSUME: 收银到店积分
  • MALL_RESERVATION: 线上自主预约到店积分
  • SIGN_IN: 签到获得积分
  • BONUS_MALL: 商品送积分
  • CASH_MALL: 商品现金送积分

积分状态 ​

  • NORMAL: 正常
  • HISTORY: 撤销
  • PROCESSING: 进行中

积分模式 ​

  • NORMAL: 正常
  • ROLLBACK: 回滚

来源类型 ​

  • INVITE: 邀客
  • CONFIG: 配置
  • MANUAL: 手动
  • SYSTEM: 系统

注意事项 ​

1. 表名动态化 ​

  • 使用动态表名机制，根据商户ID动态确定积分历史表名和顾客表名
  • 支持多租户架构，每个商户的数据存储在独立的表中

2. 待入账和已入账记录 ​

  • 系统支持查询待入账积分记录和已入账积分记录
  • 待入账记录存储在 T_CUSTOMER_UNPOINT_HISTORY 表中
  • 已入账记录存储在 T_CUSTOMER_POINT_HISTORY 表中

3. 查询条件 ​

  • 支持按顾客ID、门店ID、时间范围、来源类型等多种条件查询
  • 可以查询特定积分类型的历史记录

4. 分页和排序 ​

  • 支持标准分页参数 (pageNum, pageSize)
  • 默认按记录时间降序排列

5. 数据关联 ​

  • 积分历史记录与顾客表关联，可以获取顾客姓名等信息
  • 支持与门店表关联，可以按门店查询积分历史