指定券状态查询用户商品券列表

1curl -X GET \
2  https://api.mch.weixin.qq.com/brand/marketing/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 \
3  -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: PUB_KEY_ID_XXXX"  
6

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 ListUserProductCoupons {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/brand/marketing/product-coupon/users/{openid}/coupons";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
32    ListUserProductCoupons client = new ListUserProductCoupons(
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    ListUserProductCouponsRequest request = new ListUserProductCouponsRequest();
41    request.openid = "oh-394z-6CGkNoJrsDLTTUKiAnp4";
42    request.productCouponId = "1002323";
43    request.stockId = "100232301";
44    request.appid = "wx233544546545989";
45    request.couponState = UserProductCouponState.USED;
46    request.pageSize = 20L;
47    request.pageToken = "MTIzMjUK";
48    try {
49      ListUserProductCouponsResponse response = client.run(request);
50        // TODO: 请求成功，继续业务逻辑
51        System.out.println(response);
52    } catch (WXPayBrandUtility.ApiException e) {
53        // TODO: 请求失败，根据状态码执行不同的逻辑
54        e.printStackTrace();
55    }
56  }
57
58  public ListUserProductCouponsResponse run(ListUserProductCouponsRequest request) {
59    String uri = PATH;
60    uri = uri.replace("{openid}", WXPayBrandUtility.urlEncode(request.openid));
61    Map<String, Object> args = new HashMap<>();
62    args.put("product_coupon_id", request.productCouponId);
63    args.put("stock_id", request.stockId);
64    args.put("appid", request.appid);
65    args.put("coupon_state", request.couponState);
66    args.put("page_size", request.pageSize);
67    args.put("page_token", request.pageToken);
68    String queryString = WXPayBrandUtility.urlEncode(args);
69    if (!queryString.isEmpty()) {
70        uri = uri + "?" + queryString;
71    }
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", WXPayBrandUtility.buildAuthorization(brand_id, 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 = WXPayBrandUtility.extractBody(httpResponse);
84      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
85        // 2XX 成功，验证应答签名
86        WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
87            httpResponse.headers(), respBody);
88
89        // 从HTTP应答报文构建返回数据
90        return WXPayBrandUtility.fromJson(respBody, ListUserProductCouponsResponse.class);
91      } else {
92        throw new WXPayBrandUtility.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 brand_id;
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 brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
106    this.brand_id = brand_id;
107    this.certificateSerialNo = certificateSerialNo;
108    this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath);
109    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
110    this.wechatPayPublicKey = WXPayBrandUtility.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("coupon_state")
139    @Expose(serialize = false)
140    public UserProductCouponState couponState;
141  }
142  
143  public static class ListUserProductCouponsResponse {
144    @SerializedName("total_count")
145    public Long totalCount;
146  
147    @SerializedName("user_coupon_list")
148    public List<UserProductCouponEntity> userCouponList;
149  
150    @SerializedName("next_page_token")
151    public String nextPageToken;
152  }
153  
154  public enum UserProductCouponState {
155    @SerializedName("CONFIRMING")
156    CONFIRMING,
157    @SerializedName("PENDING")
158    PENDING,
159    @SerializedName("EFFECTIVE")
160    EFFECTIVE,
161    @SerializedName("USED")
162    USED,
163    @SerializedName("EXPIRED")
164    EXPIRED,
165    @SerializedName("DELETED")
166    DELETED,
167    @SerializedName("DEACTIVATED")
168    DEACTIVATED
169  }
170  
171  public static class UserProductCouponEntity {
172    @SerializedName("coupon_code")
173    public String couponCode;
174  
175    @SerializedName("coupon_state")
176    public UserProductCouponState couponState;
177  
178    @SerializedName("valid_begin_time")
179    public String validBeginTime;
180  
181    @SerializedName("valid_end_time")
182    public String validEndTime;
183  
184    @SerializedName("receive_time")
185    public String receiveTime;
186  
187    @SerializedName("send_request_no")
188    public String sendRequestNo;
189  
190    @SerializedName("send_channel")
191    public UserProductCouponSendChannel sendChannel;
192  
193    @SerializedName("confirm_request_no")
194    public String confirmRequestNo;
195  
196    @SerializedName("confirm_time")
197    public String confirmTime;
198  
199    @SerializedName("deactivate_request_no")
200    public String deactivateRequestNo;
201  
202    @SerializedName("deactivate_time")
203    public String deactivateTime;
204  
205    @SerializedName("deactivate_reason")
206    public String deactivateReason;
207  
208    @SerializedName("single_usage_detail")
209    public SingleUsageDetail singleUsageDetail;
210  
211    @SerializedName("sequential_usage_detail")
212    public SequentialUsageDetail sequentialUsageDetail;
213  
214    @SerializedName("product_coupon")
215    public ProductCouponEntity productCoupon;
216  
217    @SerializedName("stock")
218    public StockEntity stock;
219  
220    @SerializedName("attach")
221    public String attach;
222  
223    @SerializedName("channel_custom_info")
224    public String channelCustomInfo;
225  
226    @SerializedName("coupon_tag_info")
227    public CouponTagInfo couponTagInfo;
228  }
229  
230  public enum UserProductCouponSendChannel {
231    @SerializedName("BRAND_MANAGE")
232    BRAND_MANAGE,
233    @SerializedName("API")
234    API,
235    @SerializedName("RECEIVE_COMPONENT")
236    RECEIVE_COMPONENT
237  }
238  
239  public static class SingleUsageDetail {
240    @SerializedName("use_request_no")
241    public String useRequestNo;
242  
243    @SerializedName("use_time")
244    public String useTime;
245  
246    @SerializedName("associated_order_info")
247    public UserProductCouponAssociatedOrderInfo associatedOrderInfo;
248  
249    @SerializedName("return_request_no")
250    public String returnRequestNo;
251  
252    @SerializedName("return_time")
253    public String returnTime;
254  }
255  
256  public static class SequentialUsageDetail {
257    @SerializedName("total_count")
258    public Long totalCount;
259  
260    @SerializedName("used_count")
261    public Long usedCount;
262  
263    @SerializedName("detail_item_list")
264    public List<SequentialUsageDetailItem> detailItemList;
265  }
266  
267  public static class ProductCouponEntity {
268    @SerializedName("product_coupon_id")
269    public String productCouponId;
270  
271    @SerializedName("scope")
272    public ProductCouponScope scope;
273  
274    @SerializedName("type")
275    public ProductCouponType type;
276  
277    @SerializedName("usage_mode")
278    public UsageMode usageMode;
279  
280    @SerializedName("single_usage_info")
281    public SingleUsageInfo singleUsageInfo;
282  
283    @SerializedName("sequential_usage_info")
284    public SequentialUsageInfo sequentialUsageInfo;
285  
286    @SerializedName("display_info")
287    public ProductCouponDisplayInfo displayInfo;
288  
289    @SerializedName("out_product_no")
290    public String outProductNo;
291  
292    @SerializedName("state")
293    public ProductCouponState state;
294  
295    @SerializedName("deactivate_request_no")
296    public String deactivateRequestNo;
297  
298    @SerializedName("deactivate_time")
299    public String deactivateTime;
300  
301    @SerializedName("deactivate_reason")
302    public String deactivateReason;
303  }
304  
305  public static class StockEntity {
306    @SerializedName("product_coupon_id")
307    public String productCouponId;
308  
309    @SerializedName("stock_id")
310    public String stockId;
311  
312    @SerializedName("remark")
313    public String remark;
314  
315    @SerializedName("coupon_code_mode")
316    public CouponCodeMode couponCodeMode;
317  
318    @SerializedName("coupon_code_count_info")
319    public CouponCodeCountInfo couponCodeCountInfo;
320  
321    @SerializedName("stock_send_rule")
322    public StockSendRule stockSendRule;
323  
324    @SerializedName("single_usage_rule")
325    public SingleUsageRule singleUsageRule;
326  
327    @SerializedName("sequential_usage_rule")
328    public SequentialUsageRule sequentialUsageRule;
329  
330    @SerializedName("usage_rule_display_info")
331    public UsageRuleDisplayInfo usageRuleDisplayInfo;
332  
333    @SerializedName("coupon_display_info")
334    public CouponDisplayInfo couponDisplayInfo;
335  
336    @SerializedName("notify_config")
337    public NotifyConfig notifyConfig;
338  
339    @SerializedName("store_scope")
340    public StockStoreScope storeScope;
341  
342    @SerializedName("sent_count_info")
343    public StockSentCountInfo sentCountInfo;
344  
345    @SerializedName("state")
346    public StockState state;
347  
348    @SerializedName("deactivate_request_no")
349    public String deactivateRequestNo;
350  
351    @SerializedName("deactivate_time")
352    public String deactivateTime;
353  
354    @SerializedName("deactivate_reason")
355    public String deactivateReason;
356  }
357  
358  public static class CouponTagInfo {
359    @SerializedName("coupon_tag_list")
360    public List<UserProductCouponTag> couponTagList;
361  
362    @SerializedName("member_tag_info")
363    public MemberTagInfo memberTagInfo;
364  }
365  
366  public static class UserProductCouponAssociatedOrderInfo {
367    @SerializedName("transaction_id")
368    public String transactionId;
369  
370    @SerializedName("out_trade_no")
371    public String outTradeNo;
372  
373    @SerializedName("mchid")
374    public String mchid;
375  
376    @SerializedName("sub_mchid")
377    public String subMchid;
378  }
379  
380  public static class SequentialUsageDetailItem {
381    @SerializedName("detail_state")
382    public UserProductCouponUsageDetailItemState detailState;
383  
384    @SerializedName("valid_begin_time")
385    public String validBeginTime;
386  
387    @SerializedName("valid_end_time")
388    public String validEndTime;
389  
390    @SerializedName("use_request_no")
391    public String useRequestNo;
392  
393    @SerializedName("use_time")
394    public String useTime;
395  
396    @SerializedName("associated_order_info")
397    public UserProductCouponAssociatedOrderInfo associatedOrderInfo;
398  
399    @SerializedName("return_request_no")
400    public String returnRequestNo;
401  
402    @SerializedName("return_time")
403    public String returnTime;
404  
405    @SerializedName("delete_time")
406    public String deleteTime;
407  }
408  
409  public enum ProductCouponScope {
410    @SerializedName("ALL")
411    ALL,
412    @SerializedName("SINGLE")
413    SINGLE
414  }
415  
416  public enum ProductCouponType {
417    @SerializedName("NORMAL")
418    NORMAL,
419    @SerializedName("DISCOUNT")
420    DISCOUNT,
421    @SerializedName("EXCHANGE")
422    EXCHANGE
423  }
424  
425  public enum UsageMode {
426    @SerializedName("SINGLE")
427    SINGLE,
428    @SerializedName("SEQUENTIAL")
429    SEQUENTIAL
430  }
431  
432  public static class SingleUsageInfo {
433    @SerializedName("normal_coupon")
434    public NormalCouponUsageRule normalCoupon;
435  
436    @SerializedName("discount_coupon")
437    public DiscountCouponUsageRule discountCoupon;
438  }
439  
440  public static class SequentialUsageInfo {
441    @SerializedName("type")
442    public SequentialUsageType type;
443  
444    @SerializedName("count")
445    public Long count;
446  
447    @SerializedName("available_days")
448    public Long availableDays;
449  
450    @SerializedName("interval_days")
451    public Long intervalDays;
452  }
453  
454  public static class ProductCouponDisplayInfo {
455    @SerializedName("name")
456    public String name;
457  
458    @SerializedName("image_url")
459    public String imageUrl;
460  
461    @SerializedName("background_url")
462    public String backgroundUrl;
463  
464    @SerializedName("detail_image_url_list")
465    public List<String> detailImageUrlList;
466  
467    @SerializedName("original_price")
468    public Long originalPrice;
469  
470    @SerializedName("combo_package_list")
471    public List<ComboPackage> comboPackageList;
472  }
473  
474  public enum ProductCouponState {
475    @SerializedName("AUDITING")
476    AUDITING,
477    @SerializedName("EFFECTIVE")
478    EFFECTIVE,
479    @SerializedName("DEACTIVATED")
480    DEACTIVATED
481  }
482  
483  public enum CouponCodeMode {
484    @SerializedName("WECHATPAY")
485    WECHATPAY,
486    @SerializedName("UPLOAD")
487    UPLOAD,
488    @SerializedName("API_ASSIGN")
489    API_ASSIGN
490  }
491  
492  public static class CouponCodeCountInfo {
493    @SerializedName("total_count")
494    public Long totalCount;
495  
496    @SerializedName("available_count")
497    public Long availableCount;
498  }
499  
500  public static class StockSendRule {
501    @SerializedName("max_count")
502    public Long maxCount;
503  
504    @SerializedName("max_count_per_day")
505    public Long maxCountPerDay;
506  
507    @SerializedName("max_count_per_user")
508    public Long maxCountPerUser;
509  }
510  
511  public static class SingleUsageRule {
512    @SerializedName("coupon_available_period")
513    public SingleCouponAvailablePeriod couponAvailablePeriod;
514  
515    @SerializedName("normal_coupon")
516    public NormalCouponUsageRule normalCoupon;
517  
518    @SerializedName("discount_coupon")
519    public DiscountCouponUsageRule discountCoupon;
520  
521    @SerializedName("exchange_coupon")
522    public ExchangeCouponUsageRule exchangeCoupon;
523  }
524  
525  public static class SequentialUsageRule {
526    @SerializedName("coupon_available_period")
527    public SequentialCouponAvailablePeriod couponAvailablePeriod;
528  
529    @SerializedName("normal_coupon_list")
530    public List<NormalCouponUsageRule> normalCouponList;
531  
532    @SerializedName("discount_coupon_list")
533    public List<DiscountCouponUsageRule> discountCouponList;
534  
535    @SerializedName("exchange_coupon_list")
536    public List<ExchangeCouponUsageRule> exchangeCouponList;
537  
538    @SerializedName("special_first")
539    public Boolean specialFirst;
540  }
541  
542  public static class UsageRuleDisplayInfo {
543    @SerializedName("coupon_usage_method_list")
544    public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>();
545  
546    @SerializedName("mini_program_appid")
547    public String miniProgramAppid;
548  
549    @SerializedName("mini_program_path")
550    public String miniProgramPath;
551  
552    @SerializedName("app_path")
553    public String appPath;
554  
555    @SerializedName("usage_description")
556    public String usageDescription;
557  
558    @SerializedName("coupon_available_store_info")
559    public CouponAvailableStoreInfo couponAvailableStoreInfo;
560  }
561  
562  public static class CouponDisplayInfo {
563    @SerializedName("code_display_mode")
564    public CouponCodeDisplayMode codeDisplayMode;
565  
566    @SerializedName("background_color")
567    public String backgroundColor;
568  
569    @SerializedName("entrance_mini_program")
570    public EntranceMiniProgram entranceMiniProgram;
571  
572    @SerializedName("entrance_official_account")
573    public EntranceOfficialAccount entranceOfficialAccount;
574  
575    @SerializedName("entrance_finder")
576    public EntranceFinder entranceFinder;
577  }
578  
579  public static class NotifyConfig {
580    @SerializedName("notify_appid")
581    public String notifyAppid;
582  }
583  
584  public enum StockStoreScope {
585    @SerializedName("NONE")
586    NONE,
587    @SerializedName("ALL")
588    ALL,
589    @SerializedName("SPECIFIC")
590    SPECIFIC
591  }
592  
593  public static class StockSentCountInfo {
594    @SerializedName("total_count")
595    public Long totalCount;
596  
597    @SerializedName("today_count")
598    public Long todayCount;
599  }
600  
601  public enum StockState {
602    @SerializedName("AUDITING")
603    AUDITING,
604    @SerializedName("SENDING")
605    SENDING,
606    @SerializedName("PAUSED")
607    PAUSED,
608    @SerializedName("STOPPED")
609    STOPPED,
610    @SerializedName("DEACTIVATED")
611    DEACTIVATED
612  }
613  
614  public enum UserProductCouponTag {
615    @SerializedName("MEMBER")
616    MEMBER
617  }
618  
619  public static class MemberTagInfo {
620    @SerializedName("member_card_id")
621    public String memberCardId;
622  }
623  
624  public enum UserProductCouponUsageDetailItemState {
625    @SerializedName("PENDING")
626    PENDING,
627    @SerializedName("EFFECTIVE")
628    EFFECTIVE,
629    @SerializedName("USED")
630    USED,
631    @SerializedName("EXPIRED")
632    EXPIRED,
633    @SerializedName("DELETED")
634    DELETED,
635    @SerializedName("DEACTIVATED")
636    DEACTIVATED
637  }
638  
639  public static class NormalCouponUsageRule {
640    @SerializedName("threshold")
641    public Long threshold;
642  
643    @SerializedName("discount_amount")
644    public Long discountAmount;
645  }
646  
647  public static class DiscountCouponUsageRule {
648    @SerializedName("threshold")
649    public Long threshold;
650  
651    @SerializedName("percent_off")
652    public Long percentOff;
653  }
654  
655  public enum SequentialUsageType {
656    @SerializedName("INCREMENTAL")
657    INCREMENTAL,
658    @SerializedName("EQUAL")
659    EQUAL
660  }
661  
662  public static class ComboPackage {
663    @SerializedName("name")
664    public String name;
665  
666    @SerializedName("pick_count")
667    public Long pickCount;
668  
669    @SerializedName("choice_list")
670    public List<ComboPackageChoice> choiceList = new ArrayList<ComboPackageChoice>();
671  }
672  
673  public static class SingleCouponAvailablePeriod {
674    @SerializedName("available_begin_time")
675    public String availableBeginTime;
676  
677    @SerializedName("available_end_time")
678    public String availableEndTime;
679  
680    @SerializedName("available_days")
681    public Long availableDays;
682  
683    @SerializedName("wait_days_after_receive")
684    public Long waitDaysAfterReceive;
685  
686    @SerializedName("weekly_available_period")
687    public FixedWeekPeriod weeklyAvailablePeriod;
688  
689    @SerializedName("irregular_available_period_list")
690    public List<TimePeriod> irregularAvailablePeriodList;
691  }
692  
693  public static class ExchangeCouponUsageRule {
694    @SerializedName("threshold")
695    public Long threshold;
696  
697    @SerializedName("exchange_price")
698    public Long exchangePrice;
699  }
700  
701  public static class SequentialCouponAvailablePeriod {
702    @SerializedName("available_begin_time")
703    public String availableBeginTime;
704  
705    @SerializedName("available_end_time")
706    public String availableEndTime;
707  
708    @SerializedName("wait_days_after_receive")
709    public Long waitDaysAfterReceive;
710  
711    @SerializedName("weekly_available_period")
712    public FixedWeekPeriod weeklyAvailablePeriod;
713  
714    @SerializedName("irregular_available_period_list")
715    public List<TimePeriod> irregularAvailablePeriodList;
716  }
717  
718  public enum CouponUsageMethod {
719    @SerializedName("OFFLINE")
720    OFFLINE,
721    @SerializedName("MINI_PROGRAM")
722    MINI_PROGRAM,
723    @SerializedName("APP")
724    APP,
725    @SerializedName("PAYMENT_CODE")
726    PAYMENT_CODE
727  }
728  
729  public static class CouponAvailableStoreInfo {
730    @SerializedName("description")
731    public String description;
732  
733    @SerializedName("mini_program_appid")
734    public String miniProgramAppid;
735  
736    @SerializedName("mini_program_path")
737    public String miniProgramPath;
738  }
739  
740  public enum CouponCodeDisplayMode {
741    @SerializedName("INVISIBLE")
742    INVISIBLE,
743    @SerializedName("BARCODE")
744    BARCODE,
745    @SerializedName("QRCODE")
746    QRCODE
747  }
748  
749  public static class EntranceMiniProgram {
750    @SerializedName("appid")
751    public String appid;
752  
753    @SerializedName("path")
754    public String path;
755  
756    @SerializedName("entrance_wording")
757    public String entranceWording;
758  
759    @SerializedName("guidance_wording")
760    public String guidanceWording;
761  }
762  
763  public static class EntranceOfficialAccount {
764    @SerializedName("appid")
765    public String appid;
766  }
767  
768  public static class EntranceFinder {
769    @SerializedName("finder_id")
770    public String finderId;
771  
772    @SerializedName("finder_video_id")
773    public String finderVideoId;
774  
775    @SerializedName("finder_video_cover_image_url")
776    public String finderVideoCoverImageUrl;
777  }
778  
779  public static class ComboPackageChoice {
780    @SerializedName("name")
781    public String name;
782  
783    @SerializedName("price")
784    public Long price;
785  
786    @SerializedName("count")
787    public Long count;
788  
789    @SerializedName("image_url")
790    public String imageUrl;
791  
792    @SerializedName("mini_program_appid")
793    public String miniProgramAppid;
794  
795    @SerializedName("mini_program_path")
796    public String miniProgramPath;
797  }
798  
799  public static class FixedWeekPeriod {
800    @SerializedName("day_list")
801    public List<WeekEnum> dayList;
802  
803    @SerializedName("day_period_list")
804    public List<PeriodOfTheDay> dayPeriodList;
805  }
806  
807  public static class TimePeriod {
808    @SerializedName("begin_time")
809    public String beginTime;
810  
811    @SerializedName("end_time")
812    public String endTime;
813  }
814  
815  public enum WeekEnum {
816    @SerializedName("MONDAY")
817    MONDAY,
818    @SerializedName("TUESDAY")
819    TUESDAY,
820    @SerializedName("WEDNESDAY")
821    WEDNESDAY,
822    @SerializedName("THURSDAY")
823    THURSDAY,
824    @SerializedName("FRIDAY")
825    FRIDAY,
826    @SerializedName("SATURDAY")
827    SATURDAY,
828    @SerializedName("SUNDAY")
829    SUNDAY
830  }
831  
832  public static class PeriodOfTheDay {
833    @SerializedName("begin_time")
834    public Long beginTime;
835  
836    @SerializedName("end_time")
837    public Long endTime;
838  }
839  
840}
841

