# 查询用户的团购优惠列表

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

接口英文名：findvoucher

查询用户的团购优惠列表。

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

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

- 服务商获得其中之一权限集授权后，可通过使用 [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",
    "说明": "接口调用凭证，可使用 [access_token](/doc/channels/api/basic/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "是",
    "说明": "用户openid",
    "枚举": "-"
  },
  {
    "参数名": "status",
    "类型": "number",
    "必填": "否",
    "说明": "不填代表查所有券",
    "枚举": "枚举值"
  },
  {
    "参数名": "page_size",
    "类型": "number",
    "必填": "是",
    "说明": "页大小值限制: 1 ≤ value ≤ 50",
    "枚举": "-"
  },
  {
    "参数名": "page_ctx",
    "类型": "string",
    "必填": "是",
    "说明": "翻页上下文，第一次请求填空，后续请求值为上次请求的返回",
    "枚举": "-"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "说明": "用户openid"
  },
  {
    "参数名": "voucher_list",
    "类型": "Array",
    "说明": "用户券列表"
  },
  {
    "参数名": "page_ctx",
    "类型": "string",
    "说明": "翻页上下文，第一次请求填空，后续请求值为上次请求的返回"
  }
]
```

## 4. 枚举信息

### Body.status `Enum`

不填代表查所有券

```json
[
  {
    "枚举值": "1",
    "描述": "VOUCHER_STATUS_VALID 待使用"
  },
  {
    "枚举值": "2",
    "描述": "VOUCHER_STATUS_USED 已使用"
  },
  {
    "枚举值": "3",
    "描述": "VOUCHER_STATUS_REFUND 已退券"
  },
  {
    "枚举值": "4",
    "描述": "VOUCHER_STATUS_EXPIRED 已过期"
  }
]
```

## 5. 注意事项

单商户限频200QPS

## 6. 代码示例

请求示例

``` json 
{
   "openid": "xsdfs4534543534534",
   "status": 1,
   "page_size": 3,
   "page_ctx": ""
}
```

返回示例

``` json 
"errcode": 0,
   "errmsg": "成功",
   "openid": "xsdfs4534543534534",
   "voucher_list":[
   {
     "code":"232323",
     "status": 1,
     "send_time": 1699856182,
     "update_time": 1699856182,
     "start_time": 1699856182,
     "end_time": 1699856182,
     "consume_time": 1699856182,
     "refund_time": 1699856182,
     "product_id":  "kbfff",
     "consume_store_name": "xxx旗舰店",
     "voucher_type": 1,
     "voucher_buy_amount": 0,
     "voucher_actual_amount": 0,
     "telphone_no": "fasdf343df34545",
     "openid": "xsdfs4534543534534",
     "code_type": 1,
     "order_id": "23434sdfsdf34342",
     "sku_id": "fdsfdf"
   },
   {
     "code":"23232323",
     "status": 1,
     "send_time": 1699856182,
     "update_time": 1699856182,
     "start_time": 1699856182,
     "end_time": 1699856182,
     "consume_time": 1699856182,
     "refund_time": 1699856182,
     "product_id":  "kbfff",
     "consume_store_name": "xxx旗舰店",
     "voucher_type": 1,
     "voucher_buy_amount": 0,
     "voucher_actual_amount": 0,
     "telphone_no": "fasdf343df34545",
     "openid": "xsdfs4534543534534",
     "code_type": 1,
     "order_id": "23434sdfsdf34342",
     "sku_id": "fdsfdf"
   },
   {
     "code":"32434454545",
     "status": 1,
     "send_time": 1699856182,
     "update_time": 1699856182,
     "start_time": 1699856182,
     "end_time": 1699856182,
     "consume_time": 1699856182,
     "refund_time": 1699856182,
     "product_id":  "kbfff",
     "consume_store_name": "xxx旗舰店",
     "voucher_type": 1,
     "voucher_buy_amount": 0,
     "voucher_actual_amount": 0,
     "telphone_no": "fasdf343df34545",
     "openid": "xsdfs4534543534534",
     "code_type": 1,
     "order_id": "23434sdfsdf34342",
     "sku_id": "fdsfdf"
   }
   ],
   "page_ctx": "dsfajasdlf3434"
}
```

## 7. 错误码

此接口没有特殊错误码，可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

## 8. 适用范围

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