营销优惠

说明

用户未领取的优惠券叫做「优惠券模板」；用户领取之后的叫做「优惠券」。优惠金额单位为分。

获取优惠券模板列表

获取可供用户领取的优惠券模板列表。

URL：/app-api/promotion/coupon-template/page
Method：POST
需要鉴权：是

请求参数

参数	类型	约束	说明
productScope	Long	-	商品使用范围，`1`-全部商品（通用券），`2`-指定商品，`3`-指定品类
spuId	Long	-	商品编号，获取指定商品的优惠券模板

请求示例

通用券：

{
    "productScope": 1
}

指定商品：

{
    "productScope": 2,
    "spuId": 1009
}

响应示例

{
    "code": 0,
    "data": {
        "list": [
            {
                "id": 1,
                "name": "9 折卷",
                "description": "优惠券说明",
                "takeLimitCount": 100,
                "usePrice": 1000,
                "productScope": 1,
                "productScopeValues": [633, 634],
                "validityType": 2,
                "validStartTime": null,
                "validEndTime": null,
                "fixedStartTerm": 0,
                "fixedEndTerm": 2,
                "discountType": 2,
                "discountPercent": 90,
                "discountPrice": 1000,
                "discountLimitPrice": 9999900,
                "canTake": true
            }
        ],
        "total": 1
    },
    "msg": "成功"
}

响应说明

参数	类型	说明
id	Long	数据编号
name	String	优惠券名称
description	String	优惠券说明
takeLimitCount	Long	每人限领个数，`-1` 表示不限制
usePrice	Long	满多少金额可用，单位：分
productScope	Long	商品范围，`1`-全部商品，`2`-指定商品，`3`-指定品类
productScopeValues	List	商品范围编号数组
validityType	Long	生效日期类型，`1`-固定日期，`2`-领取之后
validStartTime	Long	固定日期-开始时间
validEndTime	Long	固定日期-结束时间
fixedStartTerm	Long	领取日期-开始天数
fixedEndTerm	Long	领取日期-结束天数
discountType	Long	优惠类型，`1`-满减，`2`-折扣
discountPercent	Long	折扣百分比
discountPrice	Long	优惠金额，单位：分
discountLimitPrice	Long	折扣上限，仅在 `discountType` 为折扣时使用
status	Long	优惠券模板状态，`0`-开启，`1`-关闭
canTake	Boolean	当前用户是否可以领取

获取优惠券模板详情

获取单个优惠券模板的详细信息。

URL：/app-api/promotion/coupon-template/getCouponTemplate
Method：POST
需要鉴权：是

请求参数

参数	类型	约束	说明
id	Long	必传	优惠券模板编号

请求示例

{
    "id": 1
}

响应示例

{
    "code": 0,
    "data": {
        "id": 1,
        "name": "9 折卷",
        "description": "优惠券说明",
        "takeLimitCount": 100,
        "usePrice": 1000,
        "productScope": 1,
        "productScopeValues": [633, 634],
        "validityType": 2,
        "fixedStartTerm": 0,
        "fixedEndTerm": 2,
        "discountType": 2,
        "discountPercent": 90,
        "discountPrice": 1000,
        "discountLimitPrice": 9999900,
        "canTake": true
    },
    "msg": "成功"
}

响应说明

响应字段同「获取优惠券模板列表」。

领取优惠券

用户领取优惠券。

URL：/app-api/promotion/coupon/take
Method：POST
需要鉴权：是

请求参数

参数	类型	约束	说明
templateId	Long	必传	优惠券模板编号

请求示例

{
    "templateId": 1
}

响应示例

{
    "code": 0,
    "data": true,
    "msg": "成功"
}

响应说明

参数	类型	说明
data	Boolean	`true`-可以继续领取，`false`-不能继续领取

说明

如果接口未抛出异常，则说明领取成功。data 返回的 true/false 代表用户是否可以继续领取该优惠券。

获取我的优惠券列表

获取用户已领取的优惠券列表。

URL：/app-api/promotion/coupon/page
Method：POST
需要鉴权：是

请求参数

参数	类型	约束	说明
status	Long	必传	优惠券状态，`1`-已领取，`2`-已使用，`3`-已过期

请求示例

{
    "status": 1
}

响应示例

{
    "code": 0,
    "data": {
        "list": [
            {
                "id": 43,
                "name": "9 折卷",
                "status": 1,
                "usePrice": 1000,
                "productScope": 1,
                "productScopeValues": [633, 634],
                "validStartTime": 1731685440000,
                "validEndTime": 1731858240000,
                "discountType": 2,
                "discountPercent": 90,
                "discountPrice": 1000,
                "discountLimitPrice": 9999900,
                "userId": 305
            }
        ],
        "total": 1
    },
    "msg": "成功"
}

响应说明

