# 获取用户优惠券详情

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

接口英文名:getusercoupon

通过此接口可获取用户优惠券详情。

相关事件通知:

# 1. 调用方式

# HTTPS 调用

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

# 云调用

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

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

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String parameters

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

# 请求体 Request Payload

参数名类型必填示例说明
user_coupon_idstring109694341用户优惠券ID
openidstringOPENID用户openid

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
user_coupon_listobjarrayuser_coupon_list
errcodenumber错误码
errmsgstring错误信息,errcode为0不返回
openidstringopenid
unionidstring用户unionid,小店接入open平台后生成的用户券会返回

# Res.user_coupon_list(Array) Object Payload

user_coupon_list

参数名类型说明
user_coupon_idstring用户优惠券ID
coupon_idstring优惠券ID
statusnumber优惠券状态,枚举值详情请参考下文
create_timenumber优惠券派发时间
update_timenumber优惠券更新时间
end_timenumber优惠券失效时间
ext_infoobjectext_info
start_timenumber优惠券生效时间
order_idstring优惠券使用的订单id
discount_feenumber优惠券金额

# Res.user_coupon_list(Array).ext_info Object Payload

ext_info

参数名类型说明
use_timenumber优惠券核销时间

# 4. 注意事项

status优惠券状态

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

# 5. 代码示例

请求示例

{
    "user_coupon_id": "109694341",
    "openid": "OPENID"
}

返回示例

{
    "errcode": 0,
    "openid": "OPENID",
    "unionid": "UNIONID",
    "user_coupon": {
        "user_coupon_id": "109694341",
        "coupon_id": "12639900",
        "status": 100,
        "create_time": 1590768000,
        "update_time": 1590811200,
        "start_time": 1590832800,
        "end_time": 1590840000,
        "ext_info": {
            "use_time": 1590836400
        },
        "order_id": "123",
        "discount_fee": 123
    }
}

# 6. 错误码

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

错误码错误描述解决方案
40003OpenID不正确
10021037优惠券不存在

# 7. 适用范围

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