dujiabo
/
zhongyouweb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
18 Commits
1 Branch
0 Tags
4.4 MiB
 
 
 
 
Tree: c1481ca6c6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c1481ca6c6'
${ noResults }
zhongyouweb/docs/api/modules/10-exchange-order-track.md

16 KiB
Raw Blame History

兑换订单追踪

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

快速索引

接口名称 方法 路径 用途
新增 POST /gd_dataserver/business/points/order/track/add 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
批量新增 POST /gd_dataserver/business/points/order/track/addBatch 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
新增并返回保存的数据 POST /gd_dataserver/business/points/order/track/addReturn 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
根据属性删除 GET /gd_dataserver/business/points/order/track/delete 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
主键删除 GET /gd_dataserver/business/points/order/track/deleteById 根据主键ID删除单条记录，成功返回 data 为 null。
批量删除 GET /gd_dataserver/business/points/order/track/deleteByIds 根据ID列表批量删除记录，成功返回 data 为 null。
查询所有 GET /gd_dataserver/business/points/order/track/getAll 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
分页查询 GET /gd_dataserver/business/points/order/track/getListByPage 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
详情 GET /gd_dataserver/business/points/order/track/info 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
条件查询 GET /gd_dataserver/business/points/order/track/list 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
查询订单追踪记录（按订单ID） GET /gd_dataserver/business/points/order/track/list/{orderId} 返回 data 为 ExchangeOrderTrack 数组，每个元素包含：id、orderId-订单ID、orderNo-订单号、fromStatus-原状态、toStatus-新状态、trackType-追踪类型、remark-备注、operator-操作人、createTime-操作时间。
查询订单追踪记录（按订单号） GET /gd_dataserver/business/points/order/track/listByNo/{orderNo} 返回 data 为 ExchangeOrderTrack 数组，字段同上。
逻辑删除 GET /gd_dataserver/business/points/order/track/removeById 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
修改 POST /gd_dataserver/business/points/order/track/updateById 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。

接口详情

新增

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

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：兑换订单追踪
  • 必填：文档未标记
字段 必填 类型 说明 示例
createTime 否 string / date-time 创建时间 -
fromStatus 否 integer / int32 变更前状态 -
id 否 integer / int64 主键ID -
ipAddress 否 string 操作IP -
operateType 否 string 操作类型：CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
operator 否 string 操作人 -
orderId 否 integer / int64 订单ID -
orderNo 否 string 订单号 -
remark 否 string 操作备注 -
statusName 否 string 状态名称 -
toStatus 否 integer / int32 变更后状态 -

响应：

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

批量新增

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

参数：

无

请求体：

  • 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/points/order/track/addReturn
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addReturnUsingPOST_7

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：兑换订单追踪
  • 必填：文档未标记
字段 必填 类型 说明 示例
createTime 否 string / date-time 创建时间 -
fromStatus 否 integer / int32 变更前状态 -
id 否 integer / int64 主键ID -
ipAddress 否 string 操作IP -
operateType 否 string 操作类型：CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
operator 否 string 操作人 -
orderId 否 integer / int64 订单ID -
orderNo 否 string 订单号 -
remark 否 string 操作备注 -
statusName 否 string 状态名称 -
toStatus 否 integer / int32 变更后状态 -

响应：

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

根据属性删除

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

参数：

字段 位置 必填 类型 说明 示例
createTime query 否 string / date-time 创建时间 -
fromStatus query 否 integer / int32 变更前状态 -
id query 否 integer / int64 主键ID -
ipAddress query 否 string 操作IP -
operateType query 否 string 操作类型：CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
operator query 否 string 操作人 -
orderId query 否 integer / int64 订单ID -
orderNo query 否 string 订单号 -
remark query 否 string 操作备注 -
statusName query 否 string 状态名称 -
toStatus query 否 integer / int32 变更后状态 -

响应：

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

主键删除

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

参数：

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

响应：

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

批量删除

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

参数：

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

响应：

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

查询所有

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

参数：

无

响应：

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

分页查询

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

参数：

字段 位置 必填 类型 说明 示例
createTime query 否 string / date-time 创建时间 -
fromStatus query 否 integer / int32 变更前状态 -
id query 否 integer / int64 主键ID -
ipAddress query 否 string 操作IP -
operateType query 否 string 操作类型：CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
operator query 否 string 操作人 -
orderId query 否 integer / int64 订单ID -
orderNo query 否 string 订单号 -
pageNum query 是 integer / int32 页码 -
remark query 否 string 操作备注 -
statusName query 否 string 状态名称 -
toStatus query 否 integer / int32 变更后状态 -
pageSize query 是 integer / int32 每页条数 -

响应：

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

详情

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

参数：

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

响应：

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

条件查询

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

参数：

字段 位置 必填 类型 说明 示例
createTime query 否 string / date-time 创建时间 -
fromStatus query 否 integer / int32 变更前状态 -
id query 否 integer / int64 主键ID -
ipAddress query 否 string 操作IP -
operateType query 否 string 操作类型：CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
operator query 否 string 操作人 -
orderId query 否 integer / int64 订单ID -
orderNo query 否 string 订单号 -
remark query 否 string 操作备注 -
statusName query 否 string 状态名称 -
toStatus query 否 integer / int32 变更后状态 -

响应：

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

查询订单追踪记录（按订单ID）

  • 用途： 返回 data 为 ExchangeOrderTrack 数组，每个元素包含：id、orderId-订单ID、orderNo-订单号、fromStatus-原状态、toStatus-新状态、trackType-追踪类型、remark-备注、operator-操作人、createTime-操作时间。
  • 请求： GET /gd_dataserver/business/points/order/track/list/{orderId}
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getTracksByOrderIdUsingGET

参数：

字段 位置 必填 类型 说明 示例
orderId path 是 integer / int64 订单ID -

响应：

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

查询订单追踪记录（按订单号）

  • 用途： 返回 data 为 ExchangeOrderTrack 数组，字段同上。
  • 请求： GET /gd_dataserver/business/points/order/track/listByNo/{orderNo}
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getTracksByOrderNoUsingGET

参数：

字段 位置 必填 类型 说明 示例
orderNo path 是 string 订单号 -

响应：

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

逻辑删除

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

参数：

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

响应：

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

修改

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

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：兑换订单追踪
  • 必填：文档未标记
字段 必填 类型 说明 示例
createTime 否 string / date-time 创建时间 -
fromStatus 否 integer / int32 变更前状态 -
id 否 integer / int64 主键ID -
ipAddress 否 string 操作IP -
operateType 否 string 操作类型：CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
operator 否 string 操作人 -
orderId 否 integer / int64 订单ID -
orderNo 否 string 订单号 -
remark 否 string 操作备注 -
statusName 否 string 状态名称 -
toStatus 否 integer / int32 变更后状态 -

响应：

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