# 查询用户的团购优惠详情
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：getvoucher
查询用户的团购优惠详情,单商户限频200QPS
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/voucher/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：164
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证，可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| encrypted_code | string | 否 | 用户订单详情页展示的二维码，需要进行URL解码。code和encrypted_data二者选其一 |
| code | string | 否 | 用户的券code，查询用户的券接口返回的code。code和encrypted_data二者选其一 |
| sku_id | string | 否 | 使用encrypted_code查询时，不用传sku_id |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| voucher | object | 用户券详情 |
# Res.voucher Object Payload
用户券详情
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| 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
券状态
| 枚举值 | 描述 |
|---|---|
| 1 | VOUCHER_STATUS_VALID 待使用 |
| 2 | VOUCHER_STATUS_USED 已使用 |
| 3 | VOUCHER_STATUS_REFUND 已退券 |
| 4 | VOUCHER_STATUS_EXPIRED 已过期 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
// 使用加密code查询
{
"encrypted_code": "csbm9"
}
// 使用明文code查询
{
"code": "sqfvm",
"sku_id": "fdsfdf
返回示例
{
"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. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10027005 | product_id不存在或填写错误 | |
| 10027011 | encrypted_code错误 | |
| 10027012 | openid错误 | |
| 10027013 | 查询的code错误，请确认code是否正确 |
# 8. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。