修改商品券

1curl -X PATCH \
2  https://api.mch.weixin.qq.com/v3/marketing/partner/product-coupon/product-coupons/1000000013 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "display_info" : {
8      "name" : "全场满100立打8折-新名字",
9      "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx",
10      "background_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx",
11      "detail_image_url_list" : [
12        "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"
13      ]
14    },
15    "out_request_no" : "12345_20250101_A3489",
16    "brand_id" : "120344"
17  }'
18

1package com.java.demo;
2
3import com.java.utils.WXPayUtility; // 引用微信支付工具库，参考：https://pay.weixin.qq.com/doc/v3/partner/4014985777
4
5import com.google.gson.annotations.SerializedName;
6import com.google.gson.annotations.Expose;
7import okhttp3.MediaType;
8import okhttp3.OkHttpClient;
9import okhttp3.Request;
10import okhttp3.RequestBody;
11import okhttp3.Response;
12
13import java.io.IOException;
14import java.io.UncheckedIOException;
15import java.security.PrivateKey;
16import java.security.PublicKey;
17import java.util.ArrayList;
18import java.util.HashMap;
19import java.util.List;
20import java.util.Map;
21
22/**
23 * 修改商品券
24 */
25public class UpdateProductCoupon {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "PATCH";
28  private static String PATH = "/v3/marketing/partner/product-coupon/product-coupons/{product_coupon_id}";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    UpdateProductCoupon client = new UpdateProductCoupon(
33      "19xxxxxxxx",                    // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340
34      "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924
35      "/path/to/apiclient_key.pem",     // 商户API证书私钥文件路径，本地文件路径
36      "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
37      "/path/to/wxp_pub.pem"           // 微信支付公钥文件路径，本地文件路径
38    );
39
40    UpdateProductCouponRequest request = new UpdateProductCouponRequest();
41    request.outRequestNo = "12345_20250101_A3489";
42    request.productCouponId = "1000000013";
43    request.displayInfo = new ProductCouponDisplayInfo();
44    request.displayInfo.name = "全场满100立打8折-新名字";
45    request.displayInfo.imageUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx";
46    request.displayInfo.backgroundUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx";
47    request.displayInfo.detailImageUrlList = new ArrayList<>();
48    {
49      request.displayInfo.detailImageUrlList.add("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx");
50    };
51    request.brandId = "120344";
52    try {
53      ProductCouponEntity response = client.run(request);
54        // TODO: 请求成功，继续业务逻辑
55        System.out.println(response);
56    } catch (WXPayUtility.ApiException e) {
57        // TODO: 请求失败，根据状态码执行不同的逻辑
58        e.printStackTrace();
59    }
60  }
61
62  public ProductCouponEntity run(UpdateProductCouponRequest request) {
63    String uri = PATH;
64    uri = uri.replace("{product_coupon_id}", WXPayUtility.urlEncode(request.productCouponId));
65    String reqBody = WXPayUtility.toJson(request);
66
67    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
68    reqBuilder.addHeader("Accept", "application/json");
69    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
70    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody));
71    reqBuilder.addHeader("Content-Type", "application/json");
72    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
73    reqBuilder.method(METHOD, requestBody);
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 = WXPayUtility.extractBody(httpResponse);
80      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
81        // 2XX 成功，验证应答签名
82        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
83            httpResponse.headers(), respBody);
84
85        // 从HTTP应答报文构建返回数据
86        return WXPayUtility.fromJson(respBody, ProductCouponEntity.class);
87      } else {
88        throw new WXPayUtility.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 mchid;
96  private final String certificateSerialNo;
97  private final PrivateKey privateKey;
98  private final String wechatPayPublicKeyId;
99  private final PublicKey wechatPayPublicKey;
100
101  public UpdateProductCoupon(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
102    this.mchid = mchid;
103    this.certificateSerialNo = certificateSerialNo;
104    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
105    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
106    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
107  }
108
109  public static class UpdateProductCouponRequest {
110    @SerializedName("out_request_no")
111    public String outRequestNo;
112  
113    @SerializedName("product_coupon_id")
114    @Expose(serialize = false)
115    public String productCouponId;
116  
117    @SerializedName("display_info")
118    public ProductCouponDisplayInfo displayInfo;
119  
120    @SerializedName("brand_id")
121    public String brandId;
122  }
123  
124  public static class ProductCouponEntity {
125    @SerializedName("product_coupon_id")
126    public String productCouponId;
127  
128    @SerializedName("scope")
129    public ProductCouponScope scope;
130  
131    @SerializedName("type")
132    public ProductCouponType type;
133  
134    @SerializedName("usage_mode")
135    public UsageMode usageMode;
136  
137    @SerializedName("single_usage_info")
138    public SingleUsageInfo singleUsageInfo;
139  
140    @SerializedName("progressive_bundle_usage_info")
141    public ProgressiveBundleUsageInfo progressiveBundleUsageInfo;
142  
143    @SerializedName("display_info")
144    public ProductCouponDisplayInfo displayInfo;
145  
146    @SerializedName("out_product_no")
147    public String outProductNo;
148  
149    @SerializedName("state")
150    public ProductCouponState state;
151  
152    @SerializedName("deactivate_request_no")
153    public String deactivateRequestNo;
154  
155    @SerializedName("deactivate_time")
156    public String deactivateTime;
157  
158    @SerializedName("deactivate_reason")
159    public String deactivateReason;
160  
161    @SerializedName("brand_id")
162    public String brandId;
163  }
164  
165  public static class ProductCouponDisplayInfo {
166    @SerializedName("name")
167    public String name;
168  
169    @SerializedName("image_url")
170    public String imageUrl;
171  
172    @SerializedName("background_url")
173    public String backgroundUrl;
174  
175    @SerializedName("detail_image_url_list")
176    public List<String> detailImageUrlList;
177  
178    @SerializedName("original_price")
179    public Long originalPrice;
180  
181    @SerializedName("combo_package_list")
182    public List<ComboPackage> comboPackageList;
183  }
184  
185  public enum ProductCouponScope {
186    @SerializedName("ALL")
187    ALL,
188    @SerializedName("SINGLE")
189    SINGLE,
190    @SerializedName("CATEGORY")
191    CATEGORY
192  }
193  
194  public enum ProductCouponType {
195    @SerializedName("NORMAL")
196    NORMAL,
197    @SerializedName("DISCOUNT")
198    DISCOUNT,
199    @SerializedName("EXCHANGE")
200    EXCHANGE
201  }
202  
203  public enum UsageMode {
204    @SerializedName("SINGLE")
205    SINGLE,
206    @SerializedName("PROGRESSIVE_BUNDLE")
207    PROGRESSIVE_BUNDLE
208  }
209  
210  public static class SingleUsageInfo {
211    @SerializedName("normal_coupon")
212    public NormalCouponUsageRule normalCoupon;
213  
214    @SerializedName("discount_coupon")
215    public DiscountCouponUsageRule discountCoupon;
216  }
217  
218  public static class ProgressiveBundleUsageInfo {
219    @SerializedName("count")
220    public Long count;
221  
222    @SerializedName("interval_days")
223    public Long intervalDays;
224  }
225  
226  public enum ProductCouponState {
227    @SerializedName("AUDITING")
228    AUDITING,
229    @SerializedName("EFFECTIVE")
230    EFFECTIVE,
231    @SerializedName("DEACTIVATED")
232    DEACTIVATED
233  }
234  
235  public static class ComboPackage {
236    @SerializedName("name")
237    public String name;
238  
239    @SerializedName("pick_count")
240    public Long pickCount;
241  
242    @SerializedName("choice_list")
243    public List<ComboPackageChoice> choiceList = new ArrayList<ComboPackageChoice>();
244  }
245  
246  public static class NormalCouponUsageRule {
247    @SerializedName("threshold")
248    public Long threshold;
249  
250    @SerializedName("discount_amount")
251    public Long discountAmount;
252  }
253  
254  public static class DiscountCouponUsageRule {
255    @SerializedName("threshold")
256    public Long threshold;
257  
258    @SerializedName("percent_off")
259    public Long percentOff;
260  }
261  
262  public static class ComboPackageChoice {
263    @SerializedName("name")
264    public String name;
265  
266    @SerializedName("price")
267    public Long price;
268  
269    @SerializedName("count")
270    public Long count;
271  
272    @SerializedName("image_url")
273    public String imageUrl;
274  
275    @SerializedName("mini_program_appid")
276    public String miniProgramAppid;
277  
278    @SerializedName("mini_program_path")
279    public String miniProgramPath;
280  }
281  
282}
283

