Skip to content

feat(channel): 实现视频号小店缺失的商品相关API（Issue #4002） #4033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 3 commits into
base: develop
Choose a base branch
from
+1,691 −0
Open

feat(channel): 实现视频号小店缺失的商品相关API（Issue #4002） #4033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1be31c6
Initial plan
Copilot May 31, 2026
22a6f33
feat(channel): 实现视频号小店缺失的14个商品相关API
Copilot Jun 1, 2026
ac1c1f3
test(channel): 为14个新增视频号小店接口添加单元测试
Copilot Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/WxChannelGiftService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
package me.chanjar.weixin.channel.api;

import me.chanjar.weixin.channel.bean.base.WxChannelBaseResponse;
import me.chanjar.weixin.channel.bean.gift.GiftGetResponse;
import me.chanjar.weixin.channel.bean.gift.GiftProductInfo;
import me.chanjar.weixin.channel.bean.gift.GiftProductListResponse;
import me.chanjar.weixin.channel.bean.gift.GiftProductResponse;
import me.chanjar.weixin.channel.bean.gift.GiftProductUpdateInfo;
import me.chanjar.weixin.channel.bean.gift.GiftSetParam;
import me.chanjar.weixin.common.error.WxErrorException;

/**
* 视频号小店 赠品管理服务接口
*
* @author <a href="https://github.com/features/copilot">GitHub Copilot</a>
* @see <a href="https://developers.weixin.qq.com/doc/store/shop/API/channels-shop-product/gift/api_addgiftproduct.html">赠品管理接口文档</a>
*/
public interface WxChannelGiftService {

/**
* 添加非卖商品（赠品）
*
* @param info 赠品信息
* @return GiftProductResponse
* @throws WxErrorException 异常
*/
GiftProductResponse addGiftProduct(GiftProductInfo info) throws WxErrorException;

/**
* 更新非卖商品（赠品）
*
* @param info 赠品更新信息
* @return GiftProductResponse
* @throws WxErrorException 异常
*/
GiftProductResponse updateGiftProduct(GiftProductUpdateInfo info) throws WxErrorException;

/**
* 在售商品转赠品（设置在售商品为赠品）
*
* @param param 请求参数（product_id + skus 列表）
* @return GiftProductListResponse
* @throws WxErrorException 异常
*/
GiftProductListResponse setProductAsGift(GiftSetParam param) throws WxErrorException;

/**
* 获取赠品详情
*
* @param productId 赠品商品ID
* @param dataType 数据类型。1: 仅获取线上数据；2: 仅获取草稿数据；3: 同时获取（默认）
* @return GiftGetResponse
* @throws WxErrorException 异常
*/
GiftGetResponse getGiftProduct(String productId, Integer dataType) throws WxErrorException;

/**
* 获取赠品列表
*
* @param pageSize 每页数量
* @param nextKey 翻页上下文，不传默认获取第一页
* @param status 赠品状态过滤
* @return GiftProductListResponse
* @throws WxErrorException 异常
*/
GiftProductListResponse listGiftProduct(Integer pageSize, String nextKey, Integer status)
throws WxErrorException;

/**
* 更新赠品库存
*
* @param productId 赠品商品ID
* @param skuId SKU ID
* @param diffType 差量类型。1: 增加；2: 减少
* @param num 变更数量
* @return WxChannelBaseResponse
* @throws WxErrorException 异常
*/
WxChannelBaseResponse updateGiftStock(String productId, String skuId, Integer diffType, Integer num)
throws WxErrorException;
}
87 changes: 87 additions & 0 deletions weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/WxChannelProductService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@
import me.chanjar.weixin.channel.bean.limit.LimitTaskAddResponse;
import me.chanjar.weixin.channel.bean.limit.LimitTaskListResponse;
import me.chanjar.weixin.channel.bean.limit.LimitTaskParam;
import me.chanjar.weixin.channel.bean.limit.LimitTaskUpdateParam;
import me.chanjar.weixin.channel.bean.limit.LimitTaskUpdateResponse;
import me.chanjar.weixin.channel.bean.product.CategoryPreCheckResponse;
import me.chanjar.weixin.channel.bean.product.ExternalProductMappingNewParam;
import me.chanjar.weixin.channel.bean.product.ExternalProductMappingNewResponse;
import me.chanjar.weixin.channel.bean.product.ExternalProductMappingParam;
import me.chanjar.weixin.channel.bean.product.ExternalProductMappingResponse;
import me.chanjar.weixin.channel.bean.product.ProductBrandRecommendParam;
import me.chanjar.weixin.channel.bean.product.ProductBrandRecommendResponse;
import me.chanjar.weixin.channel.bean.product.SkuStockBatchResponse;
import me.chanjar.weixin.channel.bean.product.SkuStockResponse;
import me.chanjar.weixin.channel.bean.product.SpuFastInfo;
Expand All @@ -14,6 +23,8 @@
import me.chanjar.weixin.channel.bean.product.SpuListResponse;
import me.chanjar.weixin.channel.bean.product.SpuUpdateInfo;
import me.chanjar.weixin.channel.bean.product.SpuUpdateResponse;
import me.chanjar.weixin.channel.bean.product.StockFlowParam;
import me.chanjar.weixin.channel.bean.product.StockFlowResponse;
import me.chanjar.weixin.channel.bean.product.link.ProductH5UrlResponse;
import me.chanjar.weixin.channel.bean.product.link.ProductQrCodeResponse;
import me.chanjar.weixin.channel.bean.product.link.ProductTagLinkResponse;
Expand Down Expand Up @@ -247,4 +258,80 @@ WxChannelBaseResponse updateStock(String productId, String skuId, Integer diffTy
* @throws WxErrorException 异常
*/
WxChannelBaseResponse deleteLimitTask(String taskId) throws WxErrorException;

/**
* 更新限时抢购任务
*
* @param param 更新参数
* @return LimitTaskUpdateResponse
* @throws WxErrorException 异常
*/
LimitTaskUpdateResponse updateLimitTask(LimitTaskUpdateParam param) throws WxErrorException;

/**
* 获取库存流水
*
* @param param 查询参数
* @return StockFlowResponse
* @throws WxErrorException 异常
*/
StockFlowResponse getStockFlow(StockFlowParam param) throws WxErrorException;

/**
* 发品前校验（校验当前商家是否具备在指定类目发品的资质）
*
* @param catId 叶子类目id
* @return CategoryPreCheckResponse
* @throws WxErrorException 异常
*/
CategoryPreCheckResponse categoryPreCheck(Long catId) throws WxErrorException;

/**
* 商品品牌推荐（根据商品信息推荐品牌）
*
* @param param 请求参数
* @return ProductBrandRecommendResponse
* @throws WxErrorException 异常
*/
ProductBrandRecommendResponse getProductBrandRecommend(ProductBrandRecommendParam param)
throws WxErrorException;

/**
* 站内外商品属性映射
*
* @param param 请求参数
* @return ExternalProductMappingResponse
* @throws WxErrorException 异常
*/
ExternalProductMappingResponse externalProductMapping(ExternalProductMappingParam param)
throws WxErrorException;

/**
* 站内外商品属性映射（新版）
*
* @param param 请求参数
* @return ExternalProductMappingNewResponse
* @throws WxErrorException 异常
*/
ExternalProductMappingNewResponse externalProductMappingNew(ExternalProductMappingNewParam param)
throws WxErrorException;

/**
* 商品立即开售（结束预售）
*
* @param productId 商品ID
* @param taskId 预售任务ID
* @return WxChannelBaseResponse
* @throws WxErrorException 异常
*/
WxChannelBaseResponse beginTimingSale(String productId, String taskId) throws WxErrorException;
Comment on lines +323 to +327

/**
* 取消商品开售（取消预售）
*
* @param productId 商品ID
* @return WxChannelBaseResponse
* @throws WxErrorException 异常
*/
WxChannelBaseResponse cancelTimingSale(String productId) throws WxErrorException;
}
7 changes: 7 additions & 0 deletions weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/WxChannelService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,11 @@ public interface WxChannelService extends BaseWxChannelService {
*/
WxChannelLiveDashboardService getLiveDashboardService();

/**
* 赠品管理服务
*
* @return 赠品管理服务
*/
WxChannelGiftService getGiftService();

}
9 changes: 9 additions & 0 deletions ...va-channel/src/main/java/me/chanjar/weixin/channel/api/impl/BaseWxChannelServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ public abstract class BaseWxChannelServiceImpl<H, P> implements WxChannelService
private WxChannelVipService vipService = null;
private WxChannelCompassFinderService compassFinderService = null;
private WxChannelLiveDashboardService liveDashboardService = null;
private WxChannelGiftService giftService = null;

