获取活动指定商品列表
更新时间:2024.09.02使用场景:商户创建活动后,可以通过该接口查询支付有礼的活动指定商品,用于管理活动。
可调用商户:商户/服务商/渠道商
接口说明
支持商户:【普通商户】
请求方式:【GET】/v3/marketing/paygiftactivity/activities/{activity_id}/goods
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
activity_id 必填 string(20)
【活动Id】活动Id
query 查询参数
offset 选填 integer
【分页页码】分页页码
limit 选填 integer
【分页大小】分页大小
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/marketing/paygiftactivity/activities/10028001/goods?offset=1&limit=20 \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" 5
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/merchant/4014931831 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 ListActivitySku { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/marketing/paygiftactivity/activities/{activity_id}/goods"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 32 ListActivitySku client = new ListActivitySku( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 ListActivitySkuRequest request = new ListActivitySkuRequest(); 41 request.activityId = "10028001"; 42 request.offset = 1L; 43 request.limit = 1L; 44 try { 45 ListActSkuResponse response = client.run(request); 46 // TODO: 请求成功,继续业务逻辑 47 System.out.println(response); 48 } catch (WXPayUtility.ApiException e) { 49 // TODO: 请求失败,根据状态码执行不同的逻辑 50 e.printStackTrace(); 51 } 52 } 53 54 public ListActSkuResponse run(ListActivitySkuRequest request) { 55 String uri = PATH; 56 uri = uri.replace("{activity_id}", WXPayUtility.urlEncode(request.activityId)); 57 Map<String, Object> args = new HashMap<>(); 58 args.put("offset", request.offset); 59 args.put("limit", request.limit); 60 String queryString = WXPayUtility.urlEncode(args); 61 if (!queryString.isEmpty()) { 62 uri = uri + "?" + queryString; 63 } 64 65 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 66 reqBuilder.addHeader("Accept", "application/json"); 67 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 68 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 69 reqBuilder.method(METHOD, null); 70 Request httpRequest = reqBuilder.build(); 71 72 // 发送HTTP请求 73 OkHttpClient client = new OkHttpClient.Builder().build(); 74 try (Response httpResponse = client.newCall(httpRequest).execute()) { 75 String respBody = WXPayUtility.extractBody(httpResponse); 76 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 77 // 2XX 成功,验证应答签名 78 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 79 httpResponse.headers(), respBody); 80 81 // 从HTTP应答报文构建返回数据 82 return WXPayUtility.fromJson(respBody, ListActSkuResponse.class); 83 } else { 84 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 85 } 86 } catch (IOException e) { 87 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 88 } 89 } 90 91 private final String mchid; 92 private final String certificateSerialNo; 93 private final PrivateKey privateKey; 94 private final String wechatPayPublicKeyId; 95 private final PublicKey wechatPayPublicKey; 96 97 public ListActivitySku(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 98 this.mchid = mchid; 99 this.certificateSerialNo = certificateSerialNo; 100 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 101 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 102 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 103 } 104 105 public static class ListActivitySkuRequest { 106 @SerializedName("activity_id") 107 @Expose(serialize = false) 108 public String activityId; 109 110 @SerializedName("offset") 111 @Expose(serialize = false) 112 public Long offset; 113 114 @SerializedName("limit") 115 @Expose(serialize = false) 116 public Long limit; 117 } 118 119 public static class ListActSkuResponse { 120 @SerializedName("data") 121 public List<SkuInfo> data; 122 123 @SerializedName("total_count") 124 public Long totalCount; 125 126 @SerializedName("offset") 127 public Long offset; 128 129 @SerializedName("limit") 130 public Long limit; 131 132 @SerializedName("activity_id") 133 public String activityId; 134 } 135 136 public static class SkuInfo { 137 @SerializedName("goods_id") 138 public String goodsId; 139 140 @SerializedName("create_time") 141 public String createTime; 142 143 @SerializedName("update_time") 144 public String updateTime; 145 } 146 147} 148
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/merchant/4015119334 5 "encoding/json" 6 "fmt" 7 "net/http" 8 "net/url" 9 "strings" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &ListActivitySkuRequest{ 27 ActivityId: wxpay_utility.String("10028001"), 28 Offset: wxpay_utility.Int64(1), 29 Limit: wxpay_utility.Int64(20), 30 } 31 32 response, err := ListActivitySku(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 ListActivitySku(config *wxpay_utility.MchConfig, request *ListActivitySkuRequest) (response *ListActSkuResponse, err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "GET" 47 path = "/v3/marketing/paygiftactivity/activities/{activity_id}/goods" 48 ) 49 50 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 51 if err != nil { 52 return nil, err 53 } 54 reqUrl.Path = strings.Replace(reqUrl.Path, "{activity_id}", url.PathEscape(*request.ActivityId), -1) 55 query := reqUrl.Query() 56 if request.Offset != nil { 57 query.Add("offset", fmt.Sprintf("%v", *request.Offset)) 58 } 59 if request.Limit != nil { 60 query.Add("limit", fmt.Sprintf("%v", *request.Limit)) 61 } 62 reqUrl.RawQuery = query.Encode() 63 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 64 if err != nil { 65 return nil, err 66 } 67 httpRequest.Header.Set("Accept", "application/json") 68 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 69 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 70 if err != nil { 71 return nil, err 72 } 73 httpRequest.Header.Set("Authorization", authorization) 74 75 client := &http.Client{} 76 httpResponse, err := client.Do(httpRequest) 77 if err != nil { 78 return nil, err 79 } 80 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 81 if err != nil { 82 return nil, err 83 } 84 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 85 // 2XX 成功,验证应答签名 86 err = wxpay_utility.ValidateResponse( 87 config.WechatPayPublicKeyId(), 88 config.WechatPayPublicKey(), 89 &httpResponse.Header, 90 respBody, 91 ) 92 if err != nil { 93 return nil, err 94 } 95 response := &ListActSkuResponse{} 96 if err := json.Unmarshal(respBody, response); err != nil { 97 return nil, err 98 } 99 100 return response, nil 101 } else { 102 return nil, wxpay_utility.NewApiException( 103 httpResponse.StatusCode, 104 httpResponse.Header, 105 respBody, 106 ) 107 } 108} 109 110type ListActivitySkuRequest struct { 111 ActivityId *string `json:"activity_id,omitempty"` 112 Offset *int64 `json:"offset,omitempty"` 113 Limit *int64 `json:"limit,omitempty"` 114} 115 116func (o *ListActivitySkuRequest) MarshalJSON() ([]byte, error) { 117 type Alias ListActivitySkuRequest 118 a := &struct { 119 ActivityId *string `json:"activity_id,omitempty"` 120 Offset *int64 `json:"offset,omitempty"` 121 Limit *int64 `json:"limit,omitempty"` 122 *Alias 123 }{ 124 // 序列化时移除非 Body 字段 125 ActivityId: nil, 126 Offset: nil, 127 Limit: nil, 128 Alias: (*Alias)(o), 129 } 130 return json.Marshal(a) 131} 132 133type ListActSkuResponse struct { 134 Data []SkuInfo `json:"data,omitempty"` 135 TotalCount *int64 `json:"total_count,omitempty"` 136 Offset *int64 `json:"offset,omitempty"` 137 Limit *int64 `json:"limit,omitempty"` 138 ActivityId *string `json:"activity_id,omitempty"` 139} 140 141type SkuInfo struct { 142 GoodsId *string `json:"goods_id,omitempty"` 143 CreateTime *string `json:"create_time,omitempty"` 144 UpdateTime *string `json:"update_time,omitempty"` 145} 146
应答参数
|
data 选填 array[object]
【结果集】商品信息列表(sku信息列表)
属性 | |
goods_id 必填 string 【指定商品】指定商品(商品sku) create_time 必填 string 【创建时间】创建时间 update_time 必填 string 【更新时间】更新时间 |
total_count 必填 integer
【总数量】
offset 必填 integer
【分页页码】分页页码
limit 必填 integer
【分页大小】分页大小
activity_id 必填 string
【活动ID】活动ID
应答示例
200 OK
1{ 2 "data" : [ 3 { 4 "goods_id" : "0345678", 5 "create_time" : "2015-05-20T13:29:35.120+08:00", 6 "update_time" : "2015-05-20T13:29:35.120+08:00" 7 } 8 ], 9 "total_count" : 24, 10 "offset" : 4, 11 "limit" : 20, 12 "activity_id" : "10028001" 13} 14
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | AppID与MchID不匹配 | 请确认AppID是否正确填写 |
400 | INVALID_REQUEST | 请求参数符合参数格式,但不符合业务规则 | 根据错误提示,传入符合业务规则的参数 |
400 | MCH_NOT_EXISTS | 商户号不存在 | 请确认发券商户号信息是否有误 |
401 | SIGN_ERROR | 签名错误或签名信息不完整 | 登录商户平台核对,传入正确信息 |
403 | NO_AUTH | 商户未被授权 | 登录商户平台核对,传入正确信息 |
404 | RESOURCE_NOT_EXISTS | 资源不存在或无可用 | 请确认资源均存在且可用 |
429 | FREQUENCY_LIMITED | 频率超限 | 请求量不要超过接口调用频率限制 |
500 | SYSTEM_ERROR | 系统错误 | 请使用相同参数稍后重新调用 |