# 获取用户优惠券详情

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getusercoupon

通过此接口可获取用户优惠券详情。 

[营销管理开发指南](/doc/store/shop/guide/marketing/coupon)

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/channels/ec/coupon/get_user_coupon?access_token=ACCESS_TOKEN
```

### 云调用

- 调用方法：channels.ec.coupon.getUserCoupon

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口支持第三方平台代微信小店商家调用。[第三方服务商调用模式介绍](/doc/store/shop/dev_before/third_party_platforms)

- 该接口所属的权限集 id 为：132

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代微信小店商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/shop/API/apimgnt/common/api_getaccesstoken)（微信小店商家）、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)（服务商代调用）"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "user_coupon_id",
    "类型": "string",
    "必填": "是",
    "示例": "109694341",
    "说明": "用户优惠券 ID"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "是",
    "示例": "OPENID",
    "说明": "用户 openid"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "说明": "用户 openid"
  },
  {
    "参数名": "unionid",
    "类型": "string",
    "说明": "用户 unionid，小店接入 open 平台后生成的用户券会返回"
  },
  {
    "参数名": "user_coupon",
    "类型": "object",
    "说明": "用户优惠券详情"
  }
]
```

### Res.user_coupon `Object Payload`

用户优惠券详情

```json
[
  {
    "参数名": "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`

扩展信息

```json
[
  {
    "参数名": "use_time",
    "类型": "number",
    "说明": "优惠券核销时间（秒级时间戳）"
  }
]
```

## 4. 枚举信息

### Res.user_coupon.status `Enum`

优惠券状态

```json
[
  {
    "枚举值": "100",
    "描述": "生效中"
  },
  {
    "枚举值": "101",
    "描述": "已过期"
  },
  {
    "枚举值": "102",
    "描述": "已使用"
  }
]
```

## 5. 注意事项

本接口无特殊注意事项

## 6. 代码示例

请求示例

```json
{
    "user_coupon_id": "109694341",
    "openid": "OPENID"
}
```

返回示例

```json
{
    "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. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/store/shop/dev_before/commErrCode)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "40003",
    "错误描述": "OpenID 不正确"
  },
  {
    "错误码": "10021037",
    "错误描述": "优惠券不存在"
  }
]
```

## 8. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。

![](https://res8.wxqcloud.qq.com.cn/wxdoc/56617deb-b17d-4cf1-bccd-71d2c41ccc76.svg)接口变更日志（1条）
2026 年 06 月 03 日文档参数对齐接口：user_coupon_list 修正为 user_coupon，删除 discount_fee 参数