微信小店
取消
中文
中文
EN
取消
  • 微信小店

    • # 获取用户优惠券ID列表

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

    接口英文名：getusercouponlist

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

    相关事件通知：

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 调用方法：channels.ec.coupon.getUserCouponList

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

    # 第三方调用

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

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

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

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    参数名类型必填说明
    openidstring是用户openid
    statusnumber否优惠券状态，不填时获取所有优惠券，填时获取特定状态优惠券,枚举值详情请参考下文
    pagenumber是页码
    page_sizenumber是页大小
    page_ctxstring是翻页上下文，第一次请求填空，后续请求值为上次请求的返回

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型示例说明
    errcodenumber错误码
    errmsgstring错误信息，errcode为0不返回
    user_coupon_listobjarray优惠券列表
    page_ctxstringTHE_PAGE_CTX_NEW翻页上下文

    # Res.user_coupon_list(Array) Object Payload

    优惠券列表

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

    # 4. 注意事项

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

    status优惠券状态

    枚举字段 枚举值 描述
    COUPON_USER_STATUS_VALID 100 生效中
    COUPON_USER_STATUS_EXPIRED 101 已过期
    COUPON_USER_STATUS_USED 102 已使用

    # 5. 代码示例

    请求示例

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

    返回示例

    {
    "errcode": 0,
    "user_coupon_list": [
        {
            "user_coupon_id": "109694341",
            "coupon_id": "12639900"
        }
    ],
    "total_num": 1,
    "page_ctx": "THE_PAGE_CTX_NEW"
}

    # 6. 错误码

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

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

    # 7. 适用范围

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