# 券模板列表

# 接口地址

/marketing/coupon/template/list

# 入参

# 字段说明

名称 类型 必填 示例 描述
beginCreationTime String "2020-04-01 10:01:30" 创建时间查询范围的开始,格式:yyyy-MM-dd HH:mm:ss。
不支持同时根据创建时间和修改时间查询,必须二者选其一。
endCreationTime String "2020-04-10 21:40:00" 创建时间查询范围的结束,格式:yyyy-MM-dd HH:mm:ss。最大时间区间1个月。
不支持同时根据创建时间和修改时间查询,必须二者选其一。
beginModifiedTime String "2020-04-01 10:01:30" 修改时间查询范围的开始,格式:yyyy-MM-dd HH:mm:ss。
不支持同时根据创建时间和修改时间查询,必须二者选其一。
endModifiedTime String "2020-04-10 21:40:00" 修改时间查询范围的结束,格式:yyyy-MM-dd HH:mm:ss。最大时间区间1个月。
不支持同时根据创建时间和修改时间查询,必须二者选其一。
currentPage Number 1 页码。取值范围:大于0的整数。默认值为1。
pageSize Number 10 每页条数。取值范围:大于0的整数。最大值100,默认值为10。

# JSON示例

{
    "paramValues": [
        {
            "beginCreationTime": "2023-01-01 00:00:00",
            "endCreationTime": "2023-01-31 23:59:59",
            "currentPage": 1,
            "pageSize": 100
        }
    ]
}

# 出参

# 字段说明

名称 类型 示例 描述
total Number 128 优惠券模板的总条数。
list CouponTemplatePageInfo[] 优惠券模板基础信息列表。

# CouponTemplatePageInfo

名称 类型 示例 描述
id Number 1 优惠券模板的唯一标识。
couponName String "免费洗车一次" 优惠券名称。
status Number 1 优惠券模板的启停用状态。0-停用,1-启用。
couponValue Number 100.00 优惠券面额。
conditionType Number 1 使用优惠券是否有门槛金额。0-无门槛,1-有门槛。
conditionValue Number 200.00 当优惠券有使用门槛时对应的门槛金额。
validityType Number 0 优惠券有效期类型。0-具体日期,1-领取后的天数。
validityBegin String "2023-12-01" 当优惠券的有效期类型为具体日期时对应的有效期开始时间。
validityEnd String "2023-12-31" 当优惠券的有效期类型为具体日期时对应的有效期结束时间。
validityDays Number 7 当优惠券的有效期类型为领取后的天数时对应的天数。
orgRangeType Number 0 优惠券的使用门店范围。0-部分门店,1-全部门店。
goodsRangeType Number 0 优惠券可用商品范围。0-部分商品,1-全部商品。
takeQuota Number 2 优惠券每人限领的张数。等于 0 时代表不限领。
totalStock Number 999 优惠券的发放总量。
remainStock Number 888 优惠券的剩余数量。
withholdStock Number 111 优惠券的锁定数量。
couponDesc String "仅限一店使用,不与其他优惠同享。最终解释权归我司所有" 优惠券的使用说明。
isDeleted Number 0 优惠券模板的删除标识。0-未删除,1-已删除。
idOwnOrg Number 16011640498246656021 优惠券模板创建门店的唯一标识。
creationTime String "2023-12-19 12:32:18" 优惠券模板的创建时间。
modifiedTime String "2023-12-19 18:19:20" 优惠券模板的修改时间。

# JSON示例

{
    "code": 200,
    "message": "OK",
    "data": {
        "total": 1,
        "list": [
            {
                "id": 1,
                "couponName": "免费洗车一次",
                "couponValue": 10,
                "couponDesc": "仅限一店使用,不与其他优惠同享。最终解释权归我司所有",
                "totalStock": 999,
                "remainStock": 888,
                "withholdStock": 111,
                "takeQuota": 2,
                "conditionType": 2,
                "conditionValue": 100,
                "validityType": 0,
                "validityBegin": "2023-12-01",
                "validityEnd": "2023-12-31",
                "validityDays": 0,
                "orgRangeType": 1,
                "goodsRangeType": 1,
                "status": 1,
                "isDeleted": 0,
                "idOwnOrg": 16011640498246656021,
                "creationTime": "2023-12-19 12:32:18",
                "modifiedTime": "2023-12-19 18:19:20"
            }
        ]
    }
}