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

