# 获取用户优惠券ID列表

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

接口英文名:getusercouponlist

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

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用。

# 第三方调用

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用)

# 请求体 Request Payload

参数名类型必填说明枚举
openidstring用户 openid-
statusnumber优惠券状态,不填时获取所有状态枚举值
pagenumber页码-
page_sizenumber每页数量-
page_ctxstring翻页上下文,第一次请求填空,后续请求填上次返回值-

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
user_coupon_listobjarray优惠券列表
page_ctxstring翻页上下文

# Res.user_coupon_list(Array) Object Payload

优惠券列表

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

# 4. 枚举信息

# Body.status Enum

优惠券状态,不填时获取所有状态

枚举值描述
100生效中
101已过期
102已使用

# 5. 注意事项

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

# 6. 代码示例

请求示例

{
    "openid": "OPENID",
    "status": 100,
    "page": 1,
    "page_size": 20,
    "page_ctx": ""
}

返回示例

{
    "errcode": 0,
    "user_coupon_list": [
        {
            "user_coupon_id": "109694341",
            "coupon_id": "123456789"
        }
    ],
    "page_ctx": "THE_PAGE_CTX_NEW"
}

# 7. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述
40003OpenID 不正确
10021001优惠券状态不对
10021036分页拉优惠券列表,页码与上次请求相差过大
10021037优惠券不存在

# 8. 适用范围

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