修改商品券批次发放预算
更新时间:2025.08.28品牌方可以通过本接口修改商品券批次的投放预算。
注:本接口每次调用只能调整一个维度的投放预算,如果你需要调整多个维度的预算,请多次调用本接口。
前置条件:
已创建
usage_mode不为PROGRESSIVE_BUNDLE的商品券对应的批次批次未失效或过期
usage_mode为PROGRESSIVE_BUNDLE的批次在批次组内,不可使用本接口,请使用【修改商品券批次组发放预算API】
频率限制:20/s
接口说明
支持商户:【品牌商户】
请求方式:【POST】/brand/marketing/product-coupon/product-coupons/{product_coupon_id}/stocks/{stock_id}/update-budget
请求域名:【主域名】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个字符之间
update_mode 必填 string
【更新模式】 本接口每次只支持更新一种限额,请选择对应的模式,并传入对应的字段。如果你需要调整多个维度的限制,请使用不同的模式多次调用本接口
可选取值
MAX_COUNT: 更新批次发放次数总上限MAX_COUNT_PER_DAY: 更新批次每日发放次数上限
current_max_count 选填 integer
【当前批次发放次数总上限】 当前批次发放次数总上限,调用本接口前,请先通过【查询商品券批次详情API】获取。当且仅当 update_mode 为 MAX_COUNT 时必传,其他模式下不应填写
target_max_count 选填 integer
【目标批次发放次数总上限】 将批次发放次数总上限更新为本值,允许小于当前批次发放次数总上限,但是不得小于当前已发放总次数。当且仅当 update_mode 为 MAX_COUNT 时必传,其他模式下不应填写
current_max_count_per_day 选填 integer
【当前批次每日发放次数上限】 当前批次每日发放次数上限,调用本接口前,请先通过【查询商品券批次详情API】获取。当且仅当 update_mode 为 MAX_COUNT_PER_DAY 时必传,其他模式下不应填写
target_max_count_per_day 选填 integer
【目标批次每日发放次数上限】 将批次每日发放次数上限更新为本值,允许小于当前批次每日发放次数上限。当且仅当 update_mode 为 MAX_COUNT_PER_DAY 时必传,其他模式下不应填写
请求示例
POST
调整批次发放次数总上限
1curl -X POST \ 2 https://api.mch.weixin.qq.com/brand/marketing/product-coupon/product-coupons/1000000013/stocks/1000000013001/update-budget \ 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 "target_max_count" : 200, 9 "update_mode" : "MAX_COUNT", 10 "out_request_no" : "update_budget_34657_20250101_123456", 11 "current_max_count" : 10000000 12 }' 13
需配合微信支付工具库 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 UpdateStockBudget { 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}/update-budget"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 UpdateStockBudget client = new UpdateStockBudget( 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 UpdateStockBudgetRequest request = new UpdateStockBudgetRequest(); 41 request.outRequestNo = "update_budget_34657_20250101_123456"; 42 request.productCouponId = "1000000013"; 43 request.stockId = "1000000013001"; 44 request.updateMode = UpdateBudgetMode.MAX_COUNT; 45 request.currentMaxCount = 10000000L; 46 request.targetMaxCount = 200L; 47 try { 48 StockEntity response = client.run(request); 49 // TODO: 请求成功,继续业务逻辑 50 System.out.println(response); 51 } catch (WXPayBrandUtility.ApiException e) { 52 // TODO: 请求失败,根据状态码执行不同的逻辑 53 e.printStackTrace(); 54 } 55 } 56 57 public StockEntity run(UpdateStockBudgetRequest request) { 58 String uri = PATH; 59 uri = uri.replace("{product_coupon_id}", WXPayBrandUtility.urlEncode(request.productCouponId)); 60 uri = uri.replace("{stock_id}", WXPayBrandUtility.urlEncode(request.stockId)); 61 String reqBody = WXPayBrandUtility.toJson(request); 62 63 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 64 reqBuilder.addHeader("Accept", "application/json"); 65 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 66 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 67 reqBuilder.addHeader("Content-Type", "application/json"); 68 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 69 reqBuilder.method(METHOD, requestBody); 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 = WXPayBrandUtility.extractBody(httpResponse); 76 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 77 // 2XX 成功,验证应答签名 78 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 79 httpResponse.headers(), respBody); 80 81 // 从HTTP应答报文构建返回数据 82 return WXPayBrandUtility.fromJson(respBody, StockEntity.class); 83 } else { 84 throw new WXPayBrandUtility.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 brand_id; 92 private final String certificateSerialNo; 93 private final PrivateKey privateKey; 94 private final String wechatPayPublicKeyId; 95 private final PublicKey wechatPayPublicKey; 96 97 public UpdateStockBudget(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 98 this.brand_id = brand_id; 99 this.certificateSerialNo = certificateSerialNo; 100 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 101 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 102 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 103 } 104 105 public static class UpdateStockBudgetRequest { 106 @SerializedName("out_request_no") 107 public String outRequestNo; 108 109 @SerializedName("product_coupon_id") 110 @Expose(serialize = false) 111 public String productCouponId; 112 113 @SerializedName("stock_id") 114 @Expose(serialize = false) 115 public String stockId; 116 117 @SerializedName("update_mode") 118 public UpdateBudgetMode updateMode; 119 120 @SerializedName("current_max_count") 121 public Long currentMaxCount; 122 123 @SerializedName("target_max_count") 124 public Long targetMaxCount; 125 126 @SerializedName("current_max_count_per_day") 127 public Long currentMaxCountPerDay; 128 129 @SerializedName("target_max_count_per_day") 130 public Long targetMaxCountPerDay; 131 } 132 133 public static class StockEntity { 134 @SerializedName("product_coupon_id") 135 public String productCouponId; 136 137 @SerializedName("stock_id") 138 public String stockId; 139 140 @SerializedName("remark") 141 public String remark; 142 143 @SerializedName("coupon_code_mode") 144 public CouponCodeMode couponCodeMode; 145 146 @SerializedName("coupon_code_count_info") 147 public CouponCodeCountInfo couponCodeCountInfo; 148 149 @SerializedName("stock_send_rule") 150 public StockSendRule stockSendRule; 151 152 @SerializedName("single_usage_rule") 153 public SingleUsageRule singleUsageRule; 154 155 @SerializedName("usage_rule_display_info") 156 public UsageRuleDisplayInfo usageRuleDisplayInfo; 157 158 @SerializedName("coupon_display_info") 159 public CouponDisplayInfo couponDisplayInfo; 160 161 @SerializedName("notify_config") 162 public NotifyConfig notifyConfig; 163 164 @SerializedName("store_scope") 165 public StockStoreScope storeScope; 166 167 @SerializedName("sent_count_info") 168 public StockSentCountInfo sentCountInfo; 169 170 @SerializedName("state") 171 public StockState state; 172 173 @SerializedName("deactivate_request_no") 174 public String deactivateRequestNo; 175 176 @SerializedName("deactivate_time") 177 public String deactivateTime; 178 179 @SerializedName("deactivate_reason") 180 public String deactivateReason; 181 } 182 183 public enum UpdateBudgetMode { 184 @SerializedName("MAX_COUNT") 185 MAX_COUNT, 186 @SerializedName("MAX_COUNT_PER_DAY") 187 MAX_COUNT_PER_DAY 188 } 189 190 public enum CouponCodeMode { 191 @SerializedName("WECHATPAY") 192 WECHATPAY, 193 @SerializedName("UPLOAD") 194 UPLOAD, 195 @SerializedName("API_ASSIGN") 196 API_ASSIGN 197 } 198 199 public static class CouponCodeCountInfo { 200 @SerializedName("total_count") 201 public Long totalCount; 202 203 @SerializedName("available_count") 204 public Long availableCount; 205 } 206 207 public static class StockSendRule { 208 @SerializedName("max_count") 209 public Long maxCount; 210 211 @SerializedName("max_count_per_day") 212 public Long maxCountPerDay; 213 214 @SerializedName("max_count_per_user") 215 public Long maxCountPerUser; 216 } 217 218 public static class SingleUsageRule { 219 @SerializedName("coupon_available_period") 220 public CouponAvailablePeriod couponAvailablePeriod; 221 222 @SerializedName("normal_coupon") 223 public NormalCouponUsageRule normalCoupon; 224 225 @SerializedName("discount_coupon") 226 public DiscountCouponUsageRule discountCoupon; 227 228 @SerializedName("exchange_coupon") 229 public ExchangeCouponUsageRule exchangeCoupon; 230 } 231 232 public static class UsageRuleDisplayInfo { 233 @SerializedName("coupon_usage_method_list") 234 public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>(); 235 236 @SerializedName("mini_program_appid") 237 public String miniProgramAppid; 238 239 @SerializedName("mini_program_path") 240 public String miniProgramPath; 241 242 @SerializedName("app_path") 243 public String appPath; 244 245 @SerializedName("usage_description") 246 public String usageDescription; 247 248 @SerializedName("coupon_available_store_info") 249 public CouponAvailableStoreInfo couponAvailableStoreInfo; 250 } 251 252 public static class CouponDisplayInfo { 253 @SerializedName("code_display_mode") 254 public CouponCodeDisplayMode codeDisplayMode; 255 256 @SerializedName("background_color") 257 public String backgroundColor; 258 259 @SerializedName("entrance_mini_program") 260 public EntranceMiniProgram entranceMiniProgram; 261 262 @SerializedName("entrance_official_account") 263 public EntranceOfficialAccount entranceOfficialAccount; 264 265 @SerializedName("entrance_finder") 266 public EntranceFinder entranceFinder; 267 } 268 269 public static class NotifyConfig { 270 @SerializedName("notify_appid") 271 public String notifyAppid; 272 } 273 274 public enum StockStoreScope { 275 @SerializedName("NONE") 276 NONE, 277 @SerializedName("ALL") 278 ALL, 279 @SerializedName("SPECIFIC") 280 SPECIFIC 281 } 282 283 public static class StockSentCountInfo { 284 @SerializedName("total_count") 285 public Long totalCount; 286 287 @SerializedName("today_count") 288 public Long todayCount; 289 } 290 291 public enum StockState { 292 @SerializedName("AUDITING") 293 AUDITING, 294 @SerializedName("SENDING") 295 SENDING, 296 @SerializedName("PAUSED") 297 PAUSED, 298 @SerializedName("STOPPED") 299 STOPPED, 300 @SerializedName("DEACTIVATED") 301 DEACTIVATED 302 } 303 304 public static class CouponAvailablePeriod { 305 @SerializedName("available_begin_time") 306 public String availableBeginTime; 307 308 @SerializedName("available_end_time") 309 public String availableEndTime; 310 311 @SerializedName("available_days") 312 public Long availableDays; 313 314 @SerializedName("wait_days_after_receive") 315 public Long waitDaysAfterReceive; 316 317 @SerializedName("weekly_available_period") 318 public FixedWeekPeriod weeklyAvailablePeriod; 319 320 @SerializedName("irregular_available_period_list") 321 public List<TimePeriod> irregularAvailablePeriodList; 322 } 323 324 public static class NormalCouponUsageRule { 325 @SerializedName("threshold") 326 public Long threshold; 327 328 @SerializedName("discount_amount") 329 public Long discountAmount; 330 } 331 332 public static class DiscountCouponUsageRule { 333 @SerializedName("threshold") 334 public Long threshold; 335 336 @SerializedName("percent_off") 337 public Long percentOff; 338 } 339 340 public static class ExchangeCouponUsageRule { 341 @SerializedName("threshold") 342 public Long threshold; 343 344 @SerializedName("exchange_price") 345 public Long exchangePrice; 346 } 347 348 public enum CouponUsageMethod { 349 @SerializedName("OFFLINE") 350 OFFLINE, 351 @SerializedName("MINI_PROGRAM") 352 MINI_PROGRAM, 353 @SerializedName("APP") 354 APP, 355 @SerializedName("PAYMENT_CODE") 356 PAYMENT_CODE 357 } 358 359 public static class CouponAvailableStoreInfo { 360 @SerializedName("description") 361 public String description; 362 363 @SerializedName("mini_program_appid") 364 public String miniProgramAppid; 365 366 @SerializedName("mini_program_path") 367 public String miniProgramPath; 368 } 369 370 public enum CouponCodeDisplayMode { 371 @SerializedName("INVISIBLE") 372 INVISIBLE, 373 @SerializedName("BARCODE") 374 BARCODE, 375 @SerializedName("QRCODE") 376 QRCODE 377 } 378 379 public static class EntranceMiniProgram { 380 @SerializedName("appid") 381 public String appid; 382 383 @SerializedName("path") 384 public String path; 385 386 @SerializedName("entrance_wording") 387 public String entranceWording; 388 389 @SerializedName("guidance_wording") 390 public String guidanceWording; 391 } 392 393 public static class EntranceOfficialAccount { 394 @SerializedName("appid") 395 public String appid; 396 } 397 398 public static class EntranceFinder { 399 @SerializedName("finder_id") 400 public String finderId; 401 402 @SerializedName("finder_video_id") 403 public String finderVideoId; 404 405 @SerializedName("finder_video_cover_image_url") 406 public String finderVideoCoverImageUrl; 407 } 408 409 public static class FixedWeekPeriod { 410 @SerializedName("day_list") 411 public List<WeekEnum> dayList; 412 413 @SerializedName("day_period_list") 414 public List<PeriodOfTheDay> dayPeriodList; 415 } 416 417 public static class TimePeriod { 418 @SerializedName("begin_time") 419 public String beginTime; 420 421 @SerializedName("end_time") 422 public String endTime; 423 } 424 425 public enum WeekEnum { 426 @SerializedName("MONDAY") 427 MONDAY, 428 @SerializedName("TUESDAY") 429 TUESDAY, 430 @SerializedName("WEDNESDAY") 431 WEDNESDAY, 432 @SerializedName("THURSDAY") 433 THURSDAY, 434 @SerializedName("FRIDAY") 435 FRIDAY, 436 @SerializedName("SATURDAY") 437 SATURDAY, 438 @SerializedName("SUNDAY") 439 SUNDAY 440 } 441 442 public static class PeriodOfTheDay { 443 @SerializedName("begin_time") 444 public Long beginTime; 445 446 @SerializedName("end_time") 447 public Long endTime; 448 } 449 450} 451
需配合微信支付工具库 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 := &UpdateStockBudgetRequest{ 29 OutRequestNo: wxpay_brand_utility.String("update_budget_34657_20250101_123456"), 30 ProductCouponId: wxpay_brand_utility.String("1000000013"), 31 StockId: wxpay_brand_utility.String("1000000013001"), 32 UpdateMode: UPDATEBUDGETMODE_MAX_COUNT.Ptr(), 33 CurrentMaxCount: wxpay_brand_utility.Int64(10000000), 34 TargetMaxCount: wxpay_brand_utility.Int64(200), 35 } 36 37 response, err := UpdateStockBudget(config, request) 38 if err != nil { 39 fmt.Printf("请求失败: %+v\n", err) 40 // TODO: 请求失败,根据状态码执行不同的处理 41 return 42 } 43 44 // TODO: 请求成功,继续业务逻辑 45 fmt.Printf("请求成功: %+v\n", response) 46} 47 48func UpdateStockBudget(config *wxpay_brand_utility.BrandConfig, request *UpdateStockBudgetRequest) (response *StockEntity, err error) { 49 const ( 50 host = "https://api.mch.weixin.qq.com" 51 method = "POST" 52 path = "/brand/marketing/product-coupon/product-coupons/{product_coupon_id}/stocks/{stock_id}/update-budget" 53 ) 54 55 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 56 if err != nil { 57 return nil, err 58 } 59 reqUrl.Path = strings.Replace(reqUrl.Path, "{product_coupon_id}", url.PathEscape(*request.ProductCouponId), -1) 60 reqUrl.Path = strings.Replace(reqUrl.Path, "{stock_id}", url.PathEscape(*request.StockId), -1) 61 reqBody, err := json.Marshal(request) 62 if err != nil { 63 return nil, err 64 } 65 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 66 if err != nil { 67 return nil, err 68 } 69 httpRequest.Header.Set("Accept", "application/json") 70 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 71 httpRequest.Header.Set("Content-Type", "application/json") 72 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 73 if err != nil { 74 return nil, err 75 } 76 httpRequest.Header.Set("Authorization", authorization) 77 78 client := &http.Client{} 79 httpResponse, err := client.Do(httpRequest) 80 if err != nil { 81 return nil, err 82 } 83 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 84 if err != nil { 85 return nil, err 86 } 87 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 88 // 2XX 成功,验证应答签名 89 err = wxpay_brand_utility.ValidateResponse( 90 config.WechatPayPublicKeyId(), 91 config.WechatPayPublicKey(), 92 &httpResponse.Header, 93 respBody, 94 ) 95 if err != nil { 96 return nil, err 97 } 98 response := &StockEntity{} 99 if err := json.Unmarshal(respBody, response); err != nil { 100 return nil, err 101 } 102 103 return response, nil 104 } else { 105 return nil, wxpay_brand_utility.NewApiException( 106 httpResponse.StatusCode, 107 httpResponse.Header, 108 respBody, 109 ) 110 } 111} 112 113type UpdateStockBudgetRequest struct { 114 OutRequestNo *string `json:"out_request_no,omitempty"` 115 ProductCouponId *string `json:"product_coupon_id,omitempty"` 116 StockId *string `json:"stock_id,omitempty"` 117 UpdateMode *UpdateBudgetMode `json:"update_mode,omitempty"` 118 CurrentMaxCount *int64 `json:"current_max_count,omitempty"` 119 TargetMaxCount *int64 `json:"target_max_count,omitempty"` 120 CurrentMaxCountPerDay *int64 `json:"current_max_count_per_day,omitempty"` 121 TargetMaxCountPerDay *int64 `json:"target_max_count_per_day,omitempty"` 122} 123 124func (o *UpdateStockBudgetRequest) MarshalJSON() ([]byte, error) { 125 type Alias UpdateStockBudgetRequest 126 a := &struct { 127 ProductCouponId *string `json:"product_coupon_id,omitempty"` 128 StockId *string `json:"stock_id,omitempty"` 129 *Alias 130 }{ 131 // 序列化时移除非 Body 字段 132 ProductCouponId: nil, 133 StockId: nil, 134 Alias: (*Alias)(o), 135 } 136 return json.Marshal(a) 137} 138 139type StockEntity struct { 140 ProductCouponId *string `json:"product_coupon_id,omitempty"` 141 StockId *string `json:"stock_id,omitempty"` 142 Remark *string `json:"remark,omitempty"` 143 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 144 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 145 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 146 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 147 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 148 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 149 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 150 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 151 SentCountInfo *StockSentCountInfo `json:"sent_count_info,omitempty"` 152 State *StockState `json:"state,omitempty"` 153 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 154 DeactivateTime *time.Time `json:"deactivate_time,omitempty"` 155 DeactivateReason *string `json:"deactivate_reason,omitempty"` 156} 157 158type UpdateBudgetMode string 159 160func (e UpdateBudgetMode) Ptr() *UpdateBudgetMode { 161 return &e 162} 163 164const ( 165 UPDATEBUDGETMODE_MAX_COUNT UpdateBudgetMode = "MAX_COUNT" 166 UPDATEBUDGETMODE_MAX_COUNT_PER_DAY UpdateBudgetMode = "MAX_COUNT_PER_DAY" 167) 168 169type CouponCodeMode string 170 171func (e CouponCodeMode) Ptr() *CouponCodeMode { 172 return &e 173} 174 175const ( 176 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 177 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 178 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 179) 180 181type CouponCodeCountInfo struct { 182 TotalCount *int64 `json:"total_count,omitempty"` 183 AvailableCount *int64 `json:"available_count,omitempty"` 184} 185 186type StockSendRule struct { 187 MaxCount *int64 `json:"max_count,omitempty"` 188 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 189 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 190} 191 192type SingleUsageRule struct { 193 CouponAvailablePeriod *CouponAvailablePeriod `json:"coupon_available_period,omitempty"` 194 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 195 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 196 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 197} 198 199type UsageRuleDisplayInfo struct { 200 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 201 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 202 MiniProgramPath *string `json:"mini_program_path,omitempty"` 203 AppPath *string `json:"app_path,omitempty"` 204 UsageDescription *string `json:"usage_description,omitempty"` 205 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 206} 207 208type CouponDisplayInfo struct { 209 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 210 BackgroundColor *string `json:"background_color,omitempty"` 211 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 212 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 213 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 214} 215 216type NotifyConfig struct { 217 NotifyAppid *string `json:"notify_appid,omitempty"` 218} 219 220type StockStoreScope string 221 222func (e StockStoreScope) Ptr() *StockStoreScope { 223 return &e 224} 225 226const ( 227 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 228 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 229 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 230) 231 232type StockSentCountInfo struct { 233 TotalCount *int64 `json:"total_count,omitempty"` 234 TodayCount *int64 `json:"today_count,omitempty"` 235} 236 237type StockState string 238 239func (e StockState) Ptr() *StockState { 240 return &e 241} 242 243const ( 244 STOCKSTATE_AUDITING StockState = "AUDITING" 245 STOCKSTATE_SENDING StockState = "SENDING" 246 STOCKSTATE_PAUSED StockState = "PAUSED" 247 STOCKSTATE_STOPPED StockState = "STOPPED" 248 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 249) 250 251type CouponAvailablePeriod struct { 252 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 253 AvailableEndTime *string `json:"available_end_time,omitempty"` 254 AvailableDays *int64 `json:"available_days,omitempty"` 255 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 256 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 257 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 258} 259 260type NormalCouponUsageRule struct { 261 Threshold *int64 `json:"threshold,omitempty"` 262 DiscountAmount *int64 `json:"discount_amount,omitempty"` 263} 264 265type DiscountCouponUsageRule struct { 266 Threshold *int64 `json:"threshold,omitempty"` 267 PercentOff *int64 `json:"percent_off,omitempty"` 268} 269 270type ExchangeCouponUsageRule struct { 271 Threshold *int64 `json:"threshold,omitempty"` 272 ExchangePrice *int64 `json:"exchange_price,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】自行发券时指定,微信支付系统不再进行自动分配。特别注意:这种模式的商品批次只可由品牌方自行发券,无法在摇一摇有优惠等微信支付渠道投放;商品券的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" : 200, 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" : "SENDING" 72} 73
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
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 | 更新「批次每日发放次数上限」时必须同时设置「当前批次每日发放次数上限」和「目标批次每日发放次数上限」 | 请同时设置「当前批次每日发放次数上限」和「目标批次每日发放次数上限」 |
400 | INVALID_REQUEST | 商品券支持APP核销时,必须提供「APP跳转路径」 | 请提供「APP跳转路径」参数 |
400 | INVALID_REQUEST | 更新「批次发放次数总上限」时必须同时设置「当前批次发放次数总上限」和「目标批次发放次数总上限」 | 请设置「当前批次发放次数总上限」和「目标批次发放次数总上限」 |
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 |


