查询用户商品券详情

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

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 := &GetUserProductCouponRequest{
28		ProductCouponId: wxpay_brand_utility.String("1000000013"),
29		StockId:         wxpay_brand_utility.String("1000000013001"),
30		CouponCode:      wxpay_brand_utility.String("Code_123456"),
31		Appid:           wxpay_brand_utility.String("wx233544546545989"),
32		Openid:          wxpay_brand_utility.String("oh-394z-6CGkNoJrsDLTTUKiAnp4"),
33	}
34
35	response, err := GetUserProductCoupon(config, request)
36	if err != nil {
37		fmt.Printf("请求失败: %+v\n", err)
38		// TODO: 请求失败，根据状态码执行不同的处理
39		return
40	}
41
42	// TODO: 请求成功，继续业务逻辑
43	fmt.Printf("请求成功: %+v\n", response)
44}
45
46func GetUserProductCoupon(config *wxpay_brand_utility.BrandConfig, request *GetUserProductCouponRequest) (response *UserProductCouponEntity, err error) {
47	const (
48		host   = "https://api.mch.weixin.qq.com"
49		method = "GET"
50		path   = "/brand/marketing/product-coupon/users/{openid}/coupons/{coupon_code}"
51	)
52
53	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
54	if err != nil {
55		return nil, err
56	}
57	reqUrl.Path = strings.Replace(reqUrl.Path, "{coupon_code}", url.PathEscape(*request.CouponCode), -1)
58	reqUrl.Path = strings.Replace(reqUrl.Path, "{openid}", url.PathEscape(*request.Openid), -1)
59	query := reqUrl.Query()
60	if request.ProductCouponId != nil {
61		query.Add("product_coupon_id", *request.ProductCouponId)
62	}
63	if request.StockId != nil {
64		query.Add("stock_id", *request.StockId)
65	}
66	if request.Appid != nil {
67		query.Add("appid", *request.Appid)
68	}
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_brand_utility.BuildAuthorization(config.BrandId(), 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_brand_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_brand_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 := &UserProductCouponEntity{}
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_brand_utility.NewApiException(
110			httpResponse.StatusCode,
111			httpResponse.Header,
112			respBody,
113		)
114	}
115}
116
117type GetUserProductCouponRequest struct {
118	ProductCouponId *string `json:"product_coupon_id,omitempty"`
119	StockId         *string `json:"stock_id,omitempty"`
120	CouponCode      *string `json:"coupon_code,omitempty"`
121	Appid           *string `json:"appid,omitempty"`
122	Openid          *string `json:"openid,omitempty"`
123}
124
125func (o *GetUserProductCouponRequest) MarshalJSON() ([]byte, error) {
126	type Alias GetUserProductCouponRequest
127	a := &struct {
128		ProductCouponId *string `json:"product_coupon_id,omitempty"`
129		StockId         *string `json:"stock_id,omitempty"`
130		CouponCode      *string `json:"coupon_code,omitempty"`
131		Appid           *string `json:"appid,omitempty"`
132		Openid          *string `json:"openid,omitempty"`
133		*Alias
134	}{
135		// 序列化时移除非 Body 字段
136		ProductCouponId: nil,
137		StockId:         nil,
138		CouponCode:      nil,
139		Appid:           nil,
140		Openid:          nil,
141		Alias:           (*Alias)(o),
142	}
143	return json.Marshal(a)
144}
145
146type UserProductCouponEntity struct {
147	CouponCode                   *string                       `json:"coupon_code,omitempty"`
148	CouponState                  *UserProductCouponState       `json:"coupon_state,omitempty"`
149	ValidBeginTime               *time.Time                    `json:"valid_begin_time,omitempty"`
150	ValidEndTime                 *time.Time                    `json:"valid_end_time,omitempty"`
151	ReceiveTime                  *string                       `json:"receive_time,omitempty"`
152	SendRequestNo                *string                       `json:"send_request_no,omitempty"`
153	SendChannel                  *UserProductCouponSendChannel `json:"send_channel,omitempty"`
154	ConfirmRequestNo             *string                       `json:"confirm_request_no,omitempty"`
155	ConfirmTime                  *time.Time                    `json:"confirm_time,omitempty"`
156	DeactivateRequestNo          *string                       `json:"deactivate_request_no,omitempty"`
157	DeactivateTime               *string                       `json:"deactivate_time,omitempty"`
158	DeactivateReason             *string                       `json:"deactivate_reason,omitempty"`
159	SingleUsageDetail            *CouponUsageDetail            `json:"single_usage_detail,omitempty"`
160	ProgressiveBundleUsageDetail *CouponUsageDetail            `json:"progressive_bundle_usage_detail,omitempty"`
161	UserProductCouponBundleInfo  *UserProductCouponBundleInfo  `json:"user_product_coupon_bundle_info,omitempty"`
162	ProductCoupon                *ProductCouponEntity          `json:"product_coupon,omitempty"`
163	Stock                        *StockEntity                  `json:"stock,omitempty"`
164	Attach                       *string                       `json:"attach,omitempty"`
165	ChannelCustomInfo            *string                       `json:"channel_custom_info,omitempty"`
166	CouponTagInfo                *CouponTagInfo                `json:"coupon_tag_info,omitempty"`
167}
168
169type UserProductCouponState string
170
171func (e UserProductCouponState) Ptr() *UserProductCouponState {
172	return &e
173}
174
175const (
176	USERPRODUCTCOUPONSTATE_CONFIRMING  UserProductCouponState = "CONFIRMING"
177	USERPRODUCTCOUPONSTATE_PENDING     UserProductCouponState = "PENDING"
178	USERPRODUCTCOUPONSTATE_EFFECTIVE   UserProductCouponState = "EFFECTIVE"
179	USERPRODUCTCOUPONSTATE_USED        UserProductCouponState = "USED"
180	USERPRODUCTCOUPONSTATE_EXPIRED     UserProductCouponState = "EXPIRED"
181	USERPRODUCTCOUPONSTATE_DELETED     UserProductCouponState = "DELETED"
182	USERPRODUCTCOUPONSTATE_DEACTIVATED UserProductCouponState = "DEACTIVATED"
183)
184
185type UserProductCouponSendChannel string
186
187func (e UserProductCouponSendChannel) Ptr() *UserProductCouponSendChannel {
188	return &e
189}
190
191const (
192	USERPRODUCTCOUPONSENDCHANNEL_BRAND_MANAGE      UserProductCouponSendChannel = "BRAND_MANAGE"
193	USERPRODUCTCOUPONSENDCHANNEL_API               UserProductCouponSendChannel = "API"
194	USERPRODUCTCOUPONSENDCHANNEL_RECEIVE_COMPONENT UserProductCouponSendChannel = "RECEIVE_COMPONENT"
195)
196
197type CouponUsageDetail struct {
198	UseRequestNo        *string                               `json:"use_request_no,omitempty"`
199	UseTime             *time.Time                            `json:"use_time,omitempty"`
200	AssociatedOrderInfo *UserProductCouponAssociatedOrderInfo `json:"associated_order_info,omitempty"`
201	ReturnRequestNo     *string                               `json:"return_request_no,omitempty"`
202	ReturnTime          *time.Time                            `json:"return_time,omitempty"`
203}
204
205type UserProductCouponBundleInfo struct {
206	UserCouponBundleId    *string `json:"user_coupon_bundle_id,omitempty"`
207	UserCouponBundleIndex *int64  `json:"user_coupon_bundle_index,omitempty"`
208	TotalCount            *int64  `json:"total_count,omitempty"`
209	UsedCount             *int64  `json:"used_count,omitempty"`
210}
211
212type ProductCouponEntity struct {
213	ProductCouponId            *string                     `json:"product_coupon_id,omitempty"`
214	Scope                      *ProductCouponScope         `json:"scope,omitempty"`
215	Type                       *ProductCouponType          `json:"type,omitempty"`
216	UsageMode                  *UsageMode                  `json:"usage_mode,omitempty"`
217	SingleUsageInfo            *SingleUsageInfo            `json:"single_usage_info,omitempty"`
218	ProgressiveBundleUsageInfo *ProgressiveBundleUsageInfo `json:"progressive_bundle_usage_info,omitempty"`
219	DisplayInfo                *ProductCouponDisplayInfo   `json:"display_info,omitempty"`
220	OutProductNo               *string                     `json:"out_product_no,omitempty"`
221	State                      *ProductCouponState         `json:"state,omitempty"`
222	DeactivateRequestNo        *string                     `json:"deactivate_request_no,omitempty"`
223	DeactivateTime             *string                     `json:"deactivate_time,omitempty"`
224	DeactivateReason           *string                     `json:"deactivate_reason,omitempty"`
225}
226
227type StockEntity struct {
228	ProductCouponId            *string               `json:"product_coupon_id,omitempty"`
229	StockId                    *string               `json:"stock_id,omitempty"`
230	Remark                     *string               `json:"remark,omitempty"`
231	CouponCodeMode             *CouponCodeMode       `json:"coupon_code_mode,omitempty"`
232	CouponCodeCountInfo        *CouponCodeCountInfo  `json:"coupon_code_count_info,omitempty"`
233	StockSendRule              *StockSendRule        `json:"stock_send_rule,omitempty"`
234	SingleUsageRule            *SingleUsageRule      `json:"single_usage_rule,omitempty"`
235	ProgressiveBundleUsageRule *StockUsageRule       `json:"progressive_bundle_usage_rule,omitempty"`
236	StockBundleInfo            *StockBundleInfo      `json:"stock_bundle_info,omitempty"`
237	UsageRuleDisplayInfo       *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"`
238	CouponDisplayInfo          *CouponDisplayInfo    `json:"coupon_display_info,omitempty"`
239	NotifyConfig               *NotifyConfig         `json:"notify_config,omitempty"`
240	StoreScope                 *StockStoreScope      `json:"store_scope,omitempty"`
241	SentCountInfo              *StockSentCountInfo   `json:"sent_count_info,omitempty"`
242	State                      *StockState           `json:"state,omitempty"`
243	DeactivateRequestNo        *string               `json:"deactivate_request_no,omitempty"`
244	DeactivateTime             *time.Time            `json:"deactivate_time,omitempty"`
245	DeactivateReason           *string               `json:"deactivate_reason,omitempty"`
246}
247
248type CouponTagInfo struct {
249	CouponTagList []UserProductCouponTag `json:"coupon_tag_list,omitempty"`
250	MemberTagInfo *MemberTagInfo         `json:"member_tag_info,omitempty"`
251}
252
253type UserProductCouponAssociatedOrderInfo struct {
254	TransactionId *string `json:"transaction_id,omitempty"`
255	OutTradeNo    *string `json:"out_trade_no,omitempty"`
256	Mchid         *string `json:"mchid,omitempty"`
257	SubMchid      *string `json:"sub_mchid,omitempty"`
258}
259
260type ProductCouponScope string
261
262func (e ProductCouponScope) Ptr() *ProductCouponScope {
263	return &e
264}
265
266const (
267	PRODUCTCOUPONSCOPE_ALL    ProductCouponScope = "ALL"
268	PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE"
269)
270
271type ProductCouponType string
272
273func (e ProductCouponType) Ptr() *ProductCouponType {
274	return &e
275}
276
277const (
278	PRODUCTCOUPONTYPE_NORMAL   ProductCouponType = "NORMAL"
279	PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT"
280	PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE"
281)
282
283type UsageMode string
284
285func (e UsageMode) Ptr() *UsageMode {
286	return &e
287}
288
289const (
290	USAGEMODE_SINGLE             UsageMode = "SINGLE"
291	USAGEMODE_PROGRESSIVE_BUNDLE UsageMode = "PROGRESSIVE_BUNDLE"
292)
293
294type SingleUsageInfo struct {
295	NormalCoupon   *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
296	DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
297}
298
299type ProgressiveBundleUsageInfo struct {
300	Count        *int64 `json:"count,omitempty"`
301	IntervalDays *int64 `json:"interval_days,omitempty"`
302}
303
304type ProductCouponDisplayInfo struct {
305	Name               *string        `json:"name,omitempty"`
306	ImageUrl           *string        `json:"image_url,omitempty"`
307	BackgroundUrl      *string        `json:"background_url,omitempty"`
308	DetailImageUrlList []string       `json:"detail_image_url_list,omitempty"`
309	OriginalPrice      *int64         `json:"original_price,omitempty"`
310	ComboPackageList   []ComboPackage `json:"combo_package_list,omitempty"`
311}
312
313type ProductCouponState string
314
315func (e ProductCouponState) Ptr() *ProductCouponState {
316	return &e
317}
318
319const (
320	PRODUCTCOUPONSTATE_AUDITING    ProductCouponState = "AUDITING"
321	PRODUCTCOUPONSTATE_EFFECTIVE   ProductCouponState = "EFFECTIVE"
322	PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED"
323)
324
325type CouponCodeMode string
326
327func (e CouponCodeMode) Ptr() *CouponCodeMode {
328	return &e
329}
330
331const (
332	COUPONCODEMODE_WECHATPAY  CouponCodeMode = "WECHATPAY"
333	COUPONCODEMODE_UPLOAD     CouponCodeMode = "UPLOAD"
334	COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN"
335)
336
337type CouponCodeCountInfo struct {
338	TotalCount     *int64 `json:"total_count,omitempty"`
339	AvailableCount *int64 `json:"available_count,omitempty"`
340}
341
342type StockSendRule struct {
343	MaxCount        *int64 `json:"max_count,omitempty"`
344	MaxCountPerDay  *int64 `json:"max_count_per_day,omitempty"`
345	MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"`
346}
347
348type SingleUsageRule struct {
349	CouponAvailablePeriod *CouponAvailablePeriod   `json:"coupon_available_period,omitempty"`
350	NormalCoupon          *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
351	DiscountCoupon        *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
352	ExchangeCoupon        *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"`
353}
354
355type StockUsageRule struct {
356	CouponAvailablePeriod *CouponAvailablePeriod   `json:"coupon_available_period,omitempty"`
357	NormalCoupon          *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
358	DiscountCoupon        *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
359	ExchangeCoupon        *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"`
360}
361
362type StockBundleInfo struct {
363	StockBundleId    *string `json:"stock_bundle_id,omitempty"`
364	StockBundleIndex *int64  `json:"stock_bundle_index,omitempty"`
365}
366
367type UsageRuleDisplayInfo struct {
368	CouponUsageMethodList    []CouponUsageMethod       `json:"coupon_usage_method_list,omitempty"`
369	MiniProgramAppid         *string                   `json:"mini_program_appid,omitempty"`
370	MiniProgramPath          *string                   `json:"mini_program_path,omitempty"`
371	AppPath                  *string                   `json:"app_path,omitempty"`
372	UsageDescription         *string                   `json:"usage_description,omitempty"`
373	CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"`
374}
375
376type CouponDisplayInfo struct {
377	CodeDisplayMode         *CouponCodeDisplayMode   `json:"code_display_mode,omitempty"`
378	BackgroundColor         *string                  `json:"background_color,omitempty"`
379	EntranceMiniProgram     *EntranceMiniProgram     `json:"entrance_mini_program,omitempty"`
380	EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"`
381	EntranceFinder          *EntranceFinder          `json:"entrance_finder,omitempty"`
382}
383
384type NotifyConfig struct {
385	NotifyAppid *string `json:"notify_appid,omitempty"`
386}
387
388type StockStoreScope string
389
390func (e StockStoreScope) Ptr() *StockStoreScope {
391	return &e
392}
393
394const (
395	STOCKSTORESCOPE_NONE     StockStoreScope = "NONE"
396	STOCKSTORESCOPE_ALL      StockStoreScope = "ALL"
397	STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC"
398)
399
400type StockSentCountInfo struct {
401	TotalCount *int64 `json:"total_count,omitempty"`
402	TodayCount *int64 `json:"today_count,omitempty"`
403}
404
405type StockState string
406
407func (e StockState) Ptr() *StockState {
408	return &e
409}
410
411const (
412	STOCKSTATE_AUDITING    StockState = "AUDITING"
413	STOCKSTATE_SENDING     StockState = "SENDING"
414	STOCKSTATE_PAUSED      StockState = "PAUSED"
415	STOCKSTATE_STOPPED     StockState = "STOPPED"
416	STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED"
417)
418
419type UserProductCouponTag string
420
421func (e UserProductCouponTag) Ptr() *UserProductCouponTag {
422	return &e
423}
424
425const (
426	USERPRODUCTCOUPONTAG_MEMBER UserProductCouponTag = "MEMBER"
427)
428
429type MemberTagInfo struct {
430	MemberCardId *string `json:"member_card_id,omitempty"`
431}
432
433type NormalCouponUsageRule struct {
434	Threshold      *int64 `json:"threshold,omitempty"`
435	DiscountAmount *int64 `json:"discount_amount,omitempty"`
436}
437
438type DiscountCouponUsageRule struct {
439	Threshold  *int64 `json:"threshold,omitempty"`
440	PercentOff *int64 `json:"percent_off,omitempty"`
441}
442
443type ComboPackage struct {
444	Name       *string              `json:"name,omitempty"`
445	PickCount  *int64               `json:"pick_count,omitempty"`
446	ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"`
447}
448
449type CouponAvailablePeriod struct {
450	AvailableBeginTime           *string          `json:"available_begin_time,omitempty"`
451	AvailableEndTime             *string          `json:"available_end_time,omitempty"`
452	AvailableDays                *int64           `json:"available_days,omitempty"`
453	WaitDaysAfterReceive         *int64           `json:"wait_days_after_receive,omitempty"`
454	WeeklyAvailablePeriod        *FixedWeekPeriod `json:"weekly_available_period,omitempty"`
455	IrregularAvailablePeriodList []TimePeriod     `json:"irregular_available_period_list,omitempty"`
456}
457
458type ExchangeCouponUsageRule struct {
459	Threshold     *int64 `json:"threshold,omitempty"`
460	ExchangePrice *int64 `json:"exchange_price,omitempty"`
461}
462
463type CouponUsageMethod string
464
465func (e CouponUsageMethod) Ptr() *CouponUsageMethod {
466	return &e
467}
468
469const (
470	COUPONUSAGEMETHOD_OFFLINE      CouponUsageMethod = "OFFLINE"
471	COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM"
472	COUPONUSAGEMETHOD_APP          CouponUsageMethod = "APP"
473	COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE"
474)
475
476type CouponAvailableStoreInfo struct {
477	Description      *string `json:"description,omitempty"`
478	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
479	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
480}
481
482type CouponCodeDisplayMode string
483
484func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode {
485	return &e
486}
487
488const (
489	COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE"
490	COUPONCODEDISPLAYMODE_BARCODE   CouponCodeDisplayMode = "BARCODE"
491	COUPONCODEDISPLAYMODE_QRCODE    CouponCodeDisplayMode = "QRCODE"
492)
493
494type EntranceMiniProgram struct {
495	Appid           *string `json:"appid,omitempty"`
496	Path            *string `json:"path,omitempty"`
497	EntranceWording *string `json:"entrance_wording,omitempty"`
498	GuidanceWording *string `json:"guidance_wording,omitempty"`
499}
500
501type EntranceOfficialAccount struct {
502	Appid *string `json:"appid,omitempty"`
503}
504
505type EntranceFinder struct {
506	FinderId                 *string `json:"finder_id,omitempty"`
507	FinderVideoId            *string `json:"finder_video_id,omitempty"`
508	FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"`
509}
510
511type ComboPackageChoice struct {
512	Name             *string `json:"name,omitempty"`
513	Price            *int64  `json:"price,omitempty"`
514	Count            *int64  `json:"count,omitempty"`
515	ImageUrl         *string `json:"image_url,omitempty"`
516	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
517	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
518}
519
520type FixedWeekPeriod struct {
521	DayList       []WeekEnum       `json:"day_list,omitempty"`
522	DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"`
523}
524
525type TimePeriod struct {
526	BeginTime *string `json:"begin_time,omitempty"`
527	EndTime   *string `json:"end_time,omitempty"`
528}
529
530type WeekEnum string
531
532func (e WeekEnum) Ptr() *WeekEnum {
533	return &e
534}
535
536const (
537	WEEKENUM_MONDAY    WeekEnum = "MONDAY"
538	WEEKENUM_TUESDAY   WeekEnum = "TUESDAY"
539	WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY"
540	WEEKENUM_THURSDAY  WeekEnum = "THURSDAY"
541	WEEKENUM_FRIDAY    WeekEnum = "FRIDAY"
542	WEEKENUM_SATURDAY  WeekEnum = "SATURDAY"
543	WEEKENUM_SUNDAY    WeekEnum = "SUNDAY"
544)
545
546type PeriodOfTheDay struct {
547	BeginTime *int64 `json:"begin_time,omitempty"`
548	EndTime   *int64 `json:"end_time,omitempty"`
549}
550