protected WxChannelConfig config;
private int retrySleepMillis = 1000;
Expand Down Expand Up @@ -473,4 +474,12 @@ public synchronized WxChannelLiveDashboardService getLiveDashboardService() {
return liveDashboardService;
}

@Override
public synchronized WxChannelGiftService getGiftService() {
if (giftService == null) {
giftService = new WxChannelGiftServiceImpl(this);
}
return giftService;
}

}
84 changes: 84 additions & 0 deletions ...va-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelGiftServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
package me.chanjar.weixin.channel.api.impl;

import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Gift.ADD_GIFT_PRODUCT_URL;
import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Gift.GET_GIFT_PRODUCT_URL;
import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Gift.LIST_GIFT_PRODUCT_URL;
import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Gift.SET_PRODUCT_AS_GIFT_URL;
import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Gift.UPDATE_GIFT_PRODUCT_URL;
import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Gift.UPDATE_GIFT_STOCK_URL;

import lombok.extern.slf4j.Slf4j;
import me.chanjar.weixin.channel.api.WxChannelGiftService;
import me.chanjar.weixin.channel.bean.base.WxChannelBaseResponse;
import me.chanjar.weixin.channel.bean.gift.GiftGetResponse;
import me.chanjar.weixin.channel.bean.gift.GiftListParam;
import me.chanjar.weixin.channel.bean.gift.GiftProductInfo;
import me.chanjar.weixin.channel.bean.gift.GiftProductListResponse;
import me.chanjar.weixin.channel.bean.gift.GiftProductResponse;
import me.chanjar.weixin.channel.bean.gift.GiftProductUpdateInfo;
import me.chanjar.weixin.channel.bean.gift.GiftSetParam;
import me.chanjar.weixin.channel.util.JsonUtils;
import me.chanjar.weixin.channel.util.ResponseUtils;
import me.chanjar.weixin.common.error.WxErrorException;

