优惠券列表 | API文档

# 优惠券列表

# 接口说明

项	值
URL	`/openapi/v1/coupon/list.json`
描述	优惠券列表
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
name	string	优惠券名称	否
grant	number	是否发放 0未发放 1发放中 2已结束	否
couponType	number	优惠券类型 1商品 2核销	否
receiveType	number	领取途径: 1直接领取 2后台赠送	否
pageDto	object	分页对象	是

# 分页对象

字段名	字段类型	说明	是否必传
pageSize	number	页大小	是。区间 (0,100]
pageNum	number	页码	是。从1开始

# 请求数据

{
  "pageDto": {
    "pageSize": 2,
    "pageNum": 1
  }
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": [
    {
      "id": 228,
      // 优惠券ID
      "name": "优惠券测试-Y5",
      // 优惠券名称
      "couponType": 1,
      // 优惠券类型 1商品 2核销
      "type": 3,
      // 优惠类型 1满减券 2直减券 3折扣券 4核销券
      "receiveType": 1,
      // 领取途径: 1 直接领取 2 后台赠送
      "fullReduction": 0,
      // 满减额度金额
      "discountedPrice": 7000,
      // 优惠金额
      "num": 2,
      // 发放数量
      "restrictNum": 1,
      // 个人领取数量 0不限 >1数量
      "drawNum": 1,
      // 已领取数量
      "status": 1,
      // 状态 1启用 0禁用
      "grant": 1,
      // 是否发放 0未发放 1发放中 2已结束
      "createdAt": 1733472093000
      // 创建时间
    },
    {
      "id": 227,
      "name": "核销优惠券-Y0",
      "couponType": 2,
      "type": 4,
      "receiveType": 1,
      "fullReduction": 0,
      "discountedPrice": 0,
      "num": 4,
      "restrictNum": 1,
      "drawNum": 0,
      "status": 1,
      "grant": 1,
      "createdAt": 1733471993000
    }
  ],
  "pageDto": {
    "count": 20,
    // 总数
    "pageNum": 1,
    "pageSize": 2
  }
}

# 优惠券新增

# 接口说明

项	值
URL	`/openapi/v1/coupon/add.json`
描述	优惠券新增
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
name	string	优惠券名称	是
couponType	number	优惠券类型 1商品 2核销	是
type	number	优惠类型 1满减券 2直减券 3折扣券 4核销券	是
receiveType	number	领取途径: 1 直接领取 2 后台赠送	是。当couponType为2时传1
scopeType	number	适用范围: 1 店铺级(全部商品) 2商品级(指定商品)	是。当couponType为2时传1
fullReduction	number	满减额度，单位毫	否。当couponType为1时必填
discountedPrice	number	优惠金额，单位毫	否。当couponType为1时必填
validType	number	有效期类型 1.固定天数 2.固定时间段	是
validDay	number	天数	否。当validType为1时必填
validStart	number	有效期开始时间	否。当validType为2时必填
validEnd	number	有效期结束时间	否。当validType为2时必填
num	number	发放数量	是
restrictNum	number	个人领取数量当couponType=1时只能传1	是
grant	number	是否发放 0未发放 1发放中 2已结束	是
goodsSkuIds	array	关联商品	否。当scopeType为2时必填

# 关联商品对象

字段名	字段类型	说明	是否必传
goodsType	number	商品类型: 1-通用商品 2-训练营	是
goodsSkuId	string	商品编号	是
goodsFkId	string	关联其它模块表的ID。默认值: -1。goods_type=2时，为营期ID。	否。当goodsType为2时必填

# 请求数据

{
  "name": "openapi商品券测试",
  "couponType": 1,
  "type": 1,
  "receiveType": 1,
  "scopeType": 2,
  "goodsSkuIds": [
    {
      "goodsType": 2,
      "goodsSkuId": "YnEI3TnYEh",
      "goodsFkId": "202501091555146581"
    }
  ],
  "fullReduction": 100000,
  "discountedPrice": 10000,
  "validType": 2,
  "validDay": 0,
  "validStart": 1736913600000,
  "validEnd": 1737013600000,
  "num": 2,
  "restrictNum": 1,
  "grant": 1
}

