# 获取优惠券ID列表

# 接口说明

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

# 注意事项

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

# 接口调用请求说明

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

# 请求参数说明

参数 类型 是否必填 描述
status number 优惠券状态,枚举值详情请参考status
page number 第几页(最小填1)
page_size number 每页数量(不超过200)
page_ctx string 翻页上下文,第一次请求填空,后续请求值为上次请求的返回

# 请求参数示例

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

# 返回参数说明

参数 类型 描述
errcode number 错误码
errmsg string 错误信息
coupons[].coupon_id string 优惠券ID
total_num number 优惠券总数
page_ctx string 翻页上下文

# 返回参数示例

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

# 错误码

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

# 枚举值

# 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 生效天数