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


