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

更新时间:2025.09.02

品牌方可以通过本接口查询已经发放给用户的特定状态的商品券

前置条件:已经给用户发券成功

频率限制:500/s

接口说明

支持商户:【普通服务商】

请求方式:【GET】/v3/marketing/partner/product-coupon/users/{openid}/coupons

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header  HTTP头参数

 Authorization  必填 string

请参考签名认证生成认证信息


 Accept  必填 string

请设置为application/json


path  路径参数

 openid  必填   string

【用户OpenID】 OpenID信息,用户在AppID下的唯一标识,获取方式参考OpenID


query  查询参数

 product_coupon_id  选填   string

【商品券ID】 商品券的唯一标识,创建商品券时由微信支付生成。查询指定商品券下的用户商品券列表,不传入时查询范围扩大至品牌下的所有商品券


 stock_id  选填   string

【批次ID】 商品券批次的唯一标识,商品券批次创建时由微信支付生成(可使用【创建商品券API】或【添加商品券批次API】创建)。查询指定商品券批次下的用户商品券列表。


 appid  必填   string

【公众账号ID】 公众账号ID也称AppID,是(微信开放平台、微信公众平台)为开发者提供的一个唯一标识,用于识别开发者的应用程序(APP、小程序、公众号)。 开发者需要先在微信开放平台或微信公众平台中申请ID,然后在服务商平台中绑定,详见服务商商户号与AppID账号关联管理


 coupon_state  选填   string

【用户商品券状态】 查询指定状态的用户商品券

可选取值

  • CONFIRMING:  待确认,用户商品券发放需要品牌方调用【确认发放用户商品券API】后才能生效

  • PENDING:  已发放待生效,用户商品券已发放成功但尚未到达可用开始时间

  • EFFECTIVE:  已生效,用户商品券已成功发放且到达可用开始时间

  • USED:  已核销,用户商品券已核销

  • EXPIRED:  已过期,用户商品券已超过有效期,不再可用

  • DELETED:  已删除,用户主动删除该券

  • DEACTIVATED:  已失效,品牌方主动调用【失效用户商品券API】或【失效用户商品券组API】使用户商品券失效


 user_coupon_bundle_id  选填   string

【用户券组ID】 用户券组的唯一标识,【向用户发放商品券批次组】时由微信支付生成,用于查询特定用户券组内的券


 page_size  选填   integer

【分页大小】 单次拉取的数据条数上限,不填默认为20,最大值50


 page_token  选填   string

【分页Token】 分页查询时,需要传入上一次调用返回的 next_page_token,首次调用不填


 brand_id  必填   string

【品牌ID】 微信支付为品牌方分配的唯一标识,该品牌应与服务商存在授权关系

请求示例

curl
Java
Go

GET

查询用户在某个批次下的券列表

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/partner/product-coupon/users/oh-394z-6CGkNoJrsDLTTUKiAnp4/coupons?product_coupon_id=1000000013&stock_id=1000000013001&appid=wx233544546545989&page_size=10&brand_id=120344 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

 total_count  必填   integer

【总个数】 满足条件的数据总条数,当且仅当 page_token 为空时提供。


 user_coupon_list  选填   array[object]

【用户商品券列表】 指定状态的用户商品券列表信息

属性

 next_page_token  选填   string(100)

【下一页Token】 分页查询时,如果还有更多数据,会返回下一页的Token,请在下一次查询时设置在 page_token 中;如果已无更多数据,则不返回此字段。

应答示例

200 OK

查询用户在某个批次下的券列表