1package main
2
3import (
4	"bytes"
5	"demo/wxpay_utility" // 引用微信支付工具库，参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446
6	"encoding/json"
7	"fmt"
8	"net/http"
9	"net/url"
10	"strings"
11)
12
13func main() {
14	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
15	config, err := wxpay_utility.CreateMchConfig(
16		"19xxxxxxxx",                 // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340
17		"1DDE55AD98Exxxxxxxxxx",      // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924
18		"/path/to/apiclient_key.pem", // 商户API证书私钥文件路径，本地文件路径
19		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
20		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
21	)
22	if err != nil {
23		fmt.Println(err)
24		return
25	}
26
27	request := &UpdateProductCouponRequest{
28		OutRequestNo:    wxpay_utility.String("12345_20250101_A3489"),
29		ProductCouponId: wxpay_utility.String("1000000013"),
30		DisplayInfo: &ProductCouponDisplayInfo{
31			Name:          wxpay_utility.String("全场满100立打8折-新名字"),
32			ImageUrl:      wxpay_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"),
33			BackgroundUrl: wxpay_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"),
34			DetailImageUrlList: []string{
35				"https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx",
36			},
37		},
38		BrandId: wxpay_utility.String("120344"),
39	}
40
41	response, err := UpdateProductCoupon(config, request)
42	if err != nil {
43		fmt.Printf("请求失败: %+v\n", err)
44		// TODO: 请求失败，根据状态码执行不同的处理
45		return
46	}
47
48	// TODO: 请求成功，继续业务逻辑
49	fmt.Printf("请求成功: %+v\n", response)
50}
51
52func UpdateProductCoupon(config *wxpay_utility.MchConfig, request *UpdateProductCouponRequest) (response *ProductCouponEntity, err error) {
53	const (
54		host   = "https://api.mch.weixin.qq.com"
55		method = "PATCH"
56		path   = "/v3/marketing/partner/product-coupon/product-coupons/{product_coupon_id}"
57	)
58
59	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
60	if err != nil {
61		return nil, err
62	}
63	reqUrl.Path = strings.Replace(reqUrl.Path, "{product_coupon_id}", url.PathEscape(*request.ProductCouponId), -1)
64	reqBody, err := json.Marshal(request)
65	if err != nil {
66		return nil, err
67	}
68	httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody))
69	if err != nil {
70		return nil, err
71	}
72	httpRequest.Header.Set("Accept", "application/json")
73	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
74	httpRequest.Header.Set("Content-Type", "application/json")
75	authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody)
76	if err != nil {
77		return nil, err
78	}
79	httpRequest.Header.Set("Authorization", authorization)
80
81	client := &http.Client{}
82	httpResponse, err := client.Do(httpRequest)
83	if err != nil {
84		return nil, err
85	}
86	respBody, err := wxpay_utility.ExtractResponseBody(httpResponse)
87	if err != nil {
88		return nil, err
89	}
90	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
91		// 2XX 成功，验证应答签名
92		err = wxpay_utility.ValidateResponse(
93			config.WechatPayPublicKeyId(),
94			config.WechatPayPublicKey(),
95			&httpResponse.Header,
96			respBody,
97		)
98		if err != nil {
99			return nil, err
100		}
101		response := &ProductCouponEntity{}
102		if err := json.Unmarshal(respBody, response); err != nil {
103			return nil, err
104		}
105
106		return response, nil
107	} else {
108		return nil, wxpay_utility.NewApiException(
109			httpResponse.StatusCode,
110			httpResponse.Header,
111			respBody,
112		)
113	}
114}
115
116type UpdateProductCouponRequest struct {
117	OutRequestNo    *string                   `json:"out_request_no,omitempty"`
118	ProductCouponId *string                   `json:"product_coupon_id,omitempty"`
119	DisplayInfo     *ProductCouponDisplayInfo `json:"display_info,omitempty"`
120	BrandId         *string                   `json:"brand_id,omitempty"`
121}
122
123func (o *UpdateProductCouponRequest) MarshalJSON() ([]byte, error) {
124	type Alias UpdateProductCouponRequest
125	a := &struct {
126		ProductCouponId *string `json:"product_coupon_id,omitempty"`
127		*Alias
128	}{
129		// 序列化时移除非 Body 字段
130		ProductCouponId: nil,
131		Alias:           (*Alias)(o),
132	}
133	return json.Marshal(a)
134}
135
136type ProductCouponEntity struct {
137	ProductCouponId            *string                     `json:"product_coupon_id,omitempty"`
138	Scope                      *ProductCouponScope         `json:"scope,omitempty"`
139	Type                       *ProductCouponType          `json:"type,omitempty"`
140	UsageMode                  *UsageMode                  `json:"usage_mode,omitempty"`
141	SingleUsageInfo            *SingleUsageInfo            `json:"single_usage_info,omitempty"`
142	ProgressiveBundleUsageInfo *ProgressiveBundleUsageInfo `json:"progressive_bundle_usage_info,omitempty"`
143	DisplayInfo                *ProductCouponDisplayInfo   `json:"display_info,omitempty"`
144	OutProductNo               *string                     `json:"out_product_no,omitempty"`
145	State                      *ProductCouponState         `json:"state,omitempty"`
146	DeactivateRequestNo        *string                     `json:"deactivate_request_no,omitempty"`
147	DeactivateTime             *string                     `json:"deactivate_time,omitempty"`
148	DeactivateReason           *string                     `json:"deactivate_reason,omitempty"`
149	BrandId                    *string                     `json:"brand_id,omitempty"`
150}
151
152type ProductCouponDisplayInfo struct {
153	Name               *string        `json:"name,omitempty"`
154	ImageUrl           *string        `json:"image_url,omitempty"`
155	BackgroundUrl      *string        `json:"background_url,omitempty"`
156	DetailImageUrlList []string       `json:"detail_image_url_list,omitempty"`
157	OriginalPrice      *int64         `json:"original_price,omitempty"`
158	ComboPackageList   []ComboPackage `json:"combo_package_list,omitempty"`
159}
160
161type ProductCouponScope string
162
163func (e ProductCouponScope) Ptr() *ProductCouponScope {
164	return &e
165}
166
167const (
168	PRODUCTCOUPONSCOPE_ALL      ProductCouponScope = "ALL"
169	PRODUCTCOUPONSCOPE_SINGLE   ProductCouponScope = "SINGLE"
170	PRODUCTCOUPONSCOPE_CATEGORY ProductCouponScope = "CATEGORY"
171)
172
173type ProductCouponType string
174
175func (e ProductCouponType) Ptr() *ProductCouponType {
176	return &e
177}
178
179const (
180	PRODUCTCOUPONTYPE_NORMAL   ProductCouponType = "NORMAL"
181	PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT"
182	PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE"
183)
184
185type UsageMode string
186
187func (e UsageMode) Ptr() *UsageMode {
188	return &e
189}
190
191const (
192	USAGEMODE_SINGLE             UsageMode = "SINGLE"
193	USAGEMODE_PROGRESSIVE_BUNDLE UsageMode = "PROGRESSIVE_BUNDLE"
194)
195
196type SingleUsageInfo struct {
197	NormalCoupon   *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
198	DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
199}
200
201type ProgressiveBundleUsageInfo struct {
202	Count        *int64 `json:"count,omitempty"`
203	IntervalDays *int64 `json:"interval_days,omitempty"`
204}
205
206type ProductCouponState string
207
208func (e ProductCouponState) Ptr() *ProductCouponState {
209	return &e
210}
211
212const (
213	PRODUCTCOUPONSTATE_AUDITING    ProductCouponState = "AUDITING"
214	PRODUCTCOUPONSTATE_EFFECTIVE   ProductCouponState = "EFFECTIVE"
215	PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED"
216)
217
218type ComboPackage struct {
219	Name       *string              `json:"name,omitempty"`
220	PickCount  *int64               `json:"pick_count,omitempty"`
221	ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"`
222}
223
224type NormalCouponUsageRule struct {
225	Threshold      *int64 `json:"threshold,omitempty"`
226	DiscountAmount *int64 `json:"discount_amount,omitempty"`
227}
228
229type DiscountCouponUsageRule struct {
230	Threshold  *int64 `json:"threshold,omitempty"`
231	PercentOff *int64 `json:"percent_off,omitempty"`
232}
233
234type ComboPackageChoice struct {
235	Name             *string `json:"name,omitempty"`
236	Price            *int64  `json:"price,omitempty"`
237	Count            *int64  `json:"count,omitempty"`
238	ImageUrl         *string `json:"image_url,omitempty"`
239	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
240	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
241}
242