券实体列表

接口地址

/marketing/coupon/list

入参

字段说明

名称	类型	必填	示例	描述
beginModifiedTime	String	否	"2022-04-01 00:00:00"	修改时间查询范围的开始，格式：yyyy-MM-dd HH:mm:ss
endModifiedTime	String	否	"2022-04-30 23:59:59"	修改时间查询范围的结束，格式：yyyy-MM-dd HH:mm:ss。最大时间区间1个月
beginCreationTime	String	否	"2022-04-01 00:00:00"	创建时间查询范围的开始，格式：yyyy-MM-dd HH:mm:ss
endCreationTime	String	否	"2022-04-30 23:59:59"	创建时间查询范围的结束，格式：yyyy-MM-dd HH:mm:ss。最大时间区间1个月。不支持同时按照创建时间和修改时间进行查询。
currentPage	Number	是	1	页码。取值范围：大于0的整数。默认值为1
pageSize	Number	是	10	每页条数。取值范围：大于0的整数。最大值100，默认值为10。

JSON示例

{
    "paramValues": [
        {
            "beginModifiedTime": "2022-04-01 00:00:00",
            "endModifiedTime": "2022-04-30 23:59:59",
            "currentPage": 1,
            "pageSize": 10
        }
    ]
}

{
    "paramValues": [
        {
            "beginCreationTime": "2022-04-01 00:00:00",
            "endCreationTime": "2022-04-30 23:59:59",
            "currentPage": 1,
            "pageSize": 10
        }
    ]
}

出参

字段说明

名称	类型	示例	描述
id	Number	8569588	券实体 ID，唯一
couponTemplateId	Number	111474	券模板 ID
couponName	String	"全车漆面纳米镀晶抵用券"	券名称
couponValue	Number	500.00	券面额
conditionType	Number	1	有无门槛。枚举值如下：0(无门槛), 1(有门槛)
conditionValue	Number	1000.00	门槛金额，当 conditionType 为 1 时才有值
validityBegin	String	"2022-04-01 00:00:00"	有效期开始时间，格式：yyyy-MM-dd HH:mm:ss
validityEnd	String	"2022-04-30 23:59:59"	有效期结束时间，格式：yyyy-MM-dd HH:mm:ss
status	Number	0	状态。枚举值如下：0(正常/未使用), 1(占用中), 2(已核销), 3(过期), 4(废弃)
customerId	Number	14870719207238282496	客户 ID
takeTime	String	"2022-03-31 15:30:40"	领取时间
takeSourceCode	String	"1206"	领取来源编码
takeSourceName	String	"领券中心"	领取来源名称
occupyTime	String	"2022-04-08 12:40:00"	预占时间，格式：yyyy-MM-dd HH:mm:ss
verifyTime	String	"2022-04-08 12:41:00"	核销时间，格式：yyyy-MM-dd HH:mm:ss
useOrderId	Number	11678644250513252441	用券订单 ID
useOrderCode	String	"GD20220715019"	用券订单号
useOrgId	Number	10907434497472394399	用券门店 ID
groupId	Number	10907434487472394300	公司 ID
createBy	Number	96058292161226708	发券操作人标识（ 对应登录用户 ID），如果是系统自动发券则为空
createByName	String	"李四"	发券操作人名称
creationTime	String	"2022-03-31 15:30:40"	创建时间，通常与 takeTime 一致
modifyBy	Number	96058292161226708	用券操作人标识（ 对应登录用户 ID）
modifyByName	String	"李四"	用券操作人名称
modifiedTime	String	"2022-04-08 12:41:00"	更新时间，通常与 verifyTime 一致
memo	String	"交保险赠送"	发券备注
carRangeType	Number	0	适用车辆范围类型，0-指定车辆 1-全部车辆
idCarList	Number[]	[16142092996945387524,16167137639864999964]	适用车辆 ID 列表，最多支持 10 个。 当 carRangeType = 0 时有值

JSON示例

{
    "code": 200,
    "message": "OK",
    "data": {
        "total": 1,
        "list": [
            {
          			"id": 8569588,
                "couponTemplateId": 111474,
          			"couponName": "全车漆面纳米镀晶抵用券",
          			"couponValue": 500.00,
          			"conditionType": 1,
                "conditionValue": 1000.00,
                "validityBegin": "2022-04-01 00:00:00",
                "validityEnd": "2022-04-30 23:59:59",
                "status": 0,
                "customerId": 14870719207238282496,
                "takeTime": "2022-03-31 15:30:40",
                "takeSourceCode": "1206",
                "takeSourceName": "领券中心",
                "occupyTime": "2022-04-08 12:40:00",
                "verifyTime": "2022-04-08 12:41:00",
                "useOrderId": 11678644250513252441,
                "useOrderCode": "GD20220715019",
                "useOrgId": 10907434497472394399,
                "groupId": 10907434487472394300,
                "createBy": 96058292161226708,
                "createByName": "李四",
                "creationTime": "2022-03-31 15:30:40",
                "modifyBy": 96058292161226708,
                "modifyByName": "李四",
                "modifiedTime": "2022-04-08 12:41:00",
                "memo": "交保险赠送",
                "carRangeType": 1
            }
        ]
    }
}