查询品牌门店列表

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/brand/partner/store/brandstores?brand_id=123456789&store_state=OPEN&offset=100&limit=20 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

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 ListBrandStores {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/v3/brand/partner/store/brandstores";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    ListBrandStores client = new ListBrandStores(
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    ListBrandStoresRequest request = new ListBrandStoresRequest();
41    request.brandId = "123456789";
42    request.storeState = StoreState.OPEN;
43    request.offset = 100L;
44    request.limit = 20L;
45    try {
46      BrandStoresListResponse response = client.run(request);
47        // TODO: 请求成功，继续业务逻辑
48        System.out.println(response);
49    } catch (WXPayUtility.ApiException e) {
50        // TODO: 请求失败，根据状态码执行不同的逻辑
51        e.printStackTrace();
52    }
53  }
54
55  public BrandStoresListResponse run(ListBrandStoresRequest request) {
56    String uri = PATH;
57    Map<String, Object> args = new HashMap<>();
58    args.put("brand_id", request.brandId);
59    args.put("store_state", request.storeState);
60    args.put("offset", request.offset);
61    args.put("limit", request.limit);
62    String queryString = WXPayUtility.urlEncode(args);
63    if (!queryString.isEmpty()) {
64        uri = uri + "?" + queryString;
65    }
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, null));
71    reqBuilder.method(METHOD, null);
72    Request httpRequest = reqBuilder.build();
73
74    // 发送HTTP请求
75    OkHttpClient client = new OkHttpClient.Builder().build();
76    try (Response httpResponse = client.newCall(httpRequest).execute()) {
77      String respBody = WXPayUtility.extractBody(httpResponse);
78      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
79        // 2XX 成功，验证应答签名
80        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
81            httpResponse.headers(), respBody);
82
83        // 从HTTP应答报文构建返回数据
84        return WXPayUtility.fromJson(respBody, BrandStoresListResponse.class);
85      } else {
86        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
87      }
88    } catch (IOException e) {
89      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
90    }
91  }
92
93  private final String mchid;
94  private final String certificateSerialNo;
95  private final PrivateKey privateKey;
96  private final String wechatPayPublicKeyId;
97  private final PublicKey wechatPayPublicKey;
98
99  public ListBrandStores(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
100    this.mchid = mchid;
101    this.certificateSerialNo = certificateSerialNo;
102    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
103    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
104    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
105  }
106
107  public static class ListBrandStoresRequest {
108    @SerializedName("brand_id")
109    @Expose(serialize = false)
110    public String brandId;
111  
112    @SerializedName("offset")
113    @Expose(serialize = false)
114    public Long offset;
115  
116    @SerializedName("limit")
117    @Expose(serialize = false)
118    public Long limit;
119  
120    @SerializedName("store_state")
121    @Expose(serialize = false)
122    public StoreState storeState;
123  }
124  
125  public static class BrandStoresListResponse {
126    @SerializedName("brand_id")
127    public String brandId;
128  
129    @SerializedName("data")
130    public List<BrandStoresEntity> data;
131  
132    @SerializedName("offset")
133    public Long offset;
134  
135    @SerializedName("limit")
136    public Long limit;
137  
138    @SerializedName("total_count")
139    public Long totalCount;
140  }
141  
142  public enum StoreState {
143    @SerializedName("OPEN")
144    OPEN,
145    @SerializedName("CREATING")
146    CREATING,
147    @SerializedName("CLOSED")
148    CLOSED
149  }
150  
151  public static class BrandStoresEntity {
152    @SerializedName("brand_id")
153    public String brandId;
154  
155    @SerializedName("store_id")
156    public String storeId;
157  
158    @SerializedName("store_state")
159    public StoreState storeState;
160  
161    @SerializedName("audit_state")
162    public AuditState auditState;
163  
164    @SerializedName("review_reject_reason")
165    public String reviewRejectReason;
166  
167    @SerializedName("store_basics")
168    public StoreBase storeBasics;
169  
170    @SerializedName("store_address")
171    public StoreLocation storeAddress;
172  
173    @SerializedName("store_business")
174    public StoreBusiness storeBusiness;
175  
176    @SerializedName("store_recipient")
177    public List<StoreRecipient> storeRecipient;
178  }
179  
180  public enum AuditState {
181    @SerializedName("SUCCESS")
182    SUCCESS,
183    @SerializedName("PROCESSING")
184    PROCESSING,
185    @SerializedName("REJECTED")
186    REJECTED
187  }
188  
189  public static class StoreBase {
190    @SerializedName("store_reference_id")
191    public String storeReferenceId;
192  
193    @SerializedName("branch_name")
194    public String branchName;
195  }
196  
197  public static class StoreLocation {
198    @SerializedName("address_code")
199    public String addressCode;
200  
201    @SerializedName("address_detail")
202    public String addressDetail;
203  
204    @SerializedName("address_complements")
205    public String addressComplements;
206  
207    @SerializedName("longitude")
208    public String longitude;
209  
210    @SerializedName("latitude")
211    public String latitude;
212  }
213  
214  public static class StoreBusiness {
215    @SerializedName("service_phone")
216    public String servicePhone;
217  
218    @SerializedName("business_hours")
219    public String businessHours;
220  }
221  
222  public static class StoreRecipient {
223    @SerializedName("mchid")
224    public String mchid;
225  
226    @SerializedName("company_name")
227    public String companyName;
228  
229    @SerializedName("recipient_state")
230    public RecipientState recipientState;
231  }
232  
233  public enum RecipientState {
234    @SerializedName("CONFIRMED")
235    CONFIRMED,
236    @SerializedName("ADMIN_REJECTED")
237    ADMIN_REJECTED,
238    @SerializedName("CONFIRMING")
239    CONFIRMING,
240    @SerializedName("TIMEOUT_REJECTED")
241    TIMEOUT_REJECTED
242  }
243  
244}
245

