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


