Litemall优惠卷管理接口文档

一、获取 token

获取X-Litemall-Admin-Token是调用Litemall商城后台管理API接口的第一步,相当于创建了一个登录凭证,其它的业务API接口,都需要依赖于X-Litemall-Admin-Token来鉴权调用者身份。

请求方式: POST(HTTPS
请求地址:/admin/auth/login
参数说明:

参数 是否必填 说明
username 用户名,默认hogwarts
password 密码,默认密码test12345

返回结果示例:

{
	"errno": 0,
	"data": {
		"adminInfo": {
			"nickName": "hogwarts",
			"avatar": "https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif"
		},
		"token": "3cded3b1-1e12-4cba-a49f-8b51936fcba0"
	},
	"errmsg": "成功"
}

备注:X-Litemall-Admin-Token 使用方法:在每个业务接口的headers中添加token键值对,键为“X-Litemall-Admin-Token”,值为具体的token值。

字段 备注
X-Litemall-Admin-Token 随机文本,例如“7172bbc7-f81a-4a78-9220-e55e3cfdf98c” 通过登录接口获取

二、优惠卷列表

管理员可以通过此接口实现查看优惠卷列表功能。
请求方式:GET(HTTPS)
请求地址:/admin/goods/list

参数说明:

{"limit":"0"}

返回结果示例:

{
    "errno": 0,
    "data": {
        "total": 7889,
        "pages": 0,
        "limit": 0,
        "page": 0,
        "list": [
            {
                "id": 1465561,
                "goodsSn": "1238",
                "name": "MC1vvtfhfd98",
                "categoryId": 0,
                "brandId": 0,
                "gallery": [],
                "keywords": "",
                "brief": "商品58",
                "isOnSale": true,
                "sortOrder": 100,
                "picUrl": "",
                "isNew": true,
                "isHot": false,
                "unit": "’件‘",
                "counterPrice": 11774.00,
                "retailPrice": 0.00,
                "addTime": "2024-09-19 11:43:50",
                "updateTime": "2024-09-19 11:43:50",
                "deleted": false
            },
    "errmsg": "成功"
}

三、查询优惠卷

管理员可以通过此接口实现查询对应优惠卷功能。
请求方式:GET(HTTPS)
请求地址:/admin/coupon/list

参数说明:

{"name":"11"}

返回结果示例:

{
  {
   "errno": 0,
    "data": {
        "total": 304,
        "pages": 16,
        "limit": 20,
        "page": 1,
        "list": [
            {
                "id": 20187,
                "name": "11",
                "desc": "1",
                "tag": "1",
                "total": 1,
                "discount": 0.00,
                "min": 0.00,
                "limit": 1,
                "type": 0,
                "status": 0,
                "goodsType": 0,
                "goodsValue": [],
                "timeType": 0,
                "days": 1,
                "addTime": "2024-09-23 06:27:31",
                "updateTime": "2024-09-23 06:27:31",
                "deleted": false
            },
    "errmsg": "成功"
}
}

四、添加优惠卷

管理员可以通过此接口实现添加优惠卷功能。
请求方式:POST(HTTP)
请求地址:/admin/coupon/create
请求示例:

{"name":"满减卷",
"desc":"达到一定金额可以使用",
"tag":"优惠",
"total":"1000",
"discount":"20",
"min":"100",
"limit":1,
"type":0,
"status":0,
"goodsType":0,
"goodsValue":[],
"timeType":0,
"days":"100",
"startTime":null,
"endTime":null
}

参数说明:

参数 是否必填 说明
name 优惠劵名称
desc 介绍
tag 标签
total 数量
discount 满减金额
min 最低消费
limit 每人限领

返回结果示例:

{
    "errno": 0,
    "data": {
        "id": 20191,
        "name": "满减卷",
        "desc": "达到一定金额可以使用",
        "tag": "优惠",
        "total": 1000,
        "discount": 20,
        "min": 100,
        "limit": 1,
        "type": 0,
        "status": 0,
        "goodsType": 0,
        "goodsValue": [],
        "timeType": 0,
        "days": 100,
        "addTime": "2024-09-23 07:59:42",
        "updateTime": "2024-09-23 07:59:42"
    },
    "errmsg": "成功"
}

五、编辑优惠卷

管理员可以通过此接口实现编辑优惠卷功能。
请求方式:POST(HTTPS)
请求地址:/admin/coupon/update
请求示例:

{"id":20191,
"name":"满减卷",
"desc":"达到一定金额可以使用",
"tag":"优惠",
"total":1000,
"discount":50,
"min":100,
"limit":1,
"type":0,
"status":0,
"goodsType":1,
"goodsValue":[1008002],
"timeType":0,
"days":100,
"addTime":"2024-09-23 07:59:42",
"updateTime":"2024-09-23 07:59:42",
"daysType":0
}

参数说明:

参数 是否必填 说明
name 优惠劵名称
desc 介绍
tag 标签
total 数量
discount 满减金额
min 最低消费
limit 每人限领

返回结果示例:

{
    "errno": 0,
    "data": {
        "id": 20190,
        "name": "满减卷",
        "desc": "达到一定金额可以使用",
        "tag": "优惠",
        "total": 1000,
        "discount": 20,
        "min": 100,
        "limit": 1,
        "type": 0,
        "status": 0,
        "goodsType": 1,
        "goodsValue": [
            1008002
        ],
        "timeType": 0,
        "days": 100,
        "addTime": "2024-09-23 07:35:45",
        "updateTime": "2024-09-23 08:24:42"
    },
    "errmsg": "成功"
}

六、删除优惠卷

管理员可以通过此接口实现删除优惠卷功能。
请求方式:POST(HTTPS)
请求地址:/admin/coupon/delete
请求示例:

{"id":20190,
"name":"满减卷",
"desc":"达到一定金额可以使用",
"tag":"优惠",
"total":1000,
"discount":20,
"min":100,
"limit":1,
"type":0,
"status":0,
"goodsType":1,
"goodsValue":[1008002],
"timeType":0,
"days":100,
"addTime":"2024-09-23 07:35:45",
"updateTime":"2024-09-23 07:35:45",
"daysType":0
}

参数说明:

参数 是否必填 说明
name 优惠劵名称
desc 介绍
tag 标签
total 数量
discount 满减金额
min 最低消费
limit 每人限领

返回结果示例:

{
"errno":0,
"errmsg":"成功"
}