添加商品券批次
更新时间:2025.08.04品牌方可以通过该接口为已有的商品券添加更多批次,多个批次可以实现品牌方多样化的投放需求。
前置条件:已创建商品券
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/marketing/partner/product-coupon/product-coupons/{product_coupon_id}/stocks
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
path 路径参数
product_coupon_id 必填 string
【商品券ID】 商品券的唯一标识,创建商品券时由微信支付生成
body 包体参数
out_request_no 必填 string(40)
【创建请求单号】 品牌创建批次请求流水号,品牌侧需保持唯一性,可使用 数字、大小写字母、下划线_
、短横线-
组成,长度在6-40个字符之间
stock 必填 object
【批次】 为商品券创建的批次详情
属性 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
remark 选填 string(20) 【备注】 仅配置品牌方可见,用于自定义信息,最多20个UTF-8字符 coupon_code_mode 必填 string 【券Code分配模式】 决定发券时用户商品券Code如何产生 可选取值
stock_send_rule 必填 object 【发放规则】 批次的发放规则
single_usage_rule 选填 object 【单券使用规则】 当且仅当
sequential_usage_rule 选填 object 【多次优惠使用规则】 当且仅当
usage_rule_display_info 必填 object 【券使用规则展示信息】 券使用规则展示信息
coupon_display_info 必填 object 【用户商品券展示信息】 用户商品券在卡包中的展示详情,包括引导用户的自定义入口
notify_config 必填 object 【事件通知配置】 发生券相关事件时,微信支付会向服务商发送通知,需要提供通知相关配置
store_scope 必填 string 【可用门店范围】 控制该批次可以在品牌下哪些门店使用 可选取值
|
brand_id 必填 string
【品牌ID】 微信支付为品牌方分配的唯一标识,该品牌应与服务商存在授权关系
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/marketing/partner/product-coupon/product-coupons/200000001/stocks \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "out_request_no" : "34657_20250101_123456", 8 "stock" : { 9 "remark" : "满减券", 10 "coupon_code_mode" : "UPLOAD", 11 "stock_send_rule" : { 12 "max_count" : 10000000, 13 "max_count_per_day" : 10000, 14 "max_count_per_user" : 1 15 }, 16 "single_usage_rule" : { 17 "coupon_available_period" : { 18 "available_begin_time" : "2025-01-01T00:00:00+08:00", 19 "available_end_time" : "2025-10-01T00:00:00+08:00", 20 "available_days" : 10, 21 "wait_days_after_receive" : 1, 22 "weekly_available_period" : { 23 "day_list" : [ 24 "MONDAY" 25 ], 26 "day_period_list" : [ 27 { 28 "begin_time" : 60, 29 "end_time" : 86399 30 } 31 ] 32 }, 33 "irregular_available_period_list" : [ 34 { 35 "begin_time" : "2025-01-01T00:00:00+08:00", 36 "end_time" : "2025-10-01T00:00:00+08:00" 37 } 38 ] 39 }, 40 "normal_coupon" : { 41 "threshold" : 10000, 42 "discount_amount" : 100 43 }, 44 "discount_coupon" : { 45 "threshold" : 10000, 46 "percent_off" : 30 47 }, 48 "exchange_coupon" : { 49 "threshold" : 10000, 50 "exchange_price" : 100 51 } 52 }, 53 "sequential_usage_rule" : { 54 "coupon_available_period" : { 55 "available_begin_time" : "2025-01-01T00:00:00+08:00", 56 "available_end_time" : "2025-10-01T00:00:00+08:00", 57 "wait_days_after_receive" : 1, 58 "weekly_available_period" : { 59 "day_list" : [ 60 "MONDAY" 61 ], 62 "day_period_list" : [ 63 { 64 "begin_time" : 60, 65 "end_time" : 86399 66 } 67 ] 68 }, 69 "irregular_available_period_list" : [ 70 { 71 "begin_time" : "2025-01-01T00:00:00+08:00", 72 "end_time" : "2025-10-01T00:00:00+08:00" 73 } 74 ] 75 }, 76 "normal_coupon_list" : [ 77 { 78 "threshold" : 10000, 79 "discount_amount" : 100 80 } 81 ], 82 "discount_coupon_list" : [ 83 { 84 "threshold" : 10000, 85 "percent_off" : 30 86 } 87 ], 88 "exchange_coupon_list" : [ 89 { 90 "threshold" : 10000, 91 "exchange_price" : 100 92 } 93 ], 94 "special_first" : false 95 }, 96 "usage_rule_display_info" : { 97 "coupon_usage_method_list" : [ 98 "MINI_PROGRAM" 99 ], 100 "mini_program_appid" : "wx1234567890", 101 "mini_program_path" : "/pages/index/product", 102 "app_path" : "https://www.example.com/jump-to-app", 103 "usage_description" : "全场可用", 104 "coupon_available_store_info" : { 105 "description" : "可在上海市区的所有门店使用,详细列表参考小程序内信息为准", 106 "mini_program_appid" : "wx1234567890", 107 "mini_program_path" : "/pages/index/store-list" 108 } 109 }, 110 "coupon_display_info" : { 111 "code_display_mode" : "QRCODE", 112 "background_color" : "Color010", 113 "entrance_mini_program" : { 114 "appid" : "wx1234567890", 115 "path" : "/pages/index/product", 116 "entrance_wording" : "欢迎选购", 117 "guidance_wording" : "获取更多优惠" 118 }, 119 "entrance_official_account" : { 120 "appid" : "wx1234567890" 121 }, 122 "entrance_finder" : { 123 "finder_id" : "gh_12345678", 124 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 125 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 126 } 127 }, 128 "notify_config" : { 129 "notify_appid" : "wx4fd12345678" 130 }, 131 "store_scope" : "SPECIFIC" 132 }, 133 "brand_id" : "120344" 134 }' 135
需配合微信支付工具库 WXPayUtility 使用,请参考 Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 添加商品券批次 24 */ 25public class CreateStock { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/marketing/partner/product-coupon/product-coupons/{product_coupon_id}/stocks"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 CreateStock client = new CreateStock( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 CreateStockRequest request = new CreateStockRequest(); 41 request.productCouponId = "200000001"; 42 request.outRequestNo = "34657_20250101_123456"; 43 request.stock = new StockForCreate(); 44 request.stock.remark = "满减券"; 45 request.stock.couponCodeMode = CouponCodeMode.UPLOAD; 46 request.stock.stockSendRule = new StockSendRule(); 47 request.stock.stockSendRule.maxCount = 10000000L; 48 request.stock.stockSendRule.maxCountPerDay = 10000L; 49 request.stock.stockSendRule.maxCountPerUser = 1L; 50 request.stock.singleUsageRule = new SingleUsageRule(); 51 request.stock.singleUsageRule.couponAvailablePeriod = new SingleCouponAvailablePeriod(); 52 request.stock.singleUsageRule.couponAvailablePeriod.availableBeginTime = "2025-01-01T00:00:00+08:00"; 53 request.stock.singleUsageRule.couponAvailablePeriod.availableEndTime = "2025-10-01T00:00:00+08:00"; 54 request.stock.singleUsageRule.couponAvailablePeriod.availableDays = 10L; 55 request.stock.singleUsageRule.couponAvailablePeriod.waitDaysAfterReceive = 1L; 56 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod = new FixedWeekPeriod(); 57 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList = new ArrayList<>(); 58 { 59 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.MONDAY); 60 }; 61 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayPeriodList = new ArrayList<>(); 62 { 63 PeriodOfTheDay dayPeriodListItem = new PeriodOfTheDay(); 64 dayPeriodListItem.beginTime = 60L; 65 dayPeriodListItem.endTime = 86399L; 66 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayPeriodList.add(dayPeriodListItem); 67 }; 68 request.stock.singleUsageRule.couponAvailablePeriod.irregularAvailablePeriodList = new ArrayList<>(); 69 { 70 TimePeriod irregularAvailablePeriodListItem = new TimePeriod(); 71 irregularAvailablePeriodListItem.beginTime = "2025-01-01T00:00:00+08:00"; 72 irregularAvailablePeriodListItem.endTime = "2025-10-01T00:00:00+08:00"; 73 request.stock.singleUsageRule.couponAvailablePeriod.irregularAvailablePeriodList.add(irregularAvailablePeriodListItem); 74 }; 75 request.stock.singleUsageRule.normalCoupon = new NormalCouponUsageRule(); 76 request.stock.singleUsageRule.normalCoupon.threshold = 10000L; 77 request.stock.singleUsageRule.normalCoupon.discountAmount = 100L; 78 request.stock.singleUsageRule.discountCoupon = new DiscountCouponUsageRule(); 79 request.stock.singleUsageRule.discountCoupon.threshold = 10000L; 80 request.stock.singleUsageRule.discountCoupon.percentOff = 30L; 81 request.stock.singleUsageRule.exchangeCoupon = new ExchangeCouponUsageRule(); 82 request.stock.singleUsageRule.exchangeCoupon.threshold = 10000L; 83 request.stock.singleUsageRule.exchangeCoupon.exchangePrice = 100L; 84 request.stock.sequentialUsageRule = new SequentialUsageRule(); 85 request.stock.sequentialUsageRule.couponAvailablePeriod = new SequentialCouponAvailablePeriod(); 86 request.stock.sequentialUsageRule.couponAvailablePeriod.availableBeginTime = "2025-01-01T00:00:00+08:00"; 87 request.stock.sequentialUsageRule.couponAvailablePeriod.availableEndTime = "2025-10-01T00:00:00+08:00"; 88 request.stock.sequentialUsageRule.couponAvailablePeriod.waitDaysAfterReceive = 1L; 89 request.stock.sequentialUsageRule.couponAvailablePeriod.weeklyAvailablePeriod = new FixedWeekPeriod(); 90 request.stock.sequentialUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList = new ArrayList<>(); 91 { 92 request.stock.sequentialUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.MONDAY); 93 }; 94 request.stock.sequentialUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayPeriodList = new ArrayList<>(); 95 { 96 PeriodOfTheDay dayPeriodListItem = new PeriodOfTheDay(); 97 dayPeriodListItem.beginTime = 60L; 98 dayPeriodListItem.endTime = 86399L; 99 request.stock.sequentialUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayPeriodList.add(dayPeriodListItem); 100 }; 101 request.stock.sequentialUsageRule.couponAvailablePeriod.irregularAvailablePeriodList = new ArrayList<>(); 102 { 103 TimePeriod irregularAvailablePeriodListItem = new TimePeriod(); 104 irregularAvailablePeriodListItem.beginTime = "2025-01-01T00:00:00+08:00"; 105 irregularAvailablePeriodListItem.endTime = "2025-10-01T00:00:00+08:00"; 106 request.stock.sequentialUsageRule.couponAvailablePeriod.irregularAvailablePeriodList.add(irregularAvailablePeriodListItem); 107 }; 108 request.stock.sequentialUsageRule.normalCouponList = new ArrayList<>(); 109 { 110 NormalCouponUsageRule normalCouponListItem = new NormalCouponUsageRule(); 111 normalCouponListItem.threshold = 10000L; 112 normalCouponListItem.discountAmount = 100L; 113 request.stock.sequentialUsageRule.normalCouponList.add(normalCouponListItem); 114 }; 115 request.stock.sequentialUsageRule.discountCouponList = new ArrayList<>(); 116 { 117 DiscountCouponUsageRule discountCouponListItem = new DiscountCouponUsageRule(); 118 discountCouponListItem.threshold = 10000L; 119 discountCouponListItem.percentOff = 30L; 120 request.stock.sequentialUsageRule.discountCouponList.add(discountCouponListItem); 121 }; 122 request.stock.sequentialUsageRule.exchangeCouponList = new ArrayList<>(); 123 { 124 ExchangeCouponUsageRule exchangeCouponListItem = new ExchangeCouponUsageRule(); 125 exchangeCouponListItem.threshold = 10000L; 126 exchangeCouponListItem.exchangePrice = 100L; 127 request.stock.sequentialUsageRule.exchangeCouponList.add(exchangeCouponListItem); 128 }; 129 request.stock.sequentialUsageRule.specialFirst = false; 130 request.stock.usageRuleDisplayInfo = new UsageRuleDisplayInfo(); 131 request.stock.usageRuleDisplayInfo.couponUsageMethodList = new ArrayList<>(); 132 { 133 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.OFFLINE); 134 }; 135 request.stock.usageRuleDisplayInfo.miniProgramAppid = "wx1234567890"; 136 request.stock.usageRuleDisplayInfo.miniProgramPath = "/pages/index/product"; 137 request.stock.usageRuleDisplayInfo.appPath = "https://www.example.com/jump-to-app"; 138 request.stock.usageRuleDisplayInfo.usageDescription = "全场可用"; 139 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo = new CouponAvailableStoreInfo(); 140 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.description = "可在上海市区的所有门店使用,详细列表参考小程序内信息为准"; 141 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.miniProgramAppid = "wx1234567890"; 142 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.miniProgramPath = "/pages/index/store-list"; 143 request.stock.couponDisplayInfo = new CouponDisplayInfo(); 144 request.stock.couponDisplayInfo.codeDisplayMode = CouponCodeDisplayMode.QRCODE; 145 request.stock.couponDisplayInfo.backgroundColor = "Color010"; 146 request.stock.couponDisplayInfo.entranceMiniProgram = new EntranceMiniProgram(); 147 request.stock.couponDisplayInfo.entranceMiniProgram.appid = "wx1234567890"; 148 request.stock.couponDisplayInfo.entranceMiniProgram.path = "/pages/index/product"; 149 request.stock.couponDisplayInfo.entranceMiniProgram.entranceWording = "欢迎选购"; 150 request.stock.couponDisplayInfo.entranceMiniProgram.guidanceWording = "获取更多优惠"; 151 request.stock.couponDisplayInfo.entranceOfficialAccount = new EntranceOfficialAccount(); 152 request.stock.couponDisplayInfo.entranceOfficialAccount.appid = "wx1234567890"; 153 request.stock.couponDisplayInfo.entranceFinder = new EntranceFinder(); 154 request.stock.couponDisplayInfo.entranceFinder.finderId = "gh_12345678"; 155 request.stock.couponDisplayInfo.entranceFinder.finderVideoId = "UDFsdf24df34dD456Hdf34"; 156 request.stock.couponDisplayInfo.entranceFinder.finderVideoCoverImageUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"; 157 request.stock.notifyConfig = new NotifyConfig(); 158 request.stock.notifyConfig.notifyAppid = "wx4fd12345678"; 159 request.stock.storeScope = StockStoreScope.SPECIFIC; 160 request.brandId = "120344"; 161 try { 162 StockEntity response = client.run(request); 163 // TODO: 请求成功,继续业务逻辑 164 System.out.println(response); 165 } catch (WXPayUtility.ApiException e) { 166 // TODO: 请求失败,根据状态码执行不同的逻辑 167 e.printStackTrace(); 168 } 169 } 170 171 public StockEntity run(CreateStockRequest request) { 172 String uri = PATH; 173 uri = uri.replace("{product_coupon_id}", WXPayUtility.urlEncode(request.productCouponId)); 174 String reqBody = WXPayUtility.toJson(request); 175 176 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 177 reqBuilder.addHeader("Accept", "application/json"); 178 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 179 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 180 reqBuilder.addHeader("Content-Type", "application/json"); 181 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 182 reqBuilder.method(METHOD, requestBody); 183 Request httpRequest = reqBuilder.build(); 184 185 // 发送HTTP请求 186 OkHttpClient client = new OkHttpClient.Builder().build(); 187 try (Response httpResponse = client.newCall(httpRequest).execute()) { 188 String respBody = WXPayUtility.extractBody(httpResponse); 189 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 190 // 2XX 成功,验证应答签名 191 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 192 httpResponse.headers(), respBody); 193 194 // 从HTTP应答报文构建返回数据 195 return WXPayUtility.fromJson(respBody, StockEntity.class); 196 } else { 197 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 198 } 199 } catch (IOException e) { 200 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 201 } 202 } 203 204 private final String mchid; 205 private final String certificateSerialNo; 206 private final PrivateKey privateKey; 207 private final String wechatPayPublicKeyId; 208 private final PublicKey wechatPayPublicKey; 209 210 public CreateStock(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 211 this.mchid = mchid; 212 this.certificateSerialNo = certificateSerialNo; 213 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 214 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 215 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 216 } 217 218 public static class CreateStockRequest { 219 @SerializedName("out_request_no") 220 public String outRequestNo; 221 222 @SerializedName("product_coupon_id") 223 @Expose(serialize = false) 224 public String productCouponId; 225 226 @SerializedName("stock") 227 public StockForCreate stock; 228 229 @SerializedName("brand_id") 230 public String brandId; 231 } 232 233 public static class StockEntity { 234 @SerializedName("product_coupon_id") 235 public String productCouponId; 236 237 @SerializedName("stock_id") 238 public String stockId; 239 240 @SerializedName("remark") 241 public String remark; 242 243 @SerializedName("coupon_code_mode") 244 public CouponCodeMode couponCodeMode; 245 246 @SerializedName("coupon_code_count_info") 247 public CouponCodeCountInfo couponCodeCountInfo; 248 249 @SerializedName("stock_send_rule") 250 public StockSendRule stockSendRule; 251 252 @SerializedName("single_usage_rule") 253 public SingleUsageRule singleUsageRule; 254 255 @SerializedName("sequential_usage_rule") 256 public SequentialUsageRule sequentialUsageRule; 257 258 @SerializedName("usage_rule_display_info") 259 public UsageRuleDisplayInfo usageRuleDisplayInfo; 260 261 @SerializedName("coupon_display_info") 262 public CouponDisplayInfo couponDisplayInfo; 263 264 @SerializedName("notify_config") 265 public NotifyConfig notifyConfig; 266 267 @SerializedName("store_scope") 268 public StockStoreScope storeScope; 269 270 @SerializedName("sent_count_info") 271 public StockSentCountInfo sentCountInfo; 272 273 @SerializedName("state") 274 public StockState state; 275 276 @SerializedName("deactivate_request_no") 277 public String deactivateRequestNo; 278 279 @SerializedName("deactivate_time") 280 public String deactivateTime; 281 282 @SerializedName("deactivate_reason") 283 public String deactivateReason; 284 285 @SerializedName("brand_id") 286 public String brandId; 287 } 288 289 public static class StockForCreate { 290 @SerializedName("remark") 291 public String remark; 292 293 @SerializedName("coupon_code_mode") 294 public CouponCodeMode couponCodeMode; 295 296 @SerializedName("stock_send_rule") 297 public StockSendRule stockSendRule; 298 299 @SerializedName("single_usage_rule") 300 public SingleUsageRule singleUsageRule; 301 302 @SerializedName("sequential_usage_rule") 303 public SequentialUsageRule sequentialUsageRule; 304 305 @SerializedName("usage_rule_display_info") 306 public UsageRuleDisplayInfo usageRuleDisplayInfo; 307 308 @SerializedName("coupon_display_info") 309 public CouponDisplayInfo couponDisplayInfo; 310 311 @SerializedName("notify_config") 312 public NotifyConfig notifyConfig; 313 314 @SerializedName("store_scope") 315 public StockStoreScope storeScope; 316 } 317 318 public enum CouponCodeMode { 319 @SerializedName("WECHATPAY") 320 WECHATPAY, 321 @SerializedName("UPLOAD") 322 UPLOAD, 323 @SerializedName("API_ASSIGN") 324 API_ASSIGN 325 } 326 327 public static class CouponCodeCountInfo { 328 @SerializedName("total_count") 329 public Long totalCount; 330 331 @SerializedName("available_count") 332 public Long availableCount; 333 } 334 335 public static class StockSendRule { 336 @SerializedName("max_count") 337 public Long maxCount; 338 339 @SerializedName("max_count_per_day") 340 public Long maxCountPerDay; 341 342 @SerializedName("max_count_per_user") 343 public Long maxCountPerUser; 344 } 345 346 public static class SingleUsageRule { 347 @SerializedName("coupon_available_period") 348 public SingleCouponAvailablePeriod couponAvailablePeriod; 349 350 @SerializedName("normal_coupon") 351 public NormalCouponUsageRule normalCoupon; 352 353 @SerializedName("discount_coupon") 354 public DiscountCouponUsageRule discountCoupon; 355 356 @SerializedName("exchange_coupon") 357 public ExchangeCouponUsageRule exchangeCoupon; 358 } 359 360 public static class SequentialUsageRule { 361 @SerializedName("coupon_available_period") 362 public SequentialCouponAvailablePeriod couponAvailablePeriod; 363 364 @SerializedName("normal_coupon_list") 365 public List<NormalCouponUsageRule> normalCouponList; 366 367 @SerializedName("discount_coupon_list") 368 public List<DiscountCouponUsageRule> discountCouponList; 369 370 @SerializedName("exchange_coupon_list") 371 public List<ExchangeCouponUsageRule> exchangeCouponList; 372 373 @SerializedName("special_first") 374 public Boolean specialFirst; 375 } 376 377 public static class UsageRuleDisplayInfo { 378 @SerializedName("coupon_usage_method_list") 379 public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>(); 380 381 @SerializedName("mini_program_appid") 382 public String miniProgramAppid; 383 384 @SerializedName("mini_program_path") 385 public String miniProgramPath; 386 387 @SerializedName("app_path") 388 public String appPath; 389 390 @SerializedName("usage_description") 391 public String usageDescription; 392 393 @SerializedName("coupon_available_store_info") 394 public CouponAvailableStoreInfo couponAvailableStoreInfo; 395 } 396 397 public static class CouponDisplayInfo { 398 @SerializedName("code_display_mode") 399 public CouponCodeDisplayMode codeDisplayMode; 400 401 @SerializedName("background_color") 402 public String backgroundColor; 403 404 @SerializedName("entrance_mini_program") 405 public EntranceMiniProgram entranceMiniProgram; 406 407 @SerializedName("entrance_official_account") 408 public EntranceOfficialAccount entranceOfficialAccount; 409 410 @SerializedName("entrance_finder") 411 public EntranceFinder entranceFinder; 412 } 413 414 public static class NotifyConfig { 415 @SerializedName("notify_appid") 416 public String notifyAppid; 417 } 418 419 public enum StockStoreScope { 420 @SerializedName("NONE") 421 NONE, 422 @SerializedName("ALL") 423 ALL, 424 @SerializedName("SPECIFIC") 425 SPECIFIC 426 } 427 428 public static class StockSentCountInfo { 429 @SerializedName("total_count") 430 public Long totalCount; 431 432 @SerializedName("today_count") 433 public Long todayCount; 434 } 435 436 public enum StockState { 437 @SerializedName("AUDITING") 438 AUDITING, 439 @SerializedName("SENDING") 440 SENDING, 441 @SerializedName("PAUSED") 442 PAUSED, 443 @SerializedName("STOPPED") 444 STOPPED, 445 @SerializedName("DEACTIVATED") 446 DEACTIVATED 447 } 448 449 public static class SingleCouponAvailablePeriod { 450 @SerializedName("available_begin_time") 451 public String availableBeginTime; 452 453 @SerializedName("available_end_time") 454 public String availableEndTime; 455 456 @SerializedName("available_days") 457 public Long availableDays; 458 459 @SerializedName("wait_days_after_receive") 460 public Long waitDaysAfterReceive; 461 462 @SerializedName("weekly_available_period") 463 public FixedWeekPeriod weeklyAvailablePeriod; 464 465 @SerializedName("irregular_available_period_list") 466 public List<TimePeriod> irregularAvailablePeriodList; 467 } 468 469 public static class NormalCouponUsageRule { 470 @SerializedName("threshold") 471 public Long threshold; 472 473 @SerializedName("discount_amount") 474 public Long discountAmount; 475 } 476 477 public static class DiscountCouponUsageRule { 478 @SerializedName("threshold") 479 public Long threshold; 480 481 @SerializedName("percent_off") 482 public Long percentOff; 483 } 484 485 public static class ExchangeCouponUsageRule { 486 @SerializedName("threshold") 487 public Long threshold; 488 489 @SerializedName("exchange_price") 490 public Long exchangePrice; 491 } 492 493 public static class SequentialCouponAvailablePeriod { 494 @SerializedName("available_begin_time") 495 public String availableBeginTime; 496 497 @SerializedName("available_end_time") 498 public String availableEndTime; 499 500 @SerializedName("wait_days_after_receive") 501 public Long waitDaysAfterReceive; 502 503 @SerializedName("weekly_available_period") 504 public FixedWeekPeriod weeklyAvailablePeriod; 505 506 @SerializedName("irregular_available_period_list") 507 public List<TimePeriod> irregularAvailablePeriodList; 508 } 509 510 public enum CouponUsageMethod { 511 @SerializedName("OFFLINE") 512 OFFLINE, 513 @SerializedName("MINI_PROGRAM") 514 MINI_PROGRAM, 515 @SerializedName("APP") 516 APP, 517 @SerializedName("PAYMENT_CODE") 518 PAYMENT_CODE 519 } 520 521 public static class CouponAvailableStoreInfo { 522 @SerializedName("description") 523 public String description; 524 525 @SerializedName("mini_program_appid") 526 public String miniProgramAppid; 527 528 @SerializedName("mini_program_path") 529 public String miniProgramPath; 530 } 531 532 public enum CouponCodeDisplayMode { 533 @SerializedName("INVISIBLE") 534 INVISIBLE, 535 @SerializedName("BARCODE") 536 BARCODE, 537 @SerializedName("QRCODE") 538 QRCODE 539 } 540 541 public static class EntranceMiniProgram { 542 @SerializedName("appid") 543 public String appid; 544 545 @SerializedName("path") 546 public String path; 547 548 @SerializedName("entrance_wording") 549 public String entranceWording; 550 551 @SerializedName("guidance_wording") 552 public String guidanceWording; 553 } 554 555 public static class EntranceOfficialAccount { 556 @SerializedName("appid") 557 public String appid; 558 } 559 560 public static class EntranceFinder { 561 @SerializedName("finder_id") 562 public String finderId; 563 564 @SerializedName("finder_video_id") 565 public String finderVideoId; 566 567 @SerializedName("finder_video_cover_image_url") 568 public String finderVideoCoverImageUrl; 569 } 570 571 public static class FixedWeekPeriod { 572 @SerializedName("day_list") 573 public List<WeekEnum> dayList; 574 575 @SerializedName("day_period_list") 576 public List<PeriodOfTheDay> dayPeriodList; 577 } 578 579 public static class TimePeriod { 580 @SerializedName("begin_time") 581 public String beginTime; 582 583 @SerializedName("end_time") 584 public String endTime; 585 } 586 587 public enum WeekEnum { 588 @SerializedName("MONDAY") 589 MONDAY, 590 @SerializedName("TUESDAY") 591 TUESDAY, 592 @SerializedName("WEDNESDAY") 593 WEDNESDAY, 594 @SerializedName("THURSDAY") 595 THURSDAY, 596 @SerializedName("FRIDAY") 597 FRIDAY, 598 @SerializedName("SATURDAY") 599 SATURDAY, 600 @SerializedName("SUNDAY") 601 SUNDAY 602 } 603 604 public static class PeriodOfTheDay { 605 @SerializedName("begin_time") 606 public Long beginTime; 607 608 @SerializedName("end_time") 609 public Long endTime; 610 } 611 612} 613
需配合微信支付工具库 wxpay_utility 使用,请参考 Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10 "strings" 11 "time" 12) 13 14func main() { 15 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 config, err := wxpay_utility.CreateMchConfig( 17 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 18 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 19 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 20 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 21 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 22 ) 23 if err != nil { 24 fmt.Println(err) 25 return 26 } 27 28 request := &CreateStockRequest{ 29 ProductCouponId: wxpay_utility.String("200000001"), 30 OutRequestNo: wxpay_utility.String("34657_20250101_123456"), 31 Stock: &StockForCreate{ 32 Remark: wxpay_utility.String("满减券"), 33 CouponCodeMode: COUPONCODEMODE_UPLOAD.Ptr(), 34 StockSendRule: &StockSendRule{ 35 MaxCount: wxpay_utility.Int64(10000000), 36 MaxCountPerDay: wxpay_utility.Int64(10000), 37 MaxCountPerUser: wxpay_utility.Int64(1), 38 }, 39 SingleUsageRule: &SingleUsageRule{ 40 CouponAvailablePeriod: &SingleCouponAvailablePeriod{ 41 AvailableBeginTime: wxpay_utility.String("2025-01-01T00:00:00+08:00"), 42 AvailableEndTime: wxpay_utility.String("2025-10-01T00:00:00+08:00"), 43 AvailableDays: wxpay_utility.Int64(10), 44 WaitDaysAfterReceive: wxpay_utility.Int64(1), 45 WeeklyAvailablePeriod: &FixedWeekPeriod{ 46 DayList: []WeekEnum{WEEKENUM_MONDAY}, 47 DayPeriodList: []PeriodOfTheDay{PeriodOfTheDay{ 48 BeginTime: wxpay_utility.Int64(60), 49 EndTime: wxpay_utility.Int64(86399), 50 }}, 51 }, 52 IrregularAvailablePeriodList: []TimePeriod{TimePeriod{ 53 BeginTime: wxpay_utility.String("2025-01-01T00:00:00+08:00"), 54 EndTime: wxpay_utility.String("2025-10-01T00:00:00+08:00"), 55 }}, 56 }, 57 NormalCoupon: &NormalCouponUsageRule{ 58 Threshold: wxpay_utility.Int64(10000), 59 DiscountAmount: wxpay_utility.Int64(100), 60 }, 61 DiscountCoupon: &DiscountCouponUsageRule{ 62 Threshold: wxpay_utility.Int64(10000), 63 PercentOff: wxpay_utility.Int64(30), 64 }, 65 ExchangeCoupon: &ExchangeCouponUsageRule{ 66 Threshold: wxpay_utility.Int64(10000), 67 ExchangePrice: wxpay_utility.Int64(100), 68 }, 69 }, 70 SequentialUsageRule: &SequentialUsageRule{ 71 CouponAvailablePeriod: &SequentialCouponAvailablePeriod{ 72 AvailableBeginTime: wxpay_utility.String("2025-01-01T00:00:00+08:00"), 73 AvailableEndTime: wxpay_utility.String("2025-10-01T00:00:00+08:00"), 74 WaitDaysAfterReceive: wxpay_utility.Int64(1), 75 WeeklyAvailablePeriod: &FixedWeekPeriod{ 76 DayList: []WeekEnum{WEEKENUM_MONDAY}, 77 DayPeriodList: []PeriodOfTheDay{PeriodOfTheDay{ 78 BeginTime: wxpay_utility.Int64(60), 79 EndTime: wxpay_utility.Int64(86399), 80 }}, 81 }, 82 IrregularAvailablePeriodList: []TimePeriod{TimePeriod{ 83 BeginTime: wxpay_utility.String("2025-01-01T00:00:00+08:00"), 84 EndTime: wxpay_utility.String("2025-10-01T00:00:00+08:00"), 85 }}, 86 }, 87 NormalCouponList: []NormalCouponUsageRule{NormalCouponUsageRule{ 88 Threshold: wxpay_utility.Int64(10000), 89 DiscountAmount: wxpay_utility.Int64(100), 90 }}, 91 DiscountCouponList: []DiscountCouponUsageRule{DiscountCouponUsageRule{ 92 Threshold: wxpay_utility.Int64(10000), 93 PercentOff: wxpay_utility.Int64(30), 94 }}, 95 ExchangeCouponList: []ExchangeCouponUsageRule{ExchangeCouponUsageRule{ 96 Threshold: wxpay_utility.Int64(10000), 97 ExchangePrice: wxpay_utility.Int64(100), 98 }}, 99 SpecialFirst: wxpay_utility.Bool(false), 100 }, 101 UsageRuleDisplayInfo: &UsageRuleDisplayInfo{ 102 CouponUsageMethodList: []CouponUsageMethod{COUPONUSAGEMETHOD_OFFLINE}, 103 MiniProgramAppid: wxpay_utility.String("wx1234567890"), 104 MiniProgramPath: wxpay_utility.String("/pages/index/product"), 105 AppPath: wxpay_utility.String("https://www.example.com/jump-to-app"), 106 UsageDescription: wxpay_utility.String("全场可用"), 107 CouponAvailableStoreInfo: &CouponAvailableStoreInfo{ 108 Description: wxpay_utility.String("可在上海市区的所有门店使用,详细列表参考小程序内信息为准"), 109 MiniProgramAppid: wxpay_utility.String("wx1234567890"), 110 MiniProgramPath: wxpay_utility.String("/pages/index/store-list"), 111 }, 112 }, 113 CouponDisplayInfo: &CouponDisplayInfo{ 114 CodeDisplayMode: COUPONCODEDISPLAYMODE_QRCODE.Ptr(), 115 BackgroundColor: wxpay_utility.String("Color010"), 116 EntranceMiniProgram: &EntranceMiniProgram{ 117 Appid: wxpay_utility.String("wx1234567890"), 118 Path: wxpay_utility.String("/pages/index/product"), 119 EntranceWording: wxpay_utility.String("欢迎选购"), 120 GuidanceWording: wxpay_utility.String("获取更多优惠"), 121 }, 122 EntranceOfficialAccount: &EntranceOfficialAccount{ 123 Appid: wxpay_utility.String("wx1234567890"), 124 }, 125 EntranceFinder: &EntranceFinder{ 126 FinderId: wxpay_utility.String("gh_12345678"), 127 FinderVideoId: wxpay_utility.String("UDFsdf24df34dD456Hdf34"), 128 FinderVideoCoverImageUrl: wxpay_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"), 129 }, 130 }, 131 NotifyConfig: &NotifyConfig{ 132 NotifyAppid: wxpay_utility.String("wx4fd12345678"), 133 }, 134 StoreScope: STOCKSTORESCOPE_SPECIFIC.Ptr(), 135 }, 136 BrandId: wxpay_utility.String("120344"), 137 } 138 139 response, err := CreateStock(config, request) 140 if err != nil { 141 fmt.Printf("请求失败: %+v\n", err) 142 // TODO: 请求失败,根据状态码执行不同的处理 143 return 144 } 145 146 // TODO: 请求成功,继续业务逻辑 147 fmt.Printf("请求成功: %+v\n", response) 148} 149 150func CreateStock(config *wxpay_utility.MchConfig, request *CreateStockRequest) (response *StockEntity, err error) { 151 const ( 152 host = "https://api.mch.weixin.qq.com" 153 method = "POST" 154 path = "/v3/marketing/partner/product-coupon/product-coupons/{product_coupon_id}/stocks" 155 ) 156 157 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 158 if err != nil { 159 return nil, err 160 } 161 reqUrl.Path = strings.Replace(reqUrl.Path, "{product_coupon_id}", url.PathEscape(*request.ProductCouponId), -1) 162 reqBody, err := json.Marshal(request) 163 if err != nil { 164 return nil, err 165 } 166 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 167 if err != nil { 168 return nil, err 169 } 170 httpRequest.Header.Set("Accept", "application/json") 171 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 172 httpRequest.Header.Set("Content-Type", "application/json") 173 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 174 if err != nil { 175 return nil, err 176 } 177 httpRequest.Header.Set("Authorization", authorization) 178 179 client := &http.Client{} 180 httpResponse, err := client.Do(httpRequest) 181 if err != nil { 182 return nil, err 183 } 184 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 185 if err != nil { 186 return nil, err 187 } 188 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 189 // 2XX 成功,验证应答签名 190 err = wxpay_utility.ValidateResponse( 191 config.WechatPayPublicKeyId(), 192 config.WechatPayPublicKey(), 193 &httpResponse.Header, 194 respBody, 195 ) 196 if err != nil { 197 return nil, err 198 } 199 response := &StockEntity{} 200 if err := json.Unmarshal(respBody, response); err != nil { 201 return nil, err 202 } 203 204 return response, nil 205 } else { 206 return nil, wxpay_utility.NewApiException( 207 httpResponse.StatusCode, 208 httpResponse.Header, 209 respBody, 210 ) 211 } 212} 213 214type CreateStockRequest struct { 215 OutRequestNo *string `json:"out_request_no,omitempty"` 216 ProductCouponId *string `json:"product_coupon_id,omitempty"` 217 Stock *StockForCreate `json:"stock,omitempty"` 218 BrandId *string `json:"brand_id,omitempty"` 219} 220 221func (o *CreateStockRequest) MarshalJSON() ([]byte, error) { 222 type Alias CreateStockRequest 223 a := &struct { 224 ProductCouponId *string `json:"product_coupon_id,omitempty"` 225 *Alias 226 }{ 227 // 序列化时移除非 Body 字段 228 ProductCouponId: nil, 229 Alias: (*Alias)(o), 230 } 231 return json.Marshal(a) 232} 233 234type StockEntity struct { 235 ProductCouponId *string `json:"product_coupon_id,omitempty"` 236 StockId *string `json:"stock_id,omitempty"` 237 Remark *string `json:"remark,omitempty"` 238 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 239 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 240 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 241 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 242 SequentialUsageRule *SequentialUsageRule `json:"sequential_usage_rule,omitempty"` 243 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 244 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 245 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 246 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 247 SentCountInfo *StockSentCountInfo `json:"sent_count_info,omitempty"` 248 State *StockState `json:"state,omitempty"` 249 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 250 DeactivateTime *time.Time `json:"deactivate_time,omitempty"` 251 DeactivateReason *string `json:"deactivate_reason,omitempty"` 252 BrandId *string `json:"brand_id,omitempty"` 253} 254 255type StockForCreate struct { 256 Remark *string `json:"remark,omitempty"` 257 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 258 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 259 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 260 SequentialUsageRule *SequentialUsageRule `json:"sequential_usage_rule,omitempty"` 261 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 262 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 263 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 264 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 265} 266 267type CouponCodeMode string 268 269func (e CouponCodeMode) Ptr() *CouponCodeMode { 270 return &e 271} 272 273const ( 274 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 275 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 276 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 277) 278 279type CouponCodeCountInfo struct { 280 TotalCount *int64 `json:"total_count,omitempty"` 281 AvailableCount *int64 `json:"available_count,omitempty"` 282} 283 284type StockSendRule struct { 285 MaxCount *int64 `json:"max_count,omitempty"` 286 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 287 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 288} 289 290type SingleUsageRule struct { 291 CouponAvailablePeriod *SingleCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 292 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 293 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 294 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 295} 296 297type SequentialUsageRule struct { 298 CouponAvailablePeriod *SequentialCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 299 NormalCouponList []NormalCouponUsageRule `json:"normal_coupon_list,omitempty"` 300 DiscountCouponList []DiscountCouponUsageRule `json:"discount_coupon_list,omitempty"` 301 ExchangeCouponList []ExchangeCouponUsageRule `json:"exchange_coupon_list,omitempty"` 302 SpecialFirst *bool `json:"special_first,omitempty"` 303} 304 305type UsageRuleDisplayInfo struct { 306 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 307 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 308 MiniProgramPath *string `json:"mini_program_path,omitempty"` 309 AppPath *string `json:"app_path,omitempty"` 310 UsageDescription *string `json:"usage_description,omitempty"` 311 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 312} 313 314type CouponDisplayInfo struct { 315 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 316 BackgroundColor *string `json:"background_color,omitempty"` 317 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 318 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 319 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 320} 321 322type NotifyConfig struct { 323 NotifyAppid *string `json:"notify_appid,omitempty"` 324} 325 326type StockStoreScope string 327 328func (e StockStoreScope) Ptr() *StockStoreScope { 329 return &e 330} 331 332const ( 333 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 334 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 335 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 336) 337 338type StockSentCountInfo struct { 339 TotalCount *int64 `json:"total_count,omitempty"` 340 TodayCount *int64 `json:"today_count,omitempty"` 341} 342 343type StockState string 344 345func (e StockState) Ptr() *StockState { 346 return &e 347} 348 349const ( 350 STOCKSTATE_AUDITING StockState = "AUDITING" 351 STOCKSTATE_SENDING StockState = "SENDING" 352 STOCKSTATE_PAUSED StockState = "PAUSED" 353 STOCKSTATE_STOPPED StockState = "STOPPED" 354 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 355) 356 357type SingleCouponAvailablePeriod struct { 358 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 359 AvailableEndTime *string `json:"available_end_time,omitempty"` 360 AvailableDays *int64 `json:"available_days,omitempty"` 361 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 362 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 363 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 364} 365 366type NormalCouponUsageRule struct { 367 Threshold *int64 `json:"threshold,omitempty"` 368 DiscountAmount *int64 `json:"discount_amount,omitempty"` 369} 370 371type DiscountCouponUsageRule struct { 372 Threshold *int64 `json:"threshold,omitempty"` 373 PercentOff *int64 `json:"percent_off,omitempty"` 374} 375 376type ExchangeCouponUsageRule struct { 377 Threshold *int64 `json:"threshold,omitempty"` 378 ExchangePrice *int64 `json:"exchange_price,omitempty"` 379} 380 381type SequentialCouponAvailablePeriod struct { 382 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 383 AvailableEndTime *string `json:"available_end_time,omitempty"` 384 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 385 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 386 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 387} 388 389type CouponUsageMethod string 390 391func (e CouponUsageMethod) Ptr() *CouponUsageMethod { 392 return &e 393} 394 395const ( 396 COUPONUSAGEMETHOD_OFFLINE CouponUsageMethod = "OFFLINE" 397 COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM" 398 COUPONUSAGEMETHOD_APP CouponUsageMethod = "APP" 399 COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE" 400) 401 402type CouponAvailableStoreInfo struct { 403 Description *string `json:"description,omitempty"` 404 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 405 MiniProgramPath *string `json:"mini_program_path,omitempty"` 406} 407 408type CouponCodeDisplayMode string 409 410func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode { 411 return &e 412} 413 414const ( 415 COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE" 416 COUPONCODEDISPLAYMODE_BARCODE CouponCodeDisplayMode = "BARCODE" 417 COUPONCODEDISPLAYMODE_QRCODE CouponCodeDisplayMode = "QRCODE" 418) 419 420type EntranceMiniProgram struct { 421 Appid *string `json:"appid,omitempty"` 422 Path *string `json:"path,omitempty"` 423 EntranceWording *string `json:"entrance_wording,omitempty"` 424 GuidanceWording *string `json:"guidance_wording,omitempty"` 425} 426 427type EntranceOfficialAccount struct { 428 Appid *string `json:"appid,omitempty"` 429} 430 431type EntranceFinder struct { 432 FinderId *string `json:"finder_id,omitempty"` 433 FinderVideoId *string `json:"finder_video_id,omitempty"` 434 FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"` 435} 436 437type FixedWeekPeriod struct { 438 DayList []WeekEnum `json:"day_list,omitempty"` 439 DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"` 440} 441 442type TimePeriod struct { 443 BeginTime *string `json:"begin_time,omitempty"` 444 EndTime *string `json:"end_time,omitempty"` 445} 446 447type WeekEnum string 448 449func (e WeekEnum) Ptr() *WeekEnum { 450 return &e 451} 452 453const ( 454 WEEKENUM_MONDAY WeekEnum = "MONDAY" 455 WEEKENUM_TUESDAY WeekEnum = "TUESDAY" 456 WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY" 457 WEEKENUM_THURSDAY WeekEnum = "THURSDAY" 458 WEEKENUM_FRIDAY WeekEnum = "FRIDAY" 459 WEEKENUM_SATURDAY WeekEnum = "SATURDAY" 460 WEEKENUM_SUNDAY WeekEnum = "SUNDAY" 461) 462 463type PeriodOfTheDay struct { 464 BeginTime *int64 `json:"begin_time,omitempty"` 465 EndTime *int64 `json:"end_time,omitempty"` 466} 467
应答参数
200 OK
product_coupon_id 必填 string(40)
【商品券ID】 商品券的唯一标识,由微信支付生成
stock_id 必填 string(40)
【批次ID】 商品券批次的唯一标识,由微信支付生成
remark 选填 string(20)
【备注】 仅配置品牌可见,用于自定义信息
coupon_code_mode 必填 string
【券Code分配模式】 决定发券时用户商品券Code如何产生
可选取值
WECHATPAY
: 微信支付随机生成,发券时由微信支付系统自动随机生成券码,品牌方无需干预,微信支付随机生成的券Code长度限制为40个字符以内UPLOAD
: 品牌方预上传Code,品牌方需先使用预上传券Code API上传自定义Code,微信支付系统发券时从中随机选取,当预存Code不足时可能影响发券,品牌应及时补充API_ASSIGN
: 品牌方自行指定,品牌方通过发券API自行发券时指定,微信支付系统不再进行自动分配。特别注意:这种模式的商品批次只可由品牌方自行发券,无法在摇一摇有优惠等微信支付渠道投放
coupon_code_count_info 选填 object
【品牌方预上传的券Code数量信息】 当且仅当 coupon_code_mode
为 UPLOAD
时存在此字段
属性 | |
total_count 必填 integer 【已上传的Code总数】 品牌方为此批次已经上传过的券Code总数量 available_count 必填 integer 【当前可用的Code数】 品牌方为此批次已经上传过的券Code中,当前剩余可用的券Code数量 |
stock_send_rule 必填 object
【发放规则】 发放规则
属性 | |
max_count 必填 integer 【发放次数总上限】 批次在生命周期内总发放次数,最多 100,000,000 次 max_count_per_day 选填 integer 【每日发放次数上限】 批次在每天内发放次数上限,每日刷新,最多 100,000,000 次。默认不限制每日发放上限 max_count_per_user 必填 integer 【每个用户领取次数上限】 每个用户最多可领取本批次的次数,最多 100 次。 |
single_usage_rule 选填 object
【单券使用规则】 当且仅当 usage_mode
为 SINGLE
时提供,其他场景不提供
属性 | |||||||||||||||||||||||||||||
coupon_available_period 必填 object 【券可核销时间】 确定用户领券后在什么时间段内可以核销
normal_coupon 选填 object 【满减券使用规则】 当且仅当
discount_coupon 选填 object 【折扣券使用规则】 当且仅当
exchange_coupon 选填 object 【兑换券使用规则】 当且仅当
|
sequential_usage_rule 选填 object
【多次优惠使用规则】 当且仅当 usage_mode
为 SEQUENTIAL
时提供,其他场景不提供
属性 | |||||||||||||||||||||||||||||
coupon_available_period 必填 object 【多次优惠可核销时间】 确定用户领取多次优惠后在什么时间段内可以核销,多次优惠可核销时间不会超过多次优惠有效天数(多次优惠商品券中配置的
normal_coupon_list 选填 array[object] 【满减券使用规则】 当且仅当
discount_coupon_list 选填 array[object] 【折扣券使用规则】 当且仅当
exchange_coupon_list 选填 array[object] 【兑换券使用规则】 当且仅当
special_first 选填 boolean 【多次优惠是否提供首笔特惠】 默认情况下为 当此字段设置为 |
usage_rule_display_info 必填 object
【券使用规则展示信息】 券使用规则展示信息
属性 | |||||
coupon_usage_method_list 必填 array[string] 【券使用方式列表】 可以配置多种使用方式 可选取值
mini_program_appid 选填 string 【小程序AppID】 品牌方小程序AppID,可在微信公众平台查看,该小程序与品牌存在绑定关系。 在 mini_program_path 选填 string 【小程序跳转路径】 品牌方小程序内部跳转路径。 在 app_path 选填 string 【APP跳转路径】 品牌方APP跳转路径,在 usage_description 必填 string(1000) 【券使用说明】 用于说明详细的券规则,长度不超过1000个UTF-8字符 coupon_available_store_info 选填 object 【券可用门店信息】 用于描述全部可用门店信息,可配置小程序跳转地址进行展示
|
coupon_display_info 必填 object
【用户商品券展示信息】 用户商品券在卡包中的展示详情,包括引导用户的自定义入口
属性 | |||||||||||||
code_display_mode 必填 string 【用户商品券Code展示模式】 决定用户商品券Code在卡包中的展示形态 可选取值
background_color 选填 string 【背景颜色】 券的背景颜色,可设置10种颜色,色值请参考下方说明。颜色取值为颜色图中的颜色名称,不填默认为 entrance_mini_program 选填 object 【小程序入口】 展示跳转小程序的入口
entrance_official_account 选填 object 【公众号入口】 展示跳转公众号的入口
entrance_finder 选填 object 【视频号入口】 展示跳转视频号的入口
|
notify_config 必填 object
【事件通知配置】 发生券相关事件时,微信支付会向服务商发送通知,需要提供通知相关配置
属性 | |
notify_appid 必填 string 【事件通知AppID】 服务商小程序或公众号AppID,可在微信公众平台查看,用于券事件通知时计算用户的OpenID,需要与服务商存在绑定关系 |
store_scope 必填 string
【可用门店范围】 控制该批次可以在品牌下哪些门店使用
可选取值
NONE
: 无关联门店,该批次对外不展示可用门店信息ALL
: 所有门店可用,该批次在品牌下的所有门店可用,品牌无需为该批次关联门店列表SPECIFIC
: 特定门店可用,品牌需调用关联门店接口关联门店,关联后该批次在关联的门店可用
sent_count_info 必填 object
【已发放次数】 本批次已发放次数
属性 | |
total_count 必填 integer 【已发放总次数】 批次在生命周期内已发放次数 today_count 必填 integer 【当天已发放次数】 批次在当天已发放次数 |
state 必填 string
【批次状态】 商品券批次状态
可选取值
AUDITING
: 审批中SENDING
: 发放中PAUSED
: 已暂停STOPPED
: 已停止,当前已到达结束时间DEACTIVATED
: 已失效,品牌方主动调用失效接口使批次失效
deactivate_request_no 选填 string
【失效请求单号】 当且仅当 state
为 DEACTIVATED
时提供,返回品牌方调用失效接口时传入的请求流水号
deactivate_time 选填 string
【失效时间】 当且仅当 state
为 DEACTIVATED
时提供,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。
deactivate_reason 选填 string
【失效原因】 当且仅当 state
为 DEACTIVATED
时提供,返回品牌方调用失效商品券批次接口时传入的失效原因
brand_id 必填 string
【品牌ID】 微信支付为品牌方分配的唯一标识,该品牌应与服务商存在授权关系
应答示例
200 OK
1{ 2 "product_coupon_id" : "200000001", 3 "stock_id" : "123456789", 4 "remark" : "满减券", 5 "coupon_code_mode" : "UPLOAD", 6 "coupon_code_count_info" : { 7 "total_count" : 10000, 8 "available_count" : 999 9 }, 10 "stock_send_rule" : { 11 "max_count" : 10000000, 12 "max_count_per_day" : 10000, 13 "max_count_per_user" : 1 14 }, 15 "single_usage_rule" : { 16 "coupon_available_period" : { 17 "available_begin_time" : "2025-01-01T00:00:00+08:00", 18 "available_end_time" : "2025-10-01T00:00:00+08:00", 19 "available_days" : 10, 20 "wait_days_after_receive" : 1, 21 "weekly_available_period" : { 22 "day_list" : [ 23 "MONDAY" 24 ], 25 "day_period_list" : [ 26 { 27 "begin_time" : 60, 28 "end_time" : 86399 29 } 30 ] 31 }, 32 "irregular_available_period_list" : [ 33 { 34 "begin_time" : "2025-01-01T00:00:00+08:00", 35 "end_time" : "2025-10-01T00:00:00+08:00" 36 } 37 ] 38 }, 39 "normal_coupon" : { 40 "threshold" : 10000, 41 "discount_amount" : 100 42 }, 43 "discount_coupon" : { 44 "threshold" : 10000, 45 "percent_off" : 30 46 }, 47 "exchange_coupon" : { 48 "threshold" : 10000, 49 "exchange_price" : 100 50 } 51 }, 52 "sequential_usage_rule" : { 53 "coupon_available_period" : { 54 "available_begin_time" : "2025-01-01T00:00:00+08:00", 55 "available_end_time" : "2025-10-01T00:00:00+08:00", 56 "wait_days_after_receive" : 1, 57 "weekly_available_period" : { 58 "day_list" : [ 59 "MONDAY" 60 ], 61 "day_period_list" : [ 62 { 63 "begin_time" : 60, 64 "end_time" : 86399 65 } 66 ] 67 }, 68 "irregular_available_period_list" : [ 69 { 70 "begin_time" : "2025-01-01T00:00:00+08:00", 71 "end_time" : "2025-10-01T00:00:00+08:00" 72 } 73 ] 74 }, 75 "normal_coupon_list" : [ 76 { 77 "threshold" : 10000, 78 "discount_amount" : 100 79 } 80 ], 81 "discount_coupon_list" : [ 82 { 83 "threshold" : 10000, 84 "percent_off" : 30 85 } 86 ], 87 "exchange_coupon_list" : [ 88 { 89 "threshold" : 10000, 90 "exchange_price" : 100 91 } 92 ], 93 "special_first" : false 94 }, 95 "usage_rule_display_info" : { 96 "coupon_usage_method_list" : [ 97 "MINI_PROGRAM" 98 ], 99 "mini_program_appid" : "wx1234567890", 100 "mini_program_path" : "/pages/index/product", 101 "app_path" : "https://www.example.com/jump-to-app", 102 "usage_description" : "全场可用", 103 "coupon_available_store_info" : { 104 "description" : "可在上海市区的所有门店使用,详细列表参考小程序内信息为准", 105 "mini_program_appid" : "wx1234567890", 106 "mini_program_path" : "/pages/index/store-list" 107 } 108 }, 109 "coupon_display_info" : { 110 "code_display_mode" : "QRCODE", 111 "background_color" : "Color010", 112 "entrance_mini_program" : { 113 "appid" : "wx1234567890", 114 "path" : "/pages/index/product", 115 "entrance_wording" : "欢迎选购", 116 "guidance_wording" : "获取更多优惠" 117 }, 118 "entrance_official_account" : { 119 "appid" : "wx1234567890" 120 }, 121 "entrance_finder" : { 122 "finder_id" : "gh_12345678", 123 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 124 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 125 } 126 }, 127 "notify_config" : { 128 "notify_appid" : "wx4fd12345678" 129 }, 130 "store_scope" : "SPECIFIC", 131 "sent_count_info" : { 132 "total_count" : 100, 133 "today_count" : 10 134 }, 135 "state" : "SENDING", 136 "deactivate_request_no" : "1002600620019090123143254436", 137 "deactivate_time" : "2025-01-01T00:00+08:00", 138 "deactivate_reason" : "批次信息有误,重新创建", 139 "brand_id" : "120344" 140} 141
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 传入参数不符合业务规则 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
400 | ALREADY_EXISTS | 商品券批次已存在 | 确认 out_request_no 字段是否重复使用,确保不同请求的 out_request_no 唯一 |
403 | NO_AUTH | 缺少业务相关权限 | 请确认已开通商品券权限 |
404 | NOT_FOUND | 未找到 product_coupon_id 对应的商品券 | 请确认 product_coupon_id 存在且属于当前品牌 |
429 | RATELIMIT_EXCEEDED | 请求超过接口频率限制 | 请稍后使用原参数重试 |