# 积分兑换订单管理



本模块共 14 个接口。源文件：`api.json`。



## 快速索引



| 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/business/exchange/order/add` | 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/business/exchange/order/addBatch` | 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/business/exchange/order/addReturn` | 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 根据属性删除 | GET | `/gd_dataserver/business/exchange/order/delete` | 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/business/exchange/order/deleteById` | 根据主键ID删除单条记录，成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/business/exchange/order/deleteByIds` | 根据ID列表批量删除记录，成功返回 data 为 null。 |
| 查询所有 | GET | `/gd_dataserver/business/exchange/order/getAll` | 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/business/exchange/order/getListByPage` | 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/business/exchange/order/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/business/exchange/order/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 查询我的兑换记录（APP端） | GET | `/gd_dataserver/business/exchange/order/myList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 ExchangeOrder 对象，主要字段：id、orderNo-订单号、userId-用户ID、itemName-物品名称、itemPrice-单价积分、quantity-数量、totalPoints-总消耗积分、status-订单状态(0待处理/1处理中/2兑换成功/3兑换失败/4已退款/5已关闭)、createTime-创建时间、finishTime-完成时间。 |
| 退款（管理端操作） | POST | `/gd_dataserver/business/exchange/order/refund/{orderId}` | 将订单状态改为已退款(4)，并退回积分到用户账户。返回 data 为 boolean。 |
| 逻辑删除 | GET | `/gd_dataserver/business/exchange/order/removeById` | 根据主键ID逻辑删除单条记录，成功返回 data 为 null。 |
| 修改 | POST | `/gd_dataserver/business/exchange/order/updateById` | 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。 |


## 接口详情



### 新增

- **用途：** 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
- **请求：** `POST /gd_dataserver/business/exchange/order/add`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `addOneUsingPOST_6`

参数：

_无_

请求体：

- Content-Type：`application/json`
- 模型：`积分兑换订单`
- 必填：文档未标记

| 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | - | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| finishTime | 否 | string / date-time | 完成时间 | - |
| id | 否 | integer / int64 | 主键ID | - |
| itemId | 否 | integer / int64 | 兑换物品ID | - |
| itemName | 否 | string | 物品名称 | - |
| itemPrice | 否 | integer / int32 | 兑换所需积分 | - |
| orderNo | 否 | string | 订单号 | - |
| quantity | 否 | integer / int32 | 兑换数量 | - |
| status | 否 | integer / int32 | 订单状态：0-待处理 1-处理中 2-兑换成功 3-兑换失败 4-已退款 5-已关闭 | - |
| thirdPartyOrderId | 否 | string | 第三方平台订单号 | - |
| thirdPartyResponse | 否 | string | 第三方回调原始数据 | - |
| totalPoints | 否 | integer / int32 | 总消耗积分 | - |
| updateTime | 否 | string / date-time | 更新时间 | - |
| userId | 否 | integer / int64 | 用户ID | - |


响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 批量新增

- **用途：** 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
- **请求：** `POST /gd_dataserver/business/exchange/order/addBatch`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `addBatchUsingPOST_6`

参数：

_无_

请求体：

- Content-Type：`application/json`
- 模型：`array<积分兑换订单>`
- 必填：文档未标记

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 新增并返回保存的数据

- **用途：** 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求：** `POST /gd_dataserver/business/exchange/order/addReturn`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `addReturnUsingPOST_6`

参数：

_无_

请求体：

- Content-Type：`application/json`
- 模型：`积分兑换订单`
- 必填：文档未标记

| 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | - | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| finishTime | 否 | string / date-time | 完成时间 | - |
| id | 否 | integer / int64 | 主键ID | - |
| itemId | 否 | integer / int64 | 兑换物品ID | - |
| itemName | 否 | string | 物品名称 | - |
| itemPrice | 否 | integer / int32 | 兑换所需积分 | - |
| orderNo | 否 | string | 订单号 | - |
| quantity | 否 | integer / int32 | 兑换数量 | - |
| status | 否 | integer / int32 | 订单状态：0-待处理 1-处理中 2-兑换成功 3-兑换失败 4-已退款 5-已关闭 | - |
| thirdPartyOrderId | 否 | string | 第三方平台订单号 | - |
| thirdPartyResponse | 否 | string | 第三方回调原始数据 | - |
| totalPoints | 否 | integer / int32 | 总消耗积分 | - |
| updateTime | 否 | string / date-time | 更新时间 | - |
| userId | 否 | integer / int64 | 用户ID | - |


响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 根据属性删除

- **用途：** 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
- **请求：** `GET /gd_dataserver/business/exchange/order/delete`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `deleteUsingGET_6`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | - | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| finishTime | query | 否 | string / date-time | 完成时间 | - |
| id | query | 否 | integer / int64 | 主键ID | - |
| itemId | query | 否 | integer / int64 | 兑换物品ID | - |
| itemName | query | 否 | string | 物品名称 | - |
| itemPrice | query | 否 | integer / int32 | 兑换所需积分 | - |
| orderNo | query | 否 | string | 订单号 | - |
| quantity | query | 否 | integer / int32 | 兑换数量 | - |
| status | query | 否 | integer / int32 | 订单状态：0-待处理 1-处理中 2-兑换成功 3-兑换失败 4-已退款 5-已关闭 | - |
| thirdPartyOrderId | query | 否 | string | 第三方平台订单号 | - |
| thirdPartyResponse | query | 否 | string | 第三方回调原始数据 | - |
| totalPoints | query | 否 | integer / int32 | 总消耗积分 | - |
| updateTime | query | 否 | string / date-time | 更新时间 | - |
| userId | query | 否 | integer / int64 | 用户ID | - |

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 主键删除

- **用途：** 根据主键ID删除单条记录，成功返回 data 为 null。
- **请求：** `GET /gd_dataserver/business/exchange/order/deleteById`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `deleteOneUsingGET_6`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | string | 主键ID | - |

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 批量删除

- **用途：** 根据ID列表批量删除记录，成功返回 data 为 null。
- **请求：** `GET /gd_dataserver/business/exchange/order/deleteByIds`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `deleteListUsingGET_13`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | string | ID列表(逗号分隔) | - |

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 查询所有

- **用途：** 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
- **请求：** `GET /gd_dataserver/business/exchange/order/getAll`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `getAllUsingGET_6`

参数：

_无_

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 分页查询

- **用途：** 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
- **请求：** `GET /gd_dataserver/business/exchange/order/getListByPage`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `getListByPageUsingGET_6`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | - | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| finishTime | query | 否 | string / date-time | 完成时间 | - |
| id | query | 否 | integer / int64 | 主键ID | - |
| itemId | query | 否 | integer / int64 | 兑换物品ID | - |
| itemName | query | 否 | string | 物品名称 | - |
| itemPrice | query | 否 | integer / int32 | 兑换所需积分 | - |
| orderNo | query | 否 | string | 订单号 | - |
| pageNum | query | 是 | integer / int32 | 页码 | - |
| quantity | query | 否 | integer / int32 | 兑换数量 | - |
| status | query | 否 | integer / int32 | 订单状态：0-待处理 1-处理中 2-兑换成功 3-兑换失败 4-已退款 5-已关闭 | - |
| thirdPartyOrderId | query | 否 | string | 第三方平台订单号 | - |
| thirdPartyResponse | query | 否 | string | 第三方回调原始数据 | - |
| totalPoints | query | 否 | integer / int32 | 总消耗积分 | - |
| updateTime | query | 否 | string / date-time | 更新时间 | - |
| userId | query | 否 | integer / int64 | 用户ID | - |
| pageSize | query | 是 | integer / int32 | 每页条数 | - |

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 详情

- **用途：** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
- **请求：** `GET /gd_dataserver/business/exchange/order/info`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `infoUsingGET_6`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | string | 主键ID | - |

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 条件查询

- **用途：** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求：** `GET /gd_dataserver/business/exchange/order/list`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `getListUsingGET_6`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | - | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| finishTime | query | 否 | string / date-time | 完成时间 | - |
| id | query | 否 | integer / int64 | 主键ID | - |
| itemId | query | 否 | integer / int64 | 兑换物品ID | - |
| itemName | query | 否 | string | 物品名称 | - |
| itemPrice | query | 否 | integer / int32 | 兑换所需积分 | - |
| orderNo | query | 否 | string | 订单号 | - |
| quantity | query | 否 | integer / int32 | 兑换数量 | - |
| status | query | 否 | integer / int32 | 订单状态：0-待处理 1-处理中 2-兑换成功 3-兑换失败 4-已退款 5-已关闭 | - |
| thirdPartyOrderId | query | 否 | string | 第三方平台订单号 | - |
| thirdPartyResponse | query | 否 | string | 第三方回调原始数据 | - |
| totalPoints | query | 否 | integer / int32 | 总消耗积分 | - |
| updateTime | query | 否 | string / date-time | 更新时间 | - |
| userId | query | 否 | integer / int64 | 用户ID | - |

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 查询我的兑换记录（APP端）

- **用途：** 返回 data 为 PageInfo 分页对象。list 中每条记录为 ExchangeOrder 对象，主要字段：id、orderNo-订单号、userId-用户ID、itemName-物品名称、itemPrice-单价积分、quantity-数量、totalPoints-总消耗积分、status-订单状态(0待处理/1处理中/2兑换成功/3兑换失败/4已退款/5已关闭)、createTime-创建时间、finishTime-完成时间。
- **请求：** `GET /gd_dataserver/business/exchange/order/myList`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `myListUsingGET`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | - | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| finishTime | query | 否 | string / date-time | 完成时间 | - |
| id | query | 否 | integer / int64 | 主键ID | - |
| itemId | query | 否 | integer / int64 | 兑换物品ID | - |
| itemName | query | 否 | string | 物品名称 | - |
| itemPrice | query | 否 | integer / int32 | 兑换所需积分 | - |
| orderNo | query | 否 | string | 订单号 | - |
| pageNum | query | 否 | integer / int32 | 页码 | - |
| quantity | query | 否 | integer / int32 | 兑换数量 | - |
| status | query | 否 | integer / int32 | 订单状态：0-待处理 1-处理中 2-兑换成功 3-兑换失败 4-已退款 5-已关闭 | - |
| thirdPartyOrderId | query | 否 | string | 第三方平台订单号 | - |
| thirdPartyResponse | query | 否 | string | 第三方回调原始数据 | - |
| totalPoints | query | 否 | integer / int32 | 总消耗积分 | - |
| updateTime | query | 否 | string / date-time | 更新时间 | - |
| userId | query | 否 | integer / int64 | 用户ID | - |
| pageSize | query | 否 | integer / int32 | 每页数量 | - |

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 退款（管理端操作）

- **用途：** 将订单状态改为已退款(4)，并退回积分到用户账户。返回 data 为 boolean。
- **请求：** `POST /gd_dataserver/business/exchange/order/refund/{orderId}`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `refundOrderUsingPOST`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| orderId | path | 是 | integer / int64 | 订单ID | - |
| operator | query | 是 | string | 操作人 | - |

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 逻辑删除

- **用途：** 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
- **请求：** `GET /gd_dataserver/business/exchange/order/removeById`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `deleteListUsingGET_12`

参数：

| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | string | 主键ID | - |

响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |


### 修改

- **用途：** 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。
- **请求：** `POST /gd_dataserver/business/exchange/order/updateById`
- **鉴权：** `X-Access-Token`（以接口定义为准）
- **operationId：** `updateByIdUsingPOST_6`

参数：

_无_

请求体：

- Content-Type：`application/json`
- 模型：`积分兑换订单`
- 必填：文档未标记

| 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | - | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| finishTime | 否 | string / date-time | 完成时间 | - |
| id | 否 | integer / int64 | 主键ID | - |
| itemId | 否 | integer / int64 | 兑换物品ID | - |
| itemName | 否 | string | 物品名称 | - |
| itemPrice | 否 | integer / int32 | 兑换所需积分 | - |
| orderNo | 否 | string | 订单号 | - |
| quantity | 否 | integer / int32 | 兑换数量 | - |
| status | 否 | integer / int32 | 订单状态：0-待处理 1-处理中 2-兑换成功 3-兑换失败 4-已退款 5-已关闭 | - |
| thirdPartyOrderId | 否 | string | 第三方平台订单号 | - |
| thirdPartyResponse | 否 | string | 第三方回调原始数据 | - |
| totalPoints | 否 | integer / int32 | 总消耗积分 | - |
| updateTime | 否 | string / date-time | 更新时间 | - |
| userId | 否 | integer / int64 | 用户ID | - |


响应：

| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |