shuhi-ui/docs/2026-08-01-API接口文档.md

2026-08-01 API 接口文档

来源: bk.shuhi.com Swagger UI - 功能模块
日期: 2026-08-01
共 14 个接口

---

接口总览

#	HTTP 方法	请求路径	描述	权限标识
1	POST	/activation/bookActivationInfo/cancel	出入库记录-作废	activation:bookActivationInfo:cancel
2	POST	/activation/bookActivationInfo/activationAdd	APP-上报激活码	app:activation:add
3	GET	/activation/bookActivationInfo/pageList	分页查询图书激活码管理列表	activation:bookActivationInfo:list
4	GET	/activation/bookActivationInfo/pageInLogs/{isbn}	分页查询图书激活码管理-入库明细	activation:bookActivationInfo:inLogs
5	GET	/activation/bookActivationInfo/inOutSum	查询出入库记录-汇总	activation:bookActivationInfo:inOutSum
6	GET	/activation/bookActivationInfo/inOutList	分页查询出入库记录	activation:bookActivationInfo:inOutList
7	GET	/activation/bookActivationCodeRepository/pagelist	分页查询图书激活码仓库列表	activation:bookActivationCodeRepository:list
8	GET	/activation/bookActivationCodeRepository/getInfo/{id}	根据主键获取图书激活码仓库详细信息	activation:bookActivationCodeRepository:query
9	POST	/activation/bookActivationInfo/outStock	出库	activation:bookActivationInfo:outStock
10	POST	/activation/bookActivationInfo/getStockAllRepository/{isbn}	点击库存查看各个仓库库存情况	activation:bookActivationInfo:list
11	POST	/activation/bookActivationInfo/getSellAllRepository/{isbn}	点击库存查看各个仓库销量情况	activation:bookActivationInfo:list
12	POST	/activation/bookActivationCodeRepository/update	修改图书激活码仓库	activation:bookActivationCodeRepository:update
13	POST	/activation/bookActivationCodeRepository/openClose	启用/禁用图书激活码仓库	activation:bookActivationCodeRepository:openClose
14	POST	/activation/bookActivationCodeRepository/add	新增图书激活码仓库	activation:bookActivationCodeRepository:add

---

接口详情

一、图书激活码管理 (/activation/bookActivationInfo)

1. 取消入库记录

• 方法: POST
• 路径: /activation/bookActivationInfo/cancel
• 描述: 出入库记录-作废
• 权限: activation:bookActivationInfo:cancel

请求体 (Request Body)

参数名	类型	必填	说明
id	integer	是	入库记录 ID
reason	string	否	废弃原因

---

2. APP上报复激活码

• 方法: POST
• 路径: /activation/bookActivationInfo/activationAdd
• 描述: APP-上报激活码
• 权限: app:activation:add

请求体 (Request Body)

参数名	类型	必填	说明
isbn	string	是	ISBN 编码
img	string	否	图片（Base64 或 URL）

---

3. 分页查询图书激活码管理列表

• 方法: GET
• 路径: /activation/bookActivationInfo/pageList
• 描述: 分页查询图书激活码管理列表
• 权限: activation:bookActivationInfo:list

查询参数 (Query Parameters)

参数名	类型	必填	说明
repositoryId	integer	否	仓库 ID
isbn	string	否	ISBN 编码
bookName	string	否	书名
orderField	integer	否	排序方式：NULL-默认 ISBN 排序，1-库存降序，2-库存升序，3-销量降序，4-销量升序

---

4. 分页查询图书激活码管理-入库明细

• 方法: GET
• 路径: /activation/bookActivationInfo/pageInLogs/{isbn}
• 描述: 分页查询图书激活码管理-入库明细
• 权限: activation:bookActivationInfo:inLogs

路径参数 (Path Parameters)

参数名	类型	必填	说明
isbn	string	是	ISBN 编码

---

5. 查询出入库记录-汇总

• 方法: GET
• 路径: /activation/bookActivationInfo/inOutSum
• 描述: 查询出入库记录-汇总（入参只看时间范围）
• 权限: activation:bookActivationInfo:inOutSum

查询参数 (Query Parameters)

参数名	类型	必填	说明
repositoryId	integer	否	仓库 ID
isbn	string	否	ISBN 编码
bookName	string	否	书名
type	integer	否	操作类型：1-入库，2-出库
remark	string	否	备注信息
startTime	string	否	操作时间开始范围（date-time）
endTime	string	否	操作时间结束范围（date-time）

