指定券状态查询用户券列表
更新时间:2025.08.04品牌方可以通过本接口查询已经发放给用户的特定状态的商品券
前置条件:已经给用户发券成功
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/marketing/partner/product-coupon/users/{openid}/coupons
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
openid 必填 string
【用户OpenID】 OpenID信息,用户在AppID下的唯一标识,获取方式参考OpenID
query 查询参数
product_coupon_id 选填 string
【商品券ID】 商品券的唯一标识,创建商品券时由微信支付生成。查询指定商品券下的用户券列表,不传入时查询范围扩大至品牌下的所有商品券
stock_id 选填 string
【批次ID】 商品券批次的唯一标识,商品券批次创建时由微信支付生成(可使用创建商品券或添加商品券批次创建)。查询指定商品券批次下的用户券列表。
appid 必填 string
【公众账号AppID】 请传入与当前调用接口服务商有绑定关系的AppID,支持小程序AppID与公众号AppID
coupon_state 选填 string
【用户券状态】 查询指定状态的用户券
可选取值
CONFIRMING
: 待确认,用户券发放需要品牌方调用确认发放用户商品券接口后才能生效PENDING
: 已发放待生效,用户券已发放成功但尚未到达可用开始时间EFFECTIVE
: 已生效,用户券已成功发放且到达可用开始时间USED
: 已核销,用户券已核销EXPIRED
: 已过期,用户券已超过有效期,不再可用DELETED
: 已删除,用户主动删除该券DEACTIVATED
: 已失效,品牌方主动调用失效用户券接口使用户券失效
page_size 选填 integer
【分页大小】 单次拉取的数据条数上限,不填默认为20,最大值50
page_token 选填 string
【分页Token】 分页查询时,需要传入上一次调用返回的 next_page_token
,首次调用不填
brand_id 必填 string
【品牌ID】 微信支付为品牌方分配的唯一标识,该品牌应与服务商存在授权关系
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/marketing/partner/product-coupon/users/oh-394z-6CGkNoJrsDLTTUKiAnp4/coupons?product_coupon_id=1002323&stock_id=100232301&appid=wx233544546545989&coupon_state=USED&page_size=20&page_token=MTIzMjUK&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 ListUserProductCoupons { 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/users/{openid}/coupons"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 ListUserProductCoupons client = new ListUserProductCoupons( 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 , 37 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 38 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 39 ); 40 41 ListUserProductCouponsRequest request = new ListUserProductCouponsRequest(); 42 request.openid = "oh-394z-6CGkNoJrsDLTTUKiAnp4"; 43 request.productCouponId = "1002323"; 44 request.stockId = "100232301"; 45 request.appid = "wx233544546545989"; 46 request.couponState = UserProductCouponState.USED; 47 request.pageSize = 20L; 48 request.pageToken = "MTIzMjUK"; 49 request.brandId = "120344"; 50 try { 51 ListUserProductCouponsResponse response = client.run(request); 52 // TODO: 请求成功,继续业务逻辑 53 System.out.println(response); 54 } catch (WXPayUtility.ApiException e) { 55 // TODO: 请求失败,根据状态码执行不同的逻辑 56 e.printStackTrace(); 57 } 58 } 59 60 public ListUserProductCouponsResponse run(ListUserProductCouponsRequest request) { 61 String uri = PATH; 62 uri = uri.replace("{openid}", WXPayUtility.urlEncode(request.openid)); 63 Map<String, Object> args = new HashMap<>(); 64 args.put("product_coupon_id", request.productCouponId); 65 args.put("stock_id", request.stockId); 66 args.put("appid", request.appid); 67 args.put("coupon_state", request.couponState); 68 args.put("page_size", request.pageSize); 69 args.put("page_token", request.pageToken); 70 args.put("brand_id", request.brandId); 71 uri = uri + "?" + WXPayUtility.urlEncode(args); 72 73 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 74 reqBuilder.addHeader("Accept", "application/json"); 75 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 76 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 77 reqBuilder.method(METHOD, null); 78 Request httpRequest = reqBuilder.build(); 79 80 // 发送HTTP请求 81 OkHttpClient client = new OkHttpClient.Builder().build(); 82 try (Response httpResponse = client.newCall(httpRequest).execute()) { 83 String respBody = WXPayUtility.extractBody(httpResponse); 84 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 85 // 2XX 成功,验证应答签名 86 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 87 httpResponse.headers(), respBody); 88 89 // 从HTTP应答报文构建返回数据 90 return WXPayUtility.fromJson(respBody, ListUserProductCouponsResponse.class); 91 } else { 92 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 93 } 94 } catch (IOException e) { 95 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 96 } 97 } 98 99 private final String mchid; 100 private final String certificateSerialNo; 101 private final PrivateKey privateKey; 102 private final String wechatPayPublicKeyId; 103 private final PublicKey wechatPayPublicKey; 104 105 public ListUserProductCoupons(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 106 this.mchid = mchid; 107 this.certificateSerialNo = certificateSerialNo; 108 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 109 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 110 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 111 } 112 113 public static class ListUserProductCouponsRequest { 114 @SerializedName("product_coupon_id") 115 @Expose(serialize = false) 116 public String productCouponId; 117 118 @SerializedName("stock_id") 119 @Expose(serialize = false) 120 public String stockId; 121 122 @SerializedName("appid") 123 @Expose(serialize = false) 124 public String appid; 125 126 @SerializedName("openid") 127 @Expose(serialize = false) 128 public String openid; 129 130 @SerializedName("page_size") 131 @Expose(serialize = false) 132 public Long pageSize; 133 134 @SerializedName("page_token") 135 @Expose(serialize = false) 136 public String pageToken; 137 138 @SerializedName("brand_id") 139 @Expose(serialize = false) 140 public String brandId; 141 142 @SerializedName("coupon_state") 143 @Expose(serialize = false) 144 public UserProductCouponState couponState; 145 } 146 147 public static class ListUserProductCouponsResponse { 148 @SerializedName("total_count") 149 public Long totalCount; 150 151 @SerializedName("user_coupon_list") 152 public List<UserProductCouponEntity> userCouponList; 153 154 @SerializedName("next_page_token") 155 public String nextPageToken; 156 } 157 158 public enum UserProductCouponState { 159 @SerializedName("CONFIRMING") 160 CONFIRMING, 161 @SerializedName("PENDING") 162 PENDING, 163 @SerializedName("EFFECTIVE") 164 EFFECTIVE, 165 @SerializedName("USED") 166 USED, 167 @SerializedName("EXPIRED") 168 EXPIRED, 169 @SerializedName("DELETED") 170 DELETED, 171 @SerializedName("DEACTIVATED") 172 DEACTIVATED 173 } 174 175 public static class UserProductCouponEntity { 176 @SerializedName("coupon_code") 177 public String couponCode; 178 179 @SerializedName("coupon_state") 180 public UserProductCouponState couponState; 181 182 @SerializedName("valid_begin_time") 183 public String validBeginTime; 184 185 @SerializedName("valid_end_time") 186 public String validEndTime; 187 188 @SerializedName("receive_time") 189 public String receiveTime; 190 191 @SerializedName("send_request_no") 192 public String sendRequestNo; 193 194 @SerializedName("send_channel") 195 public UserProductCouponSendChannel sendChannel; 196 197 @SerializedName("confirm_request_no") 198 public String confirmRequestNo; 199 200 @SerializedName("confirm_time") 201 public String confirmTime; 202 203 @SerializedName("deactivate_request_no") 204 public String deactivateRequestNo; 205 206 @SerializedName("deactivate_time") 207 public String deactivateTime; 208 209 @SerializedName("deactivate_reason") 210 public String deactivateReason; 211 212 @SerializedName("single_usage_detail") 213 public SingleUsageDetail singleUsageDetail; 214 215 @SerializedName("sequential_usage_detail") 216 public SequentialUsageDetail sequentialUsageDetail; 217 218 @SerializedName("product_coupon") 219 public ProductCouponEntity productCoupon; 220 221 @SerializedName("stock") 222 public StockEntity stock; 223 224 @SerializedName("attach") 225 public String attach; 226 227 @SerializedName("channel_custom_info") 228 public String channelCustomInfo; 229 230 @SerializedName("brand_id") 231 public String brandId; 232 } 233 234 public enum UserProductCouponSendChannel { 235 @SerializedName("API") 236 API, 237 @SerializedName("BRAND_MANAGE") 238 BRAND_MANAGE, 239 @SerializedName("MERCHANT_CARD") 240 MERCHANT_CARD, 241 @SerializedName("MEMBER") 242 MEMBER 243 } 244 245 public static class SingleUsageDetail { 246 @SerializedName("use_request_no") 247 public String useRequestNo; 248 249 @SerializedName("use_time") 250 public String useTime; 251 252 @SerializedName("associated_order_info") 253 public UserProductCouponAssociatedOrderInfo associatedOrderInfo; 254 255 @SerializedName("return_request_no") 256 public String returnRequestNo; 257 258 @SerializedName("return_time") 259 public String returnTime; 260 } 261 262 public static class SequentialUsageDetail { 263 @SerializedName("total_count") 264 public Long totalCount; 265 266 @SerializedName("used_count") 267 public Long usedCount; 268 269 @SerializedName("detail_item_list") 270 public List<SequentialUsageDetailItem> detailItemList; 271 } 272 273 public static class ProductCouponEntity { 274 @SerializedName("product_coupon_id") 275 public String productCouponId; 276 277 @SerializedName("scope") 278 public ProductCouponScope scope; 279 280 @SerializedName("type") 281 public ProductCouponType type; 282 283 @SerializedName("usage_mode") 284 public UsageMode usageMode; 285 286 @SerializedName("single_usage_info") 287 public SingleUsageInfo singleUsageInfo; 288 289 @SerializedName("sequential_usage_info") 290 public SequentialUsageInfo sequentialUsageInfo; 291 292 @SerializedName("display_info") 293 public ProductCouponDisplayInfo displayInfo; 294 295 @SerializedName("out_product_no") 296 public String outProductNo; 297 298 @SerializedName("state") 299 public ProductCouponState state; 300 301 @SerializedName("deactivate_request_no") 302 public String deactivateRequestNo; 303 304 @SerializedName("deactivate_time") 305 public String deactivateTime; 306 307 @SerializedName("deactivate_reason") 308 public String deactivateReason; 309 310 @SerializedName("brand_id") 311 public String brandId; 312 } 313 314 public static class StockEntity { 315 @SerializedName("product_coupon_id") 316 public String productCouponId; 317 318 @SerializedName("stock_id") 319 public String stockId; 320 321 @SerializedName("remark") 322 public String remark; 323 324 @SerializedName("coupon_code_mode") 325 public CouponCodeMode couponCodeMode; 326 327 @SerializedName("coupon_code_count_info") 328 public CouponCodeCountInfo couponCodeCountInfo; 329 330 @SerializedName("stock_send_rule") 331 public StockSendRule stockSendRule; 332 333 @SerializedName("single_usage_rule") 334 public SingleUsageRule singleUsageRule; 335 336 @SerializedName("sequential_usage_rule") 337 public SequentialUsageRule sequentialUsageRule; 338 339 @SerializedName("usage_rule_display_info") 340 public UsageRuleDisplayInfo usageRuleDisplayInfo; 341 342 @SerializedName("coupon_display_info") 343 public CouponDisplayInfo couponDisplayInfo; 344 345 @SerializedName("notify_config") 346 public NotifyConfig notifyConfig; 347 348 @SerializedName("store_scope") 349 public StockStoreScope storeScope; 350 351 @SerializedName("sent_count_info") 352 public StockSentCountInfo sentCountInfo; 353 354 @SerializedName("state") 355 public StockState state; 356 357 @SerializedName("deactivate_request_no") 358 public String deactivateRequestNo; 359 360 @SerializedName("deactivate_time") 361 public String deactivateTime; 362 363 @SerializedName("deactivate_reason") 364 public String deactivateReason; 365 366 @SerializedName("brand_id") 367 public String brandId; 368 } 369 370 public static class UserProductCouponAssociatedOrderInfo { 371 @SerializedName("transaction_id") 372 public String transactionId; 373 374 @SerializedName("out_trade_no") 375 public String outTradeNo; 376 377 @SerializedName("mchid") 378 public String mchid; 379 380 @SerializedName("sub_mchid") 381 public String subMchid; 382 } 383 384 public static class SequentialUsageDetailItem { 385 @SerializedName("detail_state") 386 public UserProductCouponUsageDetailItemState detailState; 387 388 @SerializedName("valid_begin_time") 389 public String validBeginTime; 390 391 @SerializedName("valid_end_time") 392 public String validEndTime; 393 394 @SerializedName("use_request_no") 395 public String useRequestNo; 396 397 @SerializedName("use_time") 398 public String useTime; 399 400 @SerializedName("associated_order_info") 401 public UserProductCouponAssociatedOrderInfo associatedOrderInfo; 402 403 @SerializedName("return_request_no") 404 public String returnRequestNo; 405 406 @SerializedName("return_time") 407 public String returnTime; 408 409 @SerializedName("delete_time") 410 public String deleteTime; 411 } 412 413 public enum ProductCouponScope { 414 @SerializedName("ALL") 415 ALL, 416 @SerializedName("SINGLE") 417 SINGLE 418 } 419 420 public enum ProductCouponType { 421 @SerializedName("NORMAL") 422 NORMAL, 423 @SerializedName("DISCOUNT") 424 DISCOUNT, 425 @SerializedName("EXCHANGE") 426 EXCHANGE 427 } 428 429 public enum UsageMode { 430 @SerializedName("SINGLE") 431 SINGLE, 432 @SerializedName("SEQUENTIAL") 433 SEQUENTIAL 434 } 435 436 public static class SingleUsageInfo { 437 @SerializedName("normal_coupon") 438 public NormalCouponUsageRule normalCoupon; 439 440 @SerializedName("discount_coupon") 441 public DiscountCouponUsageRule discountCoupon; 442 } 443 444 public static class SequentialUsageInfo { 445 @SerializedName("type") 446 public SequentialUsageType type; 447 448 @SerializedName("count") 449 public Long count; 450 451 @SerializedName("available_days") 452 public Long availableDays; 453 454 @SerializedName("interval_days") 455 public Long intervalDays; 456 } 457 458 public static class ProductCouponDisplayInfo { 459 @SerializedName("name") 460 public String name; 461 462 @SerializedName("image_url") 463 public String imageUrl; 464 465 @SerializedName("background_url") 466 public String backgroundUrl; 467 468 @SerializedName("detail_image_url_list") 469 public List<String> detailImageUrlList; 470 471 @SerializedName("original_price") 472 public Long originalPrice; 473 474 @SerializedName("combo_package_list") 475 public List<ComboPackage> comboPackageList; 476 } 477 478 public enum ProductCouponState { 479 @SerializedName("AUDITING") 480 AUDITING, 481 @SerializedName("EFFECTIVE") 482 EFFECTIVE, 483 @SerializedName("DEACTIVATED") 484 DEACTIVATED 485 } 486 487 public enum CouponCodeMode { 488 @SerializedName("WECHATPAY") 489 WECHATPAY, 490 @SerializedName("UPLOAD") 491 UPLOAD, 492 @SerializedName("API_ASSIGN") 493 API_ASSIGN 494 } 495 496 public static class CouponCodeCountInfo { 497 @SerializedName("total_count") 498 public Long totalCount; 499 500 @SerializedName("available_count") 501 public Long availableCount; 502 } 503 504 public static class StockSendRule { 505 @SerializedName("max_count") 506 public Long maxCount; 507 508 @SerializedName("max_count_per_day") 509 public Long maxCountPerDay; 510 511 @SerializedName("max_count_per_user") 512 public Long maxCountPerUser; 513 } 514 515 public static class SingleUsageRule { 516 @SerializedName("coupon_available_period") 517 public SingleCouponAvailablePeriod couponAvailablePeriod; 518 519 @SerializedName("normal_coupon") 520 public NormalCouponUsageRule normalCoupon; 521 522 @SerializedName("discount_coupon") 523 public DiscountCouponUsageRule discountCoupon; 524 525 @SerializedName("exchange_coupon") 526 public ExchangeCouponUsageRule exchangeCoupon; 527 } 528 529 public static class SequentialUsageRule { 530 @SerializedName("coupon_available_period") 531 public SequentialCouponAvailablePeriod couponAvailablePeriod; 532 533 @SerializedName("normal_coupon_list") 534 public List<NormalCouponUsageRule> normalCouponList; 535 536 @SerializedName("discount_coupon_list") 537 public List<DiscountCouponUsageRule> discountCouponList; 538 539 @SerializedName("exchange_coupon_list") 540 public List<ExchangeCouponUsageRule> exchangeCouponList; 541 542 @SerializedName("special_first") 543 public Boolean specialFirst; 544 } 545 546 public static class UsageRuleDisplayInfo { 547 @SerializedName("coupon_usage_method_list") 548 public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>(); 549 550 @SerializedName("mini_program_appid") 551 public String miniProgramAppid; 552 553 @SerializedName("mini_program_path") 554 public String miniProgramPath; 555 556 @SerializedName("app_path") 557 public String appPath; 558 559 @SerializedName("usage_description") 560 public String usageDescription; 561 562 @SerializedName("coupon_available_store_info") 563 public CouponAvailableStoreInfo couponAvailableStoreInfo; 564 } 565 566 public static class CouponDisplayInfo { 567 @SerializedName("code_display_mode") 568 public CouponCodeDisplayMode codeDisplayMode; 569 570 @SerializedName("background_color") 571 public String backgroundColor; 572 573 @SerializedName("entrance_mini_program") 574 public EntranceMiniProgram entranceMiniProgram; 575 576 @SerializedName("entrance_official_account") 577 public EntranceOfficialAccount entranceOfficialAccount; 578 579 @SerializedName("entrance_finder") 580 public EntranceFinder entranceFinder; 581 } 582 583 public static class NotifyConfig { 584 @SerializedName("notify_appid") 585 public String notifyAppid; 586 } 587 588 public enum StockStoreScope { 589 @SerializedName("NONE") 590 NONE, 591 @SerializedName("ALL") 592 ALL, 593 @SerializedName("SPECIFIC") 594 SPECIFIC 595 } 596 597 public static class StockSentCountInfo { 598 @SerializedName("total_count") 599 public Long totalCount; 600 601 @SerializedName("today_count") 602 public Long todayCount; 603 } 604 605 public enum StockState { 606 @SerializedName("AUDITING") 607 AUDITING, 608 @SerializedName("SENDING") 609 SENDING, 610 @SerializedName("PAUSED") 611 PAUSED, 612 @SerializedName("STOPPED") 613 STOPPED, 614 @SerializedName("DEACTIVATED") 615 DEACTIVATED 616 } 617 618 public enum UserProductCouponUsageDetailItemState { 619 @SerializedName("PENDING") 620 PENDING, 621 @SerializedName("EFFECTIVE") 622 EFFECTIVE, 623 @SerializedName("USED") 624 USED, 625 @SerializedName("EXPIRED") 626 EXPIRED, 627 @SerializedName("DELETED") 628 DELETED, 629 @SerializedName("DEACTIVATED") 630 DEACTIVATED 631 } 632 633 public static class NormalCouponUsageRule { 634 @SerializedName("threshold") 635 public Long threshold; 636 637 @SerializedName("discount_amount") 638 public Long discountAmount; 639 } 640 641 public static class DiscountCouponUsageRule { 642 @SerializedName("threshold") 643 public Long threshold; 644 645 @SerializedName("percent_off") 646 public Long percentOff; 647 } 648 649 public enum SequentialUsageType { 650 @SerializedName("INCREMENTAL") 651 INCREMENTAL, 652 @SerializedName("EQUAL") 653 EQUAL 654 } 655 656 public static class ComboPackage { 657 @SerializedName("name") 658 public String name; 659 660 @SerializedName("pick_count") 661 public Long pickCount; 662 663 @SerializedName("choice_list") 664 public List<ComboPackageChoice> choiceList = new ArrayList<ComboPackageChoice>(); 665 } 666 667 public static class SingleCouponAvailablePeriod { 668 @SerializedName("available_begin_time") 669 public String availableBeginTime; 670 671 @SerializedName("available_end_time") 672 public String availableEndTime; 673 674 @SerializedName("available_days") 675 public Long availableDays; 676 677 @SerializedName("wait_days_after_receive") 678 public Long waitDaysAfterReceive; 679 680 @SerializedName("weekly_available_period") 681 public FixedWeekPeriod weeklyAvailablePeriod; 682 683 @SerializedName("irregular_available_period_list") 684 public List<TimePeriod> irregularAvailablePeriodList; 685 } 686 687 public static class ExchangeCouponUsageRule { 688 @SerializedName("threshold") 689 public Long threshold; 690 691 @SerializedName("exchange_price") 692 public Long exchangePrice; 693 } 694 695 public static class SequentialCouponAvailablePeriod { 696 @SerializedName("available_begin_time") 697 public String availableBeginTime; 698 699 @SerializedName("available_end_time") 700 public String availableEndTime; 701 702 @SerializedName("wait_days_after_receive") 703 public Long waitDaysAfterReceive; 704 705 @SerializedName("weekly_available_period") 706 public FixedWeekPeriod weeklyAvailablePeriod; 707 708 @SerializedName("irregular_available_period_list") 709 public List<TimePeriod> irregularAvailablePeriodList; 710 } 711 712 public enum CouponUsageMethod { 713 @SerializedName("OFFLINE") 714 OFFLINE, 715 @SerializedName("MINI_PROGRAM") 716 MINI_PROGRAM, 717 @SerializedName("APP") 718 APP, 719 @SerializedName("PAYMENT_CODE") 720 PAYMENT_CODE 721 } 722 723 public static class CouponAvailableStoreInfo { 724 @SerializedName("description") 725 public String description; 726 727 @SerializedName("mini_program_appid") 728 public String miniProgramAppid; 729 730 @SerializedName("mini_program_path") 731 public String miniProgramPath; 732 } 733 734 public enum CouponCodeDisplayMode { 735 @SerializedName("INVISIBLE") 736 INVISIBLE, 737 @SerializedName("BARCODE") 738 BARCODE, 739 @SerializedName("QRCODE") 740 QRCODE 741 } 742 743 public static class EntranceMiniProgram { 744 @SerializedName("appid") 745 public String appid; 746 747 @SerializedName("path") 748 public String path; 749 750 @SerializedName("entrance_wording") 751 public String entranceWording; 752 753 @SerializedName("guidance_wording") 754 public String guidanceWording; 755 } 756 757 public static class EntranceOfficialAccount { 758 @SerializedName("appid") 759 public String appid; 760 } 761 762 public static class EntranceFinder { 763 @SerializedName("finder_id") 764 public String finderId; 765 766 @SerializedName("finder_video_id") 767 public String finderVideoId; 768 769 @SerializedName("finder_video_cover_image_url") 770 public String finderVideoCoverImageUrl; 771 } 772 773 public static class ComboPackageChoice { 774 @SerializedName("name") 775 public String name; 776 777 @SerializedName("price") 778 public Long price; 779 780 @SerializedName("count") 781 public Long count; 782 783 @SerializedName("image_url") 784 public String imageUrl; 785 786 @SerializedName("mini_program_appid") 787 public String miniProgramAppid; 788 789 @SerializedName("mini_program_path") 790 public String miniProgramPath; 791 } 792 793 public static class FixedWeekPeriod { 794 @SerializedName("day_list") 795 public List<WeekEnum> dayList; 796 797 @SerializedName("day_period_list") 798 public List<PeriodOfTheDay> dayPeriodList; 799 } 800 801 public static class TimePeriod { 802 @SerializedName("begin_time") 803 public String beginTime; 804 805 @SerializedName("end_time") 806 public String endTime; 807 } 808 809 public enum WeekEnum { 810 @SerializedName("MONDAY") 811 MONDAY, 812 @SerializedName("TUESDAY") 813 TUESDAY, 814 @SerializedName("WEDNESDAY") 815 WEDNESDAY, 816 @SerializedName("THURSDAY") 817 THURSDAY, 818 @SerializedName("FRIDAY") 819 FRIDAY, 820 @SerializedName("SATURDAY") 821 SATURDAY, 822 @SerializedName("SUNDAY") 823 SUNDAY 824 } 825 826 public static class PeriodOfTheDay { 827 @SerializedName("begin_time") 828 public Long beginTime; 829 830 @SerializedName("end_time") 831 public Long endTime; 832 } 833 834} 835
需配合微信支付工具库 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 := &ListUserProductCouponsRequest{ 28 ProductCouponId: wxpay_utility.String("1002323"), 29 StockId: wxpay_utility.String("100232301"), 30 Appid: wxpay_utility.String("wx233544546545989"), 31 Openid: wxpay_utility.String("oh-394z-6CGkNoJrsDLTTUKiAnp4"), 32 CouponState: USERPRODUCTCOUPONSTATE_USED.Ptr(), 33 PageSize: wxpay_utility.Int64(20), 34 PageToken: wxpay_utility.String("MTIzMjUK"), 35 BrandId: wxpay_utility.String("120344"), 36 } 37 38 response, err := ListUserProductCoupons(config, request) 39 if err != nil { 40 fmt.Printf("请求失败: %+v\n", err) 41 // TODO: 请求失败,根据状态码执行不同的处理 42 return 43 } 44 45 // TODO: 请求成功,继续业务逻辑 46 fmt.Printf("请求成功: %+v\n", response) 47} 48 49func ListUserProductCoupons(config *wxpay_utility.MchConfig, request *ListUserProductCouponsRequest) (response *ListUserProductCouponsResponse, err error) { 50 const ( 51 host = "https://api.mch.weixin.qq.com" 52 method = "GET" 53 path = "/v3/marketing/partner/product-coupon/users/{openid}/coupons" 54 ) 55 56 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 57 if err != nil { 58 return nil, err 59 } 60 reqUrl.Path = strings.Replace(reqUrl.Path, "{openid}", url.PathEscape(*request.Openid), -1) 61 query := reqUrl.Query() 62 query.Add("product_coupon_id", *request.ProductCouponId) 63 query.Add("stock_id", *request.StockId) 64 query.Add("appid", *request.Appid) 65 query.Add("coupon_state", fmt.Sprintf("%v", *request.CouponState)) 66 query.Add("page_size", fmt.Sprintf("%v", *request.PageSize)) 67 query.Add("page_token", *request.PageToken) 68 query.Add("brand_id", *request.BrandId) 69 reqUrl.RawQuery = query.Encode() 70 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 71 if err != nil { 72 return nil, err 73 } 74 httpRequest.Header.Set("Accept", "application/json") 75 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 76 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 77 if err != nil { 78 return nil, err 79 } 80 httpRequest.Header.Set("Authorization", authorization) 81 82 client := &http.Client{} 83 httpResponse, err := client.Do(httpRequest) 84 if err != nil { 85 return nil, err 86 } 87 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 88 if err != nil { 89 return nil, err 90 } 91 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 92 // 2XX 成功,验证应答签名 93 err = wxpay_utility.ValidateResponse( 94 config.WechatPayPublicKeyId(), 95 config.WechatPayPublicKey(), 96 &httpResponse.Header, 97 respBody, 98 ) 99 if err != nil { 100 return nil, err 101 } 102 response := &ListUserProductCouponsResponse{} 103 if err := json.Unmarshal(respBody, response); err != nil { 104 return nil, err 105 } 106 107 return response, nil 108 } else { 109 return nil, wxpay_utility.NewApiException( 110 httpResponse.StatusCode, 111 httpResponse.Header, 112 respBody, 113 ) 114 } 115} 116 117type ListUserProductCouponsRequest struct { 118 ProductCouponId *string `json:"product_coupon_id,omitempty"` 119 StockId *string `json:"stock_id,omitempty"` 120 Appid *string `json:"appid,omitempty"` 121 Openid *string `json:"openid,omitempty"` 122 PageSize *int64 `json:"page_size,omitempty"` 123 PageToken *string `json:"page_token,omitempty"` 124 BrandId *string `json:"brand_id,omitempty"` 125 CouponState *UserProductCouponState `json:"coupon_state,omitempty"` 126} 127 128func (o *ListUserProductCouponsRequest) MarshalJSON() ([]byte, error) { 129 type Alias ListUserProductCouponsRequest 130 a := &struct { 131 ProductCouponId *string `json:"product_coupon_id,omitempty"` 132 StockId *string `json:"stock_id,omitempty"` 133 Appid *string `json:"appid,omitempty"` 134 Openid *string `json:"openid,omitempty"` 135 PageSize *int64 `json:"page_size,omitempty"` 136 PageToken *string `json:"page_token,omitempty"` 137 BrandId *string `json:"brand_id,omitempty"` 138 CouponState *UserProductCouponState `json:"coupon_state,omitempty"` 139 *Alias 140 }{ 141 // 序列化时移除非 Body 字段 142 ProductCouponId: nil, 143 StockId: nil, 144 Appid: nil, 145 Openid: nil, 146 PageSize: nil, 147 PageToken: nil, 148 BrandId: nil, 149 CouponState: nil, 150 Alias: (*Alias)(o), 151 } 152 return json.Marshal(a) 153} 154 155type ListUserProductCouponsResponse struct { 156 TotalCount *int64 `json:"total_count,omitempty"` 157 UserCouponList []UserProductCouponEntity `json:"user_coupon_list,omitempty"` 158 NextPageToken *string `json:"next_page_token,omitempty"` 159} 160 161type UserProductCouponState string 162 163func (e UserProductCouponState) Ptr() *UserProductCouponState { 164 return &e 165} 166 167const ( 168 USERPRODUCTCOUPONSTATE_CONFIRMING UserProductCouponState = "CONFIRMING" 169 USERPRODUCTCOUPONSTATE_PENDING UserProductCouponState = "PENDING" 170 USERPRODUCTCOUPONSTATE_EFFECTIVE UserProductCouponState = "EFFECTIVE" 171 USERPRODUCTCOUPONSTATE_USED UserProductCouponState = "USED" 172 USERPRODUCTCOUPONSTATE_EXPIRED UserProductCouponState = "EXPIRED" 173 USERPRODUCTCOUPONSTATE_DELETED UserProductCouponState = "DELETED" 174 USERPRODUCTCOUPONSTATE_DEACTIVATED UserProductCouponState = "DEACTIVATED" 175) 176 177type UserProductCouponEntity struct { 178 CouponCode *string `json:"coupon_code,omitempty"` 179 CouponState *UserProductCouponState `json:"coupon_state,omitempty"` 180 ValidBeginTime *time.Time `json:"valid_begin_time,omitempty"` 181 ValidEndTime *time.Time `json:"valid_end_time,omitempty"` 182 ReceiveTime *string `json:"receive_time,omitempty"` 183 SendRequestNo *string `json:"send_request_no,omitempty"` 184 SendChannel *UserProductCouponSendChannel `json:"send_channel,omitempty"` 185 ConfirmRequestNo *string `json:"confirm_request_no,omitempty"` 186 ConfirmTime *time.Time `json:"confirm_time,omitempty"` 187 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 188 DeactivateTime *string `json:"deactivate_time,omitempty"` 189 DeactivateReason *string `json:"deactivate_reason,omitempty"` 190 SingleUsageDetail *SingleUsageDetail `json:"single_usage_detail,omitempty"` 191 SequentialUsageDetail *SequentialUsageDetail `json:"sequential_usage_detail,omitempty"` 192 ProductCoupon *ProductCouponEntity `json:"product_coupon,omitempty"` 193 Stock *StockEntity `json:"stock,omitempty"` 194 Attach *string `json:"attach,omitempty"` 195 ChannelCustomInfo *string `json:"channel_custom_info,omitempty"` 196 BrandId *string `json:"brand_id,omitempty"` 197} 198 199type UserProductCouponSendChannel string 200 201func (e UserProductCouponSendChannel) Ptr() *UserProductCouponSendChannel { 202 return &e 203} 204 205const ( 206 USERPRODUCTCOUPONSENDCHANNEL_API UserProductCouponSendChannel = "API" 207 USERPRODUCTCOUPONSENDCHANNEL_BRAND_MANAGE UserProductCouponSendChannel = "BRAND_MANAGE" 208 USERPRODUCTCOUPONSENDCHANNEL_MERCHANT_CARD UserProductCouponSendChannel = "MERCHANT_CARD" 209 USERPRODUCTCOUPONSENDCHANNEL_MEMBER UserProductCouponSendChannel = "MEMBER" 210) 211 212type SingleUsageDetail struct { 213 UseRequestNo *string `json:"use_request_no,omitempty"` 214 UseTime *time.Time `json:"use_time,omitempty"` 215 AssociatedOrderInfo *UserProductCouponAssociatedOrderInfo `json:"associated_order_info,omitempty"` 216 ReturnRequestNo *string `json:"return_request_no,omitempty"` 217 ReturnTime *time.Time `json:"return_time,omitempty"` 218} 219 220type SequentialUsageDetail struct { 221 TotalCount *int64 `json:"total_count,omitempty"` 222 UsedCount *int64 `json:"used_count,omitempty"` 223 DetailItemList []SequentialUsageDetailItem `json:"detail_item_list,omitempty"` 224} 225 226type ProductCouponEntity struct { 227 ProductCouponId *string `json:"product_coupon_id,omitempty"` 228 Scope *ProductCouponScope `json:"scope,omitempty"` 229 Type *ProductCouponType `json:"type,omitempty"` 230 UsageMode *UsageMode `json:"usage_mode,omitempty"` 231 SingleUsageInfo *SingleUsageInfo `json:"single_usage_info,omitempty"` 232 SequentialUsageInfo *SequentialUsageInfo `json:"sequential_usage_info,omitempty"` 233 DisplayInfo *ProductCouponDisplayInfo `json:"display_info,omitempty"` 234 OutProductNo *string `json:"out_product_no,omitempty"` 235 State *ProductCouponState `json:"state,omitempty"` 236 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 237 DeactivateTime *string `json:"deactivate_time,omitempty"` 238 DeactivateReason *string `json:"deactivate_reason,omitempty"` 239 BrandId *string `json:"brand_id,omitempty"` 240} 241 242type StockEntity struct { 243 ProductCouponId *string `json:"product_coupon_id,omitempty"` 244 StockId *string `json:"stock_id,omitempty"` 245 Remark *string `json:"remark,omitempty"` 246 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 247 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 248 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 249 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 250 SequentialUsageRule *SequentialUsageRule `json:"sequential_usage_rule,omitempty"` 251 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 252 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 253 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 254 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 255 SentCountInfo *StockSentCountInfo `json:"sent_count_info,omitempty"` 256 State *StockState `json:"state,omitempty"` 257 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 258 DeactivateTime *time.Time `json:"deactivate_time,omitempty"` 259 DeactivateReason *string `json:"deactivate_reason,omitempty"` 260 BrandId *string `json:"brand_id,omitempty"` 261} 262 263type UserProductCouponAssociatedOrderInfo struct { 264 TransactionId *string `json:"transaction_id,omitempty"` 265 OutTradeNo *string `json:"out_trade_no,omitempty"` 266 Mchid *string `json:"mchid,omitempty"` 267 SubMchid *string `json:"sub_mchid,omitempty"` 268} 269 270type SequentialUsageDetailItem struct { 271 DetailState *UserProductCouponUsageDetailItemState `json:"detail_state,omitempty"` 272 ValidBeginTime *time.Time `json:"valid_begin_time,omitempty"` 273 ValidEndTime *time.Time `json:"valid_end_time,omitempty"` 274 UseRequestNo *string `json:"use_request_no,omitempty"` 275 UseTime *time.Time `json:"use_time,omitempty"` 276 AssociatedOrderInfo *UserProductCouponAssociatedOrderInfo `json:"associated_order_info,omitempty"` 277 ReturnRequestNo *string `json:"return_request_no,omitempty"` 278 ReturnTime *time.Time `json:"return_time,omitempty"` 279 DeleteTime *time.Time `json:"delete_time,omitempty"` 280} 281 282type ProductCouponScope string 283 284func (e ProductCouponScope) Ptr() *ProductCouponScope { 285 return &e 286} 287 288const ( 289 PRODUCTCOUPONSCOPE_ALL ProductCouponScope = "ALL" 290 PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE" 291) 292 293type ProductCouponType string 294 295func (e ProductCouponType) Ptr() *ProductCouponType { 296 return &e 297} 298 299const ( 300 PRODUCTCOUPONTYPE_NORMAL ProductCouponType = "NORMAL" 301 PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT" 302 PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE" 303) 304 305type UsageMode string 306 307func (e UsageMode) Ptr() *UsageMode { 308 return &e 309} 310 311const ( 312 USAGEMODE_SINGLE UsageMode = "SINGLE" 313 USAGEMODE_SEQUENTIAL UsageMode = "SEQUENTIAL" 314) 315 316type SingleUsageInfo struct { 317 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 318 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 319} 320 321type SequentialUsageInfo struct { 322 Type *SequentialUsageType `json:"type,omitempty"` 323 Count *int64 `json:"count,omitempty"` 324 AvailableDays *int64 `json:"available_days,omitempty"` 325 IntervalDays *int64 `json:"interval_days,omitempty"` 326} 327 328type ProductCouponDisplayInfo struct { 329 Name *string `json:"name,omitempty"` 330 ImageUrl *string `json:"image_url,omitempty"` 331 BackgroundUrl *string `json:"background_url,omitempty"` 332 DetailImageUrlList []string `json:"detail_image_url_list,omitempty"` 333 OriginalPrice *int64 `json:"original_price,omitempty"` 334 ComboPackageList []ComboPackage `json:"combo_package_list,omitempty"` 335} 336 337type ProductCouponState string 338 339func (e ProductCouponState) Ptr() *ProductCouponState { 340 return &e 341} 342 343const ( 344 PRODUCTCOUPONSTATE_AUDITING ProductCouponState = "AUDITING" 345 PRODUCTCOUPONSTATE_EFFECTIVE ProductCouponState = "EFFECTIVE" 346 PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED" 347) 348 349type CouponCodeMode string 350 351func (e CouponCodeMode) Ptr() *CouponCodeMode { 352 return &e 353} 354 355const ( 356 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 357 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 358 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 359) 360 361type CouponCodeCountInfo struct { 362 TotalCount *int64 `json:"total_count,omitempty"` 363 AvailableCount *int64 `json:"available_count,omitempty"` 364} 365 366type StockSendRule struct { 367 MaxCount *int64 `json:"max_count,omitempty"` 368 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 369 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 370} 371 372type SingleUsageRule struct { 373 CouponAvailablePeriod *SingleCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 374 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 375 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 376 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 377} 378 379type SequentialUsageRule struct { 380 CouponAvailablePeriod *SequentialCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 381 NormalCouponList []NormalCouponUsageRule `json:"normal_coupon_list,omitempty"` 382 DiscountCouponList []DiscountCouponUsageRule `json:"discount_coupon_list,omitempty"` 383 ExchangeCouponList []ExchangeCouponUsageRule `json:"exchange_coupon_list,omitempty"` 384 SpecialFirst *bool `json:"special_first,omitempty"` 385} 386 387type UsageRuleDisplayInfo struct { 388 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 389 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 390 MiniProgramPath *string `json:"mini_program_path,omitempty"` 391 AppPath *string `json:"app_path,omitempty"` 392 UsageDescription *string `json:"usage_description,omitempty"` 393 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 394} 395 396type CouponDisplayInfo struct { 397 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 398 BackgroundColor *string `json:"background_color,omitempty"` 399 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 400 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 401 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 402} 403 404type NotifyConfig struct { 405 NotifyAppid *string `json:"notify_appid,omitempty"` 406} 407 408type StockStoreScope string 409 410func (e StockStoreScope) Ptr() *StockStoreScope { 411 return &e 412} 413 414const ( 415 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 416 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 417 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 418) 419 420type StockSentCountInfo struct { 421 TotalCount *int64 `json:"total_count,omitempty"` 422 TodayCount *int64 `json:"today_count,omitempty"` 423} 424 425type StockState string 426 427func (e StockState) Ptr() *StockState { 428 return &e 429} 430 431const ( 432 STOCKSTATE_AUDITING StockState = "AUDITING" 433 STOCKSTATE_SENDING StockState = "SENDING" 434 STOCKSTATE_PAUSED StockState = "PAUSED" 435 STOCKSTATE_STOPPED StockState = "STOPPED" 436 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 437) 438 439type UserProductCouponUsageDetailItemState string 440 441func (e UserProductCouponUsageDetailItemState) Ptr() *UserProductCouponUsageDetailItemState { 442 return &e 443} 444 445const ( 446 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_PENDING UserProductCouponUsageDetailItemState = "PENDING" 447 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_EFFECTIVE UserProductCouponUsageDetailItemState = "EFFECTIVE" 448 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_USED UserProductCouponUsageDetailItemState = "USED" 449 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_EXPIRED UserProductCouponUsageDetailItemState = "EXPIRED" 450 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_DELETED UserProductCouponUsageDetailItemState = "DELETED" 451 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_DEACTIVATED UserProductCouponUsageDetailItemState = "DEACTIVATED" 452) 453 454type NormalCouponUsageRule struct { 455 Threshold *int64 `json:"threshold,omitempty"` 456 DiscountAmount *int64 `json:"discount_amount,omitempty"` 457} 458 459type DiscountCouponUsageRule struct { 460 Threshold *int64 `json:"threshold,omitempty"` 461 PercentOff *int64 `json:"percent_off,omitempty"` 462} 463 464type SequentialUsageType string 465 466func (e SequentialUsageType) Ptr() *SequentialUsageType { 467 return &e 468} 469 470const ( 471 SEQUENTIALUSAGETYPE_INCREMENTAL SequentialUsageType = "INCREMENTAL" 472 SEQUENTIALUSAGETYPE_EQUAL SequentialUsageType = "EQUAL" 473) 474 475type ComboPackage struct { 476 Name *string `json:"name,omitempty"` 477 PickCount *int64 `json:"pick_count,omitempty"` 478 ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"` 479} 480 481type SingleCouponAvailablePeriod struct { 482 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 483 AvailableEndTime *string `json:"available_end_time,omitempty"` 484 AvailableDays *int64 `json:"available_days,omitempty"` 485 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 486 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 487 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 488} 489 490type ExchangeCouponUsageRule struct { 491 Threshold *int64 `json:"threshold,omitempty"` 492 ExchangePrice *int64 `json:"exchange_price,omitempty"` 493} 494 495type SequentialCouponAvailablePeriod struct { 496 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 497 AvailableEndTime *string `json:"available_end_time,omitempty"` 498 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 499 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 500 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 501} 502 503type CouponUsageMethod string 504 505func (e CouponUsageMethod) Ptr() *CouponUsageMethod { 506 return &e 507} 508 509const ( 510 COUPONUSAGEMETHOD_OFFLINE CouponUsageMethod = "OFFLINE" 511 COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM" 512 COUPONUSAGEMETHOD_APP CouponUsageMethod = "APP" 513 COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE" 514) 515 516type CouponAvailableStoreInfo struct { 517 Description *string `json:"description,omitempty"` 518 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 519 MiniProgramPath *string `json:"mini_program_path,omitempty"` 520} 521 522type CouponCodeDisplayMode string 523 524func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode { 525 return &e 526} 527 528const ( 529 COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE" 530 COUPONCODEDISPLAYMODE_BARCODE CouponCodeDisplayMode = "BARCODE" 531 COUPONCODEDISPLAYMODE_QRCODE CouponCodeDisplayMode = "QRCODE" 532) 533 534type EntranceMiniProgram struct { 535 Appid *string `json:"appid,omitempty"` 536 Path *string `json:"path,omitempty"` 537 EntranceWording *string `json:"entrance_wording,omitempty"` 538 GuidanceWording *string `json:"guidance_wording,omitempty"` 539} 540 541type EntranceOfficialAccount struct { 542 Appid *string `json:"appid,omitempty"` 543} 544 545type EntranceFinder struct { 546 FinderId *string `json:"finder_id,omitempty"` 547 FinderVideoId *string `json:"finder_video_id,omitempty"` 548 FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"` 549} 550 551type ComboPackageChoice struct { 552 Name *string `json:"name,omitempty"` 553 Price *int64 `json:"price,omitempty"` 554 Count *int64 `json:"count,omitempty"` 555 ImageUrl *string `json:"image_url,omitempty"` 556 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 557 MiniProgramPath *string `json:"mini_program_path,omitempty"` 558} 559 560type FixedWeekPeriod struct { 561 DayList []WeekEnum `json:"day_list,omitempty"` 562 DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"` 563} 564 565type TimePeriod struct { 566 BeginTime *string `json:"begin_time,omitempty"` 567 EndTime *string `json:"end_time,omitempty"` 568} 569 570type WeekEnum string 571 572func (e WeekEnum) Ptr() *WeekEnum { 573 return &e 574} 575 576const ( 577 WEEKENUM_MONDAY WeekEnum = "MONDAY" 578 WEEKENUM_TUESDAY WeekEnum = "TUESDAY" 579 WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY" 580 WEEKENUM_THURSDAY WeekEnum = "THURSDAY" 581 WEEKENUM_FRIDAY WeekEnum = "FRIDAY" 582 WEEKENUM_SATURDAY WeekEnum = "SATURDAY" 583 WEEKENUM_SUNDAY WeekEnum = "SUNDAY" 584) 585 586type PeriodOfTheDay struct { 587 BeginTime *int64 `json:"begin_time,omitempty"` 588 EndTime *int64 `json:"end_time,omitempty"` 589} 590
应答参数
200 OK
total_count 必填 integer
【总个数】 满足条件的数据总条数,当且仅当 page_token
为空时提供。
user_coupon_list 选填 array[object]
【用户券列表】 指定状态的用户券列表信息
属性 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
coupon_code 必填 string(40) 【用户券Code】 用户券的唯一标识 coupon_state 必填 string 【用户券状态】 可选取值
valid_begin_time 必填 string 【有效期开始时间】 用户券可用开始时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间) valid_end_time 必填 string 【有效期结束时间】 用户券可用结束时间。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间) receive_time 必填 string 【领券时间】 用户领券时间。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间) send_request_no 必填 string 【发券请求单号】 发券时传入的请求流水号 send_channel 必填 string 【发券渠道】 描述用户券是经由什么渠道发送的 可选取值
confirm_request_no 选填 string 【确认请求单号】 品牌方确认发券请求时传入的的请求流水号。当且仅当 品牌方调用确认发放用户商品券接口后提供。 confirm_time 选填 string 【确认发放时间】 品牌方确认发券时间,当且仅当 品牌方调用确认发放用户商品券接口后提供。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间) deactivate_request_no 选填 string 【失效请求单号】 品牌方失效券请求时传入的的请求流水号。当且仅当 deactivate_time 选填 string 【失效时间】 失效时间,当且仅当 deactivate_reason 选填 string 【失效原因】 失效券的原因,当且仅当 single_usage_detail 选填 object 【单券使用详情】 当且仅当
sequential_usage_detail 选填 object 【次卡使用详情】 当且仅当
product_coupon 必填 object 【商品券信息】 该用户券对应的商品券详情
stock 必填 object 【批次信息】 该用户券发券时使用的批次详情
attach 选填 string 【自定义附加信息】 调用发券接口时品牌方使用 注: 发券渠道多样,只有品牌方通过发券接口发放的券才会在查询和回调中携带此字段,其他渠道发放的券 channel_custom_info 选填 string(1000) 【渠道自定义信息】 使用微信支付提供的其他渠道(比如「摇一摇有优惠」)发放商品券时,渠道可能会设置该渠道特定的自定义信息,请根据 brand_id 必填 string 【品牌ID】 微信支付为品牌方分配的唯一标识,该品牌应与服务商存在授权关系 |
next_page_token 选填 string(100)
【下一页Token】 分页查询时,如果还有更多数据,会返回下一页的Token,请在下一次查询时设置在 page_token
中;如果已无更多数据,则不返回此字段。
应答示例
200 OK
1{ 2 "total_count" : 20, 3 "user_coupon_list" : [ 4 { 5 "coupon_code" : "123446565767", 6 "coupon_state" : "USED", 7 "valid_begin_time" : "2025-01-01T00:00+08:00", 8 "valid_end_time" : "2025-01-30T23:59:59+08:00", 9 "receive_time" : "2025-01-01T09:10:00+08:00", 10 "send_request_no" : "MCHSEND202003101234", 11 "send_channel" : "API", 12 "confirm_request_no" : "MCHCONFIRM202003101234", 13 "confirm_time" : "2025-01-20T13:29:35+08:00", 14 "deactivate_request_no" : "1002600620019090123143254436", 15 "deactivate_time" : "2025-01-20T13:29:35+08:00", 16 "deactivate_reason" : "商品已下线", 17 "single_usage_detail" : { 18 "use_request_no" : "MCHUSE202003101234", 19 "use_time" : "2025-07-20T13:29:35+08:00", 20 "associated_order_info" : { 21 "transaction_id" : "4200000000123456789123456789", 22 "out_trade_no" : "trade_no_20250724123456", 23 "mchid" : "1234567890", 24 "sub_mchid" : "1234567890" 25 }, 26 "return_request_no" : "MCHRETURN202003101234", 27 "return_time" : "2025-07-20T14:29:35+08:00" 28 }, 29 "sequential_usage_detail" : { 30 "total_count" : 10, 31 "used_count" : 3, 32 "detail_item_list" : [ 33 { 34 "detail_state" : "USED", 35 "valid_begin_time" : "2025-07-24T00:00+08:00", 36 "valid_end_time" : "2025-07-30T23:59:59+08:00", 37 "use_request_no" : "MCHUSE202003101234", 38 "use_time" : "2025-07-20T13:29:35+08:00", 39 "associated_order_info" : { 40 "transaction_id" : "4200000000123456789123456789", 41 "out_trade_no" : "trade_no_20250724123456", 42 "mchid" : "1234567890", 43 "sub_mchid" : "1234567890" 44 }, 45 "return_request_no" : "MCHRETURN202003101234", 46 "return_time" : "2025-07-20T14:29:35+08:00", 47 "delete_time" : "2025-07-20T14:29:35+08:00" 48 } 49 ] 50 }, 51 "product_coupon" : { 52 "product_coupon_id" : "1002323", 53 "scope" : "ALL", 54 "type" : "NORMAL", 55 "usage_mode" : "SEQUENTIAL", 56 "single_usage_info" : { 57 "normal_coupon" : { 58 "threshold" : 10000, 59 "discount_amount" : 100 60 }, 61 "discount_coupon" : { 62 "threshold" : 10000, 63 "percent_off" : 30 64 } 65 }, 66 "sequential_usage_info" : { 67 "type" : "EQUAL", 68 "count" : 10, 69 "available_days" : 10, 70 "interval_days" : 1 71 }, 72 "display_info" : { 73 "name" : "全场满100可减10元", 74 "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 75 "background_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 76 "detail_image_url_list" : [ 77 "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 78 ], 79 "original_price" : 10000, 80 "combo_package_list" : [ 81 { 82 "name" : "咖啡2选1", 83 "pick_count" : 3, 84 "choice_list" : [ 85 { 86 "name" : "美式", 87 "price" : 10000, 88 "count" : 2, 89 "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 90 "mini_program_appid" : "wx4fd12345678", 91 "mini_program_path" : "/pages/index/index" 92 } 93 ] 94 } 95 ] 96 }, 97 "out_product_no" : "example_out_product_no", 98 "state" : "AUDITING", 99 "deactivate_request_no" : "1002600620019090123143254436", 100 "deactivate_time" : "2025-06-20T13:29:35+08:00", 101 "deactivate_reason" : "商品已下架", 102 "brand_id" : "120344" 103 }, 104 "stock" : { 105 "product_coupon_id" : "200000001", 106 "stock_id" : "123456789", 107 "remark" : "满减券", 108 "coupon_code_mode" : "UPLOAD", 109 "coupon_code_count_info" : { 110 "total_count" : 10000, 111 "available_count" : 999 112 }, 113 "stock_send_rule" : { 114 "max_count" : 10000000, 115 "max_count_per_day" : 10000, 116 "max_count_per_user" : 1 117 }, 118 "single_usage_rule" : { 119 "coupon_available_period" : { 120 "available_begin_time" : "2025-01-01T00:00:00+08:00", 121 "available_end_time" : "2025-10-01T00:00:00+08:00", 122 "available_days" : 10, 123 "wait_days_after_receive" : 1, 124 "weekly_available_period" : { 125 "day_list" : [ 126 "MONDAY" 127 ], 128 "day_period_list" : [ 129 { 130 "begin_time" : 60, 131 "end_time" : 86399 132 } 133 ] 134 }, 135 "irregular_available_period_list" : [ 136 { 137 "begin_time" : "2025-01-01T00:00:00+08:00", 138 "end_time" : "2025-10-01T00:00:00+08:00" 139 } 140 ] 141 }, 142 "normal_coupon" : { 143 "threshold" : 10000, 144 "discount_amount" : 100 145 }, 146 "discount_coupon" : { 147 "threshold" : 10000, 148 "percent_off" : 30 149 }, 150 "exchange_coupon" : { 151 "threshold" : 10000, 152 "exchange_price" : 100 153 } 154 }, 155 "sequential_usage_rule" : { 156 "coupon_available_period" : { 157 "available_begin_time" : "2025-01-01T00:00:00+08:00", 158 "available_end_time" : "2025-10-01T00:00:00+08:00", 159 "wait_days_after_receive" : 1, 160 "weekly_available_period" : { 161 "day_list" : [ 162 "MONDAY" 163 ], 164 "day_period_list" : [ 165 { 166 "begin_time" : 60, 167 "end_time" : 86399 168 } 169 ] 170 }, 171 "irregular_available_period_list" : [ 172 { 173 "begin_time" : "2025-01-01T00:00:00+08:00", 174 "end_time" : "2025-10-01T00:00:00+08:00" 175 } 176 ] 177 }, 178 "normal_coupon_list" : [ 179 { 180 "threshold" : 10000, 181 "discount_amount" : 100 182 } 183 ], 184 "discount_coupon_list" : [ 185 { 186 "threshold" : 10000, 187 "percent_off" : 30 188 } 189 ], 190 "exchange_coupon_list" : [ 191 { 192 "threshold" : 10000, 193 "exchange_price" : 100 194 } 195 ], 196 "special_first" : false 197 }, 198 "usage_rule_display_info" : { 199 "coupon_usage_method_list" : [ 200 "MINI_PROGRAM" 201 ], 202 "mini_program_appid" : "wx1234567890", 203 "mini_program_path" : "/pages/index/product", 204 "app_path" : "https://www.example.com/jump-to-app", 205 "usage_description" : "全场可用", 206 "coupon_available_store_info" : { 207 "description" : "可在上海市区的所有门店使用,详细列表参考小程序内信息为准", 208 "mini_program_appid" : "wx1234567890", 209 "mini_program_path" : "/pages/index/store-list" 210 } 211 }, 212 "coupon_display_info" : { 213 "code_display_mode" : "QRCODE", 214 "background_color" : "Color010", 215 "entrance_mini_program" : { 216 "appid" : "wx1234567890", 217 "path" : "/pages/index/product", 218 "entrance_wording" : "欢迎选购", 219 "guidance_wording" : "获取更多优惠" 220 }, 221 "entrance_official_account" : { 222 "appid" : "wx1234567890" 223 }, 224 "entrance_finder" : { 225 "finder_id" : "gh_12345678", 226 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 227 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 228 } 229 }, 230 "notify_config" : { 231 "notify_appid" : "wx4fd12345678" 232 }, 233 "store_scope" : "SPECIFIC", 234 "sent_count_info" : { 235 "total_count" : 100, 236 "today_count" : 10 237 }, 238 "state" : "SENDING", 239 "deactivate_request_no" : "1002600620019090123143254436", 240 "deactivate_time" : "2025-01-01T00:00+08:00", 241 "deactivate_reason" : "批次信息有误,重新创建", 242 "brand_id" : "120344" 243 }, 244 "attach" : "example_attach", 245 "channel_custom_info" : "example_channel_custom_info", 246 "brand_id" : "120344" 247 } 248 ], 249 "next_page_token" : "MTIzNDUK" 250} 251
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 传入参数不符合业务规则 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
403 | NO_AUTH | 缺少业务相关权限 | 请确认已开通商品券权限 |
404 | NOT_FOUND | 未找到 product_coupon_id 对应的商品券 | 请确认 product_coupon_id 存在且属于当前品牌 |
404 | NOT_FOUND | 未找到 stock_id 对应的商品券批次 | 请确认 stock_id 存在且属于当前商品券 |
429 | RATELIMIT_EXCEEDED | 请求超过接口频率限制 | 请稍后使用原参数重试 |