/**
* 视频号小店 赠品管理服务实现
*
* @author <a href="https://github.com/features/copilot">GitHub Copilot</a>
*/
@Slf4j
public class WxChannelGiftServiceImpl implements WxChannelGiftService {

/** 微信商店服务 */
private final BaseWxChannelServiceImpl<?, ?> shopService;

public WxChannelGiftServiceImpl(BaseWxChannelServiceImpl<?, ?> shopService) {
this.shopService = shopService;
}

@Override
public GiftProductResponse addGiftProduct(GiftProductInfo info) throws WxErrorException {
String reqJson = JsonUtils.encode(info);
String resJson = shopService.post(ADD_GIFT_PRODUCT_URL, reqJson);
return ResponseUtils.decode(resJson, GiftProductResponse.class);
Comment on lines +39 to +43
}

@Override
public GiftProductResponse updateGiftProduct(GiftProductUpdateInfo info) throws WxErrorException {
String reqJson = JsonUtils.encode(info);
String resJson = shopService.post(UPDATE_GIFT_PRODUCT_URL, reqJson);
return ResponseUtils.decode(resJson, GiftProductResponse.class);
}

@Override
public GiftProductListResponse setProductAsGift(GiftSetParam param) throws WxErrorException {
String reqJson = JsonUtils.encode(param);
String resJson = shopService.post(SET_PRODUCT_AS_GIFT_URL, reqJson);
return ResponseUtils.decode(resJson, GiftProductListResponse.class);
}

@Override
public GiftGetResponse getGiftProduct(String productId, Integer dataType) throws WxErrorException {
String reqJson = "{\"product_id\":\"" + productId + "\",\"data_type\":" + dataType + "}";

@augmentcode augmentcode Bot Jul 1, 2026 •
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

getGiftProduct is building the request body via raw string concatenation; if productId contains characters needing JSON escaping (or if dataType is null), this can generate invalid JSON or send unintended values to the API. Consider using a structured JSON builder/JsonUtils.encode(...) approach so fields are properly escaped and optional fields can be omitted when unset.

Other locations where this applies: weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelGiftServiceImpl.java:79, weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelProductServiceImpl.java:279, weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelProductServiceImpl.java:310, weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelProductServiceImpl.java:317

Severity: medium

Other Locations
  • weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelGiftServiceImpl.java:79
  • weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelProductServiceImpl.java:279
  • weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelProductServiceImpl.java:310
  • weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelProductServiceImpl.java:317

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve the default gift data type

The new API documents dataType as defaulting to 3, but when callers pass null to use that default this manually constructed body sends an explicit "data_type":null instead of omitting the optional field like the other request beans do. For stores relying on the documented default, WeChat can reject the request rather than returning both online and draft data; use a NON_NULL request bean or default the value before serializing.

Useful? React with 👍 / 👎.

String resJson = shopService.post(GET_GIFT_PRODUCT_URL, reqJson);
Comment on lines +61 to +63
return ResponseUtils.decode(resJson, GiftGetResponse.class);
}

@Override
public GiftProductListResponse listGiftProduct(Integer pageSize, String nextKey, Integer status)
throws WxErrorException {
GiftListParam param = new GiftListParam(pageSize, nextKey, status);
String reqJson = JsonUtils.encode(param);
String resJson = shopService.post(LIST_GIFT_PRODUCT_URL, reqJson);
return ResponseUtils.decode(resJson, GiftProductListResponse.class);
}

@Override
public WxChannelBaseResponse updateGiftStock(String productId, String skuId, Integer diffType, Integer num)
throws WxErrorException {
String reqJson = "{\"product_id\":\"" + productId + "\",\"sku_id\":\"" + skuId
+ "\",\"diff_type\":" + diffType + ",\"num\":" + num + "}";
String resJson = shopService.post(UPDATE_GIFT_STOCK_URL, reqJson);
return ResponseUtils.decode(resJson, WxChannelBaseResponse.class);
}
}
Loading