查询商品券指定批次
更新时间:2025.08.04品牌方可以通过该接口查询某个商品券批次的详情。
前置条件:已创建商品券批次
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/marketing/partner/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
path 路径参数
product_coupon_id 必填 string
【商品券ID】 商品券的唯一标识,创建商品券时由微信支付生成
stock_id 必填 string
【批次ID】 商品券批次的唯一标识,商品券批次创建时由微信支付生成(可使用创建商品券或添加商品券批次创建),请确保该批次属于 product_coupon_id 对应的商品券
query 查询参数
brand_id 必填 string
【品牌ID】 微信支付为品牌方分配的唯一标识,该品牌应与服务商存在授权关系
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/marketing/partner/product-coupon/product-coupons/200000001/stocks/123456789?brand_id=120344 \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" 5
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 查询商品券批次详情 24 */ 25public class GetStock { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/marketing/partner/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/v3/partner/4013080340 32 GetStock client = new GetStock( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 GetStockRequest request = new GetStockRequest(); 41 request.productCouponId = "200000001"; 42 request.stockId = "123456789"; 43 request.brandId = "120344"; 44 try { 45 StockEntity response = client.run(request); 46 // TODO: 请求成功,继续业务逻辑 47 System.out.println(response); 48 } catch (WXPayUtility.ApiException e) { 49 // TODO: 请求失败,根据状态码执行不同的逻辑 50 e.printStackTrace(); 51 } 52 } 53 54 public StockEntity run(GetStockRequest request) { 55 String uri = PATH; 56 uri = uri.replace("{product_coupon_id}", WXPayUtility.urlEncode(request.productCouponId)); 57 uri = uri.replace("{stock_id}", WXPayUtility.urlEncode(request.stockId)); 58 Map<String, Object> args = new HashMap<>(); 59 args.put("brand_id", request.brandId); 60 String queryString = WXPayUtility.urlEncode(args); 61 if (!queryString.isEmpty()) { 62 uri = uri + "?" + queryString; 63 } 64 65 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 66 reqBuilder.addHeader("Accept", "application/json"); 67 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 68 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 69 reqBuilder.method(METHOD, null); 70 Request httpRequest = reqBuilder.build(); 71 72 // 发送HTTP请求 73 OkHttpClient client = new OkHttpClient.Builder().build(); 74 try (Response httpResponse = client.newCall(httpRequest).execute()) { 75 String respBody = WXPayUtility.extractBody(httpResponse); 76 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 77 // 2XX 成功,验证应答签名 78 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 79 httpResponse.headers(), respBody); 80 81 // 从HTTP应答报文构建返回数据 82 return WXPayUtility.fromJson(respBody, StockEntity.class); 83 } else { 84 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 85 } 86 } catch (IOException e) { 87 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 88 } 89 } 90 91 private final String mchid; 92 private final String certificateSerialNo; 93 private final PrivateKey privateKey; 94 private final String wechatPayPublicKeyId; 95 private final PublicKey wechatPayPublicKey; 96 97 public GetStock(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 98 this.mchid = mchid; 99 this.certificateSerialNo = certificateSerialNo; 100 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 101 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 102 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 103 } 104 105 public static class GetStockRequest { 106 @SerializedName("product_coupon_id") 107 @Expose(serialize = false) 108 public String productCouponId; 109 110 @SerializedName("stock_id") 111 @Expose(serialize = false) 112 public String stockId; 113 114 @SerializedName("brand_id") 115 @Expose(serialize = false) 116 public String brandId; 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("sequential_usage_rule") 142 public SequentialUsageRule sequentialUsageRule; 143 144 @SerializedName("usage_rule_display_info") 145 public UsageRuleDisplayInfo usageRuleDisplayInfo; 146 147 @SerializedName("coupon_display_info") 148 public CouponDisplayInfo couponDisplayInfo; 149 150 @SerializedName("notify_config") 151 public NotifyConfig notifyConfig; 152 153 @SerializedName("store_scope") 154 public StockStoreScope storeScope; 155 156 @SerializedName("sent_count_info") 157 public StockSentCountInfo sentCountInfo; 158 159 @SerializedName("state") 160 public StockState state; 161 162 @SerializedName("deactivate_request_no") 163 public String deactivateRequestNo; 164 165 @SerializedName("deactivate_time") 166 public String deactivateTime; 167 168 @SerializedName("deactivate_reason") 169 public String deactivateReason; 170 171 @SerializedName("brand_id") 172 public String brandId; 173 } 174 175 public enum CouponCodeMode { 176 @SerializedName("WECHATPAY") 177 WECHATPAY, 178 @SerializedName("UPLOAD") 179 UPLOAD, 180 @SerializedName("API_ASSIGN") 181 API_ASSIGN 182 } 183 184 public static class CouponCodeCountInfo { 185 @SerializedName("total_count") 186 public Long totalCount; 187 188 @SerializedName("available_count") 189 public Long availableCount; 190 } 191 192 public static class StockSendRule { 193 @SerializedName("max_count") 194 public Long maxCount; 195 196 @SerializedName("max_count_per_day") 197 public Long maxCountPerDay; 198 199 @SerializedName("max_count_per_user") 200 public Long maxCountPerUser; 201 } 202 203 public static class SingleUsageRule { 204 @SerializedName("coupon_available_period") 205 public SingleCouponAvailablePeriod couponAvailablePeriod; 206 207 @SerializedName("normal_coupon") 208 public NormalCouponUsageRule normalCoupon; 209 210 @SerializedName("discount_coupon") 211 public DiscountCouponUsageRule discountCoupon; 212 213 @SerializedName("exchange_coupon") 214 public ExchangeCouponUsageRule exchangeCoupon; 215 } 216 217 public static class SequentialUsageRule { 218 @SerializedName("coupon_available_period") 219 public SequentialCouponAvailablePeriod couponAvailablePeriod; 220 221 @SerializedName("normal_coupon_list") 222 public List<NormalCouponUsageRule> normalCouponList; 223 224 @SerializedName("discount_coupon_list") 225 public List<DiscountCouponUsageRule> discountCouponList; 226 227 @SerializedName("exchange_coupon_list") 228 public List<ExchangeCouponUsageRule> exchangeCouponList; 229 230 @SerializedName("special_first") 231 public Boolean specialFirst; 232 } 233 234 public static class UsageRuleDisplayInfo { 235 @SerializedName("coupon_usage_method_list") 236 public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>(); 237 238 @SerializedName("mini_program_appid") 239 public String miniProgramAppid; 240 241 @SerializedName("mini_program_path") 242 public String miniProgramPath; 243 244 @SerializedName("app_path") 245 public String appPath; 246 247 @SerializedName("usage_description") 248 public String usageDescription; 249 250 @SerializedName("coupon_available_store_info") 251 public CouponAvailableStoreInfo couponAvailableStoreInfo; 252 } 253 254 public static class CouponDisplayInfo { 255 @SerializedName("code_display_mode") 256 public CouponCodeDisplayMode codeDisplayMode; 257 258 @SerializedName("background_color") 259 public String backgroundColor; 260 261 @SerializedName("entrance_mini_program") 262 public EntranceMiniProgram entranceMiniProgram; 263 264 @SerializedName("entrance_official_account") 265 public EntranceOfficialAccount entranceOfficialAccount; 266 267 @SerializedName("entrance_finder") 268 public EntranceFinder entranceFinder; 269 } 270 271 public static class NotifyConfig { 272 @SerializedName("notify_appid") 273 public String notifyAppid; 274 } 275 276 public enum StockStoreScope { 277 @SerializedName("NONE") 278 NONE, 279 @SerializedName("ALL") 280 ALL, 281 @SerializedName("SPECIFIC") 282 SPECIFIC 283 } 284 285 public static class StockSentCountInfo { 286 @SerializedName("total_count") 287 public Long totalCount; 288 289 @SerializedName("today_count") 290 public Long todayCount; 291 } 292 293 public enum StockState { 294 @SerializedName("AUDITING") 295 AUDITING, 296 @SerializedName("SENDING") 297 SENDING, 298 @SerializedName("PAUSED") 299 PAUSED, 300 @SerializedName("STOPPED") 301 STOPPED, 302 @SerializedName("DEACTIVATED") 303 DEACTIVATED 304 } 305 306 public static class SingleCouponAvailablePeriod { 307 @SerializedName("available_begin_time") 308 public String availableBeginTime; 309 310 @SerializedName("available_end_time") 311 public String availableEndTime; 312 313 @SerializedName("available_days") 314 public Long availableDays; 315 316 @SerializedName("wait_days_after_receive") 317 public Long waitDaysAfterReceive; 318 319 @SerializedName("weekly_available_period") 320 public FixedWeekPeriod weeklyAvailablePeriod; 321 322 @SerializedName("irregular_available_period_list") 323 public List<TimePeriod> irregularAvailablePeriodList; 324 } 325 326 public static class NormalCouponUsageRule { 327 @SerializedName("threshold") 328 public Long threshold; 329 330 @SerializedName("discount_amount") 331 public Long discountAmount; 332 } 333 334 public static class DiscountCouponUsageRule { 335 @SerializedName("threshold") 336 public Long threshold; 337 338 @SerializedName("percent_off") 339 public Long percentOff; 340 } 341 342 public static class ExchangeCouponUsageRule { 343 @SerializedName("threshold") 344 public Long threshold; 345 346 @SerializedName("exchange_price") 347 public Long exchangePrice; 348 } 349 350 public static class SequentialCouponAvailablePeriod { 351 @SerializedName("available_begin_time") 352 public String availableBeginTime; 353 354 @SerializedName("available_end_time") 355 public String availableEndTime; 356 357 @SerializedName("wait_days_after_receive") 358 public Long waitDaysAfterReceive; 359 360 @SerializedName("weekly_available_period") 361 public FixedWeekPeriod weeklyAvailablePeriod; 362 363 @SerializedName("irregular_available_period_list") 364 public List<TimePeriod> irregularAvailablePeriodList; 365 } 366 367 public enum CouponUsageMethod { 368 @SerializedName("OFFLINE") 369 OFFLINE, 370 @SerializedName("MINI_PROGRAM") 371 MINI_PROGRAM, 372 @SerializedName("APP") 373 APP, 374 @SerializedName("PAYMENT_CODE") 375 PAYMENT_CODE 376 } 377 378 public static class CouponAvailableStoreInfo { 379 @SerializedName("description") 380 public String description; 381 382 @SerializedName("mini_program_appid") 383 public String miniProgramAppid; 384 385 @SerializedName("mini_program_path") 386 public String miniProgramPath; 387 } 388 389 public enum CouponCodeDisplayMode { 390 @SerializedName("INVISIBLE") 391 INVISIBLE, 392 @SerializedName("BARCODE") 393 BARCODE, 394 @SerializedName("QRCODE") 395 QRCODE 396 } 397 398 public static class EntranceMiniProgram { 399 @SerializedName("appid") 400 public String appid; 401 402 @SerializedName("path") 403 public String path; 404 405 @SerializedName("entrance_wording") 406 public String entranceWording; 407 408 @SerializedName("guidance_wording") 409 public String guidanceWording; 410 } 411 412 public static class EntranceOfficialAccount { 413 @SerializedName("appid") 414 public String appid; 415 } 416 417 public static class EntranceFinder { 418 @SerializedName("finder_id") 419 public String finderId; 420 421 @SerializedName("finder_video_id") 422 public String finderVideoId; 423 424 @SerializedName("finder_video_cover_image_url") 425 public String finderVideoCoverImageUrl; 426 } 427 428 public static class FixedWeekPeriod { 429 @SerializedName("day_list") 430 public List<WeekEnum> dayList; 431 432 @SerializedName("day_period_list") 433 public List<PeriodOfTheDay> dayPeriodList; 434 } 435 436 public static class TimePeriod { 437 @SerializedName("begin_time") 438 public String beginTime; 439 440 @SerializedName("end_time") 441 public String endTime; 442 } 443 444 public enum WeekEnum { 445 @SerializedName("MONDAY") 446 MONDAY, 447 @SerializedName("TUESDAY") 448 TUESDAY, 449 @SerializedName("WEDNESDAY") 450 WEDNESDAY, 451 @SerializedName("THURSDAY") 452 THURSDAY, 453 @SerializedName("FRIDAY") 454 FRIDAY, 455 @SerializedName("SATURDAY") 456 SATURDAY, 457 @SerializedName("SUNDAY") 458 SUNDAY 459 } 460 461 public static class PeriodOfTheDay { 462 @SerializedName("begin_time") 463 public Long beginTime; 464 465 @SerializedName("end_time") 466 public Long endTime; 467 } 468 469} 470
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 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/v3/partner/4013080340 15 config, err := wxpay_utility.CreateMchConfig( 16 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 17 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 18 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &GetStockRequest{ 28 ProductCouponId: wxpay_utility.String("200000001"), 29 StockId: wxpay_utility.String("123456789"), 30 BrandId: wxpay_utility.String("120344"), 31 } 32 33 response, err := GetStock(config, request) 34 if err != nil { 35 fmt.Printf("请求失败: %+v\n", err) 36 // TODO: 请求失败,根据状态码执行不同的处理 37 return 38 } 39 40 // TODO: 请求成功,继续业务逻辑 41 fmt.Printf("请求成功: %+v\n", response) 42} 43 44func GetStock(config *wxpay_utility.MchConfig, request *GetStockRequest) (response *StockEntity, err error) { 45 const ( 46 host = "https://api.mch.weixin.qq.com" 47 method = "GET" 48 path = "/v3/marketing/partner/product-coupon/product-coupons/{product_coupon_id}/stocks/{stock_id}" 49 ) 50 51 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 52 if err != nil { 53 return nil, err 54 } 55 reqUrl.Path = strings.Replace(reqUrl.Path, "{product_coupon_id}", url.PathEscape(*request.ProductCouponId), -1) 56 reqUrl.Path = strings.Replace(reqUrl.Path, "{stock_id}", url.PathEscape(*request.StockId), -1) 57 query := reqUrl.Query() 58 if request.BrandId != nil { 59 query.Add("brand_id", *request.BrandId) 60 } 61 reqUrl.RawQuery = query.Encode() 62 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 63 if err != nil { 64 return nil, err 65 } 66 httpRequest.Header.Set("Accept", "application/json") 67 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 68 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 69 if err != nil { 70 return nil, err 71 } 72 httpRequest.Header.Set("Authorization", authorization) 73 74 client := &http.Client{} 75 httpResponse, err := client.Do(httpRequest) 76 if err != nil { 77 return nil, err 78 } 79 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 80 if err != nil { 81 return nil, err 82 } 83 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 84 // 2XX 成功,验证应答签名 85 err = wxpay_utility.ValidateResponse( 86 config.WechatPayPublicKeyId(), 87 config.WechatPayPublicKey(), 88 &httpResponse.Header, 89 respBody, 90 ) 91 if err != nil { 92 return nil, err 93 } 94 response := &StockEntity{} 95 if err := json.Unmarshal(respBody, response); err != nil { 96 return nil, err 97 } 98 99 return response, nil 100 } else { 101 return nil, wxpay_utility.NewApiException( 102 httpResponse.StatusCode, 103 httpResponse.Header, 104 respBody, 105 ) 106 } 107} 108 109type GetStockRequest struct { 110 ProductCouponId *string `json:"product_coupon_id,omitempty"` 111 StockId *string `json:"stock_id,omitempty"` 112 BrandId *string `json:"brand_id,omitempty"` 113} 114 115func (o *GetStockRequest) MarshalJSON() ([]byte, error) { 116 type Alias GetStockRequest 117 a := &struct { 118 ProductCouponId *string `json:"product_coupon_id,omitempty"` 119 StockId *string `json:"stock_id,omitempty"` 120 BrandId *string `json:"brand_id,omitempty"` 121 *Alias 122 }{ 123 // 序列化时移除非 Body 字段 124 ProductCouponId: nil, 125 StockId: nil, 126 BrandId: nil, 127 Alias: (*Alias)(o), 128 } 129 return json.Marshal(a) 130} 131 132type StockEntity struct { 133 ProductCouponId *string `json:"product_coupon_id,omitempty"` 134 StockId *string `json:"stock_id,omitempty"` 135 Remark *string `json:"remark,omitempty"` 136 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 137 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 138 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 139 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 140 SequentialUsageRule *SequentialUsageRule `json:"sequential_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 BrandId *string `json:"brand_id,omitempty"` 151} 152 153type CouponCodeMode string 154 155func (e CouponCodeMode) Ptr() *CouponCodeMode { 156 return &e 157} 158 159const ( 160 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 161 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 162 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 163) 164 165type CouponCodeCountInfo struct { 166 TotalCount *int64 `json:"total_count,omitempty"` 167 AvailableCount *int64 `json:"available_count,omitempty"` 168} 169 170type StockSendRule struct { 171 MaxCount *int64 `json:"max_count,omitempty"` 172 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 173 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 174} 175 176type SingleUsageRule struct { 177 CouponAvailablePeriod *SingleCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 178 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 179 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 180 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 181} 182 183type SequentialUsageRule struct { 184 CouponAvailablePeriod *SequentialCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 185 NormalCouponList []NormalCouponUsageRule `json:"normal_coupon_list,omitempty"` 186 DiscountCouponList []DiscountCouponUsageRule `json:"discount_coupon_list,omitempty"` 187 ExchangeCouponList []ExchangeCouponUsageRule `json:"exchange_coupon_list,omitempty"` 188 SpecialFirst *bool `json:"special_first,omitempty"` 189} 190 191type UsageRuleDisplayInfo struct { 192 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 193 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 194 MiniProgramPath *string `json:"mini_program_path,omitempty"` 195 AppPath *string `json:"app_path,omitempty"` 196 UsageDescription *string `json:"usage_description,omitempty"` 197 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 198} 199 200type CouponDisplayInfo struct { 201 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 202 BackgroundColor *string `json:"background_color,omitempty"` 203 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 204 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 205 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 206} 207 208type NotifyConfig struct { 209 NotifyAppid *string `json:"notify_appid,omitempty"` 210} 211 212type StockStoreScope string 213 214func (e StockStoreScope) Ptr() *StockStoreScope { 215 return &e 216} 217 218const ( 219 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 220 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 221 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 222) 223 224type StockSentCountInfo struct { 225 TotalCount *int64 `json:"total_count,omitempty"` 226 TodayCount *int64 `json:"today_count,omitempty"` 227} 228 229type StockState string 230 231func (e StockState) Ptr() *StockState { 232 return &e 233} 234 235const ( 236 STOCKSTATE_AUDITING StockState = "AUDITING" 237 STOCKSTATE_SENDING StockState = "SENDING" 238 STOCKSTATE_PAUSED StockState = "PAUSED" 239 STOCKSTATE_STOPPED StockState = "STOPPED" 240 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 241) 242 243type SingleCouponAvailablePeriod struct { 244 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 245 AvailableEndTime *string `json:"available_end_time,omitempty"` 246 AvailableDays *int64 `json:"available_days,omitempty"` 247 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 248 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 249 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 250} 251 252type NormalCouponUsageRule struct { 253 Threshold *int64 `json:"threshold,omitempty"` 254 DiscountAmount *int64 `json:"discount_amount,omitempty"` 255} 256 257type DiscountCouponUsageRule struct { 258 Threshold *int64 `json:"threshold,omitempty"` 259 PercentOff *int64 `json:"percent_off,omitempty"` 260} 261 262type ExchangeCouponUsageRule struct { 263 Threshold *int64 `json:"threshold,omitempty"` 264 ExchangePrice *int64 `json:"exchange_price,omitempty"` 265} 266 267type SequentialCouponAvailablePeriod struct { 268 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 269 AvailableEndTime *string `json:"available_end_time,omitempty"` 270 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 271 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 272 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 273} 274 275type CouponUsageMethod string 276 277func (e CouponUsageMethod) Ptr() *CouponUsageMethod { 278 return &e 279} 280 281const ( 282 COUPONUSAGEMETHOD_OFFLINE CouponUsageMethod = "OFFLINE" 283 COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM" 284 COUPONUSAGEMETHOD_APP CouponUsageMethod = "APP" 285 COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE" 286) 287 288type CouponAvailableStoreInfo struct { 289 Description *string `json:"description,omitempty"` 290 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 291 MiniProgramPath *string `json:"mini_program_path,omitempty"` 292} 293 294type CouponCodeDisplayMode string 295 296func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode { 297 return &e 298} 299 300const ( 301 COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE" 302 COUPONCODEDISPLAYMODE_BARCODE CouponCodeDisplayMode = "BARCODE" 303 COUPONCODEDISPLAYMODE_QRCODE CouponCodeDisplayMode = "QRCODE" 304) 305 306type EntranceMiniProgram struct { 307 Appid *string `json:"appid,omitempty"` 308 Path *string `json:"path,omitempty"` 309 EntranceWording *string `json:"entrance_wording,omitempty"` 310 GuidanceWording *string `json:"guidance_wording,omitempty"` 311} 312 313type EntranceOfficialAccount struct { 314 Appid *string `json:"appid,omitempty"` 315} 316 317type EntranceFinder struct { 318 FinderId *string `json:"finder_id,omitempty"` 319 FinderVideoId *string `json:"finder_video_id,omitempty"` 320 FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"` 321} 322 323type FixedWeekPeriod struct { 324 DayList []WeekEnum `json:"day_list,omitempty"` 325 DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"` 326} 327 328type TimePeriod struct { 329 BeginTime *string `json:"begin_time,omitempty"` 330 EndTime *string `json:"end_time,omitempty"` 331} 332 333type WeekEnum string 334 335func (e WeekEnum) Ptr() *WeekEnum { 336 return &e 337} 338 339const ( 340 WEEKENUM_MONDAY WeekEnum = "MONDAY" 341 WEEKENUM_TUESDAY WeekEnum = "TUESDAY" 342 WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY" 343 WEEKENUM_THURSDAY WeekEnum = "THURSDAY" 344 WEEKENUM_FRIDAY WeekEnum = "FRIDAY" 345 WEEKENUM_SATURDAY WeekEnum = "SATURDAY" 346 WEEKENUM_SUNDAY WeekEnum = "SUNDAY" 347) 348 349type PeriodOfTheDay struct { 350 BeginTime *int64 `json:"begin_time,omitempty"` 351 EndTime *int64 `json:"end_time,omitempty"` 352} 353
应答参数
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 时提供,返回品牌方调用失效商品券批次接口时传入的失效原因
brand_id 必填 string
【品牌ID】 微信支付为品牌方分配的唯一标识,该品牌应与服务商存在授权关系
应答示例
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 "brand_id" : "120344" 140} 141
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
403 | NO_AUTH | 缺少业务相关权限 | 请确认已开通商品券权限 |
404 | NOT_FOUND | 未找到 product_coupon_id 对应的商品券 | 请确认 product_coupon_id 存在且属于当前品牌 |
404 | NOT_FOUND | 未找到 stock_id 对应的商品券批次 | 请确认 stock_id 存在且属于当前商品券 |
429 | RATELIMIT_EXCEEDED | 请求超过接口频率限制 | 请稍后使用原参数重试 |

