# 获取优惠券ID列表

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getcouponlist

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

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 调用方法:channels.ec.coupon.getList

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

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

  • 该接口所属的权限集 id 为:132

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
statusnumber2优惠券状态,枚举值详情请参考下文
pagenumber1第几页(最小填1)
page_sizenumber10每页数量(不超过200)
page_ctxstringTHE_PAGE_CTX翻页上下文,第一次请求填空,后续请求值为上次请求的返回

# 3. 返回参数

# 返回体 Response Payload

参数名类型示例说明
errcodenumber0错误码
errmsgstringok错误信息
couponsobjarraycoupons
total_numnumber优惠券总数
page_ctxstring-翻页上下文

# Res.coupons(Array) Object Payload

coupons

参数名类型说明
coupon_idnumber优惠券ID

# 4. 注意事项

  • 每次请求的页码间隔不能超过10;
  • 第一次请求的页码要小于10,或者是最后一页;
  • 一页最大200。

status优惠券状态

枚举值 描述
1 未生效,编辑中
2 生效
3 已过期
4 已作废
5 删除
200 过期 or 作废的券

type

枚举值 描述
1 商品条件折券
2 商品满减券
3 商品统一折扣券
4 商品直减券
101 店铺条件折扣券
102 店铺满减券
103 店铺统一折扣券
104 店铺直减券

promote_type

枚举字段名 枚举值 描述
PROMOTE_TYPE_SHOP 1 小店内推广
PROMOTE_TYPE_VIP 9 会员券
PROMOTE_TYPE_VIP_REGISTER 10 会员开卡礼券

valid_type

枚举字段名 枚举值 描述
COUPON_VALID_TYPE_TIME 1 指定时间范围生效
COUPON_VALID_TYPE_DAY 2 生效天数

# 5. 代码示例

请求示例

{
    "status": 2,
    "page": 1,
    "page_size": 10,
    "page_ctx": "THE_PAGE_CTX"
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "coupons": [
        {
            "coupon_id": "123"
        }
    ],
    "total_num": 10,
    "page_ctx": "THE_PAGE_CTX_NEW"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
10021001优惠券状态不对
10021036分页拉优惠券列表,页码与上次请求相差过大

# 7. 适用范围

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