创建商品券
更新时间:2025.08.04品牌方可以通过该接口创建商品券和批次。微信支付创建成功后,会返回此次创建的商品券以及批次。品牌方可在【经营平台】上配置【活动】对商品券进行投放。
频率限制:接口级限制1000/min
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/marketing/partner/product-coupon/product-coupons
请求域名:【主域名】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
body 包体参数
out_request_no 必填 string(40)
【创建请求单号】 品牌创建商品券的请求流水号,品牌侧需保持唯一性,可使用 数字、大小写字母、下划线_
、短横线-
组成,长度在6-40个字符之间
scope 必填 string
【优惠范围】 商品券的优惠范围
可选取值
ALL
: 全场券,此时券类型type
仅可配置为NORMAL
或DISCOUNT
SINGLE
: 单品券,此时券类型type
配置不受限制,即可配置为NORMAL
、DISCOUNT
或EXCHANGE
type 必填 string
【商品券类型】 商品券的优惠类型
可选取值
NORMAL
: 满减券DISCOUNT
: 折扣券EXCHANGE
: 换购券,仅在scope
为SINGLE
时可配置
usage_mode 必填 string
【使用模式】 商品券使用模式
可选取值
SINGLE
: 单券,即用户只能使用一次,使用后券失效SEQUENTIAL
: 多次优惠,即用户可以按顺序多次使用,每次核销成功后会发放下一次优惠机会,直到用完为止
single_usage_info 选填 object
【单券模式信息】 单券模式配置信息,当且仅当 usage_mode
为 SINGLE
时必传,其他模式不应填写。
属性 | |||||||||
normal_coupon 选填 object 【满减券使用规则】 本商品券内所有批次均以此规则提供满减优惠,当且仅当
discount_coupon 选填 object 【折扣券使用规则】 本商品券内所有批次均以此规则提供折扣优惠,当且仅当
|
sequential_usage_info 选填 object
【多次优惠模式信息】 多次优惠模式配置信息,当且仅当 usage_mode
为 SEQUENTIAL
时必传,其他模式不应填写。
属性 | |
type 必填 string 【多次优惠规则类型】 多次优惠规则类型 可选取值
count 必填 integer 【可使用次数】 本多次优惠领取后用户可使用次数,最多15次 available_days 必填 integer 【多次优惠有效天数】 用户的多次优惠生效后 N 天内有效,最少3天,最多365天 interval_days 选填 integer 【多次优惠使用间隔天数】 多次优惠多次使用之间需要间隔的天数,最高7天。例如:
默认情况下为 |
display_info 必填 object
【展示信息】 商品券展示信息
属性 | |||||||||
name 必填 string(15) 【商品券名称】 商品券名称,长度不超过15个UTF-8字符 image_url 必填 string 【商品券图片】 商品图片的链接地址,仅支持通过图片上传接口获取的图片URL地址。
background_url 必填 string 【商品券背景图】 商品背景图片的URL地址,仅支持通过图片上传接口获取的图片URL地址。
detail_image_url_list 选填 array[string] 【商品券详情图列表】 商品详情图URL地址列表,用于最多可上传8张图片,仅支持通过图片上传接口获取的图片URL地址。
original_price 选填 integer 【商品原价】 单位为分,当且仅当 combo_package_list 选填 array[object] 【套餐组合】 当
|
out_product_no 选填 string(40)
【外部商品ID】 品牌侧的商品标识,品牌可自行选择传入,长度不超过40个字符。
注:微信支付不校验此参数的唯一性,即允许多个商品券共享外部商品ID。
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
创建满100可用的全场8折券
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/marketing/partner/product-coupon/product-coupons \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "out_product_no" : "Product_1234567890", 8 "scope" : "ALL", 9 "usage_mode" : "SINGLE", 10 "display_info" : { 11 "name" : "全场满100立打8折", 12 "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 13 "background_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 14 "detail_image_url_list" : [ 15 "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 16 ] 17 }, 18 "single_usage_info" : { 19 "discount_coupon" : { 20 "threshold" : 10000, 21 "percent_off" : 20 22 } 23 }, 24 "type" : "DISCOUNT", 25 "stock" : { 26 "remark" : "8月工作日有效批次", 27 "coupon_code_mode" : "UPLOAD", 28 "stock_send_rule" : { 29 "max_count" : 10000000, 30 "max_count_per_user" : 1 31 }, 32 "single_usage_rule" : { 33 "coupon_available_period" : { 34 "available_begin_time" : "2025-08-01T00:00:00+08:00", 35 "available_end_time" : "2025-08-31T23:59:59+08:00", 36 "available_days" : 30, 37 "weekly_available_period" : { 38 "day_list" : [ 39 "MONDAY", 40 "TUESDAY", 41 "WEDNESDAY", 42 "THURSDAY", 43 "FRIDAY" 44 ] 45 } 46 } 47 }, 48 "usage_rule_display_info" : { 49 "coupon_usage_method_list" : [ 50 "OFFLINE", 51 "MINI_PROGRAM", 52 "PAYMENT_CODE" 53 ], 54 "mini_program_appid" : "wx1234567890", 55 "mini_program_path" : "/pages/index/product", 56 "usage_description" : "工作日可用", 57 "coupon_available_store_info" : { 58 "description" : "所有门店可用,可使用小程序查看门店列表", 59 "mini_program_appid" : "wx1234567890", 60 "mini_program_path" : "/pages/index/store-list" 61 } 62 }, 63 "coupon_display_info" : { 64 "code_display_mode" : "QRCODE", 65 "background_color" : "Color010", 66 "entrance_mini_program" : { 67 "appid" : "wx1234567890", 68 "path" : "/pages/index/product", 69 "entrance_wording" : "欢迎选购", 70 "guidance_wording" : "获取更多优惠" 71 }, 72 "entrance_official_account" : { 73 "appid" : "wx1234567890" 74 }, 75 "entrance_finder" : { 76 "finder_id" : "gh_12345678", 77 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 78 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 79 } 80 }, 81 "store_scope" : "NONE", 82 "notify_config" : { 83 "notify_appid" : "wx4fd12345678" 84 } 85 }, 86 "out_request_no" : "12345_20250101_A3489", 87 "brand_id" : "120344" 88 }' 89
需配合微信支付工具库 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 CreateProductCoupon { 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"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 CreateProductCoupon client = new CreateProductCoupon( 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 CreateProductCouponRequest request = new CreateProductCouponRequest(); 41 request.outRequestNo = "12345_20250101_A3489"; 42 request.scope = ProductCouponScope.ALL; 43 request.type = ProductCouponType.DISCOUNT; 44 request.usageMode = UsageMode.SINGLE; 45 request.singleUsageInfo = new SingleUsageInfo(); 46 request.singleUsageInfo.discountCoupon = new DiscountCouponUsageRule(); 47 request.singleUsageInfo.discountCoupon.threshold = 10000L; 48 request.singleUsageInfo.discountCoupon.percentOff = 20L; 49 request.displayInfo = new ProductCouponDisplayInfo(); 50 request.displayInfo.name = "全场满100立打8折"; 51 request.displayInfo.imageUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"; 52 request.displayInfo.backgroundUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"; 53 request.displayInfo.detailImageUrlList = new ArrayList<>(); 54 { 55 request.displayInfo.detailImageUrlList.add("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"); 56 }; 57 request.outProductNo = "Product_1234567890"; 58 request.stock = new StockForCreate(); 59 request.stock.remark = "8月工作日有效批次"; 60 request.stock.couponCodeMode = CouponCodeMode.UPLOAD; 61 request.stock.stockSendRule = new StockSendRule(); 62 request.stock.stockSendRule.maxCount = 10000000L; 63 request.stock.stockSendRule.maxCountPerUser = 1L; 64 request.stock.singleUsageRule = new SingleUsageRule(); 65 request.stock.singleUsageRule.couponAvailablePeriod = new SingleCouponAvailablePeriod(); 66 request.stock.singleUsageRule.couponAvailablePeriod.availableBeginTime = "2025-08-01T00:00:00+08:00"; 67 request.stock.singleUsageRule.couponAvailablePeriod.availableEndTime = "2025-08-31T23:59:59+08:00"; 68 request.stock.singleUsageRule.couponAvailablePeriod.availableDays = 30L; 69 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod = new FixedWeekPeriod(); 70 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList = new ArrayList<>(); 71 { 72 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.MONDAY); 73 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.TUESDAY); 74 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.WEDNESDAY); 75 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.THURSDAY); 76 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.FRIDAY); 77 }; 78 request.stock.usageRuleDisplayInfo = new UsageRuleDisplayInfo(); 79 request.stock.usageRuleDisplayInfo.couponUsageMethodList = new ArrayList<>(); 80 { 81 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.OFFLINE); 82 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.MINI_PROGRAM); 83 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.PAYMENT_CODE); 84 }; 85 request.stock.usageRuleDisplayInfo.miniProgramAppid = "wx1234567890"; 86 request.stock.usageRuleDisplayInfo.miniProgramPath = "/pages/index/product"; 87 request.stock.usageRuleDisplayInfo.usageDescription = "工作日可用"; 88 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo = new CouponAvailableStoreInfo(); 89 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.description = "所有门店可用,可使用小程序查看门店列表"; 90 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.miniProgramAppid = "wx1234567890"; 91 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.miniProgramPath = "/pages/index/store-list"; 92 request.stock.couponDisplayInfo = new CouponDisplayInfo(); 93 request.stock.couponDisplayInfo.codeDisplayMode = CouponCodeDisplayMode.QRCODE; 94 request.stock.couponDisplayInfo.backgroundColor = "Color010"; 95 request.stock.couponDisplayInfo.entranceMiniProgram = new EntranceMiniProgram(); 96 request.stock.couponDisplayInfo.entranceMiniProgram.appid = "wx1234567890"; 97 request.stock.couponDisplayInfo.entranceMiniProgram.path = "/pages/index/product"; 98 request.stock.couponDisplayInfo.entranceMiniProgram.entranceWording = "欢迎选购"; 99 request.stock.couponDisplayInfo.entranceMiniProgram.guidanceWording = "获取更多优惠"; 100 request.stock.couponDisplayInfo.entranceOfficialAccount = new EntranceOfficialAccount(); 101 request.stock.couponDisplayInfo.entranceOfficialAccount.appid = "wx1234567890"; 102 request.stock.couponDisplayInfo.entranceFinder = new EntranceFinder(); 103 request.stock.couponDisplayInfo.entranceFinder.finderId = "gh_12345678"; 104 request.stock.couponDisplayInfo.entranceFinder.finderVideoId = "UDFsdf24df34dD456Hdf34"; 105 request.stock.couponDisplayInfo.entranceFinder.finderVideoCoverImageUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"; 106 request.stock.notifyConfig = new NotifyConfig(); 107 request.stock.notifyConfig.notifyAppid = "wx4fd12345678"; 108 request.stock.storeScope = StockStoreScope.NONE; 109 request.brandId = "120344"; 110 try { 111 CreateProductCouponResponse response = client.run(request); 112 // TODO: 请求成功,继续业务逻辑 113 System.out.println(response); 114 } catch (WXPayUtility.ApiException e) { 115 // TODO: 请求失败,根据状态码执行不同的逻辑 116 e.printStackTrace(); 117 } 118 } 119 120 public CreateProductCouponResponse run(CreateProductCouponRequest request) { 121 String uri = PATH; 122 String reqBody = WXPayUtility.toJson(request); 123 124 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 125 reqBuilder.addHeader("Accept", "application/json"); 126 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 127 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 128 reqBuilder.addHeader("Content-Type", "application/json"); 129 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 130 reqBuilder.method(METHOD, requestBody); 131 Request httpRequest = reqBuilder.build(); 132 133 // 发送HTTP请求 134 OkHttpClient client = new OkHttpClient.Builder().build(); 135 try (Response httpResponse = client.newCall(httpRequest).execute()) { 136 String respBody = WXPayUtility.extractBody(httpResponse); 137 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 138 // 2XX 成功,验证应答签名 139 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 140 httpResponse.headers(), respBody); 141 142 // 从HTTP应答报文构建返回数据 143 return WXPayUtility.fromJson(respBody, CreateProductCouponResponse.class); 144 } else { 145 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 146 } 147 } catch (IOException e) { 148 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 149 } 150 } 151 152 private final String mchid; 153 private final String certificateSerialNo; 154 private final PrivateKey privateKey; 155 private final String wechatPayPublicKeyId; 156 private final PublicKey wechatPayPublicKey; 157 158 public CreateProductCoupon(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 159 this.mchid = mchid; 160 this.certificateSerialNo = certificateSerialNo; 161 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 162 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 163 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 164 } 165 166 public static class CreateProductCouponRequest { 167 @SerializedName("out_request_no") 168 public String outRequestNo; 169 170 @SerializedName("scope") 171 public ProductCouponScope scope; 172 173 @SerializedName("type") 174 public ProductCouponType type; 175 176 @SerializedName("usage_mode") 177 public UsageMode usageMode; 178 179 @SerializedName("single_usage_info") 180 public SingleUsageInfo singleUsageInfo; 181 182 @SerializedName("sequential_usage_info") 183 public SequentialUsageInfo sequentialUsageInfo; 184 185 @SerializedName("display_info") 186 public ProductCouponDisplayInfo displayInfo; 187 188 @SerializedName("out_product_no") 189 public String outProductNo; 190 191 @SerializedName("stock") 192 public StockForCreate stock; 193 194 @SerializedName("brand_id") 195 public String brandId; 196 } 197 198 public static class CreateProductCouponResponse { 199 @SerializedName("product_coupon_id") 200 public String productCouponId; 201 202 @SerializedName("scope") 203 public ProductCouponScope scope; 204 205 @SerializedName("type") 206 public ProductCouponType type; 207 208 @SerializedName("usage_mode") 209 public UsageMode usageMode; 210 211 @SerializedName("single_usage_info") 212 public SingleUsageInfo singleUsageInfo; 213 214 @SerializedName("sequential_usage_info") 215 public SequentialUsageInfo sequentialUsageInfo; 216 217 @SerializedName("display_info") 218 public ProductCouponDisplayInfo displayInfo; 219 220 @SerializedName("out_product_no") 221 public String outProductNo; 222 223 @SerializedName("state") 224 public ProductCouponState state; 225 226 @SerializedName("stock") 227 public StockEntity stock; 228 229 @SerializedName("brand_id") 230 public String brandId; 231 } 232 233 public enum ProductCouponScope { 234 @SerializedName("ALL") 235 ALL, 236 @SerializedName("SINGLE") 237 SINGLE 238 } 239 240 public enum ProductCouponType { 241 @SerializedName("NORMAL") 242 NORMAL, 243 @SerializedName("DISCOUNT") 244 DISCOUNT, 245 @SerializedName("EXCHANGE") 246 EXCHANGE 247 } 248 249 public enum UsageMode { 250 @SerializedName("SINGLE") 251 SINGLE, 252 @SerializedName("SEQUENTIAL") 253 SEQUENTIAL 254 } 255 256 public static class SingleUsageInfo { 257 @SerializedName("normal_coupon") 258 public NormalCouponUsageRule normalCoupon; 259 260 @SerializedName("discount_coupon") 261 public DiscountCouponUsageRule discountCoupon; 262 } 263 264 public static class SequentialUsageInfo { 265 @SerializedName("type") 266 public SequentialUsageType type; 267 268 @SerializedName("count") 269 public Long count; 270 271 @SerializedName("available_days") 272 public Long availableDays; 273 274 @SerializedName("interval_days") 275 public Long intervalDays; 276 } 277 278 public static class ProductCouponDisplayInfo { 279 @SerializedName("name") 280 public String name; 281 282 @SerializedName("image_url") 283 public String imageUrl; 284 285 @SerializedName("background_url") 286 public String backgroundUrl; 287 288 @SerializedName("detail_image_url_list") 289 public List<String> detailImageUrlList; 290 291 @SerializedName("original_price") 292 public Long originalPrice; 293 294 @SerializedName("combo_package_list") 295 public List<ComboPackage> comboPackageList; 296 } 297 298 public static class StockForCreate { 299 @SerializedName("remark") 300 public String remark; 301 302 @SerializedName("coupon_code_mode") 303 public CouponCodeMode couponCodeMode; 304 305 @SerializedName("stock_send_rule") 306 public StockSendRule stockSendRule; 307 308 @SerializedName("single_usage_rule") 309 public SingleUsageRule singleUsageRule; 310 311 @SerializedName("sequential_usage_rule") 312 public SequentialUsageRule sequentialUsageRule; 313 314 @SerializedName("usage_rule_display_info") 315 public UsageRuleDisplayInfo usageRuleDisplayInfo; 316 317 @SerializedName("coupon_display_info") 318 public CouponDisplayInfo couponDisplayInfo; 319 320 @SerializedName("notify_config") 321 public NotifyConfig notifyConfig; 322 323 @SerializedName("store_scope") 324 public StockStoreScope storeScope; 325 } 326 327 public enum ProductCouponState { 328 @SerializedName("AUDITING") 329 AUDITING, 330 @SerializedName("EFFECTIVE") 331 EFFECTIVE, 332 @SerializedName("DEACTIVATED") 333 DEACTIVATED 334 } 335 336 public static class StockEntity { 337 @SerializedName("product_coupon_id") 338 public String productCouponId; 339 340 @SerializedName("stock_id") 341 public String stockId; 342 343 @SerializedName("remark") 344 public String remark; 345 346 @SerializedName("coupon_code_mode") 347 public CouponCodeMode couponCodeMode; 348 349 @SerializedName("coupon_code_count_info") 350 public CouponCodeCountInfo couponCodeCountInfo; 351 352 @SerializedName("stock_send_rule") 353 public StockSendRule stockSendRule; 354 355 @SerializedName("single_usage_rule") 356 public SingleUsageRule singleUsageRule; 357 358 @SerializedName("sequential_usage_rule") 359 public SequentialUsageRule sequentialUsageRule; 360 361 @SerializedName("usage_rule_display_info") 362 public UsageRuleDisplayInfo usageRuleDisplayInfo; 363 364 @SerializedName("coupon_display_info") 365 public CouponDisplayInfo couponDisplayInfo; 366 367 @SerializedName("notify_config") 368 public NotifyConfig notifyConfig; 369 370 @SerializedName("store_scope") 371 public StockStoreScope storeScope; 372 373 @SerializedName("sent_count_info") 374 public StockSentCountInfo sentCountInfo; 375 376 @SerializedName("state") 377 public StockState state; 378 379 @SerializedName("deactivate_request_no") 380 public String deactivateRequestNo; 381 382 @SerializedName("deactivate_time") 383 public String deactivateTime; 384 385 @SerializedName("deactivate_reason") 386 public String deactivateReason; 387 388 @SerializedName("brand_id") 389 public String brandId; 390 } 391 392 public static class NormalCouponUsageRule { 393 @SerializedName("threshold") 394 public Long threshold; 395 396 @SerializedName("discount_amount") 397 public Long discountAmount; 398 } 399 400 public static class DiscountCouponUsageRule { 401 @SerializedName("threshold") 402 public Long threshold; 403 404 @SerializedName("percent_off") 405 public Long percentOff; 406 } 407 408 public enum SequentialUsageType { 409 @SerializedName("INCREMENTAL") 410 INCREMENTAL, 411 @SerializedName("EQUAL") 412 EQUAL 413 } 414 415 public static class ComboPackage { 416 @SerializedName("name") 417 public String name; 418 419 @SerializedName("pick_count") 420 public Long pickCount; 421 422 @SerializedName("choice_list") 423 public List<ComboPackageChoice> choiceList = new ArrayList<ComboPackageChoice>(); 424 } 425 426 public enum CouponCodeMode { 427 @SerializedName("WECHATPAY") 428 WECHATPAY, 429 @SerializedName("UPLOAD") 430 UPLOAD, 431 @SerializedName("API_ASSIGN") 432 API_ASSIGN 433 } 434 435 public static class StockSendRule { 436 @SerializedName("max_count") 437 public Long maxCount; 438 439 @SerializedName("max_count_per_day") 440 public Long maxCountPerDay; 441 442 @SerializedName("max_count_per_user") 443 public Long maxCountPerUser; 444 } 445 446 public static class SingleUsageRule { 447 @SerializedName("coupon_available_period") 448 public SingleCouponAvailablePeriod couponAvailablePeriod; 449 450 @SerializedName("normal_coupon") 451 public NormalCouponUsageRule normalCoupon; 452 453 @SerializedName("discount_coupon") 454 public DiscountCouponUsageRule discountCoupon; 455 456 @SerializedName("exchange_coupon") 457 public ExchangeCouponUsageRule exchangeCoupon; 458 } 459 460 public static class SequentialUsageRule { 461 @SerializedName("coupon_available_period") 462 public SequentialCouponAvailablePeriod couponAvailablePeriod; 463 464 @SerializedName("normal_coupon_list") 465 public List<NormalCouponUsageRule> normalCouponList; 466 467 @SerializedName("discount_coupon_list") 468 public List<DiscountCouponUsageRule> discountCouponList; 469 470 @SerializedName("exchange_coupon_list") 471 public List<ExchangeCouponUsageRule> exchangeCouponList; 472 473 @SerializedName("special_first") 474 public Boolean specialFirst; 475 } 476 477 public static class UsageRuleDisplayInfo { 478 @SerializedName("coupon_usage_method_list") 479 public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>(); 480 481 @SerializedName("mini_program_appid") 482 public String miniProgramAppid; 483 484 @SerializedName("mini_program_path") 485 public String miniProgramPath; 486 487 @SerializedName("app_path") 488 public String appPath; 489 490 @SerializedName("usage_description") 491 public String usageDescription; 492 493 @SerializedName("coupon_available_store_info") 494 public CouponAvailableStoreInfo couponAvailableStoreInfo; 495 } 496 497 public static class CouponDisplayInfo { 498 @SerializedName("code_display_mode") 499 public CouponCodeDisplayMode codeDisplayMode; 500 501 @SerializedName("background_color") 502 public String backgroundColor; 503 504 @SerializedName("entrance_mini_program") 505 public EntranceMiniProgram entranceMiniProgram; 506 507 @SerializedName("entrance_official_account") 508 public EntranceOfficialAccount entranceOfficialAccount; 509 510 @SerializedName("entrance_finder") 511 public EntranceFinder entranceFinder; 512 } 513 514 public static class NotifyConfig { 515 @SerializedName("notify_appid") 516 public String notifyAppid; 517 } 518 519 public enum StockStoreScope { 520 @SerializedName("NONE") 521 NONE, 522 @SerializedName("ALL") 523 ALL, 524 @SerializedName("SPECIFIC") 525 SPECIFIC 526 } 527 528 public static class CouponCodeCountInfo { 529 @SerializedName("total_count") 530 public Long totalCount; 531 532 @SerializedName("available_count") 533 public Long availableCount; 534 } 535 536 public static class StockSentCountInfo { 537 @SerializedName("total_count") 538 public Long totalCount; 539 540 @SerializedName("today_count") 541 public Long todayCount; 542 } 543 544 public enum StockState { 545 @SerializedName("AUDITING") 546 AUDITING, 547 @SerializedName("SENDING") 548 SENDING, 549 @SerializedName("PAUSED") 550 PAUSED, 551 @SerializedName("STOPPED") 552 STOPPED, 553 @SerializedName("DEACTIVATED") 554 DEACTIVATED 555 } 556 557 public static class ComboPackageChoice { 558 @SerializedName("name") 559 public String name; 560 561 @SerializedName("price") 562 public Long price; 563 564 @SerializedName("count") 565 public Long count; 566 567 @SerializedName("image_url") 568 public String imageUrl; 569 570 @SerializedName("mini_program_appid") 571 public String miniProgramAppid; 572 573 @SerializedName("mini_program_path") 574 public String miniProgramPath; 575 } 576 577 public static class SingleCouponAvailablePeriod { 578 @SerializedName("available_begin_time") 579 public String availableBeginTime; 580 581 @SerializedName("available_end_time") 582 public String availableEndTime; 583 584 @SerializedName("available_days") 585 public Long availableDays; 586 587 @SerializedName("wait_days_after_receive") 588 public Long waitDaysAfterReceive; 589 590 @SerializedName("weekly_available_period") 591 public FixedWeekPeriod weeklyAvailablePeriod; 592 593 @SerializedName("irregular_available_period_list") 594 public List<TimePeriod> irregularAvailablePeriodList; 595 } 596 597 public static class ExchangeCouponUsageRule { 598 @SerializedName("threshold") 599 public Long threshold; 600 601 @SerializedName("exchange_price") 602 public Long exchangePrice; 603 } 604 605 public static class SequentialCouponAvailablePeriod { 606 @SerializedName("available_begin_time") 607 public String availableBeginTime; 608 609 @SerializedName("available_end_time") 610 public String availableEndTime; 611 612 @SerializedName("wait_days_after_receive") 613 public Long waitDaysAfterReceive; 614 615 @SerializedName("weekly_available_period") 616 public FixedWeekPeriod weeklyAvailablePeriod; 617 618 @SerializedName("irregular_available_period_list") 619 public List<TimePeriod> irregularAvailablePeriodList; 620 } 621 622 public enum CouponUsageMethod { 623 @SerializedName("OFFLINE") 624 OFFLINE, 625 @SerializedName("MINI_PROGRAM") 626 MINI_PROGRAM, 627 @SerializedName("APP") 628 APP, 629 @SerializedName("PAYMENT_CODE") 630 PAYMENT_CODE 631 } 632 633 public static class CouponAvailableStoreInfo { 634 @SerializedName("description") 635 public String description; 636 637 @SerializedName("mini_program_appid") 638 public String miniProgramAppid; 639 640 @SerializedName("mini_program_path") 641 public String miniProgramPath; 642 } 643 644 public enum CouponCodeDisplayMode { 645 @SerializedName("INVISIBLE") 646 INVISIBLE, 647 @SerializedName("BARCODE") 648 BARCODE, 649 @SerializedName("QRCODE") 650 QRCODE 651 } 652 653 public static class EntranceMiniProgram { 654 @SerializedName("appid") 655 public String appid; 656 657 @SerializedName("path") 658 public String path; 659 660 @SerializedName("entrance_wording") 661 public String entranceWording; 662 663 @SerializedName("guidance_wording") 664 public String guidanceWording; 665 } 666 667 public static class EntranceOfficialAccount { 668 @SerializedName("appid") 669 public String appid; 670 } 671 672 public static class EntranceFinder { 673 @SerializedName("finder_id") 674 public String finderId; 675 676 @SerializedName("finder_video_id") 677 public String finderVideoId; 678 679 @SerializedName("finder_video_cover_image_url") 680 public String finderVideoCoverImageUrl; 681 } 682 683 public static class FixedWeekPeriod { 684 @SerializedName("day_list") 685 public List<WeekEnum> dayList; 686 687 @SerializedName("day_period_list") 688 public List<PeriodOfTheDay> dayPeriodList; 689 } 690 691 public static class TimePeriod { 692 @SerializedName("begin_time") 693 public String beginTime; 694 695 @SerializedName("end_time") 696 public String endTime; 697 } 698 699 public enum WeekEnum { 700 @SerializedName("MONDAY") 701 MONDAY, 702 @SerializedName("TUESDAY") 703 TUESDAY, 704 @SerializedName("WEDNESDAY") 705 WEDNESDAY, 706 @SerializedName("THURSDAY") 707 THURSDAY, 708 @SerializedName("FRIDAY") 709 FRIDAY, 710 @SerializedName("SATURDAY") 711 SATURDAY, 712 @SerializedName("SUNDAY") 713 SUNDAY 714 } 715 716 public static class PeriodOfTheDay { 717 @SerializedName("begin_time") 718 public Long beginTime; 719 720 @SerializedName("end_time") 721 public Long endTime; 722 } 723 724} 725
需配合微信支付工具库 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 "time" 11) 12 13func main() { 14 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 15 config, err := wxpay_utility.CreateMchConfig( 16 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 17 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 18 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &CreateProductCouponRequest{ 28 OutRequestNo: wxpay_utility.String("12345_20250101_A3489"), 29 Scope: PRODUCTCOUPONSCOPE_ALL.Ptr(), 30 Type: PRODUCTCOUPONTYPE_DISCOUNT.Ptr(), 31 UsageMode: USAGEMODE_SINGLE.Ptr(), 32 SingleUsageInfo: &SingleUsageInfo{ 33 DiscountCoupon: &DiscountCouponUsageRule{ 34 Threshold: wxpay_utility.Int64(10000), 35 PercentOff: wxpay_utility.Int64(20), 36 }, 37 }, 38 DisplayInfo: &ProductCouponDisplayInfo{ 39 Name: wxpay_utility.String("全场满100立打8折"), 40 ImageUrl: wxpay_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"), 41 BackgroundUrl: wxpay_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"), 42 DetailImageUrlList: []string{ 43 "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 44 }, 45 }, 46 OutProductNo: wxpay_utility.String("Product_1234567890"), 47 Stock: &StockForCreate{ 48 Remark: wxpay_utility.String("8月工作日有效批次"), 49 CouponCodeMode: COUPONCODEMODE_UPLOAD.Ptr(), 50 StockSendRule: &StockSendRule{ 51 MaxCount: wxpay_utility.Int64(10000000), 52 MaxCountPerUser: wxpay_utility.Int64(1), 53 }, 54 SingleUsageRule: &SingleUsageRule{ 55 CouponAvailablePeriod: &SingleCouponAvailablePeriod{ 56 AvailableBeginTime: wxpay_utility.String("2025-08-01T00:00:00+08:00"), 57 AvailableEndTime: wxpay_utility.String("2025-08-31T23:59:59+08:00"), 58 AvailableDays: wxpay_utility.Int64(30), 59 WeeklyAvailablePeriod: &FixedWeekPeriod{ 60 DayList: []WeekEnum{ 61 WEEKENUM_MONDAY, 62 WEEKENUM_TUESDAY, 63 WEEKENUM_WEDNESDAY, 64 WEEKENUM_THURSDAY, 65 WEEKENUM_FRIDAY, 66 }, 67 }, 68 }, 69 }, 70 UsageRuleDisplayInfo: &UsageRuleDisplayInfo{ 71 CouponUsageMethodList: []CouponUsageMethod{ 72 COUPONUSAGEMETHOD_OFFLINE, 73 COUPONUSAGEMETHOD_MINI_PROGRAM, 74 COUPONUSAGEMETHOD_PAYMENT_CODE, 75 }, 76 MiniProgramAppid: wxpay_utility.String("wx1234567890"), 77 MiniProgramPath: wxpay_utility.String("/pages/index/product"), 78 UsageDescription: wxpay_utility.String("工作日可用"), 79 CouponAvailableStoreInfo: &CouponAvailableStoreInfo{ 80 Description: wxpay_utility.String("所有门店可用,可使用小程序查看门店列表"), 81 MiniProgramAppid: wxpay_utility.String("wx1234567890"), 82 MiniProgramPath: wxpay_utility.String("/pages/index/store-list"), 83 }, 84 }, 85 CouponDisplayInfo: &CouponDisplayInfo{ 86 CodeDisplayMode: COUPONCODEDISPLAYMODE_QRCODE.Ptr(), 87 BackgroundColor: wxpay_utility.String("Color010"), 88 EntranceMiniProgram: &EntranceMiniProgram{ 89 Appid: wxpay_utility.String("wx1234567890"), 90 Path: wxpay_utility.String("/pages/index/product"), 91 EntranceWording: wxpay_utility.String("欢迎选购"), 92 GuidanceWording: wxpay_utility.String("获取更多优惠"), 93 }, 94 EntranceOfficialAccount: &EntranceOfficialAccount{ 95 Appid: wxpay_utility.String("wx1234567890"), 96 }, 97 EntranceFinder: &EntranceFinder{ 98 FinderId: wxpay_utility.String("gh_12345678"), 99 FinderVideoId: wxpay_utility.String("UDFsdf24df34dD456Hdf34"), 100 FinderVideoCoverImageUrl: wxpay_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"), 101 }, 102 }, 103 NotifyConfig: &NotifyConfig{ 104 NotifyAppid: wxpay_utility.String("wx4fd12345678"), 105 }, 106 StoreScope: STOCKSTORESCOPE_NONE.Ptr(), 107 }, 108 BrandId: wxpay_utility.String("120344"), 109 } 110 111 response, err := CreateProductCoupon(config, request) 112 if err != nil { 113 fmt.Printf("请求失败: %+v\n", err) 114 // TODO: 请求失败,根据状态码执行不同的处理 115 return 116 } 117 118 // TODO: 请求成功,继续业务逻辑 119 fmt.Printf("请求成功: %+v\n", response) 120} 121 122func CreateProductCoupon(config *wxpay_utility.MchConfig, request *CreateProductCouponRequest) (response *CreateProductCouponResponse, err error) { 123 const ( 124 host = "https://api.mch.weixin.qq.com" 125 method = "POST" 126 path = "/v3/marketing/partner/product-coupon/product-coupons" 127 ) 128 129 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 130 if err != nil { 131 return nil, err 132 } 133 reqBody, err := json.Marshal(request) 134 if err != nil { 135 return nil, err 136 } 137 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 138 if err != nil { 139 return nil, err 140 } 141 httpRequest.Header.Set("Accept", "application/json") 142 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 143 httpRequest.Header.Set("Content-Type", "application/json") 144 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 145 if err != nil { 146 return nil, err 147 } 148 httpRequest.Header.Set("Authorization", authorization) 149 150 client := &http.Client{} 151 httpResponse, err := client.Do(httpRequest) 152 if err != nil { 153 return nil, err 154 } 155 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 156 if err != nil { 157 return nil, err 158 } 159 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 160 // 2XX 成功,验证应答签名 161 err = wxpay_utility.ValidateResponse( 162 config.WechatPayPublicKeyId(), 163 config.WechatPayPublicKey(), 164 &httpResponse.Header, 165 respBody, 166 ) 167 if err != nil { 168 return nil, err 169 } 170 response := &CreateProductCouponResponse{} 171 if err := json.Unmarshal(respBody, response); err != nil { 172 return nil, err 173 } 174 175 return response, nil 176 } else { 177 return nil, wxpay_utility.NewApiException( 178 httpResponse.StatusCode, 179 httpResponse.Header, 180 respBody, 181 ) 182 } 183} 184 185type CreateProductCouponRequest struct { 186 OutRequestNo *string `json:"out_request_no,omitempty"` 187 Scope *ProductCouponScope `json:"scope,omitempty"` 188 Type *ProductCouponType `json:"type,omitempty"` 189 UsageMode *UsageMode `json:"usage_mode,omitempty"` 190 SingleUsageInfo *SingleUsageInfo `json:"single_usage_info,omitempty"` 191 SequentialUsageInfo *SequentialUsageInfo `json:"sequential_usage_info,omitempty"` 192 DisplayInfo *ProductCouponDisplayInfo `json:"display_info,omitempty"` 193 OutProductNo *string `json:"out_product_no,omitempty"` 194 Stock *StockForCreate `json:"stock,omitempty"` 195 BrandId *string `json:"brand_id,omitempty"` 196} 197 198type CreateProductCouponResponse struct { 199 ProductCouponId *string `json:"product_coupon_id,omitempty"` 200 Scope *ProductCouponScope `json:"scope,omitempty"` 201 Type *ProductCouponType `json:"type,omitempty"` 202 UsageMode *UsageMode `json:"usage_mode,omitempty"` 203 SingleUsageInfo *SingleUsageInfo `json:"single_usage_info,omitempty"` 204 SequentialUsageInfo *SequentialUsageInfo `json:"sequential_usage_info,omitempty"` 205 DisplayInfo *ProductCouponDisplayInfo `json:"display_info,omitempty"` 206 OutProductNo *string `json:"out_product_no,omitempty"` 207 State *ProductCouponState `json:"state,omitempty"` 208 Stock *StockEntity `json:"stock,omitempty"` 209 BrandId *string `json:"brand_id,omitempty"` 210} 211 212type ProductCouponScope string 213 214func (e ProductCouponScope) Ptr() *ProductCouponScope { 215 return &e 216} 217 218const ( 219 PRODUCTCOUPONSCOPE_ALL ProductCouponScope = "ALL" 220 PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE" 221) 222 223type ProductCouponType string 224 225func (e ProductCouponType) Ptr() *ProductCouponType { 226 return &e 227} 228 229const ( 230 PRODUCTCOUPONTYPE_NORMAL ProductCouponType = "NORMAL" 231 PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT" 232 PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE" 233) 234 235type UsageMode string 236 237func (e UsageMode) Ptr() *UsageMode { 238 return &e 239} 240 241const ( 242 USAGEMODE_SINGLE UsageMode = "SINGLE" 243 USAGEMODE_SEQUENTIAL UsageMode = "SEQUENTIAL" 244) 245 246type SingleUsageInfo struct { 247 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 248 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 249} 250 251type SequentialUsageInfo struct { 252 Type *SequentialUsageType `json:"type,omitempty"` 253 Count *int64 `json:"count,omitempty"` 254 AvailableDays *int64 `json:"available_days,omitempty"` 255 IntervalDays *int64 `json:"interval_days,omitempty"` 256} 257 258type ProductCouponDisplayInfo struct { 259 Name *string `json:"name,omitempty"` 260 ImageUrl *string `json:"image_url,omitempty"` 261 BackgroundUrl *string `json:"background_url,omitempty"` 262 DetailImageUrlList []string `json:"detail_image_url_list,omitempty"` 263 OriginalPrice *int64 `json:"original_price,omitempty"` 264 ComboPackageList []ComboPackage `json:"combo_package_list,omitempty"` 265} 266 267type StockForCreate struct { 268 Remark *string `json:"remark,omitempty"` 269 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 270 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 271 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 272 SequentialUsageRule *SequentialUsageRule `json:"sequential_usage_rule,omitempty"` 273 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 274 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 275 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 276 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 277} 278 279type ProductCouponState string 280 281func (e ProductCouponState) Ptr() *ProductCouponState { 282 return &e 283} 284 285const ( 286 PRODUCTCOUPONSTATE_AUDITING ProductCouponState = "AUDITING" 287 PRODUCTCOUPONSTATE_EFFECTIVE ProductCouponState = "EFFECTIVE" 288 PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED" 289) 290 291type StockEntity struct { 292 ProductCouponId *string `json:"product_coupon_id,omitempty"` 293 StockId *string `json:"stock_id,omitempty"` 294 Remark *string `json:"remark,omitempty"` 295 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 296 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 297 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 298 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 299 SequentialUsageRule *SequentialUsageRule `json:"sequential_usage_rule,omitempty"` 300 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 301 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 302 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 303 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 304 SentCountInfo *StockSentCountInfo `json:"sent_count_info,omitempty"` 305 State *StockState `json:"state,omitempty"` 306 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 307 DeactivateTime *time.Time `json:"deactivate_time,omitempty"` 308 DeactivateReason *string `json:"deactivate_reason,omitempty"` 309 BrandId *string `json:"brand_id,omitempty"` 310} 311 312type NormalCouponUsageRule struct { 313 Threshold *int64 `json:"threshold,omitempty"` 314 DiscountAmount *int64 `json:"discount_amount,omitempty"` 315} 316 317type DiscountCouponUsageRule struct { 318 Threshold *int64 `json:"threshold,omitempty"` 319 PercentOff *int64 `json:"percent_off,omitempty"` 320} 321 322type SequentialUsageType string 323 324func (e SequentialUsageType) Ptr() *SequentialUsageType { 325 return &e 326} 327 328const ( 329 SEQUENTIALUSAGETYPE_INCREMENTAL SequentialUsageType = "INCREMENTAL" 330 SEQUENTIALUSAGETYPE_EQUAL SequentialUsageType = "EQUAL" 331) 332 333type ComboPackage struct { 334 Name *string `json:"name,omitempty"` 335 PickCount *int64 `json:"pick_count,omitempty"` 336 ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"` 337} 338 339type CouponCodeMode string 340 341func (e CouponCodeMode) Ptr() *CouponCodeMode { 342 return &e 343} 344 345const ( 346 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 347 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 348 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 349) 350 351type StockSendRule struct { 352 MaxCount *int64 `json:"max_count,omitempty"` 353 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 354 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 355} 356 357type SingleUsageRule struct { 358 CouponAvailablePeriod *SingleCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 359 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 360 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 361 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 362} 363 364type SequentialUsageRule struct { 365 CouponAvailablePeriod *SequentialCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 366 NormalCouponList []NormalCouponUsageRule `json:"normal_coupon_list,omitempty"` 367 DiscountCouponList []DiscountCouponUsageRule `json:"discount_coupon_list,omitempty"` 368 ExchangeCouponList []ExchangeCouponUsageRule `json:"exchange_coupon_list,omitempty"` 369 SpecialFirst *bool `json:"special_first,omitempty"` 370} 371 372type UsageRuleDisplayInfo struct { 373 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 374 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 375 MiniProgramPath *string `json:"mini_program_path,omitempty"` 376 AppPath *string `json:"app_path,omitempty"` 377 UsageDescription *string `json:"usage_description,omitempty"` 378 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 379} 380 381type CouponDisplayInfo struct { 382 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 383 BackgroundColor *string `json:"background_color,omitempty"` 384 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 385 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 386 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 387} 388 389type NotifyConfig struct { 390 NotifyAppid *string `json:"notify_appid,omitempty"` 391} 392 393type StockStoreScope string 394 395func (e StockStoreScope) Ptr() *StockStoreScope { 396 return &e 397} 398 399const ( 400 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 401 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 402 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 403) 404 405type CouponCodeCountInfo struct { 406 TotalCount *int64 `json:"total_count,omitempty"` 407 AvailableCount *int64 `json:"available_count,omitempty"` 408} 409 410type StockSentCountInfo struct { 411 TotalCount *int64 `json:"total_count,omitempty"` 412 TodayCount *int64 `json:"today_count,omitempty"` 413} 414 415type StockState string 416 417func (e StockState) Ptr() *StockState { 418 return &e 419} 420 421const ( 422 STOCKSTATE_AUDITING StockState = "AUDITING" 423 STOCKSTATE_SENDING StockState = "SENDING" 424 STOCKSTATE_PAUSED StockState = "PAUSED" 425 STOCKSTATE_STOPPED StockState = "STOPPED" 426 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 427) 428 429type ComboPackageChoice struct { 430 Name *string `json:"name,omitempty"` 431 Price *int64 `json:"price,omitempty"` 432 Count *int64 `json:"count,omitempty"` 433 ImageUrl *string `json:"image_url,omitempty"` 434 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 435 MiniProgramPath *string `json:"mini_program_path,omitempty"` 436} 437 438type SingleCouponAvailablePeriod struct { 439 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 440 AvailableEndTime *string `json:"available_end_time,omitempty"` 441 AvailableDays *int64 `json:"available_days,omitempty"` 442 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 443 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 444 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 445} 446 447type ExchangeCouponUsageRule struct { 448 Threshold *int64 `json:"threshold,omitempty"` 449 ExchangePrice *int64 `json:"exchange_price,omitempty"` 450} 451 452type SequentialCouponAvailablePeriod struct { 453 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 454 AvailableEndTime *string `json:"available_end_time,omitempty"` 455 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 456 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 457 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 458} 459 460type CouponUsageMethod string 461 462func (e CouponUsageMethod) Ptr() *CouponUsageMethod { 463 return &e 464} 465 466const ( 467 COUPONUSAGEMETHOD_OFFLINE CouponUsageMethod = "OFFLINE" 468 COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM" 469 COUPONUSAGEMETHOD_APP CouponUsageMethod = "APP" 470 COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE" 471) 472 473type CouponAvailableStoreInfo struct { 474 Description *string `json:"description,omitempty"` 475 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 476 MiniProgramPath *string `json:"mini_program_path,omitempty"` 477} 478 479type CouponCodeDisplayMode string 480 481func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode { 482 return &e 483} 484 485const ( 486 COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE" 487 COUPONCODEDISPLAYMODE_BARCODE CouponCodeDisplayMode = "BARCODE" 488 COUPONCODEDISPLAYMODE_QRCODE CouponCodeDisplayMode = "QRCODE" 489) 490 491type EntranceMiniProgram struct { 492 Appid *string `json:"appid,omitempty"` 493 Path *string `json:"path,omitempty"` 494 EntranceWording *string `json:"entrance_wording,omitempty"` 495 GuidanceWording *string `json:"guidance_wording,omitempty"` 496} 497 498type EntranceOfficialAccount struct { 499 Appid *string `json:"appid,omitempty"` 500} 501 502type EntranceFinder struct { 503 FinderId *string `json:"finder_id,omitempty"` 504 FinderVideoId *string `json:"finder_video_id,omitempty"` 505 FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"` 506} 507 508type FixedWeekPeriod struct { 509 DayList []WeekEnum `json:"day_list,omitempty"` 510 DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"` 511} 512 513type TimePeriod struct { 514 BeginTime *string `json:"begin_time,omitempty"` 515 EndTime *string `json:"end_time,omitempty"` 516} 517 518type WeekEnum string 519 520func (e WeekEnum) Ptr() *WeekEnum { 521 return &e 522} 523 524const ( 525 WEEKENUM_MONDAY WeekEnum = "MONDAY" 526 WEEKENUM_TUESDAY WeekEnum = "TUESDAY" 527 WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY" 528 WEEKENUM_THURSDAY WeekEnum = "THURSDAY" 529 WEEKENUM_FRIDAY WeekEnum = "FRIDAY" 530 WEEKENUM_SATURDAY WeekEnum = "SATURDAY" 531 WEEKENUM_SUNDAY WeekEnum = "SUNDAY" 532) 533 534type PeriodOfTheDay struct { 535 BeginTime *int64 `json:"begin_time,omitempty"` 536 EndTime *int64 `json:"end_time,omitempty"` 537} 538
应答参数
200 OK
product_coupon_id 必填 string(40)
【商品券ID】 商品券的唯一标识,本接口成功时由微信支付生成
scope 必填 string
【优惠范围】 商品券优惠范围
可选取值
ALL
: 全场券,此时券类型type
仅可配置为NORMAL
或DISCOUNT
SINGLE
: 单品券,此时券类型type
配置不受限制,即可配置为NORMAL
、DISCOUNT
或EXCHANGE
type 必填 string
【商品券类型】 商品券的优惠类型
可选取值
NORMAL
: 满减券DISCOUNT
: 折扣券EXCHANGE
: 换购券,仅在scope
为SINGLE
时可配置
usage_mode 必填 string
【使用模式】 商品券使用模式
可选取值
SINGLE
: 单券,即用户只能使用一次,使用后券失效SEQUENTIAL
: 多次优惠,即用户可以按顺序多次使用,每次核销成功后会发放下一次优惠机会,直到用完为止
single_usage_info 选填 object
【单券模式信息】 单券模式配置信息,当且仅当 usage_mode
为 SINGLE
时提供,其他模式不提供。
属性 | |||||||||
normal_coupon 选填 object 【满减券使用规则】 本商品券内所有批次均以此规则提供满减优惠,当且仅当
discount_coupon 选填 object 【折扣券使用规则】 本商品券内所有批次均以此规则提供折扣优惠,当且仅当
|
sequential_usage_info 选填 object
【多次优惠模式信息】 多次优惠模式配置信息,当且仅当 usage_mode
为 SEQUENTIAL
时提供,其他模式不提供。
属性 | |
type 必填 string 【多次优惠规则类型】 多次优惠规则类型 可选取值
count 必填 integer 【可使用次数】 本多次优惠领取后用户可使用次数,最多15次 available_days 必填 integer 【多次优惠有效天数】 用户的多次优惠生效后 N 天内有效,最少3天,最多365天 interval_days 选填 integer 【多次优惠使用间隔天数】 多次优惠多次使用之间需要间隔的天数,最高7天。例如:
默认情况下为 |
display_info 必填 object
【展示信息】 商品券展示信息
属性 | |||||||||
name 必填 string(15) 【商品券名称】 商品券名称,长度不超过15个UTF-8字符 image_url 必填 string 【商品券图片】 商品图片的链接地址,仅支持通过图片上传接口获取的图片URL地址。
background_url 必填 string 【商品券背景图】 商品背景图片的URL地址,仅支持通过图片上传接口获取的图片URL地址。
detail_image_url_list 选填 array[string] 【商品券详情图列表】 商品详情图URL地址列表,用于最多可上传8张图片,仅支持通过图片上传接口获取的图片URL地址。
original_price 选填 integer 【商品原价】 单位为分,当且仅当 combo_package_list 选填 array[object] 【套餐组合】 当
|
out_product_no 选填 string
【外部商品ID】 商户创建商品券时主动传入的外部商品ID,原样返回
state 必填 string
【商品券状态】 商品券状态
可选取值
AUDITING
: 审批中,审批完成前商品券不可用EFFECTIVE
: 生效中,商品券已生效,可以正常使用DEACTIVATED
: 已失效,品牌方主动调用失效接口使商品券失效
stock 必填 object
【批次】 商品券批次信息
属性 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_coupon_id 必填 string(40) 【商品券ID】 商品券的唯一标识,由微信支付生成 stock_id 必填 string(40) 【批次ID】 商品券批次的唯一标识,由微信支付生成 remark 选填 string(20) 【备注】 仅配置品牌可见,用于自定义信息 coupon_code_mode 必填 string 【券Code分配模式】 决定发券时用户商品券Code如何产生 可选取值
coupon_code_count_info 选填 object 【品牌方预上传的券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 【可用门店范围】 控制该批次可以在品牌下哪些门店使用 可选取值
sent_count_info 必填 object 【已发放次数】 本批次已发放次数
state 必填 string 【批次状态】 商品券批次状态 可选取值
deactivate_request_no 选填 string 【失效请求单号】 当且仅当 deactivate_time 选填 string 【失效时间】 当且仅当 deactivate_reason 选填 string 【失效原因】 当且仅当 brand_id 必填 string 【品牌ID】 微信支付为品牌方分配的唯一标识,该品牌应与服务商存在授权关系 |
brand_id 必填 string
【品牌ID】 微信支付为品牌方分配的唯一标识,该品牌应与服务商存在授权关系
应答示例
200 OK
创建满100可用的全场8折券
1{ 2 "product_coupon_id" : "1000000013", 3 "scope" : "ALL", 4 "type" : "DISCOUNT", 5 "usage_mode" : "SINGLE", 6 "single_usage_info" : { 7 "discount_coupon" : { 8 "threshold" : 10000, 9 "percent_off" : 20 10 } 11 }, 12 "display_info" : { 13 "name" : "全场满100立打8折", 14 "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 15 "background_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 16 "detail_image_url_list" : [ 17 "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 18 ] 19 }, 20 "state" : "EFFECTIVE", 21 "out_product_no" : "Product_1234567890", 22 "stock" : { 23 "product_coupon_id" : "1000000013", 24 "stock_id" : "1000000013001", 25 "remark" : "8月工作日有效批次", 26 "coupon_code_mode" : "UPLOAD", 27 "coupon_code_count_info" : { 28 "total_count" : 0, 29 "available_count" : 0 30 }, 31 "stock_send_rule" : { 32 "max_count" : 10000000, 33 "max_count_per_user" : 1 34 }, 35 "single_usage_rule" : { 36 "coupon_available_period" : { 37 "available_begin_time" : "2025-08-01T00:00:00+08:00", 38 "available_end_time" : "2025-08-31T23:59:59+08:00", 39 "available_days" : 30, 40 "weekly_available_period" : { 41 "day_list" : [ 42 "MONDAY", 43 "TUESDAY", 44 "WEDNESDAY", 45 "THURSDAY", 46 "FRIDAY" 47 ] 48 } 49 } 50 }, 51 "usage_rule_display_info" : { 52 "coupon_usage_method_list" : [ 53 "OFFLINE", 54 "MINI_PROGRAM", 55 "PAYMENT_CODE" 56 ], 57 "mini_program_appid" : "wx1234567890", 58 "mini_program_path" : "/pages/index/product", 59 "usage_description" : "工作日可用", 60 "coupon_available_store_info" : { 61 "description" : "所有门店可用,可使用小程序查看门店列表", 62 "mini_program_appid" : "wx1234567890", 63 "mini_program_path" : "/pages/index/store-list" 64 } 65 }, 66 "coupon_display_info" : { 67 "code_display_mode" : "QRCODE", 68 "background_color" : "Color010", 69 "entrance_mini_program" : { 70 "appid" : "wx1234567890", 71 "path" : "/pages/index/product", 72 "entrance_wording" : "欢迎选购", 73 "guidance_wording" : "获取更多优惠" 74 }, 75 "entrance_official_account" : { 76 "appid" : "wx1234567890" 77 }, 78 "entrance_finder" : { 79 "finder_id" : "gh_12345678", 80 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 81 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 82 } 83 }, 84 "notify_config" : { 85 "notify_appid" : "wx4fd12345678" 86 }, 87 "store_scope" : "NONE", 88 "sent_count_info" : { 89 "total_count" : 0, 90 "today_count" : 0 91 }, 92 "state" : "SENDING", 93 "brand_id" : "120344" 94 }, 95 "brand_id" : "120344" 96} 97
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
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 | 缺少业务相关权限 | 请确认已开通商品券权限 |
429 | RATELIMIT_EXCEEDED | 请求超过接口频率限制 | 请稍后使用原参数重试 |