USER_POINTS_ORDER_API.md 2.2 KB

用户积分订单 API 文档

本文档描述了用户积分订单相关的接口规范。

1. 积分订单列表查询

  • URL: /v2/user/points/order/list
  • Method: GET
  • 描述: 分页查询用户的积分订单记录,包含订单详情及关联的用户基础信息。

请求参数

字段名 类型 必填 说明
page integer 否 页码,默认 1
size integer 否 每页大小,默认 10
userId long 否 用户ID
productId integer 否 产品ID
startTime string 否 开始时间 (yyyy-MM-dd HH:mm:ss)
endTime string 否 结束时间 (yyyy-MM-dd HH:mm:ss)

响应参数 (data 字段)

返回 Mybatis-Plus Page 对象,包含 records (订单列表), total (总数), size (页大小), current (当前页) 等。

records 中的对象 (UserPointsOrderVO) 结构如下:

字段名 类型 说明
id long 订单ID
userId long 用户ID
productId integer 产品ID
points integer 积分数量
transactionId string 交易ID (第三方支付流水号)
payPrice decimal 支付价格
createTime string 订单创建时间
nickname string 用户昵称
avatar string 用户头像URL
email string 用户邮箱
appleUserId string 苹果用户ID
originalTransactionId string 原始交易ID
platform string 平台
language string 语言

示例请求

GET /v2/user/points/order/list?page=1&size=10&userId=12345

示例响应

{
  "code": 200,
  "message": "success",
  "success": true,
  "data": {
    "records": [
      {
        "id": 1001,
        "userId": 12345,
        "productId": 1,
        "points": 100,
        "transactionId": "TXN_123456789",
        "payPrice": 9.99,
        "createTime": "2023-10-27 10:00:00",
        "nickname": "User123",
        "avatar": "http://example.com/avatar.jpg",
        "email": "user@example.com"
      }
    ],
    "total": 1,
    "size": 10,
    "current": 1,
    "pages": 1
  },
  "timestamp": 1698372000000
}