# 查询用户的团购优惠详情

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

接口英文名：getvoucher

查询用户的团购优惠详情,单商户限频200QPS

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/channels/ec/voucher/get?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
[
  {
    "参数名": "encrypted_code",
    "类型": "string",
    "必填": "否",
    "说明": "用户订单详情页展示的二维码，需要进行URL解码。code和encrypted_data二者选其一"
  },
  {
    "参数名": "code",
    "类型": "string",
    "必填": "否",
    "说明": "用户的券code，查询用户的券接口返回的code。code和encrypted_data二者选其一"
  },
  {
    "参数名": "sku_id",
    "类型": "string",
    "必填": "否",
    "说明": "使用encrypted_code查询时，不用传sku_id"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "voucher",
    "类型": "object",
    "说明": "用户券详情"
  }
]
```

### Res.voucher `Object Payload`

用户券详情

```json
[
  {
    "参数名": "code",
    "类型": "string",
    "说明": "券code，平台生成的code是数字加字母的组合，最长32位，商家自定义code不超过48位，也是数字加字母的组合",
    "枚举": "-"
  },
  {
    "参数名": "status",
    "类型": "number",
    "说明": "券状态",
    "枚举": "枚举值"
  },
  {
    "参数名": "send_time",
    "类型": "number",
    "说明": "发放时间，时间戳",
    "枚举": "-"
  },
  {
    "参数名": "update_time",
    "类型": "number",
    "说明": "最近更新时间，时间戳",
    "枚举": "-"
  },
  {
    "参数名": "start_time",
    "类型": "number",
    "说明": "核销生效时间，时间戳",
    "枚举": "-"
  },
  {
    "参数名": "end_time",
    "类型": "number",
    "说明": "核销结束时间，时间戳",
    "枚举": "-"
  }
]
```

## 4. 枚举信息

### Res.voucher.status `Enum`

券状态

```json
[
  {
    "枚举值": "1",
    "描述": "待使用"
  },
  {
    "枚举值": "2",
    "描述": "已使用"
  },
  {
    "枚举值": "3",
    "描述": "已退券"
  },
  {
    "枚举值": "4",
    "描述": "已过期"
  },
  {
    "枚举值": "5",
    "描述": "已预约"
  }
]
```

## 5. 注意事项

本接口无特殊注意事项

## 6. 代码示例

请求示例

``` json
// 使用加密code查询
{
   "encrypted_code": "csbm9"
}

// 使用明文code查询
{
   "code": "sqfvm",
   "sku_id": "fdsfdf
```

返回示例

``` json
{
   "errcode": 0,
   "errmsg": "成功",
   "voucher": {
     "code":"sqfvm",
     "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",
     "union_id": "232323"
   }
}
```

## 7. 错误码

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

```json
[
  {
    "错误码": "40001",
    "错误描述": "invalid credential, access_token is invalid or not latest",
    "解决方案": ""
  },
  {
    "错误码": "41001",
    "错误描述": "access_token missing",
    "解决方案": ""
  },
  {
    "错误码": "42001",
    "错误描述": "access_token expired",
    "解决方案": ""
  },
  {
    "错误码": "10027005",
    "错误描述": "product_id或者sku_id不存在或填写错误",
    "解决方案": "请检查sku输入是否正确"
  },
  {
    "错误码": "10027011",
    "错误描述": "encrypted_code错误",
    "解决方案": "检查encrypted_code输入是否正确"
  },
  {
    "错误码": "10027012",
    "错误描述": "openid错误",
    "解决方案": "请检查openid输入是否正确"
  },
  {
    "错误码": "10027013",
    "错误描述": "查询的code错误，请确认code是否正确",
    "解决方案": "请检查code输入是否正确"
  },
  {
    "错误码": "10027026",
    "错误描述": "请求参数的code和encrypted_code都未设置",
    "解决方案": "code和或者encrypted_code至少填一个"
  },
  {
    "错误码": "10027033",
    "错误描述": "无权限操作此券",
    "解决方案": "仅支持操作自己创建或者发放的券"
  },
  {
    "错误码": "10027034",
    "错误描述": "无效的code",
    "解决方案": "请检查code输入是否正确"
  },
  {
    "错误码": "10027036",
    "错误描述": "券不存在",
    "解决方案": "请检查sku_id、code、encrypted_code输入是否正确"
  }
]
```

## 8. 适用范围

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

![](https://res8.wxqcloud.qq.com.cn/wxdoc/56617deb-b17d-4cf1-bccd-71d2c41ccc76.svg)接口变更日志（2条）
2026 年 06 月 22 日VoucherStatus新增【已预约】枚举
2025 年 12 月 05 日新增错误码转义信息