1package main
2
3import (
4	"demo/wxpay_utility" // 引用微信支付工具库，参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446
5	"encoding/json"
6	"fmt"
7	"net/http"
8	"net/url"
9)
10
11func main() {
12	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
13	config, err := wxpay_utility.CreateMchConfig(
14		"19xxxxxxxx",                 // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340
15		"1DDE55AD98Exxxxxxxxxx",      // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924
16		"/path/to/apiclient_key.pem", // 商户API证书私钥文件路径，本地文件路径
17		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
18		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
19	)
20	if err != nil {
21		fmt.Println(err)
22		return
23	}
24
25	request := &ListBrandStoresRequest{
26		BrandId:    wxpay_utility.String("123456789"),
27		StoreState: STORESTATE_OPEN.Ptr(),
28		Offset:     wxpay_utility.Int64(100),
29		Limit:      wxpay_utility.Int64(20),
30	}
31
32	response, err := ListBrandStores(config, request)
33	if err != nil {
34		fmt.Printf("请求失败: %+v\n", err)
35		// TODO: 请求失败，根据状态码执行不同的处理
36		return
37	}
38
39	// TODO: 请求成功，继续业务逻辑
40	fmt.Printf("请求成功: %+v\n", response)
41}
42
43func ListBrandStores(config *wxpay_utility.MchConfig, request *ListBrandStoresRequest) (response *BrandStoresListResponse, err error) {
44	const (
45		host   = "https://api.mch.weixin.qq.com"
46		method = "GET"
47		path   = "/v3/brand/partner/store/brandstores"
48	)
49
50	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
51	if err != nil {
52		return nil, err
53	}
54	query := reqUrl.Query()
55	if request.BrandId != nil {
56		query.Add("brand_id", *request.BrandId)
57	}
58	if request.StoreState != nil {
59		query.Add("store_state", fmt.Sprintf("%v", *request.StoreState))
60	}
61	if request.Offset != nil {
62		query.Add("offset", fmt.Sprintf("%v", *request.Offset))
63	}
64	if request.Limit != nil {
65		query.Add("limit", fmt.Sprintf("%v", *request.Limit))
66	}
67	reqUrl.RawQuery = query.Encode()
68	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
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	authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
75	if err != nil {
76		return nil, err
77	}
78	httpRequest.Header.Set("Authorization", authorization)
79
80	client := &http.Client{}
81	httpResponse, err := client.Do(httpRequest)
82	if err != nil {
83		return nil, err
84	}
85	respBody, err := wxpay_utility.ExtractResponseBody(httpResponse)
86	if err != nil {
87		return nil, err
88	}
89	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
90		// 2XX 成功，验证应答签名
91		err = wxpay_utility.ValidateResponse(
92			config.WechatPayPublicKeyId(),
93			config.WechatPayPublicKey(),
94			&httpResponse.Header,
95			respBody,
96		)
97		if err != nil {
98			return nil, err
99		}
100		response := &BrandStoresListResponse{}
101		if err := json.Unmarshal(respBody, response); err != nil {
102			return nil, err
103		}
104
105		return response, nil
106	} else {
107		return nil, wxpay_utility.NewApiException(
108			httpResponse.StatusCode,
109			httpResponse.Header,
110			respBody,
111		)
112	}
113}
114
115type ListBrandStoresRequest struct {
116	BrandId    *string     `json:"brand_id,omitempty"`
117	Offset     *int64      `json:"offset,omitempty"`
118	Limit      *int64      `json:"limit,omitempty"`
119	StoreState *StoreState `json:"store_state,omitempty"`
120}
121
122func (o *ListBrandStoresRequest) MarshalJSON() ([]byte, error) {
123	type Alias ListBrandStoresRequest
124	a := &struct {
125		BrandId    *string     `json:"brand_id,omitempty"`
126		Offset     *int64      `json:"offset,omitempty"`
127		Limit      *int64      `json:"limit,omitempty"`
128		StoreState *StoreState `json:"store_state,omitempty"`
129		*Alias
130	}{
131		// 序列化时移除非 Body 字段
132		BrandId:    nil,
133		Offset:     nil,
134		Limit:      nil,
135		StoreState: nil,
136		Alias:      (*Alias)(o),
137	}
138	return json.Marshal(a)
139}
140
141type BrandStoresListResponse struct {
142	BrandId    *string             `json:"brand_id,omitempty"`
143	Data       []BrandStoresEntity `json:"data,omitempty"`
144	Offset     *int64              `json:"offset,omitempty"`
145	Limit      *int64              `json:"limit,omitempty"`
146	TotalCount *int64              `json:"total_count,omitempty"`
147}
148
149type StoreState string
150
151func (e StoreState) Ptr() *StoreState {
152	return &e
153}
154
155const (
156	STORESTATE_OPEN     StoreState = "OPEN"
157	STORESTATE_CREATING StoreState = "CREATING"
158	STORESTATE_CLOSED   StoreState = "CLOSED"
159)
160
161type BrandStoresEntity struct {
162	BrandId            *string          `json:"brand_id,omitempty"`
163	StoreId            *string          `json:"store_id,omitempty"`
164	StoreState         *StoreState      `json:"store_state,omitempty"`
165	AuditState         *AuditState      `json:"audit_state,omitempty"`
166	ReviewRejectReason *string          `json:"review_reject_reason,omitempty"`
167	StoreBasics        *StoreBase       `json:"store_basics,omitempty"`
168	StoreAddress       *StoreLocation   `json:"store_address,omitempty"`
169	StoreBusiness      *StoreBusiness   `json:"store_business,omitempty"`
170	StoreRecipient     []StoreRecipient `json:"store_recipient,omitempty"`
171}
172
173type AuditState string
174
175func (e AuditState) Ptr() *AuditState {
176	return &e
177}
178
179const (
180	AUDITSTATE_SUCCESS    AuditState = "SUCCESS"
181	AUDITSTATE_PROCESSING AuditState = "PROCESSING"
182	AUDITSTATE_REJECTED   AuditState = "REJECTED"
183)
184
185type StoreBase struct {
186	StoreReferenceId *string `json:"store_reference_id,omitempty"`
187	BranchName       *string `json:"branch_name,omitempty"`
188}
189
190type StoreLocation struct {
191	AddressCode        *string `json:"address_code,omitempty"`
192	AddressDetail      *string `json:"address_detail,omitempty"`
193	AddressComplements *string `json:"address_complements,omitempty"`
194	Longitude          *string `json:"longitude,omitempty"`
195	Latitude           *string `json:"latitude,omitempty"`
196}
197
198type StoreBusiness struct {
199	ServicePhone  *string `json:"service_phone,omitempty"`
200	BusinessHours *string `json:"business_hours,omitempty"`
201}
202
203type StoreRecipient struct {
204	Mchid          *string         `json:"mchid,omitempty"`
205	CompanyName    *string         `json:"company_name,omitempty"`
206	RecipientState *RecipientState `json:"recipient_state,omitempty"`
207}
208
209type RecipientState string
210
211func (e RecipientState) Ptr() *RecipientState {
212	return &e
213}
214
215const (
216	RECIPIENTSTATE_CONFIRMED        RecipientState = "CONFIRMED"
217	RECIPIENTSTATE_ADMIN_REJECTED   RecipientState = "ADMIN_REJECTED"
218	RECIPIENTSTATE_CONFIRMING       RecipientState = "CONFIRMING"
219	RECIPIENTSTATE_TIMEOUT_REJECTED RecipientState = "TIMEOUT_REJECTED"
220)
221