# 获取用户优惠券ID列表

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

接口英文名：getusercouponlist

通过此接口可以获取用户优惠券 ID 列表。 

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

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

- 出入参和 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
[
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "是",
    "说明": "用户 openid",
    "枚举": "-"
  },
  {
    "参数名": "status",
    "类型": "number",
    "必填": "否",
    "说明": "优惠券状态，不填时获取所有状态",
    "枚举": "枚举值"
  },
  {
    "参数名": "page",
    "类型": "number",
    "必填": "是",
    "说明": "页码",
    "枚举": "-"
  },
  {
    "参数名": "page_size",
    "类型": "number",
    "必填": "是",
    "说明": "每页数量",
    "枚举": "-"
  },
  {
    "参数名": "page_ctx",
    "类型": "string",
    "必填": "是",
    "说明": "翻页上下文，第一次请求填空，后续请求填上次返回值",
    "枚举": "-"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "user_coupon_list",
    "类型": "objarray",
    "说明": "优惠券列表"
  },
  {
    "参数名": "page_ctx",
    "类型": "string",
    "说明": "翻页上下文"
  }
]
```

">

### Res.user_coupon_list(Array) `Object Payload`

优惠券列表

```json
[
  {
    "参数名": "user_coupon_id",
    "类型": "number",
    "说明": "用户优惠券 ID"
  },
  {
    "参数名": "coupon_id",
    "类型": "number",
    "说明": "优惠券 ID"
  }
]
```

## 4. 枚举信息

### Body.status `Enum`

优惠券状态，不填时获取所有状态

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

## 5. 注意事项

- 每次请求的页码间隔不能超过 10
- 第一次请求的页码要小于 10，或者是最后一页
- 一页最大 200 条

## 6. 代码示例

请求示例

```json
{
    "openid": "OPENID",
    "status": 100,
    "page": 1,
    "page_size": 20,
    "page_ctx": ""
}
```

返回示例

```json
{
    "errcode": 0,
    "user_coupon_list": [
        {
            "user_coupon_id": "109694341",
            "coupon_id": "123456789"
        }
    ],
    "page_ctx": "THE_PAGE_CTX_NEW"
}
```

## 7. 错误码

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

```json
[
  {
    "错误码": "40003",
    "错误描述": "OpenID 不正确"
  },
  {
    "错误码": "10021001",
    "错误描述": "优惠券状态不对"
  },
  {
    "错误码": "10021036",
    "错误描述": "分页拉优惠券列表，页码与上次请求相差过大"
  },
  {
    "错误码": "10021037",
    "错误描述": "优惠券不存在"
  }
]
```

## 8. 适用范围

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