添加商品券批次
更新时间:2025.08.28品牌方可以通过该接口为已有的商品券添加更多批次,多个批次可以实现品牌方多样化的投放需求。
注:同一个商品券下,最多只能有200个生效中的批次,已过期和已失效的批次不计入统计。
前置条件:商品券处于 EFFECTIVE 状态
频率限制:20/s
接口说明
支持商户:【品牌商户】
请求方式:【POST】/brand/marketing/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
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
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 【单券使用规则】 当且仅当
usage_rule_display_info 必填 object 【券使用规则展示信息】 券使用规则展示信息
coupon_display_info 必填 object 【用户商品券展示信息】 用户商品券在卡包中的展示详情,包括引导用户的自定义入口
notify_config 必填 object 【事件通知配置】 发生券相关事件时,微信支付会向品牌方发送通知,需要提供通知相关配置
store_scope 必填 string 【可用门店范围】 控制该批次可以在品牌下哪些门店使用 可选取值
|
请求示例
POST
为满100可用的全场8折券添加批次
1curl -X POST \ 2 https://api.mch.weixin.qq.com/brand/marketing/product-coupon/product-coupons/1000000013/stocks \ 3 -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: PUB_KEY_ID_XXXX" \ 6 -H "Content-Type: application/json" \ 7 -d '{ 8 "stock" : { 9 "remark" : "8月工作日有效批次", 10 "coupon_code_mode" : "UPLOAD", 11 "stock_send_rule" : { 12 "max_count" : 10000000, 13 "max_count_per_user" : 1 14 }, 15 "single_usage_rule" : { 16 "coupon_available_period" : { 17 "available_begin_time" : "2025-08-01T00:00:00+08:00", 18 "available_end_time" : "2025-08-31T23:59:59+08:00", 19 "available_days" : 30, 20 "weekly_available_period" : { 21 "day_list" : [ 22 "MONDAY", 23 "TUESDAY", 24 "WEDNESDAY", 25 "THURSDAY", 26 "FRIDAY" 27 ] 28 } 29 } 30 }, 31 "usage_rule_display_info" : { 32 "coupon_usage_method_list" : [ 33 "OFFLINE", 34 "MINI_PROGRAM", 35 "PAYMENT_CODE" 36 ], 37 "mini_program_appid" : "wx1234567890", 38 "mini_program_path" : "/pages/index/product", 39 "usage_description" : "工作日可用", 40 "coupon_available_store_info" : { 41 "description" : "所有门店可用,可使用小程序查看门店列表", 42 "mini_program_appid" : "wx1234567890", 43 "mini_program_path" : "/pages/index/store-list" 44 } 45 }, 46 "coupon_display_info" : { 47 "code_display_mode" : "QRCODE", 48 "background_color" : "Color010", 49 "entrance_mini_program" : { 50 "appid" : "wx1234567890", 51 "path" : "/pages/index/product", 52 "entrance_wording" : "欢迎选购", 53 "guidance_wording" : "获取更多优惠" 54 }, 55 "entrance_official_account" : { 56 "appid" : "wx1234567890" 57 }, 58 "entrance_finder" : { 59 "finder_id" : "gh_12345678", 60 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 61 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 62 } 63 }, 64 "store_scope" : "NONE", 65 "notify_config" : { 66 "notify_appid" : "wx4fd12345678" 67 } 68 }, 69 "out_request_no" : "12345_20250101_A3489" 70 }' 71
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayBrandUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/brand/4015826861 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 = "/brand/marketing/product-coupon/product-coupons/{product_coupon_id}/stocks"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 CreateStock client = new CreateStock( 33 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 34 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 35 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 CreateStockRequest request = new CreateStockRequest(); 41 request.outRequestNo = "12345_20250101_A3489"; 42 request.productCouponId = "1000000013"; 43 request.stock = new StockForCreate(); 44 request.stock.remark = "8月工作日有效批次"; 45 request.stock.couponCodeMode = CouponCodeMode.UPLOAD; 46 request.stock.stockSendRule = new StockSendRule(); 47 request.stock.stockSendRule.maxCount = 10000000L; 48 request.stock.stockSendRule.maxCountPerUser = 1L; 49 request.stock.singleUsageRule = new SingleUsageRule(); 50 request.stock.singleUsageRule.couponAvailablePeriod = new CouponAvailablePeriod(); 51 request.stock.singleUsageRule.couponAvailablePeriod.availableBeginTime = "2025-08-01T00:00:00+08:00"; 52 request.stock.singleUsageRule.couponAvailablePeriod.availableEndTime = "2025-08-31T23:59:59+08:00"; 53 request.stock.singleUsageRule.couponAvailablePeriod.availableDays = 30L; 54 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod = new FixedWeekPeriod(); 55 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList = new ArrayList<>(); 56 { 57 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.MONDAY); 58 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.TUESDAY); 59 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.WEDNESDAY); 60 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.THURSDAY); 61 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.FRIDAY); 62 }; 63 request.stock.usageRuleDisplayInfo = new UsageRuleDisplayInfo(); 64 request.stock.usageRuleDisplayInfo.couponUsageMethodList = new ArrayList<>(); 65 { 66 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.OFFLINE); 67 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.MINI_PROGRAM); 68 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.PAYMENT_CODE); 69 }; 70 request.stock.usageRuleDisplayInfo.miniProgramAppid = "wx1234567890"; 71 request.stock.usageRuleDisplayInfo.miniProgramPath = "/pages/index/product"; 72 request.stock.usageRuleDisplayInfo.usageDescription = "工作日可用"; 73 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo = new CouponAvailableStoreInfo(); 74 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.description = "所有门店可用,可使用小程序查看门店列表"; 75 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.miniProgramAppid = "wx1234567890"; 76 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.miniProgramPath = "/pages/index/store-list"; 77 request.stock.couponDisplayInfo = new CouponDisplayInfo(); 78 request.stock.couponDisplayInfo.codeDisplayMode = CouponCodeDisplayMode.QRCODE; 79 request.stock.couponDisplayInfo.backgroundColor = "Color010"; 80 request.stock.couponDisplayInfo.entranceMiniProgram = new EntranceMiniProgram(); 81 request.stock.couponDisplayInfo.entranceMiniProgram.appid = "wx1234567890"; 82 request.stock.couponDisplayInfo.entranceMiniProgram.path = "/pages/index/product"; 83 request.stock.couponDisplayInfo.entranceMiniProgram.entranceWording = "欢迎选购"; 84 request.stock.couponDisplayInfo.entranceMiniProgram.guidanceWording = "获取更多优惠"; 85 request.stock.couponDisplayInfo.entranceOfficialAccount = new EntranceOfficialAccount(); 86 request.stock.couponDisplayInfo.entranceOfficialAccount.appid = "wx1234567890"; 87 request.stock.couponDisplayInfo.entranceFinder = new EntranceFinder(); 88 request.stock.couponDisplayInfo.entranceFinder.finderId = "gh_12345678"; 89 request.stock.couponDisplayInfo.entranceFinder.finderVideoId = "UDFsdf24df34dD456Hdf34"; 90 request.stock.couponDisplayInfo.entranceFinder.finderVideoCoverImageUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"; 91 request.stock.notifyConfig = new NotifyConfig(); 92 request.stock.notifyConfig.notifyAppid = "wx4fd12345678"; 93 request.stock.storeScope = StockStoreScope.NONE; 94 try { 95 StockEntity response = client.run(request); 96 // TODO: 请求成功,继续业务逻辑 97 System.out.println(response); 98 } catch (WXPayBrandUtility.ApiException e) { 99 // TODO: 请求失败,根据状态码执行不同的逻辑 100 e.printStackTrace(); 101 } 102 } 103 104 public StockEntity run(CreateStockRequest request) { 105 String uri = PATH; 106 uri = uri.replace("{product_coupon_id}", WXPayBrandUtility.urlEncode(request.productCouponId)); 107 String reqBody = WXPayBrandUtility.toJson(request); 108 109 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 110 reqBuilder.addHeader("Accept", "application/json"); 111 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 112 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 113 reqBuilder.addHeader("Content-Type", "application/json"); 114 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 115 reqBuilder.method(METHOD, requestBody); 116 Request httpRequest = reqBuilder.build(); 117 118 // 发送HTTP请求 119 OkHttpClient client = new OkHttpClient.Builder().build(); 120 try (Response httpResponse = client.newCall(httpRequest).execute()) { 121 String respBody = WXPayBrandUtility.extractBody(httpResponse); 122 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 123 // 2XX 成功,验证应答签名 124 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 125 httpResponse.headers(), respBody); 126 127 // 从HTTP应答报文构建返回数据 128 return WXPayBrandUtility.fromJson(respBody, StockEntity.class); 129 } else { 130 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 131 } 132 } catch (IOException e) { 133 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 134 } 135 } 136 137 private final String brand_id; 138 private final String certificateSerialNo; 139 private final PrivateKey privateKey; 140 private final String wechatPayPublicKeyId; 141 private final PublicKey wechatPayPublicKey; 142 143 public CreateStock(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 144 this.brand_id = brand_id; 145 this.certificateSerialNo = certificateSerialNo; 146 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 147 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 148 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 149 } 150 151 public static class CreateStockRequest { 152 @SerializedName("out_request_no") 153 public String outRequestNo; 154 155 @SerializedName("product_coupon_id") 156 @Expose(serialize = false) 157 public String productCouponId; 158 159 @SerializedName("stock") 160 public StockForCreate stock; 161 } 162 163 public static class StockEntity { 164 @SerializedName("product_coupon_id") 165 public String productCouponId; 166 167 @SerializedName("stock_id") 168 public String stockId; 169 170 @SerializedName("remark") 171 public String remark; 172 173 @SerializedName("coupon_code_mode") 174 public CouponCodeMode couponCodeMode; 175 176 @SerializedName("coupon_code_count_info") 177 public CouponCodeCountInfo couponCodeCountInfo; 178 179 @SerializedName("stock_send_rule") 180 public StockSendRule stockSendRule; 181 182 @SerializedName("single_usage_rule") 183 public SingleUsageRule singleUsageRule; 184 185 @SerializedName("usage_rule_display_info") 186 public UsageRuleDisplayInfo usageRuleDisplayInfo; 187 188 @SerializedName("coupon_display_info") 189 public CouponDisplayInfo couponDisplayInfo; 190 191 @SerializedName("notify_config") 192 public NotifyConfig notifyConfig; 193 194 @SerializedName("store_scope") 195 public StockStoreScope storeScope; 196 197 @SerializedName("sent_count_info") 198 public StockSentCountInfo sentCountInfo; 199 200 @SerializedName("state") 201 public StockState state; 202 203 @SerializedName("deactivate_request_no") 204 public String deactivateRequestNo; 205 206 @SerializedName("deactivate_time") 207 public String deactivateTime; 208 209 @SerializedName("deactivate_reason") 210 public String deactivateReason; 211 } 212 213 public static class StockForCreate { 214 @SerializedName("remark") 215 public String remark; 216 217 @SerializedName("coupon_code_mode") 218 public CouponCodeMode couponCodeMode; 219 220 @SerializedName("stock_send_rule") 221 public StockSendRule stockSendRule; 222 223 @SerializedName("single_usage_rule") 224 public SingleUsageRule singleUsageRule; 225 226 @SerializedName("usage_rule_display_info") 227 public UsageRuleDisplayInfo usageRuleDisplayInfo; 228 229 @SerializedName("coupon_display_info") 230 public CouponDisplayInfo couponDisplayInfo; 231 232 @SerializedName("notify_config") 233 public NotifyConfig notifyConfig; 234 235 @SerializedName("store_scope") 236 public StockStoreScope storeScope; 237 } 238 239 public enum CouponCodeMode { 240 @SerializedName("WECHATPAY") 241 WECHATPAY, 242 @SerializedName("UPLOAD") 243 UPLOAD, 244 @SerializedName("API_ASSIGN") 245 API_ASSIGN 246 } 247 248 public static class CouponCodeCountInfo { 249 @SerializedName("total_count") 250 public Long totalCount; 251 252 @SerializedName("available_count") 253 public Long availableCount; 254 } 255 256 public static class StockSendRule { 257 @SerializedName("max_count") 258 public Long maxCount; 259 260 @SerializedName("max_count_per_day") 261 public Long maxCountPerDay; 262 263 @SerializedName("max_count_per_user") 264 public Long maxCountPerUser; 265 } 266 267 public static class SingleUsageRule { 268 @SerializedName("coupon_available_period") 269 public CouponAvailablePeriod couponAvailablePeriod; 270 271 @SerializedName("normal_coupon") 272 public NormalCouponUsageRule normalCoupon; 273 274 @SerializedName("discount_coupon") 275 public DiscountCouponUsageRule discountCoupon; 276 277 @SerializedName("exchange_coupon") 278 public ExchangeCouponUsageRule exchangeCoupon; 279 } 280 281 public static class UsageRuleDisplayInfo { 282 @SerializedName("coupon_usage_method_list") 283 public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>(); 284 285 @SerializedName("mini_program_appid") 286 public String miniProgramAppid; 287 288 @SerializedName("mini_program_path") 289 public String miniProgramPath; 290 291 @SerializedName("app_path") 292 public String appPath; 293 294 @SerializedName("usage_description") 295 public String usageDescription; 296 297 @SerializedName("coupon_available_store_info") 298 public CouponAvailableStoreInfo couponAvailableStoreInfo; 299 } 300 301 public static class CouponDisplayInfo { 302 @SerializedName("code_display_mode") 303 public CouponCodeDisplayMode codeDisplayMode; 304 305 @SerializedName("background_color") 306 public String backgroundColor; 307 308 @SerializedName("entrance_mini_program") 309 public EntranceMiniProgram entranceMiniProgram; 310 311 @SerializedName("entrance_official_account") 312 public EntranceOfficialAccount entranceOfficialAccount; 313 314 @SerializedName("entrance_finder") 315 public EntranceFinder entranceFinder; 316 } 317 318 public static class NotifyConfig { 319 @SerializedName("notify_appid") 320 public String notifyAppid; 321 } 322 323 public enum StockStoreScope { 324 @SerializedName("NONE") 325 NONE, 326 @SerializedName("ALL") 327 ALL, 328 @SerializedName("SPECIFIC") 329 SPECIFIC 330 } 331 332 public static class StockSentCountInfo { 333 @SerializedName("total_count") 334 public Long totalCount; 335 336 @SerializedName("today_count") 337 public Long todayCount; 338 } 339 340 public enum StockState { 341 @SerializedName("AUDITING") 342 AUDITING, 343 @SerializedName("SENDING") 344 SENDING, 345 @SerializedName("PAUSED") 346 PAUSED, 347 @SerializedName("STOPPED") 348 STOPPED, 349 @SerializedName("DEACTIVATED") 350 DEACTIVATED 351 } 352 353 public static class CouponAvailablePeriod { 354 @SerializedName("available_begin_time") 355 public String availableBeginTime; 356 357 @SerializedName("available_end_time") 358 public String availableEndTime; 359 360 @SerializedName("available_days") 361 public Long availableDays; 362 363 @SerializedName("wait_days_after_receive") 364 public Long waitDaysAfterReceive; 365 366 @SerializedName("weekly_available_period") 367 public FixedWeekPeriod weeklyAvailablePeriod; 368 369 @SerializedName("irregular_available_period_list") 370 public List<TimePeriod> irregularAvailablePeriodList; 371 } 372 373 public static class NormalCouponUsageRule { 374 @SerializedName("threshold") 375 public Long threshold; 376 377 @SerializedName("discount_amount") 378 public Long discountAmount; 379 } 380 381 public static class DiscountCouponUsageRule { 382 @SerializedName("threshold") 383 public Long threshold; 384 385 @SerializedName("percent_off") 386 public Long percentOff; 387 } 388 389 public static class ExchangeCouponUsageRule { 390 @SerializedName("threshold") 391 public Long threshold; 392 393 @SerializedName("exchange_price") 394 public Long exchangePrice; 395 } 396 397 public enum CouponUsageMethod { 398 @SerializedName("OFFLINE") 399 OFFLINE, 400 @SerializedName("MINI_PROGRAM") 401 MINI_PROGRAM, 402 @SerializedName("APP") 403 APP, 404 @SerializedName("PAYMENT_CODE") 405 PAYMENT_CODE 406 } 407 408 public static class CouponAvailableStoreInfo { 409 @SerializedName("description") 410 public String description; 411 412 @SerializedName("mini_program_appid") 413 public String miniProgramAppid; 414 415 @SerializedName("mini_program_path") 416 public String miniProgramPath; 417 } 418 419 public enum CouponCodeDisplayMode { 420 @SerializedName("INVISIBLE") 421 INVISIBLE, 422 @SerializedName("BARCODE") 423 BARCODE, 424 @SerializedName("QRCODE") 425 QRCODE 426 } 427 428 public static class EntranceMiniProgram { 429 @SerializedName("appid") 430 public String appid; 431 432 @SerializedName("path") 433 public String path; 434 435 @SerializedName("entrance_wording") 436 public String entranceWording; 437 438 @SerializedName("guidance_wording") 439 public String guidanceWording; 440 } 441 442 public static class EntranceOfficialAccount { 443 @SerializedName("appid") 444 public String appid; 445 } 446 447 public static class EntranceFinder { 448 @SerializedName("finder_id") 449 public String finderId; 450 451 @SerializedName("finder_video_id") 452 public String finderVideoId; 453 454 @SerializedName("finder_video_cover_image_url") 455 public String finderVideoCoverImageUrl; 456 } 457 458 public static class FixedWeekPeriod { 459 @SerializedName("day_list") 460 public List<WeekEnum> dayList; 461 462 @SerializedName("day_period_list") 463 public List<PeriodOfTheDay> dayPeriodList; 464 } 465 466 public static class TimePeriod { 467 @SerializedName("begin_time") 468 public String beginTime; 469 470 @SerializedName("end_time") 471 public String endTime; 472 } 473 474 public enum WeekEnum { 475 @SerializedName("MONDAY") 476 MONDAY, 477 @SerializedName("TUESDAY") 478 TUESDAY, 479 @SerializedName("WEDNESDAY") 480 WEDNESDAY, 481 @SerializedName("THURSDAY") 482 THURSDAY, 483 @SerializedName("FRIDAY") 484 FRIDAY, 485 @SerializedName("SATURDAY") 486 SATURDAY, 487 @SerializedName("SUNDAY") 488 SUNDAY 489 } 490 491 public static class PeriodOfTheDay { 492 @SerializedName("begin_time") 493 public Long beginTime; 494 495 @SerializedName("end_time") 496 public Long endTime; 497 } 498 499} 500
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_brand_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/brand/4015826866 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/brand/4015415289 16 config, err := wxpay_brand_utility.CreateBrandConfig( 17 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 18 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 19 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 20 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 21 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 22 ) 23 if err != nil { 24 fmt.Println(err) 25 return 26 } 27 28 request := &CreateStockRequest{ 29 OutRequestNo: wxpay_brand_utility.String("12345_20250101_A3489"), 30 ProductCouponId: wxpay_brand_utility.String("1000000013"), 31 Stock: &StockForCreate{ 32 Remark: wxpay_brand_utility.String("8月工作日有效批次"), 33 CouponCodeMode: COUPONCODEMODE_UPLOAD.Ptr(), 34 StockSendRule: &StockSendRule{ 35 MaxCount: wxpay_brand_utility.Int64(10000000), 36 MaxCountPerUser: wxpay_brand_utility.Int64(1), 37 }, 38 SingleUsageRule: &SingleUsageRule{ 39 CouponAvailablePeriod: &CouponAvailablePeriod{ 40 AvailableBeginTime: wxpay_brand_utility.String("2025-08-01T00:00:00+08:00"), 41 AvailableEndTime: wxpay_brand_utility.String("2025-08-31T23:59:59+08:00"), 42 AvailableDays: wxpay_brand_utility.Int64(30), 43 WeeklyAvailablePeriod: &FixedWeekPeriod{ 44 DayList: []WeekEnum{ 45 WEEKENUM_MONDAY, 46 WEEKENUM_TUESDAY, 47 WEEKENUM_WEDNESDAY, 48 WEEKENUM_THURSDAY, 49 WEEKENUM_FRIDAY, 50 }, 51 }, 52 }, 53 }, 54 UsageRuleDisplayInfo: &UsageRuleDisplayInfo{ 55 CouponUsageMethodList: []CouponUsageMethod{ 56 COUPONUSAGEMETHOD_OFFLINE, 57 COUPONUSAGEMETHOD_MINI_PROGRAM, 58 COUPONUSAGEMETHOD_PAYMENT_CODE, 59 }, 60 MiniProgramAppid: wxpay_brand_utility.String("wx1234567890"), 61 MiniProgramPath: wxpay_brand_utility.String("/pages/index/product"), 62 UsageDescription: wxpay_brand_utility.String("工作日可用"), 63 CouponAvailableStoreInfo: &CouponAvailableStoreInfo{ 64 Description: wxpay_brand_utility.String("所有门店可用,可使用小程序查看门店列表"), 65 MiniProgramAppid: wxpay_brand_utility.String("wx1234567890"), 66 MiniProgramPath: wxpay_brand_utility.String("/pages/index/store-list"), 67 }, 68 }, 69 CouponDisplayInfo: &CouponDisplayInfo{ 70 CodeDisplayMode: COUPONCODEDISPLAYMODE_QRCODE.Ptr(), 71 BackgroundColor: wxpay_brand_utility.String("Color010"), 72 EntranceMiniProgram: &EntranceMiniProgram{ 73 Appid: wxpay_brand_utility.String("wx1234567890"), 74 Path: wxpay_brand_utility.String("/pages/index/product"), 75 EntranceWording: wxpay_brand_utility.String("欢迎选购"), 76 GuidanceWording: wxpay_brand_utility.String("获取更多优惠"), 77 }, 78 EntranceOfficialAccount: &EntranceOfficialAccount{ 79 Appid: wxpay_brand_utility.String("wx1234567890"), 80 }, 81 EntranceFinder: &EntranceFinder{ 82 FinderId: wxpay_brand_utility.String("gh_12345678"), 83 FinderVideoId: wxpay_brand_utility.String("UDFsdf24df34dD456Hdf34"), 84 FinderVideoCoverImageUrl: wxpay_brand_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"), 85 }, 86 }, 87 NotifyConfig: &NotifyConfig{ 88 NotifyAppid: wxpay_brand_utility.String("wx4fd12345678"), 89 }, 90 StoreScope: STOCKSTORESCOPE_NONE.Ptr(), 91 }, 92 } 93 94 response, err := CreateStock(config, request) 95 if err != nil { 96 fmt.Printf("请求失败: %+v\n", err) 97 // TODO: 请求失败,根据状态码执行不同的处理 98 return 99 } 100 101 // TODO: 请求成功,继续业务逻辑 102 fmt.Printf("请求成功: %+v\n", response) 103} 104 105func CreateStock(config *wxpay_brand_utility.BrandConfig, request *CreateStockRequest) (response *StockEntity, err error) { 106 const ( 107 host = "https://api.mch.weixin.qq.com" 108 method = "POST" 109 path = "/brand/marketing/product-coupon/product-coupons/{product_coupon_id}/stocks" 110 ) 111 112 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 113 if err != nil { 114 return nil, err 115 } 116 reqUrl.Path = strings.Replace(reqUrl.Path, "{product_coupon_id}", url.PathEscape(*request.ProductCouponId), -1) 117 reqBody, err := json.Marshal(request) 118 if err != nil { 119 return nil, err 120 } 121 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 122 if err != nil { 123 return nil, err 124 } 125 httpRequest.Header.Set("Accept", "application/json") 126 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 127 httpRequest.Header.Set("Content-Type", "application/json") 128 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 129 if err != nil { 130 return nil, err 131 } 132 httpRequest.Header.Set("Authorization", authorization) 133 134 client := &http.Client{} 135 httpResponse, err := client.Do(httpRequest) 136 if err != nil { 137 return nil, err 138 } 139 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 140 if err != nil { 141 return nil, err 142 } 143 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 144 // 2XX 成功,验证应答签名 145 err = wxpay_brand_utility.ValidateResponse( 146 config.WechatPayPublicKeyId(), 147 config.WechatPayPublicKey(), 148 &httpResponse.Header, 149 respBody, 150 ) 151 if err != nil { 152 return nil, err 153 } 154 response := &StockEntity{} 155 if err := json.Unmarshal(respBody, response); err != nil { 156 return nil, err 157 } 158 159 return response, nil 160 } else { 161 return nil, wxpay_brand_utility.NewApiException( 162 httpResponse.StatusCode, 163 httpResponse.Header, 164 respBody, 165 ) 166 } 167} 168 169type CreateStockRequest struct { 170 OutRequestNo *string `json:"out_request_no,omitempty"` 171 ProductCouponId *string `json:"product_coupon_id,omitempty"` 172 Stock *StockForCreate `json:"stock,omitempty"` 173} 174 175func (o *CreateStockRequest) MarshalJSON() ([]byte, error) { 176 type Alias CreateStockRequest 177 a := &struct { 178 ProductCouponId *string `json:"product_coupon_id,omitempty"` 179 *Alias 180 }{ 181 // 序列化时移除非 Body 字段 182 ProductCouponId: nil, 183 Alias: (*Alias)(o), 184 } 185 return json.Marshal(a) 186} 187 188type StockEntity struct { 189 ProductCouponId *string `json:"product_coupon_id,omitempty"` 190 StockId *string `json:"stock_id,omitempty"` 191 Remark *string `json:"remark,omitempty"` 192 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 193 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 194 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 195 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 196 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 197 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 198 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 199 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 200 SentCountInfo *StockSentCountInfo `json:"sent_count_info,omitempty"` 201 State *StockState `json:"state,omitempty"` 202 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 203 DeactivateTime *time.Time `json:"deactivate_time,omitempty"` 204 DeactivateReason *string `json:"deactivate_reason,omitempty"` 205} 206 207type StockForCreate struct { 208 Remark *string `json:"remark,omitempty"` 209 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 210 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 211 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 212 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 213 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 214 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 215 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 216} 217 218type CouponCodeMode string 219 220func (e CouponCodeMode) Ptr() *CouponCodeMode { 221 return &e 222} 223 224const ( 225 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 226 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 227 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 228) 229 230type CouponCodeCountInfo struct { 231 TotalCount *int64 `json:"total_count,omitempty"` 232 AvailableCount *int64 `json:"available_count,omitempty"` 233} 234 235type StockSendRule struct { 236 MaxCount *int64 `json:"max_count,omitempty"` 237 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 238 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 239} 240 241type SingleUsageRule struct { 242 CouponAvailablePeriod *CouponAvailablePeriod `json:"coupon_available_period,omitempty"` 243 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 244 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 245 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 246} 247 248type UsageRuleDisplayInfo struct { 249 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 250 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 251 MiniProgramPath *string `json:"mini_program_path,omitempty"` 252 AppPath *string `json:"app_path,omitempty"` 253 UsageDescription *string `json:"usage_description,omitempty"` 254 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 255} 256 257type CouponDisplayInfo struct { 258 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 259 BackgroundColor *string `json:"background_color,omitempty"` 260 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 261 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 262 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 263} 264 265type NotifyConfig struct { 266 NotifyAppid *string `json:"notify_appid,omitempty"` 267} 268 269type StockStoreScope string 270 271func (e StockStoreScope) Ptr() *StockStoreScope { 272 return &e 273} 274 275const ( 276 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 277 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 278 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 279) 280 281type StockSentCountInfo struct { 282 TotalCount *int64 `json:"total_count,omitempty"` 283 TodayCount *int64 `json:"today_count,omitempty"` 284} 285 286type StockState string 287 288func (e StockState) Ptr() *StockState { 289 return &e 290} 291 292const ( 293 STOCKSTATE_AUDITING StockState = "AUDITING" 294 STOCKSTATE_SENDING StockState = "SENDING" 295 STOCKSTATE_PAUSED StockState = "PAUSED" 296 STOCKSTATE_STOPPED StockState = "STOPPED" 297 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 298) 299 300type CouponAvailablePeriod struct { 301 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 302 AvailableEndTime *string `json:"available_end_time,omitempty"` 303 AvailableDays *int64 `json:"available_days,omitempty"` 304 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 305 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 306 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 307} 308 309type NormalCouponUsageRule struct { 310 Threshold *int64 `json:"threshold,omitempty"` 311 DiscountAmount *int64 `json:"discount_amount,omitempty"` 312} 313 314type DiscountCouponUsageRule struct { 315 Threshold *int64 `json:"threshold,omitempty"` 316 PercentOff *int64 `json:"percent_off,omitempty"` 317} 318 319type ExchangeCouponUsageRule struct { 320 Threshold *int64 `json:"threshold,omitempty"` 321 ExchangePrice *int64 `json:"exchange_price,omitempty"` 322} 323 324type CouponUsageMethod string 325 326func (e CouponUsageMethod) Ptr() *CouponUsageMethod { 327 return &e 328} 329 330const ( 331 COUPONUSAGEMETHOD_OFFLINE CouponUsageMethod = "OFFLINE" 332 COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM" 333 COUPONUSAGEMETHOD_APP CouponUsageMethod = "APP" 334 COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE" 335) 336 337type CouponAvailableStoreInfo struct { 338 Description *string `json:"description,omitempty"` 339 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 340 MiniProgramPath *string `json:"mini_program_path,omitempty"` 341} 342 343type CouponCodeDisplayMode string 344 345func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode { 346 return &e 347} 348 349const ( 350 COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE" 351 COUPONCODEDISPLAYMODE_BARCODE CouponCodeDisplayMode = "BARCODE" 352 COUPONCODEDISPLAYMODE_QRCODE CouponCodeDisplayMode = "QRCODE" 353) 354 355type EntranceMiniProgram struct { 356 Appid *string `json:"appid,omitempty"` 357 Path *string `json:"path,omitempty"` 358 EntranceWording *string `json:"entrance_wording,omitempty"` 359 GuidanceWording *string `json:"guidance_wording,omitempty"` 360} 361 362type EntranceOfficialAccount struct { 363 Appid *string `json:"appid,omitempty"` 364} 365 366type EntranceFinder struct { 367 FinderId *string `json:"finder_id,omitempty"` 368 FinderVideoId *string `json:"finder_video_id,omitempty"` 369 FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"` 370} 371 372type FixedWeekPeriod struct { 373 DayList []WeekEnum `json:"day_list,omitempty"` 374 DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"` 375} 376 377type TimePeriod struct { 378 BeginTime *string `json:"begin_time,omitempty"` 379 EndTime *string `json:"end_time,omitempty"` 380} 381 382type WeekEnum string 383 384func (e WeekEnum) Ptr() *WeekEnum { 385 return &e 386} 387 388const ( 389 WEEKENUM_MONDAY WeekEnum = "MONDAY" 390 WEEKENUM_TUESDAY WeekEnum = "TUESDAY" 391 WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY" 392 WEEKENUM_THURSDAY WeekEnum = "THURSDAY" 393 WEEKENUM_FRIDAY WeekEnum = "FRIDAY" 394 WEEKENUM_SATURDAY WeekEnum = "SATURDAY" 395 WEEKENUM_SUNDAY WeekEnum = "SUNDAY" 396) 397 398type PeriodOfTheDay struct { 399 BeginTime *int64 `json:"begin_time,omitempty"` 400 EndTime *int64 `json:"end_time,omitempty"` 401} 402
应答参数
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】自行发券时指定,微信支付系统不再进行自动分配。特别注意:这种模式的商品批次只可由品牌方自行发券,无法在摇一摇有优惠等微信支付渠道投放;商品券的usage_mode为PROGRESSIVE_BUNDLE时不可使用本模式
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 【兑换券使用规则】 当且仅当
|
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,支持小程序、服务号、公众号、APP类型的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(128)
【失效请求单号】 当且仅当 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(150)
【失效原因】 当且仅当 state 为 DEACTIVATED 时提供,返回品牌方调用【失效商品券批次API】时传入的失效原因
应答示例
200 OK
为满100可用的全场8折券添加批次
1{ 2 "product_coupon_id" : "1000000013", 3 "stock_id" : "1000000013001", 4 "remark" : "8月工作日有效批次", 5 "coupon_code_mode" : "UPLOAD", 6 "coupon_code_count_info" : { 7 "total_count" : 0, 8 "available_count" : 0 9 }, 10 "stock_send_rule" : { 11 "max_count" : 10000000, 12 "max_count_per_user" : 1 13 }, 14 "single_usage_rule" : { 15 "coupon_available_period" : { 16 "available_begin_time" : "2025-08-01T00:00:00+08:00", 17 "available_end_time" : "2025-08-31T23:59:59+08:00", 18 "available_days" : 30, 19 "weekly_available_period" : { 20 "day_list" : [ 21 "MONDAY", 22 "TUESDAY", 23 "WEDNESDAY", 24 "THURSDAY", 25 "FRIDAY" 26 ] 27 } 28 } 29 }, 30 "usage_rule_display_info" : { 31 "coupon_usage_method_list" : [ 32 "OFFLINE", 33 "MINI_PROGRAM", 34 "PAYMENT_CODE" 35 ], 36 "mini_program_appid" : "wx1234567890", 37 "mini_program_path" : "/pages/index/product", 38 "usage_description" : "工作日可用", 39 "coupon_available_store_info" : { 40 "description" : "所有门店可用,可使用小程序查看门店列表", 41 "mini_program_appid" : "wx1234567890", 42 "mini_program_path" : "/pages/index/store-list" 43 } 44 }, 45 "coupon_display_info" : { 46 "code_display_mode" : "QRCODE", 47 "background_color" : "Color010", 48 "entrance_mini_program" : { 49 "appid" : "wx1234567890", 50 "path" : "/pages/index/product", 51 "entrance_wording" : "欢迎选购", 52 "guidance_wording" : "获取更多优惠" 53 }, 54 "entrance_official_account" : { 55 "appid" : "wx1234567890" 56 }, 57 "entrance_finder" : { 58 "finder_id" : "gh_12345678", 59 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 60 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 61 } 62 }, 63 "notify_config" : { 64 "notify_appid" : "wx4fd12345678" 65 }, 66 "store_scope" : "NONE", 67 "sent_count_info" : { 68 "total_count" : 0, 69 "today_count" : 0 70 }, 71 "state" : "SENDING" 72} 73
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
400 | INVALID_REQUEST | usage_mode 为 SINGLE 时,批次未填写 single_usage_rule | 请填写 single_usage_rule |
400 | INVALID_REQUEST | usage_mode 为 SEQUENTIAL 时,批次未填写 sequential_usage_rule | 请填写 sequential_usage_rule |
400 | INVALID_REQUEST | 单券使用模式的商品券批次,应该在「单券使用规则」中包含对应类型的优惠规则。对于文档中标记不应填写的优惠规则应删除。 | 请在「单券使用规则」中包含对应类型的优惠规则,并删除文档中标记不应填写的优惠规则。 |
400 | INVALID_REQUEST | 多次优惠使用模式的商品券批次,应该在「多次优惠使用规则」中包含对应类型的优惠规则,且数量与多次优惠的优惠次数相等 | 在「多次优惠使用规则」中包含对应类型的优惠规则,且数量与多次优惠的优惠次数相等 |
400 | INVALID_REQUEST | 单品满减券或单品折扣券不应在商品券中设置「满减券使用规则」或「折扣券使用规则」,而是应该在商品券批次中设置 | 请删除商品券中的「满减券使用规则」或「折扣券使用规则」,并在商品券批次中设置对应的优惠规则 |
403 | NO_AUTH | 品牌没有此接口权限 | 品牌没有此接口权限 |
400 | INVALID_REQUEST | 商品券支持APP核销时,必须提供「APP跳转路径」 | 请提供「APP跳转路径」参数 |
400 | PARAM_ERROR | 分页大小超出限制,请根据接口文档调整到允许的范围 | 请调整分页大小到规定范围 |
400 | INVALID_REQUEST | 商品券支持小程序核销时,必须提供「小程序AppID」 | 请提供「小程序AppID」 |
400 | INVALID_REQUEST | 单品券必须提供商品原价,请补充 | 请补充商品原价 |
400 | INVALID_REQUEST | 商品券支持小程序核销时,必须提供「小程序跳转路径」 | 请提供提供「小程序跳转路径」 |
400 | INVALID_REQUEST | 单品券必须提供商品券套餐组合信息,请补充 | 请提供商品券套餐组合信息 |
400 | PARAM_ERROR | 时间字符串格式错误,请使用 RFC3339 标准格式 | 请使用 RFC3339 标准格式 |
400 | INVALID_REQUEST | 单券模式下,全场折扣券应在商品券中提供折扣券使用规则信息 | 请在商品券中提供「折扣券使用规则信息」 |
400 | INVALID_REQUEST | 单券模式下,全场满减券应在商品券中提供满减券使用规则信息 | 请在商品券中提供「满减券使用规则信息」 |
400 | INVALID_REQUEST | 每周固定可用时间(weekly_available_period)中提供当天可用时间段时(day_period_list),每周可用星期数(day_list)必填 | 请补充 每周可用星期数(day_list) |
400 | INVALID_REQUEST | 单券模式下,全场券需要提供「单券模式信息(single_usage_info)」 | 请提供单券模式信息(single_usage_info) |
400 | INVALID_REQUEST | 多次优惠模式下必须提供「多次优惠模式信息(sequential_usage_info)」 | 请填写 多次优惠模式信息(sequential_usage_info) |
400 | INVALID_REQUEST | 传入的OpenID不合法 | 请使用参数 AppID 对应的的OpenID |