# 返回数据

{
  "msg": "操作成功",
  "code": 200,
  "data": 311,
  "pageDto": null
}

# 优惠券详情

# 接口说明

项	值
URL	`/openapi/v1/coupon/info.json`
描述	优惠券详情
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	number	优惠券ID	是

# 请求数据

{
  "id": 5
}

# 返回数据

{
  "msg": "操作成功",
  "code": 200,
  "data": {
    "id": 5,
    // 优惠券ID
    "name": "指定商品-满500-299",
    // 优惠券名称
    "couponType": 1,
    // 优惠券类型 1商品 2核销
    "type": 1,
    // 优惠类型 1满减券 2直减券 3折扣券 4核销券
    "scopeType": 2,
    // 适用范围: 1 店铺级(全部商品) 2商品级(指定商品)
    "receiveType": 1,
    // 领取途径: 1 直接领取 2 后台赠送
    "fullReduction": 5000000,
    // 满减额度，单位毫
    "discountedPrice": 2990000,
    // 优惠金额，单位毫
    "validType": 1,
    // 有效期类型 1.固定天数 2.固定时间段
    "validDay": 1,
    // 天数
    "validStart": 0,
    // 有效期开始时间
    "validEnd": 0,
    // 有效期结束时间
    "num": 3,
    // 发放数量
    "drawNum": 3,
    // 已领取数量
    "restrictNum": 1,
    // 个人领取数量 0不限 >1数量
    "grant": 2,
    // 是否发放 0未发放 1发放中 2已结束
    "createdAt": 1710725108000,
    // 创建时间
    "goods": [
      // 关联商品
      {
        "couponId": 5,
        // 优惠券ID
        "scopeType": 2,
        // 适用范围: 1 店铺级(全部商品) 2商品级(指定商品)
        "goodsType": 1,
        // 商品类型: 1-通用商品 2-训练营
        "goodsSkuId": "202403071951216047",
        // 商品编号
        "goodsFkId": null
        // 关联其它模块表的ID。默认值: -1。goods_type=2时，为营期ID
      },
      {
        "couponId": 5,
        "scopeType": 2,
        "goodsType": 2,
        "goodsSkuId": "202403111757381591",
        "goodsFkId": "53TM8qNG7Z"
      }
    ]
  },
  "pageDto": null
}

# 优惠券编辑

# 接口说明

项	值
URL	`/openapi/v1/coupon/update.json`
描述	优惠券编辑
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	number	优惠券ID	是
name	string	优惠券名称	是
type	number	优惠类型 1满减券 2直减券 3折扣券 4核销券	是
scopeType	number	适用范围: 1 店铺级(全部商品) 2商品级(指定商品)	是。当couponType为2时传1
fullReduction	number	满减额度，单位毫	否。当couponType为1时必填
discountedPrice	number	优惠金额，单位毫	否。当couponType为1时必填
validType	number	有效期类型 1.固定天数 2.固定时间段	是
validDay	number	天数	否。当validType为1时必填
validStart	number	有效期开始时间	否。当validType为2时必填
validEnd	number	有效期结束时间	否。当validType为2时必填
num	number	发放数量	是
restrictNum	number	个人领取数量当couponType=1时只能传1	是
grant	number	是否发放 0未发放 1发放中 2已结束	是
goodsSkuIds	array	关联商品	否。当scopeType为2时必填

# 关联商品对象

字段名	字段类型	说明	是否必传
goodsType	number	商品类型: 1-通用商品 2-训练营	是
goodsSkuId	string	商品编号	是
goodsFkId	string	关联其它模块表的ID。默认值: -1。goods_type=2时，为营期ID。	否。当goodsType为2时必填

# 请求数据

