GoodsApi.java 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. package com.qdb.sdk.api;
  2. import com.alibaba.fastjson2.TypeReference;
  3. import com.qdb.sdk.QdbClient;
  4. import com.qdb.sdk.QdbException;
  5. import com.qdb.sdk.model.request.*;
  6. import com.qdb.sdk.model.response.*;
  7. import java.util.List;
  8. /**
  9. * 商品管理 API
  10. * <p>
  11. * 提供商品上传、查询、单位管理等接口的调用封装。
  12. * 对应文档:02-商品管理.md
  13. * </p>
  14. *
  15. * @author qdb-sdk
  16. * @version 1.0.0
  17. */
  18. public class GoodsApi extends BaseQdbApi {
  19. /** 商品上传(系统商品 + 店铺商品) */
  20. private static final String METHOD_GOODS_SAVE = "foonsu.erp.goods.save";
  21. /** 系统商品上传(批量,最大100) */
  22. private static final String METHOD_SYS_GOODS_SAVE = "foonsu.erp.sysGoods.save";
  23. /** 商品单位查询 */
  24. private static final String METHOD_SYS_GOODS_LIST_UNIT = "foonsu.erp.sysGoods.listUnit";
  25. /** 系统商品查询 */
  26. private static final String METHOD_SYS_GOODS_LIST = "foonsu.erp.sysGoods.list";
  27. /** 批量新增店铺商品 */
  28. private static final String METHOD_PLATFORM_GOODS_BATCH_SAVE = "foonsu.erp.platForm.goods.batchSave";
  29. /** 批量修改店铺商品 */
  30. private static final String METHOD_PLATFORM_GOODS_BATCH_UPDATE = "foonsu.erp.platForm.goods.batchUpdate";
  31. public GoodsApi(QdbClient client) {
  32. super(client);
  33. }
  34. /**
  35. * 商品上传
  36. * <p>
  37. * 上传至系统商品以及店铺商品(即【商品信息】、【店铺商品设置】页面)。
  38. * </p>
  39. *
  40. * @param request 商品上传请求参数
  41. * @return 响应对象(data 为 null)
  42. * @throws QdbException 调用失败时抛出
  43. */
  44. public QdbResponse<Void> saveGoods(GoodsSaveRequest request) throws QdbException {
  45. return execute(METHOD_GOODS_SAVE, request);
  46. }
  47. /**
  48. * 系统商品上传
  49. * <p>
  50. * 批量上传至系统商品(即【商品信息】页面),单次最大100条。
  51. * </p>
  52. *
  53. * @param request 系统商品上传请求参数
  54. * @return 响应对象,data 包含上传结果统计
  55. * @throws QdbException 调用失败时抛出
  56. */
  57. public QdbResponse<SysGoodsSaveResponse> saveSysGoods(SysGoodsSaveRequest request) throws QdbException {
  58. return execute(METHOD_SYS_GOODS_SAVE, request, SysGoodsSaveResponse.class);
  59. }
  60. /**
  61. * 商品单位查询
  62. * <p>
  63. * 查询商品单位列表。
  64. * </p>
  65. *
  66. * @param request 查询请求参数(可分页)
  67. * @return 响应对象,data 包含单位列表
  68. * @throws QdbException 调用失败时抛出
  69. */
  70. public QdbResponse<GoodsUnitListResponse> listGoodsUnits(GoodsUnitQueryRequest request) throws QdbException {
  71. return execute(METHOD_SYS_GOODS_LIST_UNIT, request, GoodsUnitListResponse.class);
  72. }
  73. /**
  74. * 系统商品查询
  75. * <p>
  76. * 查询系统商品信息(即【商品信息】、【组合商品】页面数据)。
  77. * 注意:此方法解析 data 为扁平列表,不适用于分页场景。
  78. * 分页场景请使用 {@link #listSysGoodsPaged(SysGoodsQueryRequest)}。
  79. * </p>
  80. *
  81. * @param request 查询请求参数(支持多种筛选条件)
  82. * @return 响应对象,data 为系统商品列表
  83. * @throws QdbException 调用失败时抛出
  84. */
  85. public QdbResponse<List<SysGoodsVO>> listSysGoods(SysGoodsQueryRequest request) throws QdbException {
  86. return execute(METHOD_SYS_GOODS_LIST, request,
  87. new TypeReference<List<SysGoodsVO>>() {});
  88. }
  89. /**
  90. * 系统商品查询(带分页信息)
  91. * <p>
  92. * 查询系统商品信息,返回包含 total 和 data 的分页结果。
  93. * 适用于需要分页遍历所有系统商品的场景(如同步到本地缓存)。
  94. * </p>
  95. *
  96. * @param request 查询请求参数
  97. * @return 响应对象,data 为包含 total 和商品列表的分页结果
  98. * @throws QdbException 调用失败时抛出
  99. */
  100. public QdbResponse<SysGoodsPageResult> listSysGoodsPaged(SysGoodsQueryRequest request) throws QdbException {
  101. return execute(METHOD_SYS_GOODS_LIST, request,
  102. new TypeReference<SysGoodsPageResult>() {});
  103. }
  104. /**
  105. * 批量新增店铺商品
  106. * <p>
  107. * 批量新增店铺商品(即【店铺商品设置】页面)。
  108. * </p>
  109. *
  110. * @param request 批量新增请求参数
  111. * @return 响应对象,data 包含操作结果统计
  112. * @throws QdbException 调用失败时抛出
  113. */
  114. public QdbResponse<PlatformGoodsBatchResponse> batchSavePlatformGoods(
  115. PlatformGoodsBatchSaveRequest request) throws QdbException {
  116. return execute(METHOD_PLATFORM_GOODS_BATCH_SAVE, request, PlatformGoodsBatchResponse.class);
  117. }
  118. /**
  119. * 批量修改店铺商品
  120. * <p>
  121. * 批量更新店铺商品信息。
  122. * </p>
  123. *
  124. * @param request 批量修改请求参数
  125. * @return 响应对象,data 包含操作结果统计
  126. * @throws QdbException 调用失败时抛出
  127. */
  128. public QdbResponse<PlatformGoodsBatchResponse> batchUpdatePlatformGoods(
  129. PlatformGoodsBatchUpdateRequest request) throws QdbException {
  130. return execute(METHOD_PLATFORM_GOODS_BATCH_UPDATE, request, PlatformGoodsBatchResponse.class);
  131. }
  132. }