• 开发者平台
  • >
  • 餐饮文档中心

查询券模板列表收费

(下行接口)客如云提供查询券模板列表

授权方式:门店授权

请求描述

HTTP请求方式:POST
HTTP请求头类型:Content-Type=application/json
URI:  /open/v1/crm/coupon/page

1.公共参数

详情可查看【公共说明】中的公共参数模块

2.业务参数

参数名 类型 是否必填 参数描述
brandId Long 客如云品牌Id
couponTypeList List<Intger> 优惠券类型((2, 折扣券),(3, 礼品券),(4, 代金券))
validDateTypeList List<Intger> 有效期类型((1, 相对日期), (2, 绝对日期))
pageSize Integer 每页数量,默认20条
currentPage Integer 页码

业务示例(JSON)

{
  "brandId": 2479,
  "couponTypeList": [1],
  "validDateTypeList": [1],
  "pageSize": 20,
  "currentPage": 1
}

响应参数

参数名 类型 是否必填 参数描述
code Int 返回编码,详见错误码
message String 返回信息
messageUuid String 消息uuid
result ResultPage 返回响应数据,json对象或数组,可空

ResultPage

参数名 类型 是否必填 参数描述
currentPage Long 当前页
totalPage Long 总页数
pageSize Long 每页条数
totalRows Long 总数据条数
items List<CouponInfo> 模板列表

CouponInfo

参数名 类型 是否必填 参数描述
id Long 券模版ID
name String 优惠券名字
couponType String 优惠券类型(FullCutCoupon(1, 满减券),DiscountCoupon(2, 折扣券),GiftCoupon(3, 礼品券),VoucherCoupon(4, 代金券))
status Intger 优惠券状态(Disabled(0, “已失效”), Unused(1, “未使用”), Using(2, “使用中”), Nostock(3, “无库存”))
denominationType String 面额类型(Money(1, “金额”), Quantity(2, “数量”), Discount(3, “折扣”))
denominationValue Double 面额值,面额类型Money(1, “金额”)时,单位元
fullValue Integer 最低消费金额
surplusNum Integer 剩余库存
totalNum Integer 投放总量
validType String 有效期类型:RelativeDate(1, 相对日期), AbsoluteDate(2, 绝对日期)
validStartDay String 有效起始日期(yyyy-MM-dd)
validEndDay String 有效结束日期(yyyy-MM-dd)
validDayNum Integer 有效期天数
periodStart String 开始时段
periodEnd String 结束时段
shopNameList List<String> 可用门店列表集合
weekday String 星期可用日
restrictWeekDay boolean 是否限制星期
content String 券内容
currentDayValid Boolean 是否当天可用

响应示例(JSON)

{
  "code": 0,
  "message": "string",
  "messageUuid": "string",
  "result": {
    "id":11122,
    "name":"优惠券",
    "couponType":"1",
    "status":0,
    "denominationType":"1",
    "denominationValue":500.00
  }
}
目录