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