参数	类型	说明
id	Long	数据编号
name	String	优惠券名称
status	Long	优惠券状态，`1`-已领取，`2`-已使用，`3`-已过期
usePrice	Long	满多少金额可用
productScope	Long	商品范围，`1`-全部商品，`2`-指定商品，`3`-指定品类
productScopeValues	List	商品范围编号数组
validityType	Long	生效日期类型，`1`-固定日期，`2`-领取之后
validStartTime	Long	固定日期-开始时间
validEndTime	Long	固定日期-结束时间
fixedStartTerm	Long	领取日期-开始天数
fixedEndTerm	Long	领取日期-结束天数
discountType	Long	优惠类型，`1`-满减，`2`-折扣
discountPercent	Long	折扣百分比
discountPrice	Long	优惠金额，单位：分
discountLimitPrice	Long	折扣上限
userId	Long	用户编号
takeType	Long	领取方式，`1`-直接领取，`2`-指定发放，`3`-新人专享，`4`-积分兑换

获取我的优惠券详情

获取用户已领取的优惠券详情。

URL：/app-api/promotion/coupon/get
Method：POST
需要鉴权：是

请求参数

参数	类型	约束	说明
couponId	Long	必传	优惠券数据编号

请求示例

{
    "couponId": 43
}

响应示例

{
    "code": 0,
    "data": {
        "id": 43,
        "name": "9 折卷",
        "status": 1,
        "usePrice": 1000,
        "productScope": 1,
        "productScopeValues": [633, 634],
        "validStartTime": 1731685440000,
        "validEndTime": 1731858240000,
        "discountType": 2,
        "discountPercent": 90,
        "discountPrice": 1000,
        "discountLimitPrice": 9999900,
        "userId": 305
    },
    "msg": "成功"
}

响应说明

响应字段同「获取我的优惠券列表」。

积分兑换优惠券模板列表

获取可积分兑换的优惠券模板列表。

URL：/app-api/promotion/coupon-template/getPointCouponTemplatePage
Method：POST
需要鉴权：是

请求参数

参数	类型	约束	说明
productScope	Long	-	商品使用范围，`1`-全部商品，`2`-指定商品，`3`-指定品类

请求示例

{
    "productScope": 1
}

响应示例

{
    "code": 0,
    "data": {
        "list": [
            {
                "id": 32,
                "name": "200积分兑换满1000减10元优惠券",
                "description": "200积分兑换满1000减10元优惠券",
                "takeLimitCount": -1,
                "usePrice": 100000,
                "productScope": 1,
                "productScopeValues": [],
                "validityType": 2,
                "fixedStartTerm": 0,
                "fixedEndTerm": 180,
                "discountType": 1,
                "discountPercent": 0,
                "discountPrice": 1000,
                "discountLimitPrice": 0,
                "status": 0,
                "canTake": true,
                "pointPrice": null
            }
        ],
        "total": 1
    },
    "msg": "成功"
}

响应说明

参数	类型	说明
id	Long	数据编号
name	String	优惠券名称
description	String	优惠券说明
takeLimitCount	Long	每人限领个数，`-1` 表示不限制
usePrice	Long	满多少金额可用
productScope	Long	商品范围，`1`-全部商品，`2`-指定商品，`3`-指定品类
productScopeValues	List	商品范围编号数组
validityType	Long	生效日期类型，`1`-固定日期，`2`-领取之后
validStartTime	Long	固定日期-开始时间
validEndTime	Long	固定日期-结束时间
fixedStartTerm	Long	领取日期-开始天数
fixedEndTerm	Long	领取日期-结束天数
discountType	Long	优惠类型，`1`-满减，`2`-折扣
discountPercent	Long	折扣百分比
discountPrice	Long	优惠金额，单位：分
discountLimitPrice	Long	折扣上限
status	Long	优惠券模板状态，`0`-开启，`1`-关闭
canTake	Boolean	当前用户是否可以领取
pointPrice	Long	积分兑换所需积分

获取优惠券模板列表​

请求参数​

请求示例​

响应示例​

响应说明​

获取优惠券模板详情​

请求参数​

请求示例​

响应示例​

响应说明​

领取优惠券​

请求参数​

请求示例​

响应示例​

响应说明​

获取我的优惠券列表​

请求参数​

请求示例​

响应示例​

响应说明​

获取我的优惠券详情​

请求参数​

请求示例​

响应示例​

响应说明​

积分兑换优惠券模板列表​

请求参数​

请求示例​

响应示例​

响应说明​

获取优惠券模板列表

请求参数

请求示例

响应示例

响应说明

获取优惠券模板详情

请求参数

请求示例

响应示例

响应说明

领取优惠券

请求参数

请求示例

响应示例

响应说明

获取我的优惠券列表

请求参数

请求示例

响应示例

响应说明

获取我的优惠券详情

请求参数

请求示例

响应示例

响应说明

积分兑换优惠券模板列表

请求参数

请求示例

响应示例

响应说明