1{
2  "total_count" : 1,
3  "user_coupon_list" : [
4    {
5      "coupon_code" : "Code_123456",
6      "coupon_state" : "EFFECTIVE",
7      "valid_begin_time" : "2025-08-02T00:00:00+08:00",
8      "valid_end_time" : "2025-08-31T23:59:59+08:00",
9      "receive_time" : "2025-08-02T00:00:00+08:00",
10      "send_request_no" : "MCHSEND202003101234",
11      "send_channel" : "API",
12      "confirm_request_no" : "MCHCONFIRM202003101234",
13      "confirm_time" : "2025-08-02T00:00:05+08:00",
14      "single_usage_detail" : { },
15      "product_coupon" : {
16        "product_coupon_id" : "1000000013",
17        "scope" : "ALL",
18        "type" : "DISCOUNT",
19        "usage_mode" : "SINGLE",
20        "single_usage_info" : {
21          "discount_coupon" : {
22            "threshold" : 10000,
23            "percent_off" : 20
24          }
25        },
26        "display_info" : {
27          "name" : "全场满100立打8折-新名字",
28          "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx",
29          "background_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx",
30          "detail_image_url_list" : [
31            "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"
32          ]
33        },
34        "state" : "EFFECTIVE",
35        "out_product_no" : "Product_1234567890",
36        "brand_id" : "120344"
37      },
38      "stock" : {
39        "product_coupon_id" : "1000000013",
40        "stock_id" : "1000000013001",
41        "remark" : "8月工作日有效批次",
42        "coupon_code_mode" : "UPLOAD",
43        "coupon_code_count_info" : {
44          "total_count" : 0,
45          "available_count" : 0
46        },
47        "stock_send_rule" : {
48          "max_count" : 10000000,
49          "max_count_per_user" : 1
50        },
51        "single_usage_rule" : {
52          "coupon_available_period" : {
53            "available_begin_time" : "2025-08-01T00:00:00+08:00",
54            "available_end_time" : "2025-08-31T23:59:59+08:00",
55            "available_days" : 30,
56            "weekly_available_period" : {
57              "day_list" : [
58                "MONDAY",
59                "TUESDAY",
60                "WEDNESDAY",
61                "THURSDAY",
62                "FRIDAY"
63              ]
64            }
65          }
66        },
67        "usage_rule_display_info" : {
68          "coupon_usage_method_list" : [
69            "OFFLINE",
70            "MINI_PROGRAM",
71            "PAYMENT_CODE"
72          ],
73          "mini_program_appid" : "wx1234567890",
74          "mini_program_path" : "/pages/index/product",
75          "usage_description" : "工作日可用",
76          "coupon_available_store_info" : {
77            "description" : "所有门店可用,可使用小程序查看门店列表",
78            "mini_program_appid" : "wx1234567890",
79            "mini_program_path" : "/pages/index/store-list"
80          }
81        },
82        "coupon_display_info" : {
83          "code_display_mode" : "QRCODE",
84          "background_color" : "Color010",
85          "entrance_mini_program" : {
86            "appid" : "wx1234567890",
87            "path" : "/pages/index/product",
88            "entrance_wording" : "欢迎选购",
89            "guidance_wording" : "获取更多优惠"
90          },
91          "entrance_official_account" : {
92            "appid" : "wx1234567890"
93          },
94          "entrance_finder" : {
95            "finder_id" : "gh_12345678",
96            "finder_video_id" : "UDFsdf24df34dD456Hdf34",
97            "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"
98          }
99        },
100        "notify_config" : {
101          "notify_appid" : "wx4fd12345678"
102        },
103        "store_scope" : "NONE",
104        "sent_count_info" : {
105          "total_count" : 0,
106          "today_count" : 0
107        },
108        "state" : "SENDING",
109        "brand_id" : "120344"
110      },
111      "attach" : "any attach content",
112      "brand_id" : "120344"
113    }
114  ]
115}
116

 

错误码

以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

400

INVALID_REQUEST

传入参数不符合业务规则

请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足

404

NOT_FOUND

未找到 product_coupon_id 对应的商品券

请确认 product_coupon_id 存在且属于当前品牌

404

NOT_FOUND

未找到 stock_id 对应的商品券批次

请确认 stock_id 存在且属于当前商品券

429

RATELIMIT_EXCEEDED

请求超过接口频率限制

请稍后使用原参数重试

 

元宝AI
反馈
目录
置顶