# 获取优惠券详情
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getcoupon
通过该接口可获取优惠券详情信息。
相关事件通知:
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/coupon/get?access_token=ACCESS_TOKEN
# 云调用
调用方法:channels.ec.coupon.get
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代微信小店商家调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为:132
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用) |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| coupon_id | string | 是 | 12639900 | 优惠券id |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | 0 | 错误码 |
| errmsg | string | ok | 错误信息 |
| coupon | object | coupon |
# Res.coupon Object Payload
coupon
| 参数名 | 类型 | 说明 |
|---|---|---|
| coupon_id | string | 优惠券 |
| type | number | 优惠券类型,枚举值详情请参考下文 |
| status | number | 优惠券状态 |
| create_time | number | 优惠券创建时间 |
| update_time | number | 优惠券更新时间 |
| coupon_info | object | coupon_info |
| stock_info | object | stock_info |
# Res.coupon.coupon_info Object Payload
coupon_info
| 参数名 | 类型 | 说明 |
|---|---|---|
| name | string | 优惠券名称 |
| promote_info | object | promote_info |
| discount_info | object | discount_info |
| receive_info | object | receive_info |
| valid_info | object | valid_info |
| ext_info | object | ext_info |
# Res.coupon.coupon_info.promote_info Object Payload
promote_info
| 参数名 | 类型 | 说明 |
|---|---|---|
| promote_type | number | promote_type,枚举值详情请参考下文 |
# Res.coupon.coupon_info.discount_info Object Payload
discount_info
| 参数名 | 类型 | 说明 |
|---|---|---|
| discount_condition | object | discount_condition |
| discount_num | number | 优惠券折扣数 * 1000, 例如 5.1折-> 5100 |
| discount_fee | number | 优惠券减少金额, 单位分, 例如0.5元-> 50 |
# Res.coupon.coupon_info.discount_info.discount_condition Object Payload
discount_condition
| 参数名 | 类型 | 说明 |
|---|---|---|
| product_cnt | number | 优惠券使用条件, 满 x 件商品可用 |
| product_price | number | 优惠券使用条件, 价格满 x 可用,单位分 |
| product_ids | array | 优惠券使用条件, 指定商品 id 可用 |
# Res.coupon.coupon_info.receive_info Object Payload
receive_info
| 参数名 | 类型 | 说明 |
|---|---|---|
| start_time | number | 优惠券领用开始时间 |
| end_time | number | 优惠券领用结束时间 |
| limit_num_one_person | number | 单人限领张数 |
| total_num | number | 优惠券领用总数 |
# Res.coupon.coupon_info.valid_info Object Payload
valid_info
| 参数名 | 类型 | 说明 |
|---|---|---|
| valid_type | number | 优惠券有效期类型,枚举值详情请参考下文 |
| valid_day_num | number | 优惠券有效天数,valid_type=2时才有意义 |
| start_time | string | 优惠券有效期开始时间,valid_type=1时才有意义 |
| end_time | string | 优惠券有效期结束时间,valid_type=1时才有意义 |
# Res.coupon.coupon_info.ext_info Object Payload
ext_info
| 参数名 | 类型 | 说明 |
|---|---|---|
| jump_product_id | string | 商品折扣券领取后跳转的商品id |
| notes | string | 备注信息 |
| valid_time | number | 优惠券有效时间 |
| invalid_time | number | 优惠券失效时间 |
# Res.coupon.stock_info Object Payload
stock_info
| 参数名 | 类型 | 说明 |
|---|---|---|
| issued_num | number | 优惠券剩余量 |
| receive_num | number | 优惠券领用量 |
| used_num | number | 优惠券已用量 |
# 4. 注意事项
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 | 生效天数 |
# 5. 代码示例
请求示例
{
"coupon_id": 12639900
}
返回示例
{
"errcode": 0,
"coupon": {
"coupon_id": "12639900",
"type": 103,
"status": 5,
"create_time": 1594885385,
"update_time": 1594886327,
"coupon_info": {
"name": "scs",
"promote_info": {
"promote_type": 1
},
"discount_info": {
"discount_num": 9900
},
"receive_info": {
"end_time": 1673110742,
"limit_num_one_person": 1,
"start_time": 1673110742,
"total_num": 100
},
"valid_info": {
"valid_type": 1,
"valid_day_num": 0,
"start_time": 1594828800,
"end_time": 1595433600
}
},
"stock_info": {
"issued_num": 95,
"receive_num": 3,
"used_num": 2
}
}
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10021037 | 优惠券不存在 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。