# 获取优惠券ID列表
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南。
接口英文名：getcouponlist
通过此接口可以获取优惠券 ID 列表。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/coupon/get_list?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代微信小店商家调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为：132
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代微信小店商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，可使用 access_token（微信小店商家）、authorizer_access_token（服务商代调用） |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 | 枚举 |
|---|---|---|---|---|---|
| status | number | 是 | 2 | 优惠券状态 | 枚举值 |
| page | number | 是 | 1 | 页码（最小填 1） | - |
| page_size | number | 是 | 10 | 每页数量（不超过 200） | - |
| page_ctx | string | 是 | 翻页上下文，第一次请求填空，后续请求填上次返回值 | - |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | 0 | 错误码 |
| errmsg | string | ok | 错误信息 |
| coupons | objarray | 优惠券列表 | |
| total_num | number | 优惠券总数 | |
| page_ctx | string | 翻页上下文 |
# Res.coupons(Array) Object Payload
优惠券列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| coupon_id | number | 优惠券 ID |
# 4. 枚举信息
# Body.status Enum
优惠券状态
| 枚举值 | 描述 |
|---|---|
| 1 | 编辑中 |
| 2 | 已生效 |
| 3 | 已过期 |
| 4 | 已作废 |
| 5 | 已删除 |
| 200 | 过期或作废 |
# 5. 注意事项
- 每次请求的页码间隔不能超过 10
- 第一次请求的页码要小于 10，或者是最后一页
- 一页最大 200 条
# 6. 代码示例
请求示例
{
"status": 2,
"page": 1,
"page_size": 10,
"page_ctx": ""
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"coupons": [
{ "coupon_id": "123456789" }
],
"total_num": 10,
"page_ctx": "THE_PAGE_CTX_NEW"
}
# 7. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 10021001 | 优惠券状态不对 |
| 10021036 | 分页拉优惠券列表，页码与上次请求相差过大 |
| 10021037 | 优惠券不存在 |
# 8. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。
接口变更日志（1条）2025 年 11 月 21 日
新增错误码10021037