{
  "id": 311,
  "name": "openapi商品券测试1",
  "couponType": 1,
  "type": 1,
  "receiveType": 1,
  "scopeType": 2,
  "goodsSkuIds": [
    {
      "goodsType": 2,
      "goodsSkuId": "YnEI3TnYEh",
      "goodsFkId": "202501091555146581"
    }
  ],
  "fullReduction": 100000,
  "discountedPrice": 10000,
  "validType": 2,
  "validDay": 0,
  "validStart": 1736913600000,
  "validEnd": 1737013600000,
  "num": 2,
  "restrictNum": 1,
  "grant": 1
}

# 返回数据

{
  "msg": "操作成功",
  "code": 200,
  "data": true,
  "pageDto": null
}

# 优惠券分享

# 接口说明

项	值
URL	`/openapi/v1/coupon/share.json`
描述	优惠券分享
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	number	优惠券ID	是

# 请求数据

{
  "id": 5
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": {
    "coupon_name": "openapi商品券测试1", // 优惠券名称
    "coupon_id": 311, // 优惠券ID
    "share_url": "https://test-dxb.baijiayun.com/s/Y5cFwEPQFK", // 
    "biz_id": 1
  },
  "pageDto": null
}

# 优惠券发放

# 接口说明

项	值
URL	`/openapi/v1/coupon/grant.json`
描述	优惠券发放
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	number	优惠券ID	是

# 请求数据

{
  "id": 5
}

# 返回数据

{
  "msg": "操作成功",
  "code": 200,
  "data": true,
  "pageDto": null
}

# 优惠券结束发放

# 接口说明

项	值
URL	`/openapi/v1/coupon/finishGrant.json`
描述	优惠券结束发放
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	number	优惠券ID	是

# 请求数据

{
  "id": 5
}

# 返回数据

{
  "msg": "操作成功",
  "code": 200,
  "data": true,
  "pageDto": null
}

# 优惠券删除

# 接口说明

项	值
URL	`/openapi/v1/coupon/delete.json`
描述	优惠券删除
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	number	优惠券ID	是

# 请求数据

{
  "id": 5
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": true,
  "pageDto": null
}

# 优惠券领取列表

# 接口说明

项	值
URL	`/openapi/v1/coupon/getList.json`
描述	优惠券领取列表
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	number	优惠券ID	是
status	number	状态 0 未使用 1.使用 2.已过期	否
pageDto	object	分页对象	是

# 分页对象

字段名	字段类型	说明	是否必传
pageSize	number	页大小	是。区间 (0,100]
pageNum	number	页码	是。从1开始

# 请求数据

{
  "pageDto": {
    "pageSize": 2,
    "pageNum": 1
  }
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": [
    {
      "id": 861,
      // 领取记录ID
      "customerNum": "LBQyXbmppH",
      // 学员编号
      "startAt": 1733476930000,
      // 有效开始时间
      "expireAt": 1733563330000,
      // 过期时间
      "employAt": 0,
      // 使用时间
      "status": 0,
      // 状态 0 未使用 1.使用 2.已过期
      "orderNo": "",
      // 使用订单号
      "liveId": 11277,
      // 领取直播ID
      "roomId": "24120651890869",
      // 领取房间ID
      "couponSn": "d0750009e17b9cd6b01de9fc75a97e05",
      // 百家云直播优惠券码
      "createdAt": 1733476930000
      // 领取时间
    },
    {
      "id": 860,
      "customerNum": "LBQyXbmppH",
      "startAt": 1733476784000,
      "expireAt": 1733735984000,
      "employAt": 1733476841000,
      "status": 1,
      "orderNo": "24120617204019829246",
      "liveId": 11277,
      "roomId": "24120651890869",
      "couponSn": "54178c27c579f55b9d80aa1f7da93475",
      "createdAt": 1733476785000
    }
  ],
  "pageDto": {
    "count": 10,
    // 总数
    "pageNum": 1,
    "pageSize": 2
  }
}

# 学员优惠券状态更新

# 接口说明

项	值
URL	`/openapi/v1/coupon/use.json`
描述	学员优惠券使用状态更新
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
couponCustomerId	number	学员优惠券ID	是
status	number	状态 0 未使用 1.已使用 2.已过期	是

# 请求数据

{
  "couponCustomerId": 1012,
  "status": 1
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": true,
  "pageDto": null
}

← 全局黑名单商品 →