Appearance
创建优惠券
历史版本
请求路径
- 请求方式:
POST
- 请求头:
Content-Type:application/json
- 接口地址:
https://gateway.nuoyunapi.com/Api/Coupon/createCoupon/2.0.0
- 频率限制:
10秒100次
请求参数
参数名 | 类型 | 必需 | 说明 |
---|---|---|---|
name | string | 是 | 优惠券名称 |
type | integer | 是 | 优惠券类型:1--随机立减券;2--满减券;3--折扣券;4--奖品兑换券 |
use_limit | string | 否 | 优惠券使用金额门槛,范围0-999999;0--无门槛;>0--门槛值 |
amount_range | array[string] | 否 | type=1时必填,定义随机立减金额,数量1-5个;存在门槛时,最小值不能大于门槛 |
amount_minus | string | 否 | type=2,3时必填,减免金额0.10-9999.99,折扣范围1.0-9.9,只能保留小数点后一位 |
total_number | integer | 是 | 优惠券数量,1-999999 |
is_all_goods | integer | 是 | 商品可用范围:1--全部商品;2--部分商品可用;3--部分商品不可用 |
is_all_goods_ids | array[integer] | 是 | 部分商品可用/不可用ID |
time_type | integer | 是 | 自定义时间:1--自定义开始结束时间;2--领取当日;3--领取次日 |
valid_start_time | string | 否 | 自定义开始时间,不能小于当前时间,小于自定义结束时间(time_type=1时必填) |
valid_end_time | string | 是 | 自定义结束时间,不能小于当前时间,大于自定义开始时间(time_type=1时必填) |
valid_days | integer | 否 | 领取后有效天数,1-9999(time_type为2,3时必填) |
get_coupon_type | integer | 是 | 领取规则:领取次数限制类型,1--无限;2--限制 |
get_number_limit | integer | 否 | 领取规则:领取限制次数 |
allow_share | integer | 否 | 领取规则:分享设置,type=1,2,3时必填;1--允许;2--不允许 |
from_goods_detail | integer | 否 | 领取规则:type=1,2,3时必填,商品详情页可领,1--是;2--否 |
from_all_room | string | 是 | 领取规则:推送到所有直播间设置项,1--设置;2--不设置 |
from_bind_room | integer | 是 | 领取规则:绑定直播间可领,1--只可推送至绑定直播间;2--可推送至所有直播间 |
bind_room_ids | array[integer] | 否 | 领取规则:绑定直播间ID,只可推送至绑定直播间时必填 |
jump_type | integer | 否 | 领取规则:跳转类型,type=1,2,3时必填;1--店铺;2--商品;3--直播间 |
jump_params | integer | 否 | 领取规则:跳转对应商品id或直播间id,仅支持单个 |
progress_switch | integer | 否 | 领取规则:领取进度条开关,type=1,2,3时必填;1--开;2--关 |
goods_switch | integer | 否 | 领取规则:商品显示开关,type=1,2,3时必填;1--开;2--关 |
allow_superpose | integer | 否 | 使用规则:优惠券是否可与秒杀优惠活动叠加使用,type=1,2,3时必填;1--是;2--否 |
allow_superpose_coupon | integer | 否 | 使用规则:叠加其他优惠券,type=1,2,3时必填;1--允许;2--不允许 |
allow_superpose_coupon_self | integer | 否 | 使用规则:叠加自身优惠券,type=1,2,3时必填;1--允许;2--不允许 |
refund_type | integer | 否 | 使用规则:type=1,2,3时必填,优惠券退款类型,1--退还优惠券;2--仅退款 |
prize_content | string | 否 | 奖品兑换券优惠内容,type=4时必填,长度不超过16 |
check_mobile | integer | 否 | 手机号授权,type=4时必填,1--开启;2--关闭 |
请求示例
示例1:随机立减券
json
{
"name": "随机立减券",
"type": 1,
"use_limit": 100,
"amount_range": [
"1",
"2.02",
"3.03"
],
"total_number": 1,
"is_all_goods": 2,
"is_all_goods_ids": [1, 2, 3],
"time_type": 3,
"valid_days": 3,
"get_coupon_type": 1,
"get_number_limit": 20,
"allow_share": 1,
"from_goods_detail": 1,
"from_bind_room": 2,
"bind_room_ids": [1, 2, 3],
"from_all_room": 1,
"jump_type": 3,
"jump_params": 1,
"progress_switch": 1,
"goods_switch": 1,
"allow_superpose": 1,
"allow_superpose_coupon": 1,
"allow_superpose_coupon_self": 2,
"refund_type": 2
}
示例2:满减券
json
{
"name": "满减券",
"type": 2,
"use_limit": 100,
"amount_minus": "10.00",
"total_number": 1,
"is_all_goods": 2,
"is_all_goods_ids": [1, 2, 3],
"time_type": 3,
"valid_days": 3,
"get_coupon_type": 1,
"get_number_limit": 20,
"allow_share": 1,
"from_goods_detail": 1,
"from_bind_room": 2,
"bind_room_ids": [1, 2, 3],
"from_all_room": 1,
"jump_type": 3,
"jump_params": 1,
"progress_switch": 1,
"goods_switch": 1,
"allow_superpose": 1,
"allow_superpose_coupon": 1,
"allow_superpose_coupon_self": 2,
"refund_type": 2
}
示例3:折扣券
json
{
"name": "折扣券",
"type": 3,
"use_limit": 100,
"amount_discount": "10.00",
"total_number": 1,
"is_all_goods": 2,
"is_all_goods_ids": [1, 2, 3],
"time_type": 3,
"valid_days": 3,
"get_coupon_type": 1,
"get_number_limit": 20,
"allow_share": 1,
"from_goods_detail": 1,
"from_bind_room": 2,
"bind_room_ids": [1, 2, 3],
"from_all_room": 1,
"jump_type": 3,
"jump_params": 1,
"progress_switch": 1,
"goods_switch": 1,
"allow_superpose": 1,
"allow_superpose_coupon": 1,
"allow_superpose_coupon_self": 2,
"refund_type": 2
}
示例4:奖品兑换券
json
{
"name": "奖品对换券",
"type": 4,
"use_limit": 100,
"amount_discount": "10.00",
"total_number": 1,
"time_type": 1,
"valid_start_time": "2025-07-12 00:00:00",
"valid_end_time": "2025-07-13 00:00:00",
"get_coupon_type": 1,
"get_number_limit": 20,
"from_bind_room": 2,
"bind_room_ids": [1, 2, 3],
"from_all_room": 1,
"prize_content": "绿色地球一日游",
"check_mobile": 1
}
响应参数
参数 | 必选 | 类型 | 描述 |
---|---|---|---|
code | 是 | integer | 状态码:200-成功,400-失败 |
msg | 是 | string | 提示信息 |
data | 是 | object | 消息内容 |
data
参数结构
参数 | 必选 | 类型 | 说明 |
---|---|---|---|
id | 是 | integer | 新增优惠券id |
响应示例
json
{
"code": 200,
"msg": "Success",
"data": {
"id": 2377
}
}