查询用户商品券详情

更新时间:2025.09.02

品牌方可以通过本接口查询已经发放给用户的商品券详情

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

频率限制:500/s

接口说明

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

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

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

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

请求参数

Header  HTTP头参数

 Authorization  必填 string

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


 Accept  必填 string

请设置为application/json


path  路径参数

 coupon_code  必填   string(40)

【用户商品券Code】 券的唯一标识


 openid  必填   string

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


query  查询参数

 product_coupon_id  必填   string

【商品券ID】 商品券的唯一标识,创建商品券时由微信支付生成


 stock_id  必填   string

【批次ID】 商品券批次的唯一标识,商品券批次创建时由微信支付生成(可使用创建商品券添加商品券批次创建),请确保该批次属于 product_coupon_id 对应的商品券


 appid  必填   string

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


 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/Code_123456?product_coupon_id=1000000013&stock_id=1000000013001&appid=wx233544546545989&brand_id=120344 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

 coupon_code  必填   string(40)

【用户商品券Code】 用户商品券的唯一标识


 coupon_state  必填   string

【用户商品券状态】 

可选取值

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

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

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

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

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

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

  • DEACTIVATED:  已失效,品牌方主动调用失效用户商品券接口使用户商品券失效


 valid_begin_time  必填   string

【有效期开始时间】 用户商品券可用开始时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)


 valid_end_time  必填   string

【有效期结束时间】 用户商品券可用结束时间。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)


 receive_time  必填   string

【领券时间】 用户领券时间。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)


 send_request_no  必填   string(128)

【发券请求单号】 发券时传入的请求流水号


 send_channel  必填   string

【发券渠道】 描述用户商品券是经由什么渠道发送的

可选取值

  • BRAND_MANAGE:  摇一摇有优惠,通过摇一摇有优惠渠道发放

  • API:  服务商自主发券,服务商通过发券接口自主发券到商家名片

  • RECEIVE_COMPONENT:  小程序领券组件,服务商通过小程序领券组件发券


 confirm_request_no  选填   string

【确认请求单号】 品牌方确认发券请求时传入的的请求流水号。当且仅当 品牌方调用确认发放用户商品券接口后提供。


 confirm_time  选填   string

【确认发放时间】 品牌方确认发券时间,当且仅当 品牌方调用确认发放用户商品券接口后提供。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)


 deactivate_request_no  选填   string(128)

【失效请求单号】 品牌方失效券请求时传入的的请求流水号。当且仅当 coupon_state 为 DEACTIVATED 时提供。


 deactivate_time  选填   string

【失效时间】 失效时间,当且仅当 coupon_state 为 DEACTIVATED 时提供。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)


 deactivate_reason  选填   string(150)

【失效原因】 失效券的原因,当且仅当 coupon_state 为 DEACTIVATED 时提供,返回品牌方调用失效用户商品券接口时传入的失效原因


 single_usage_detail  选填   object

【单券使用详情】 当且仅当 usage_mode 为 SINGLE 时提供

属性

 progressive_bundle_usage_detail  选填   object

【多次优惠使用详情】 当且仅当 usage_mode 为 PROGRESSIVE_BUNDLE 时提供

属性

 user_product_coupon_bundle_info  选填   object

【用户券组信息】 当前用户券所属用户券组的信息,当且仅当 usage_mode 为 PROGRESSIVE_BUNDLE 时提供

属性

 product_coupon  必填   object

【商品券信息】 该用户商品券对应的商品券详情

属性

 stock  必填   object

【批次信息】 该用户商品券发券时使用的批次详情

属性

 attach  选填   string

【自定义附加信息】 调用发券接口时品牌方使用 attach 字段主动设置的附加信息。微信支付不会解析该信息,仅在查询用户商品券和回调中原样返回。

注: 发券渠道多样,只有品牌方通过发券接口发放的券才会在查询和回调中携带此字段,其他渠道发放的券 attach 为空。


 channel_custom_info  选填   string(1000)

【渠道自定义信息】 使用微信支付提供的其他渠道(比如「摇一摇有优惠」)发放商品券时,渠道可能会设置该渠道特定的自定义信息,请根据 send_channel 字段判断如何解析本字段。不同渠道的自定义信息格式不同,请根据对应渠道的文档解析。


 coupon_tag_info  选填   object

【用户商品券标签信息】 用户商品券标签信息

属性

 brand_id  必填   string

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

应答示例

200 OK

查询指定用户券

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

 

错误码

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

状态码

错误码

描述

解决方案

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 存在且属于当前商品券

404

NOT_FOUND

未找到 coupon_code 对应的用户商品券

请确认 coupon_code 存在且属于当前商品券批次,且已发放给用户

429

RATELIMIT_EXCEEDED

请求超过接口频率限制

请稍后使用原参数重试

 

元宝AI
反馈
目录
置顶