1package main
2
3import (
4	"demo/wxpay_brand_utility" // 引用微信支付工具库，参考 https://pay.weixin.qq.com/doc/brand/4015826866
5	"encoding/json"
6	"fmt"
7	"net/http"
8	"net/url"
9	"strings"
10	"time"
11)
12
13func main() {
14	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
15	config, err := wxpay_brand_utility.CreateBrandConfig(
16		"xxxxxxxx",                   // 品牌ID，是由微信支付系统生成并分配给每个品牌方的唯一标识符，品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289
17		"1DDE55AD98Exxxxxxxxxx",      // 品牌API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570
18		"/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径，本地文件路径
19		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439
20		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
21	)
22	if err != nil {
23		fmt.Println(err)
24		return
25	}
26
27	request := &ListUserProductCouponsRequest{
28		ProductCouponId: wxpay_brand_utility.String("1002323"),
29		StockId:         wxpay_brand_utility.String("100232301"),
30		Appid:           wxpay_brand_utility.String("wx233544546545989"),
31		Openid:          wxpay_brand_utility.String("oh-394z-6CGkNoJrsDLTTUKiAnp4"),
32		CouponState:     USERPRODUCTCOUPONSTATE_USED.Ptr(),
33		PageSize:        wxpay_brand_utility.Int64(20),
34		PageToken:       wxpay_brand_utility.String("MTIzMjUK"),
35	}
36
37	response, err := ListUserProductCoupons(config, request)
38	if err != nil {
39		fmt.Printf("请求失败: %+v\n", err)
40		// TODO: 请求失败，根据状态码执行不同的处理
41		return
42	}
43
44	// TODO: 请求成功，继续业务逻辑
45	fmt.Printf("请求成功: %+v\n", response)
46}
47
48func ListUserProductCoupons(config *wxpay_brand_utility.BrandConfig, request *ListUserProductCouponsRequest) (response *ListUserProductCouponsResponse, err error) {
49	const (
50		host   = "https://api.mch.weixin.qq.com"
51		method = "GET"
52		path   = "/brand/marketing/product-coupon/users/{openid}/coupons"
53	)
54
55	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
56	if err != nil {
57		return nil, err
58	}
59	reqUrl.Path = strings.Replace(reqUrl.Path, "{openid}", url.PathEscape(*request.Openid), -1)
60	query := reqUrl.Query()
61	if request.ProductCouponId != nil {
62		query.Add("product_coupon_id", *request.ProductCouponId)
63	}
64	if request.StockId != nil {
65		query.Add("stock_id", *request.StockId)
66	}
67	if request.Appid != nil {
68		query.Add("appid", *request.Appid)
69	}
70	if request.CouponState != nil {
71		query.Add("coupon_state", fmt.Sprintf("%v", *request.CouponState))
72	}
73	if request.PageSize != nil {
74		query.Add("page_size", fmt.Sprintf("%v", *request.PageSize))
75	}
76	if request.PageToken != nil {
77		query.Add("page_token", *request.PageToken)
78	}
79	reqUrl.RawQuery = query.Encode()
80	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
81	if err != nil {
82		return nil, err
83	}
84	httpRequest.Header.Set("Accept", "application/json")
85	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
86	authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
87	if err != nil {
88		return nil, err
89	}
90	httpRequest.Header.Set("Authorization", authorization)
91
92	client := &http.Client{}
93	httpResponse, err := client.Do(httpRequest)
94	if err != nil {
95		return nil, err
96	}
97	respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse)
98	if err != nil {
99		return nil, err
100	}
101	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
102		// 2XX 成功，验证应答签名
103		err = wxpay_brand_utility.ValidateResponse(
104			config.WechatPayPublicKeyId(),
105			config.WechatPayPublicKey(),
106			&httpResponse.Header,
107			respBody,
108		)
109		if err != nil {
110			return nil, err
111		}
112		response := &ListUserProductCouponsResponse{}
113		if err := json.Unmarshal(respBody, response); err != nil {
114			return nil, err
115		}
116
117		return response, nil
118	} else {
119		return nil, wxpay_brand_utility.NewApiException(
120			httpResponse.StatusCode,
121			httpResponse.Header,
122			respBody,
123		)
124	}
125}
126
127type ListUserProductCouponsRequest struct {
128	ProductCouponId *string                 `json:"product_coupon_id,omitempty"`
129	StockId         *string                 `json:"stock_id,omitempty"`
130	Appid           *string                 `json:"appid,omitempty"`
131	Openid          *string                 `json:"openid,omitempty"`
132	PageSize        *int64                  `json:"page_size,omitempty"`
133	PageToken       *string                 `json:"page_token,omitempty"`
134	CouponState     *UserProductCouponState `json:"coupon_state,omitempty"`
135}
136
137func (o *ListUserProductCouponsRequest) MarshalJSON() ([]byte, error) {
138	type Alias ListUserProductCouponsRequest
139	a := &struct {
140		ProductCouponId *string                 `json:"product_coupon_id,omitempty"`
141		StockId         *string                 `json:"stock_id,omitempty"`
142		Appid           *string                 `json:"appid,omitempty"`
143		Openid          *string                 `json:"openid,omitempty"`
144		PageSize        *int64                  `json:"page_size,omitempty"`
145		PageToken       *string                 `json:"page_token,omitempty"`
146		CouponState     *UserProductCouponState `json:"coupon_state,omitempty"`
147		*Alias
148	}{
149		// 序列化时移除非 Body 字段
150		ProductCouponId: nil,
151		StockId:         nil,
152		Appid:           nil,
153		Openid:          nil,
154		PageSize:        nil,
155		PageToken:       nil,
156		CouponState:     nil,
157		Alias:           (*Alias)(o),
158	}
159	return json.Marshal(a)
160}
161
162type ListUserProductCouponsResponse struct {
163	TotalCount     *int64                    `json:"total_count,omitempty"`
164	UserCouponList []UserProductCouponEntity `json:"user_coupon_list,omitempty"`
165	NextPageToken  *string                   `json:"next_page_token,omitempty"`
166}
167
168type UserProductCouponState string
169
170func (e UserProductCouponState) Ptr() *UserProductCouponState {
171	return &e
172}
173
174const (
175	USERPRODUCTCOUPONSTATE_CONFIRMING  UserProductCouponState = "CONFIRMING"
176	USERPRODUCTCOUPONSTATE_PENDING     UserProductCouponState = "PENDING"
177	USERPRODUCTCOUPONSTATE_EFFECTIVE   UserProductCouponState = "EFFECTIVE"
178	USERPRODUCTCOUPONSTATE_USED        UserProductCouponState = "USED"
179	USERPRODUCTCOUPONSTATE_EXPIRED     UserProductCouponState = "EXPIRED"
180	USERPRODUCTCOUPONSTATE_DELETED     UserProductCouponState = "DELETED"
181	USERPRODUCTCOUPONSTATE_DEACTIVATED UserProductCouponState = "DEACTIVATED"
182)
183
184type UserProductCouponEntity struct {
185	CouponCode            *string                       `json:"coupon_code,omitempty"`
186	CouponState           *UserProductCouponState       `json:"coupon_state,omitempty"`
187	ValidBeginTime        *time.Time                    `json:"valid_begin_time,omitempty"`
188	ValidEndTime          *time.Time                    `json:"valid_end_time,omitempty"`
189	ReceiveTime           *string                       `json:"receive_time,omitempty"`
190	SendRequestNo         *string                       `json:"send_request_no,omitempty"`
191	SendChannel           *UserProductCouponSendChannel `json:"send_channel,omitempty"`
192	ConfirmRequestNo      *string                       `json:"confirm_request_no,omitempty"`
193	ConfirmTime           *time.Time                    `json:"confirm_time,omitempty"`
194	DeactivateRequestNo   *string                       `json:"deactivate_request_no,omitempty"`
195	DeactivateTime        *string                       `json:"deactivate_time,omitempty"`
196	DeactivateReason      *string                       `json:"deactivate_reason,omitempty"`
197	SingleUsageDetail     *SingleUsageDetail            `json:"single_usage_detail,omitempty"`
198	SequentialUsageDetail *SequentialUsageDetail        `json:"sequential_usage_detail,omitempty"`
199	ProductCoupon         *ProductCouponEntity          `json:"product_coupon,omitempty"`
200	Stock                 *StockEntity                  `json:"stock,omitempty"`
201	Attach                *string                       `json:"attach,omitempty"`
202	ChannelCustomInfo     *string                       `json:"channel_custom_info,omitempty"`
203	CouponTagInfo         *CouponTagInfo                `json:"coupon_tag_info,omitempty"`
204}
205
206type UserProductCouponSendChannel string
207
208func (e UserProductCouponSendChannel) Ptr() *UserProductCouponSendChannel {
209	return &e
210}
211
212const (
213	USERPRODUCTCOUPONSENDCHANNEL_BRAND_MANAGE      UserProductCouponSendChannel = "BRAND_MANAGE"
214	USERPRODUCTCOUPONSENDCHANNEL_API               UserProductCouponSendChannel = "API"
215	USERPRODUCTCOUPONSENDCHANNEL_RECEIVE_COMPONENT UserProductCouponSendChannel = "RECEIVE_COMPONENT"
216)
217
218type SingleUsageDetail struct {
219	UseRequestNo        *string                               `json:"use_request_no,omitempty"`
220	UseTime             *time.Time                            `json:"use_time,omitempty"`
221	AssociatedOrderInfo *UserProductCouponAssociatedOrderInfo `json:"associated_order_info,omitempty"`
222	ReturnRequestNo     *string                               `json:"return_request_no,omitempty"`
223	ReturnTime          *time.Time                            `json:"return_time,omitempty"`
224}
225
226type SequentialUsageDetail struct {
227	TotalCount     *int64                      `json:"total_count,omitempty"`
228	UsedCount      *int64                      `json:"used_count,omitempty"`
229	DetailItemList []SequentialUsageDetailItem `json:"detail_item_list,omitempty"`
230}
231
232type ProductCouponEntity struct {
233	ProductCouponId     *string                   `json:"product_coupon_id,omitempty"`
234	Scope               *ProductCouponScope       `json:"scope,omitempty"`
235	Type                *ProductCouponType        `json:"type,omitempty"`
236	UsageMode           *UsageMode                `json:"usage_mode,omitempty"`
237	SingleUsageInfo     *SingleUsageInfo          `json:"single_usage_info,omitempty"`
238	SequentialUsageInfo *SequentialUsageInfo      `json:"sequential_usage_info,omitempty"`
239	DisplayInfo         *ProductCouponDisplayInfo `json:"display_info,omitempty"`
240	OutProductNo        *string                   `json:"out_product_no,omitempty"`
241	State               *ProductCouponState       `json:"state,omitempty"`
242	DeactivateRequestNo *string                   `json:"deactivate_request_no,omitempty"`
243	DeactivateTime      *string                   `json:"deactivate_time,omitempty"`
244	DeactivateReason    *string                   `json:"deactivate_reason,omitempty"`
245}
246
247type StockEntity struct {
248	ProductCouponId      *string               `json:"product_coupon_id,omitempty"`
249	StockId              *string               `json:"stock_id,omitempty"`
250	Remark               *string               `json:"remark,omitempty"`
251	CouponCodeMode       *CouponCodeMode       `json:"coupon_code_mode,omitempty"`
252	CouponCodeCountInfo  *CouponCodeCountInfo  `json:"coupon_code_count_info,omitempty"`
253	StockSendRule        *StockSendRule        `json:"stock_send_rule,omitempty"`
254	SingleUsageRule      *SingleUsageRule      `json:"single_usage_rule,omitempty"`
255	SequentialUsageRule  *SequentialUsageRule  `json:"sequential_usage_rule,omitempty"`
256	UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"`
257	CouponDisplayInfo    *CouponDisplayInfo    `json:"coupon_display_info,omitempty"`
258	NotifyConfig         *NotifyConfig         `json:"notify_config,omitempty"`
259	StoreScope           *StockStoreScope      `json:"store_scope,omitempty"`
260	SentCountInfo        *StockSentCountInfo   `json:"sent_count_info,omitempty"`
261	State                *StockState           `json:"state,omitempty"`
262	DeactivateRequestNo  *string               `json:"deactivate_request_no,omitempty"`
263	DeactivateTime       *time.Time            `json:"deactivate_time,omitempty"`
264	DeactivateReason     *string               `json:"deactivate_reason,omitempty"`
265}
266
267type CouponTagInfo struct {
268	CouponTagList []UserProductCouponTag `json:"coupon_tag_list,omitempty"`
269	MemberTagInfo *MemberTagInfo         `json:"member_tag_info,omitempty"`
270}
271
272type UserProductCouponAssociatedOrderInfo struct {
273	TransactionId *string `json:"transaction_id,omitempty"`
274	OutTradeNo    *string `json:"out_trade_no,omitempty"`
275	Mchid         *string `json:"mchid,omitempty"`
276	SubMchid      *string `json:"sub_mchid,omitempty"`
277}
278
279type SequentialUsageDetailItem struct {
280	DetailState         *UserProductCouponUsageDetailItemState `json:"detail_state,omitempty"`
281	ValidBeginTime      *time.Time                             `json:"valid_begin_time,omitempty"`
282	ValidEndTime        *time.Time                             `json:"valid_end_time,omitempty"`
283	UseRequestNo        *string                                `json:"use_request_no,omitempty"`
284	UseTime             *time.Time                             `json:"use_time,omitempty"`
285	AssociatedOrderInfo *UserProductCouponAssociatedOrderInfo  `json:"associated_order_info,omitempty"`
286	ReturnRequestNo     *string                                `json:"return_request_no,omitempty"`
287	ReturnTime          *time.Time                             `json:"return_time,omitempty"`
288	DeleteTime          *time.Time                             `json:"delete_time,omitempty"`
289}
290
291type ProductCouponScope string
292
293func (e ProductCouponScope) Ptr() *ProductCouponScope {
294	return &e
295}
296
297const (
298	PRODUCTCOUPONSCOPE_ALL    ProductCouponScope = "ALL"
299	PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE"
300)
301
302type ProductCouponType string
303
304func (e ProductCouponType) Ptr() *ProductCouponType {
305	return &e
306}
307
308const (
309	PRODUCTCOUPONTYPE_NORMAL   ProductCouponType = "NORMAL"
310	PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT"
311	PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE"
312)
313
314type UsageMode string
315
316func (e UsageMode) Ptr() *UsageMode {
317	return &e
318}
319
320const (
321	USAGEMODE_SINGLE     UsageMode = "SINGLE"
322	USAGEMODE_SEQUENTIAL UsageMode = "SEQUENTIAL"
323)
324
325type SingleUsageInfo struct {
326	NormalCoupon   *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
327	DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
328}
329
330type SequentialUsageInfo struct {
331	Type          *SequentialUsageType `json:"type,omitempty"`
332	Count         *int64               `json:"count,omitempty"`
333	AvailableDays *int64               `json:"available_days,omitempty"`
334	IntervalDays  *int64               `json:"interval_days,omitempty"`
335}
336
337type ProductCouponDisplayInfo struct {
338	Name               *string        `json:"name,omitempty"`
339	ImageUrl           *string        `json:"image_url,omitempty"`
340	BackgroundUrl      *string        `json:"background_url,omitempty"`
341	DetailImageUrlList []string       `json:"detail_image_url_list,omitempty"`
342	OriginalPrice      *int64         `json:"original_price,omitempty"`
343	ComboPackageList   []ComboPackage `json:"combo_package_list,omitempty"`
344}
345
346type ProductCouponState string
347
348func (e ProductCouponState) Ptr() *ProductCouponState {
349	return &e
350}
351
352const (
353	PRODUCTCOUPONSTATE_AUDITING    ProductCouponState = "AUDITING"
354	PRODUCTCOUPONSTATE_EFFECTIVE   ProductCouponState = "EFFECTIVE"
355	PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED"
356)
357
358type CouponCodeMode string
359
360func (e CouponCodeMode) Ptr() *CouponCodeMode {
361	return &e
362}
363
364const (
365	COUPONCODEMODE_WECHATPAY  CouponCodeMode = "WECHATPAY"
366	COUPONCODEMODE_UPLOAD     CouponCodeMode = "UPLOAD"
367	COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN"
368)
369
370type CouponCodeCountInfo struct {
371	TotalCount     *int64 `json:"total_count,omitempty"`
372	AvailableCount *int64 `json:"available_count,omitempty"`
373}
374
375type StockSendRule struct {
376	MaxCount        *int64 `json:"max_count,omitempty"`
377	MaxCountPerDay  *int64 `json:"max_count_per_day,omitempty"`
378	MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"`
379}
380
381type SingleUsageRule struct {
382	CouponAvailablePeriod *SingleCouponAvailablePeriod `json:"coupon_available_period,omitempty"`
383	NormalCoupon          *NormalCouponUsageRule       `json:"normal_coupon,omitempty"`
384	DiscountCoupon        *DiscountCouponUsageRule     `json:"discount_coupon,omitempty"`
385	ExchangeCoupon        *ExchangeCouponUsageRule     `json:"exchange_coupon,omitempty"`
386}
387
388type SequentialUsageRule struct {
389	CouponAvailablePeriod *SequentialCouponAvailablePeriod `json:"coupon_available_period,omitempty"`
390	NormalCouponList      []NormalCouponUsageRule          `json:"normal_coupon_list,omitempty"`
391	DiscountCouponList    []DiscountCouponUsageRule        `json:"discount_coupon_list,omitempty"`
392	ExchangeCouponList    []ExchangeCouponUsageRule        `json:"exchange_coupon_list,omitempty"`
393	SpecialFirst          *bool                            `json:"special_first,omitempty"`
394}
395
396type UsageRuleDisplayInfo struct {
397	CouponUsageMethodList    []CouponUsageMethod       `json:"coupon_usage_method_list,omitempty"`
398	MiniProgramAppid         *string                   `json:"mini_program_appid,omitempty"`
399	MiniProgramPath          *string                   `json:"mini_program_path,omitempty"`
400	AppPath                  *string                   `json:"app_path,omitempty"`
401	UsageDescription         *string                   `json:"usage_description,omitempty"`
402	CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"`
403}
404
405type CouponDisplayInfo struct {
406	CodeDisplayMode         *CouponCodeDisplayMode   `json:"code_display_mode,omitempty"`
407	BackgroundColor         *string                  `json:"background_color,omitempty"`
408	EntranceMiniProgram     *EntranceMiniProgram     `json:"entrance_mini_program,omitempty"`
409	EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"`
410	EntranceFinder          *EntranceFinder          `json:"entrance_finder,omitempty"`
411}
412
413type NotifyConfig struct {
414	NotifyAppid *string `json:"notify_appid,omitempty"`
415}
416
417type StockStoreScope string
418
419func (e StockStoreScope) Ptr() *StockStoreScope {
420	return &e
421}
422
423const (
424	STOCKSTORESCOPE_NONE     StockStoreScope = "NONE"
425	STOCKSTORESCOPE_ALL      StockStoreScope = "ALL"
426	STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC"
427)
428
429type StockSentCountInfo struct {
430	TotalCount *int64 `json:"total_count,omitempty"`
431	TodayCount *int64 `json:"today_count,omitempty"`
432}
433
434type StockState string
435
436func (e StockState) Ptr() *StockState {
437	return &e
438}
439
440const (
441	STOCKSTATE_AUDITING    StockState = "AUDITING"
442	STOCKSTATE_SENDING     StockState = "SENDING"
443	STOCKSTATE_PAUSED      StockState = "PAUSED"
444	STOCKSTATE_STOPPED     StockState = "STOPPED"
445	STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED"
446)
447
448type UserProductCouponTag string
449
450func (e UserProductCouponTag) Ptr() *UserProductCouponTag {
451	return &e
452}
453
454const (
455	USERPRODUCTCOUPONTAG_MEMBER UserProductCouponTag = "MEMBER"
456)
457
458type MemberTagInfo struct {
459	MemberCardId *string `json:"member_card_id,omitempty"`
460}
461
462type UserProductCouponUsageDetailItemState string
463
464func (e UserProductCouponUsageDetailItemState) Ptr() *UserProductCouponUsageDetailItemState {
465	return &e
466}
467
468const (
469	USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_PENDING     UserProductCouponUsageDetailItemState = "PENDING"
470	USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_EFFECTIVE   UserProductCouponUsageDetailItemState = "EFFECTIVE"
471	USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_USED        UserProductCouponUsageDetailItemState = "USED"
472	USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_EXPIRED     UserProductCouponUsageDetailItemState = "EXPIRED"
473	USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_DELETED     UserProductCouponUsageDetailItemState = "DELETED"
474	USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_DEACTIVATED UserProductCouponUsageDetailItemState = "DEACTIVATED"
475)
476
477type NormalCouponUsageRule struct {
478	Threshold      *int64 `json:"threshold,omitempty"`
479	DiscountAmount *int64 `json:"discount_amount,omitempty"`
480}
481
482type DiscountCouponUsageRule struct {
483	Threshold  *int64 `json:"threshold,omitempty"`
484	PercentOff *int64 `json:"percent_off,omitempty"`
485}
486
487type SequentialUsageType string
488
489func (e SequentialUsageType) Ptr() *SequentialUsageType {
490	return &e
491}
492
493const (
494	SEQUENTIALUSAGETYPE_INCREMENTAL SequentialUsageType = "INCREMENTAL"
495	SEQUENTIALUSAGETYPE_EQUAL       SequentialUsageType = "EQUAL"
496)
497
498type ComboPackage struct {
499	Name       *string              `json:"name,omitempty"`
500	PickCount  *int64               `json:"pick_count,omitempty"`
501	ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"`
502}
503
504type SingleCouponAvailablePeriod struct {
505	AvailableBeginTime           *string          `json:"available_begin_time,omitempty"`
506	AvailableEndTime             *string          `json:"available_end_time,omitempty"`
507	AvailableDays                *int64           `json:"available_days,omitempty"`
508	WaitDaysAfterReceive         *int64           `json:"wait_days_after_receive,omitempty"`
509	WeeklyAvailablePeriod        *FixedWeekPeriod `json:"weekly_available_period,omitempty"`
510	IrregularAvailablePeriodList []TimePeriod     `json:"irregular_available_period_list,omitempty"`
511}
512
513type ExchangeCouponUsageRule struct {
514	Threshold     *int64 `json:"threshold,omitempty"`
515	ExchangePrice *int64 `json:"exchange_price,omitempty"`
516}
517
518type SequentialCouponAvailablePeriod struct {
519	AvailableBeginTime           *string          `json:"available_begin_time,omitempty"`
520	AvailableEndTime             *string          `json:"available_end_time,omitempty"`
521	WaitDaysAfterReceive         *int64           `json:"wait_days_after_receive,omitempty"`
522	WeeklyAvailablePeriod        *FixedWeekPeriod `json:"weekly_available_period,omitempty"`
523	IrregularAvailablePeriodList []TimePeriod     `json:"irregular_available_period_list,omitempty"`
524}
525
526type CouponUsageMethod string
527
528func (e CouponUsageMethod) Ptr() *CouponUsageMethod {
529	return &e
530}
531
532const (
533	COUPONUSAGEMETHOD_OFFLINE      CouponUsageMethod = "OFFLINE"
534	COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM"
535	COUPONUSAGEMETHOD_APP          CouponUsageMethod = "APP"
536	COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE"
537)
538
539type CouponAvailableStoreInfo struct {
540	Description      *string `json:"description,omitempty"`
541	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
542	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
543}
544
545type CouponCodeDisplayMode string
546
547func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode {
548	return &e
549}
550
551const (
552	COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE"
553	COUPONCODEDISPLAYMODE_BARCODE   CouponCodeDisplayMode = "BARCODE"
554	COUPONCODEDISPLAYMODE_QRCODE    CouponCodeDisplayMode = "QRCODE"
555)
556
557type EntranceMiniProgram struct {
558	Appid           *string `json:"appid,omitempty"`
559	Path            *string `json:"path,omitempty"`
560	EntranceWording *string `json:"entrance_wording,omitempty"`
561	GuidanceWording *string `json:"guidance_wording,omitempty"`
562}
563
564type EntranceOfficialAccount struct {
565	Appid *string `json:"appid,omitempty"`
566}
567
568type EntranceFinder struct {
569	FinderId                 *string `json:"finder_id,omitempty"`
570	FinderVideoId            *string `json:"finder_video_id,omitempty"`
571	FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"`
572}
573
574type ComboPackageChoice struct {
575	Name             *string `json:"name,omitempty"`
576	Price            *int64  `json:"price,omitempty"`
577	Count            *int64  `json:"count,omitempty"`
578	ImageUrl         *string `json:"image_url,omitempty"`
579	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
580	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
581}
582
583type FixedWeekPeriod struct {
584	DayList       []WeekEnum       `json:"day_list,omitempty"`
585	DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"`
586}
587
588type TimePeriod struct {
589	BeginTime *string `json:"begin_time,omitempty"`
590	EndTime   *string `json:"end_time,omitempty"`
591}
592
593type WeekEnum string
594
595func (e WeekEnum) Ptr() *WeekEnum {
596	return &e
597}
598
599const (
600	WEEKENUM_MONDAY    WeekEnum = "MONDAY"
601	WEEKENUM_TUESDAY   WeekEnum = "TUESDAY"
602	WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY"
603	WEEKENUM_THURSDAY  WeekEnum = "THURSDAY"
604	WEEKENUM_FRIDAY    WeekEnum = "FRIDAY"
605	WEEKENUM_SATURDAY  WeekEnum = "SATURDAY"
606	WEEKENUM_SUNDAY    WeekEnum = "SUNDAY"
607)
608
609type PeriodOfTheDay struct {
610	BeginTime *int64 `json:"begin_time,omitempty"`
611	EndTime   *int64 `json:"end_time,omitempty"`
612}
613