# 获取优惠券详情

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

接口英文名:getcoupon

通过该接口可获取优惠券详情信息。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用。

# 第三方调用

# 2. 请求参数

# 查询参数 Query String Parameters

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

# 请求体 Request Payload

参数名类型必填示例说明
coupon_idstring123456789优惠券 ID

# 3. 返回参数

# 返回体 Response Payload

参数名类型示例说明
errcodenumber0错误码
errmsgstringok错误信息
couponobject优惠券信息

# Res.coupon Object Payload

优惠券信息

参数名类型说明枚举
coupon_idstring优惠券 ID-
typenumber优惠券类型枚举值
statusnumber优惠券状态枚举值
create_timenumber优惠券创建时间(秒级时间戳)-
update_timenumber优惠券更新时间(秒级时间戳)-
coupon_infoobject优惠券内容信息-
stock_infoobject库存信息-

# Res.coupon.coupon_info Object Payload

优惠券内容信息

参数名类型说明
namestring优惠券名称
promote_infoobject推广信息
discount_infoobject优惠信息
receive_infoobject领取信息
valid_infoobject有效期信息
ext_infoobject扩展信息

# Res.coupon.coupon_info.promote_info Object Payload

推广信息

参数名类型说明
promote_typenumber推广类型。1=小店内推广,9=会员券,10=会员开卡礼券

# Res.coupon.coupon_info.discount_info Object Payload

优惠信息

参数名类型说明
discount_conditionobject优惠门槛
discount_numnumber折扣数,5000=5折
discount_feenumber减免金额,单位为分

# Res.coupon.coupon_info.discount_info.discount_condition Object Payload

优惠门槛

参数名类型说明
product_cntnumber件数门槛
product_pricenumber价格门槛,单位为分
product_idsarray指定商品 id 列表

# Res.coupon.coupon_info.receive_info Object Payload

领取信息

参数名类型说明
start_timenumber领用开始时间(秒级时间戳)
end_timenumber领用结束时间(秒级时间戳)
limit_num_one_personnumber单人限领张数
total_numnumber领用总数

# Res.coupon.coupon_info.valid_info Object Payload

有效期信息

参数名类型说明
valid_typenumber有效期类型。1=指定时间范围,2=生效天数
valid_day_numnumber有效天数,valid_type=2 时有意义
start_timestring有效期开始时间,valid_type=1 时有意义
end_timestring有效期结束时间,valid_type=1 时有意义

# Res.coupon.coupon_info.ext_info Object Payload

扩展信息

参数名类型说明
jump_product_idstring领取后跳转的商品 id
notesstring备注信息
valid_timenumber优惠券有效时间(秒级时间戳)
invalid_timenumber优惠券失效时间(秒级时间戳)

# Res.coupon.stock_info Object Payload

库存信息

参数名类型说明
issued_numnumber优惠券剩余量
receive_numnumber优惠券领用量
used_numnumber优惠券已用量

# 4. 枚举信息

# Res.coupon.type Enum

优惠券类型

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

# Res.coupon.status Enum

优惠券状态

枚举值描述
1编辑中
2已生效
3已过期
4已作废
5已删除

# 5. 注意事项

本接口无特殊注意事项

# 6. 代码示例

请求示例

{
    "coupon_id": "123456789"
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "coupon": {
        "coupon_id": "123456789",
        "type": 103,
        "status": 2,
        "create_time": 1594885385,
        "update_time": 1594886327,
        "coupon_info": {
            "name": "全店9.9折券",
            "promote_info": { "promote_type": 1 },
            "discount_info": { "discount_num": 9900 },
            "receive_info": {
                "start_time": 1673110742,
                "end_time": 1673196742,
                "limit_num_one_person": 1,
                "total_num": 100
            },
            "valid_info": {
                "valid_type": 1,
                "start_time": 1594828800,
                "end_time": 1595433600
            }
        },
        "stock_info": {
            "issued_num": 95,
            "receive_num": 3,
            "used_num": 2
        }
    }
}

# 7. 错误码

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

错误码错误描述
10021037优惠券不存在

# 8. 适用范围

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