---

6. 分页查询出入库记录

• 方法: GET
• 路径: /activation/bookActivationInfo/inOutList
• 描述: 分页查询出入库记录
• 权限: activation:bookActivationInfo:inOutList

查询参数 (Query Parameters)

参数名	类型	必填	说明
repositoryId	integer	否	仓库 ID
isbn	string	否	ISBN 编码
bookName	string	否	书名
type	integer	否	操作类型：1-入库，2-出库
remark	string	否	备注信息
startTime	string	否	操作时间开始范围（date-time）
endTime	string	否	操作时间结束范围（date-time）

---

7. 出库

• 方法: POST
• 路径: /activation/bookActivationInfo/outStock
• 描述: 出库
• 权限: activation:bookActivationInfo:outStock

请求体 (Request Body)

参数名	类型	必填	说明
repositoryId	integer	是	仓库 ID
isbn	string	是	ISBN 编码
num	integer	是	出库数量
price	number	否	单价
remark	string	否	备注

---

8. 点击库存查看各个仓库库存情况

• 方法: POST
• 路径: /activation/bookActivationInfo/getStockAllRepository/{isbn}
• 描述: 点击库存查看各个仓库库存情况
• 权限: activation:bookActivationInfo:list

路径参数 (Path Parameters)

参数名	类型	必填	说明
isbn	string	是	ISBN 编码

---

9. 点击库存查看各个仓库销量情况

• 方法: POST
• 路径: /activation/bookActivationInfo/getSellAllRepository/{isbn}
• 描述: 点击库存查看各个仓库销量情况
• 权限: activation:bookActivationInfo:list

路径参数 (Path Parameters)

参数名	类型	必填	说明
isbn	string	是	ISBN 编码

---

二、图书激活码仓库管理 (/activation/bookActivationCodeRepository)

10. 分页查询图书激活码仓库列表

• 方法: GET
• 路径: /activation/bookActivationCodeRepository/pagelist
• 描述: 分页查询图书激活码仓库列表
• 权限: activation:bookActivationCodeRepository:list

查询参数 (Query Parameters)

参数名	类型	必填	说明
repositoryName	string	否	仓库名称
contactsName	string	否	联系人
mobile	string	否	手机号
status	string	否	使用状态：NULL-全部，1-启用，2-禁用

---

11. 根据主键获取图书激活码仓库详细信息

• 方法: GET
• 路径: /activation/bookActivationCodeRepository/getInfo/{id}
• 描述: 根据主键获取图书激活码仓库详细信息
• 权限: activation:bookActivationCodeRepository:query

路径参数 (Path Parameters)

参数名	类型	必填	说明
id	integer	是	仓库主键 ID

---

12. 修改图书激活码仓库

• 方法: POST
• 路径: /activation/bookActivationCodeRepository/update
• 描述: 修改图书激活码仓库
• 权限: activation:bookActivationCodeRepository:update

请求体 (Request Body)

参数名	类型	必填	说明
id	integer	是	仓库 ID
repositoryName	string	是	仓库名称
contactsName	string	否	联系人
mobile	string	否	手机号
provinceId	integer	否	省 ID
cityId	integer	否	市 ID
countyId	integer	否	县 ID
addressDetail	string	否	详细地址
status	string	否	使用状态：1-启用，2-禁用

---

13. 启用/禁用图书激活码仓库

• 方法: POST
• 路径: /activation/bookActivationCodeRepository/openClose
• 描述: 启用/禁用图书激活码仓库
• 权限: activation:bookActivationCodeRepository:openClose

请求体 (Request Body)

参数名	类型	必填	说明
id	integer	是	仓库 ID
status	string	是	使用状态：1-启用，2-禁用

---

14. 新增图书激活码仓库

• 方法: POST
• 路径: /activation/bookActivationCodeRepository/add
• 描述: 新增图书激活码仓库
• 权限: activation:bookActivationCodeRepository:add

请求体 (Request Body)

参数名	类型	必填	说明
id	integer	否	新增时为 NULL
repositoryName	string	是	仓库名称
contactsName	string	否	联系人
mobile	string	否	手机号
provinceId	integer	否	省 ID
cityId	integer	否	市 ID
countyId	integer	否	县 ID
addressDetail	string	否	详细地址
status	string	否	使用状态：1-启用，2-禁用

---

统计

维度	详情
接口总数	14
GET 接口	6
POST 接口	8
图书激活码管理模块	9 个接口
图书激活码仓库管理模块	5 个接口