# 创建优惠券

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

接口英文名:createcoupon

可通过此接口创建优惠券。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用。

# 第三方调用

# 2. 请求参数

# 查询参数 Query String Parameters

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

# 请求体 Request Payload

参数名类型必填说明枚举
typenumber优惠券类型枚举值
namestring优惠券名称,最长 10 个中文字符-
promote_infoobject推广信息-
discount_infoobject优惠信息-
receive_infoobject领取信息-
valid_infoobject有效期信息-
ext_infoobject扩展信息-
auto_valid_infoobject自动生效信息-

# Body.promote_info Object Payload

推广信息

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

# Body.discount_info Object Payload

优惠信息

参数名类型必填说明
discount_conditionobject优惠门槛
discount_numnumber折扣数,5000=5折,范围 1000~10000,必须是 100 的整数倍,不可低于 2 折
discount_feenumber减免金额,单位为分,不可超过200元,同时如果是商品券,适用商品优惠后不可低于原价2折,如果是店铺满减券,不可低于价格门槛的2折。

# Body.receive_info Object Payload

领取信息

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

# Body.valid_info Object Payload

有效期信息

参数名类型必填说明
valid_typenumber有效期类型。1=指定时间范围生效,2=生效天数
valid_day_numnumber优惠券有效期天数,valid_type=2 时必填
start_timenumber优惠券有效期开始时间(秒级时间戳),valid_type=1 时必填
end_timenumber优惠券有效期结束时间(秒级时间戳),valid_type=1 时必填

# Body.ext_info Object Payload

扩展信息

参数名类型必填说明
jump_product_idnumber商品折扣券领取后跳转的商品 id
notesstring备注信息

# Body.auto_valid_info Object Payload

自动生效信息

参数名类型必填说明
auto_valid_typenumber自动生效类型。0=不启用,1=启用(自动生效时间为 receive_info.start_time)

# Body.discount_info.discount_condition Object Payload

优惠门槛

参数名类型必填说明
product_cntnumber商品件数门槛,不能和价格门槛同时设置
product_pricenumber商品价格门槛,单位为分,不能和件数门槛同时设置
product_idsarray商品 id 列表,商品券必填,最多 200 个

# 3. 返回参数

# 返回体 Response Payload

参数名类型示例说明
errcodenumber0错误码
errmsgstringok错误信息
dataobject返回数据

# Res.data Object Payload

返回数据

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

# 4. 枚举信息

# Body.type Enum

优惠券类型

枚举值含义必填字段
1商品条件折券discount_condition.product_ids、discount_condition.product_cnt、discount_info.discount_num
2商品满减券discount_condition.product_ids、discount_condition.product_price、discount_info.discount_fee
3商品统一折扣券discount_condition.product_ids、discount_info.discount_num
4商品直减券(如果小于可用商品中的最小价格会提醒;没有商品时超过50w提醒)discount_condition.product_ids、discount_info.discount_fee
101店铺条件折扣券discount_condition.product_cnt、discount_info.discount_num
102店铺满减券discount_condition.product_price、discount_info.discount_fee
103店铺统一折扣券discount_info.discount_num
104店铺直减券(如果小于可用商品中的最小价格会提醒;没有商品时超过50w提醒)discount_info.discount_fee

# 5. 注意事项

  • 创建优惠券时 status=1(未生效,编辑中)
  • 所有时间字段均为以秒为单位的时间戳

# 6. 代码示例

请求示例

{
    "type": 2,
    "name": "双十一特惠券",
    "discount_info": {
        "discount_condition": {
            "product_ids": ["10000000000001", "10000000000002"],
            "product_price": 100
        },
        "discount_fee": 50
    },
    "promote_info": {
        "promote_type": 1
    },
    "receive_info": {
        "start_time": 1673110742,
        "end_time": 1673196742,
        "limit_num_one_person": 1,
        "total_num": 100
    },
    "valid_info": {
        "valid_type": 2,
        "valid_day_num": 7
    },
    "auto_valid_info": {
        "auto_valid_type": 1
    }
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "coupon_id": "123456789"
    }
}

# 7. 错误码

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

错误码错误描述
10021005优惠券名称太长
10021006校验折扣数失败
10021007校验优惠价格失败
10021008校验直减券是否小于最低价格
10021009校验领取时间失败
10021010校验有效时间失败
10021011校验优惠券总发放量失败
10021012校验限领失败
10021013校验商户失败
10021014推广类型不对
10021021校验入参失败,含有非商户的指定商品
10021024优惠券信息违规
10021035创建优惠券类型暂不支持
10021061店铺未开启会员功能
10021071券可领取的结束时间应晚于当前时间
10021072券可领取的开始时间应早于券有效期的结束时间
10021073有效开始时间应早于有效结束时间
10021074券有效结束时间应晚于领取结束时间
10021075领取后有效期最长 180 天
10021077领券时间区间不可大于 365 天
10021078券有效期区间不可大于 365 天
10021080置券时传了非上架商品

# 8. 适用范围

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