# 获取用户优惠券详情
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:getusercoupon
通过此接口可获取用户优惠券详情。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/coupon/get_user_coupon?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代微信小店商家调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为:132
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用) |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| user_coupon_id | string | 是 | 109694341 | 用户优惠券 ID |
| openid | string | 是 | OPENID | 用户 openid |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| openid | string | 用户 openid |
| unionid | string | 用户 unionid,小店接入 open 平台后生成的用户券会返回 |
| user_coupon | object | 用户优惠券详情 |
# Res.user_coupon Object Payload
用户优惠券详情
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| user_coupon_id | string | 用户优惠券 ID | - |
| coupon_id | string | 优惠券 ID | - |
| status | number | 优惠券状态 | 枚举值 |
| create_time | number | 优惠券派发时间(秒级时间戳) | - |
| update_time | number | 优惠券更新时间(秒级时间戳) | - |
| start_time | number | 优惠券生效时间(秒级时间戳) | - |
| end_time | number | 优惠券失效时间(秒级时间戳) | - |
| order_id | string | 优惠券使用的订单 ID | - |
| ext_info | object | 扩展信息 | - |
# Res.user_coupon.ext_info Object Payload
扩展信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| use_time | number | 优惠券核销时间(秒级时间戳) |
# 4. 枚举信息
# Res.user_coupon.status Enum
优惠券状态
| 枚举值 | 描述 |
|---|---|
| 100 | 生效中 |
| 101 | 已过期 |
| 102 | 已使用 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
{
"user_coupon_id": "109694341",
"openid": "OPENID"
}
返回示例
{
"errcode": 0,
"openid": "OPENID",
"unionid": "UNIONID",
"user_coupon": {
"user_coupon_id": "109694341",
"coupon_id": "123456789",
"status": 100,
"create_time": 1590768000,
"start_time": 1590832800,
"end_time": 1590840000,
"order_id": "123",
"ext_info": { "use_time": 1590836400 }
}
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 40003 | OpenID 不正确 |
| 10021037 | 优惠券不存在 |
# 8. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。
2026 年 06 月 03 日
文档参数对齐接口:user_coupon_list 修正为 user_coupon,删除 discount_fee 参数