feat:【mall 商城】API 风格调整

This commit is contained in:
YunaiV
2025-10-08 11:17:22 +08:00
parent 4648f2023b
commit 5cdf1af39f
26 changed files with 399 additions and 731 deletions

View File

@@ -5,18 +5,18 @@ import { requestClient } from '#/api/request';
export namespace MallBannerApi { export namespace MallBannerApi {
/** Banner 信息 */ /** Banner 信息 */
export interface Banner { export interface Banner {
id: number; id: number; // Banner 编号
title: string; title: string; // Banner 标题
picUrl: string; picUrl: string; // Banner 图片
status: number; status: number; // 状态
url: string; url: string; // 链接地址
position: number; position: number; // Banner 位置
sort: number; sort: number; // 排序
memo: string; memo: string; // 备注
} }
} }
/** 查询Banner管理列表 */ /** 查询 Banner 管理列表 */
export function getBannerPage(params: PageParam) { export function getBannerPage(params: PageParam) {
return requestClient.get<PageResult<MallBannerApi.Banner>>( return requestClient.get<PageResult<MallBannerApi.Banner>>(
'/promotion/banner/page', '/promotion/banner/page',
@@ -24,24 +24,24 @@ export function getBannerPage(params: PageParam) {
); );
} }
/** 查询Banner管理详情 */ /** 查询 Banner 管理详情 */
export function getBanner(id: number) { export function getBanner(id: number) {
return requestClient.get<MallBannerApi.Banner>( return requestClient.get<MallBannerApi.Banner>(
`/promotion/banner/get?id=${id}`, `/promotion/banner/get?id=${id}`,
); );
} }
/** 新增Banner管理 */ /** 新增 Banner 管理 */
export function createBanner(data: MallBannerApi.Banner) { export function createBanner(data: MallBannerApi.Banner) {
return requestClient.post('/promotion/banner/create', data); return requestClient.post('/promotion/banner/create', data);
} }
/** 修改Banner管理 */ /** 修改 Banner 管理 */
export function updateBanner(data: MallBannerApi.Banner) { export function updateBanner(data: MallBannerApi.Banner) {
return requestClient.put('/promotion/banner/update', data); return requestClient.put('/promotion/banner/update', data);
} }
/** 删除Banner管理 */ /** 删除 Banner 管理 */
export function deleteBanner(id: number) { export function deleteBanner(id: number) {
return requestClient.delete(`/promotion/banner/delete?id=${id}`); return requestClient.delete(`/promotion/banner/delete?id=${id}`);
} }

View File

@@ -5,18 +5,12 @@ import { requestClient } from '#/api/request';
export namespace MallBrandApi { export namespace MallBrandApi {
/** 商品品牌 */ /** 商品品牌 */
export interface Brand { export interface Brand {
/** 品牌编号 */ id?: number; // 品牌编号
id?: number; name: string; // 品牌名称
/** 品牌名称 */ picUrl: string; // 品牌图片
name: string; sort?: number; // 品牌排序
/** 品牌图片 */ description?: string; // 品牌描述
picUrl: string; status: number; // 开启状态
/** 品牌排序 */
sort?: number;
/** 品牌描述 */
description?: string;
/** 开启状态 */
status: number;
} }
} }

View File

@@ -3,18 +3,12 @@ import { requestClient } from '#/api/request';
export namespace MallCategoryApi { export namespace MallCategoryApi {
/** 产品分类 */ /** 产品分类 */
export interface Category { export interface Category {
/** 分类编号 */ id?: number; // 分类编号
id?: number; parentId?: number; // 父分类编号
/** 父分类编号 */ name: string; // 分类名称
parentId?: number; picUrl: string; // 移动端分类图
/** 分类名称 */ sort: number; // 分类排序
name: string; status: number; // 开启状态
/** 移动端分类图 */
picUrl: string;
/** 分类排序 */
sort: number;
/** 开启状态 */
status: number;
} }
} }

View File

@@ -4,47 +4,47 @@ import { requestClient } from '#/api/request';
export namespace MallCommentApi { export namespace MallCommentApi {
export interface Property { export interface Property {
propertyId: number; propertyId: number; // 属性 ID
propertyName: string; propertyName: string; // 属性名称
valueId: number; valueId: number; // 属性值 ID
valueName: string; valueName: string; // 属性值名称
} }
/** 商品评论 */ /** 商品评论 */
export interface Comment { export interface Comment {
id: number; id: number; // 评论编号
userId: number; userId: number; // 用户编号
userNickname: string; userNickname: string; // 用户昵称
userAvatar: string; userAvatar: string; // 用户头像
anonymous: boolean; anonymous: boolean; // 是否匿名
orderId: number; orderId: number; // 订单编号
orderItemId: number; orderItemId: number; // 订单项编号
spuId: number; spuId: number; // 商品SPU编号
spuName: string; spuName: string; // 商品名称
skuId: number; skuId: number; // 商品SKU编号
visible: boolean; visible: boolean; // 是否可见
scores: number; scores: number; // 总评分
descriptionScores: number; descriptionScores: number; // 描述评分
benefitScores: number; benefitScores: number; // 服务评分
content: string; content: string; // 评论内容
picUrls: string[]; picUrls: string[]; // 评论图片
replyStatus: boolean; replyStatus: boolean; // 是否回复
replyUserId: number; replyUserId: number; // 回复人编号
replyContent: string; replyContent: string; // 回复内容
replyTime: Date; replyTime: Date; // 回复时间
createTime: Date; createTime: Date; // 创建时间
skuProperties: Property[]; skuProperties: Property[]; // SKU 属性数组
} }
/** 评论可见性更新 */ /** 评论可见性更新 */
export interface CommentVisibleUpdate { export interface CommentVisibleUpdate {
id: number; id: number; // 评论编号
visible: boolean; visible: boolean; // 是否可见
} }
/** 评论回复 */ /** 评论回复 */
export interface CommentReply { export interface CommentReply {
id: number; id: number; // 评论编号
replyContent: string; replyContent: string; // 回复内容
} }
} }

View File

@@ -5,12 +5,9 @@ import { requestClient } from '#/api/request';
export namespace MallFavoriteApi { export namespace MallFavoriteApi {
/** 商品收藏 */ /** 商品收藏 */
export interface Favorite { export interface Favorite {
/** 收藏编号 */ id?: number; // 收藏编号
id?: number; userId?: string; // 用户编号
/** 用户编号 */ spuId?: number; // 商品 SPU 编号
userId?: string;
/** 商品 SPU 编号 */
spuId?: null | number;
} }
} }

View File

@@ -5,21 +5,15 @@ import { requestClient } from '#/api/request';
export namespace MallHistoryApi { export namespace MallHistoryApi {
/** 商品浏览记录 */ /** 商品浏览记录 */
export interface BrowseHistory { export interface BrowseHistory {
/** 记录编号 */ id?: number; // 记录编号
id?: number; userId?: number; // 用户编号
/** 用户编号 */ spuId?: number; // 商品 SPU 编号
userId?: number; createTime?: Date; // 浏览时间
/** 商品 SPU 编号 */
spuId?: number;
/** 浏览时间 */
createTime?: Date;
} }
} }
/** /**
* 获得商品浏览记录分页 * 获得商品浏览记录分页
*
* @param params 请求参数
*/ */
export function getBrowseHistoryPage(params: PageParam) { export function getBrowseHistoryPage(params: PageParam) {
return requestClient.get<PageResult<MallHistoryApi.BrowseHistory>>( return requestClient.get<PageResult<MallHistoryApi.BrowseHistory>>(

View File

@@ -5,29 +5,22 @@ import { requestClient } from '#/api/request';
export namespace MallPropertyApi { export namespace MallPropertyApi {
/** 商品属性 */ /** 商品属性 */
export interface Property { export interface Property {
/** 属性编号 */ id?: number; // 属性编号
id?: number; name: string; // 名称
/** 名称 */ remark?: string; // 备注
name: string;
/** 备注 */
remark?: string;
} }
/** 属性值 */ /** 属性值 */
export interface PropertyValue { export interface PropertyValue {
/** 属性值编号 */ id?: number; // 属性值编号
id?: number; propertyId?: number; // 属性项的编号
/** 属性项的编号 */ name: string; // 名称
propertyId?: number; remark?: string; // 备注
/** 名称 */
name: string;
/** 备注 */
remark?: string;
} }
/** 属性值查询参数 */ /** 属性值查询参数 */
export interface PropertyValueQuery extends PageParam { export interface PropertyValueQuery extends PageParam {
propertyId?: number; propertyId?: number; // 属性编号
} }
} }

View File

@@ -5,124 +5,73 @@ import { requestClient } from '#/api/request';
export namespace MallSpuApi { export namespace MallSpuApi {
/** 商品属性 */ /** 商品属性 */
export interface Property { export interface Property {
/** 属性编号 */ propertyId?: number; // 属性编号
propertyId?: number; propertyName?: string; // 属性名称
/** 属性名称 */ valueId?: number; // 属性值编号
propertyName?: string; valueName?: string; // 属性值名称
/** 属性值编号 */
valueId?: number;
/** 属性值名称 */
valueName?: string;
} }
/** 商品 SKU */ /** 商品 SKU */
export interface Sku { export interface Sku {
/** 商品 SKU 编号 */ id?: number; // 商品 SKU 编号
id?: number; name?: string; // 商品 SKU 名称
/** 商品 SKU 名称 */ spuId?: number; // SPU 编号
name?: string; properties?: Property[]; // 属性数组
/** SPU 编号 */ price?: number | string; // 商品价格
spuId?: number; marketPrice?: number | string; // 市场价
/** 属性数组 */ costPrice?: number | string; // 成本价
properties?: Property[]; barCode?: string; // 商品条码
/** 商品价格 */ picUrl?: string; // 图片地址
price?: number | string; stock?: number; // 库存
/** 市场价 */ weight?: number; // 商品重量单位kg 千克
marketPrice?: number | string; volume?: number; // 商品体积单位m^3 平米
/** 成本价 */ firstBrokeragePrice?: number | string; // 一级分销的佣金
costPrice?: number | string; secondBrokeragePrice?: number | string; // 二级分销的佣金
/** 商品条码 */ salesCount?: number; // 商品销量
barCode?: string;
/** 图片地址 */
picUrl?: string;
/** 库存 */
stock?: number;
/** 商品重量单位kg 千克 */
weight?: number;
/** 商品体积单位m^3 平米 */
volume?: number;
/** 一级分销的佣金 */
firstBrokeragePrice?: number | string;
/** 二级分销的佣金 */
secondBrokeragePrice?: number | string;
/** 商品销量 */
salesCount?: number;
} }
/** 优惠券模板 */ /** 优惠券模板 */
export interface GiveCouponTemplate { export interface GiveCouponTemplate {
/** 优惠券编号 */ id?: number; // 优惠券编号
id?: number; name?: string; // 优惠券名称
/** 优惠券名称 */
name?: string;
} }
/** 商品 SPU */ /** 商品 SPU */
export interface Spu { export interface Spu {
/** 商品编号 */ id?: number; // 商品编号
id?: number; name?: string; // 商品名称
/** 商品名称 */ categoryId?: number; // 商品分类
name?: string; keyword?: string; // 关键字
/** 商品分类 */ unit?: number; // 单位
categoryId?: number; picUrl?: string; // 商品封面图
/** 关键字 */ sliderPicUrls?: string[]; // 商品轮播图
keyword?: string; introduction?: string; // 商品简介
/** 单位 */ deliveryTypes?: number[]; // 配送方式
unit?: number | undefined; deliveryTemplateId?: number; // 运费模版
/** 商品封面图 */ brandId?: number; // 商品品牌编号
picUrl?: string; specType?: boolean; // 商品规格
/** 商品轮播图 */ subCommissionType?: boolean; // 分销类型
sliderPicUrls?: string[]; skus?: Sku[]; // sku数组
/** 商品简介 */ description?: string; // 商品详情
introduction?: string; sort?: number; // 商品排序
/** 配送方式 */ giveIntegral?: number; // 赠送积分
deliveryTypes?: number[]; virtualSalesCount?: number; // 虚拟销量
/** 运费模版 */ price?: number; // 商品价格
deliveryTemplateId?: number | undefined; combinationPrice?: number; // 商品拼团价格
/** 商品品牌编号 */ seckillPrice?: number; // 商品秒杀价格
brandId?: number; salesCount?: number; // 商品销量
/** 商品规格 */ marketPrice?: number; // 市场价
specType?: boolean; costPrice?: number; // 成本价
/** 分销类型 */ stock?: number; // 商品库存
subCommissionType?: boolean; createTime?: Date; // 商品创建时间
/** sku数组 */ status?: number; // 商品状态
skus?: Sku[]; browseCount?: number; // 浏览量
/** 商品详情 */
description?: string;
/** 商品排序 */
sort?: number;
/** 赠送积分 */
giveIntegral?: number;
/** 虚拟销量 */
virtualSalesCount?: number;
/** 商品价格 */
price?: number;
/** 商品拼团价格 */
combinationPrice?: number;
/** 商品秒杀价格 */
seckillPrice?: number;
/** 商品销量 */
salesCount?: number;
/** 市场价 */
marketPrice?: number;
/** 成本价 */
costPrice?: number;
/** 商品库存 */
stock?: number;
/** 商品创建时间 */
createTime?: Date;
/** 商品状态 */
status?: number;
/** 浏览量 */
browseCount?: number;
} }
/** 商品状态更新 */ /** 商品状态更新 */
export interface StatusUpdate { export interface StatusUpdate {
/** 商品编号 */ id: number; // 商品编号
id: number; status: number; // 商品状态
/** 商品状态 */
status: number;
} }
} }

View File

@@ -5,32 +5,19 @@ import { requestClient } from '#/api/request';
export namespace MallArticleApi { export namespace MallArticleApi {
/** 文章管理 */ /** 文章管理 */
export interface Article { export interface Article {
/** 文章编号 */ id: number; // 文章编号
id: number; categoryId: number; // 分类编号
/** 分类编号 */ title: string; // 文章标题
categoryId: number; author: string; // 作者
/** 文章标题 */ picUrl: string; // 封面图
title: string; introduction: string; // 文章简介
/** 作者 */ browseCount: string; // 浏览数量
author: string; sort: number; // 排序
/** 封面图 */ status: number; // 状态
picUrl: string; spuId: number; // 商品编号
/** 文章简介 */ recommendHot: boolean; // 是否热门
introduction: string; recommendBanner: boolean; // 是否轮播图
/** 浏览数量 */ content: string; // 文章内容
browseCount: string;
/** 排序 */
sort: number;
/** 状态 */
status: number;
/** 商品编号 */
spuId: number;
/** 是否热门 */
recommendHot: boolean;
/** 是否轮播图 */
recommendBanner: boolean;
/** 文章内容 */
content: string;
} }
} }

View File

@@ -5,16 +5,11 @@ import { requestClient } from '#/api/request';
export namespace MallArticleCategoryApi { export namespace MallArticleCategoryApi {
/** 文章分类 */ /** 文章分类 */
export interface ArticleCategory { export interface ArticleCategory {
/** 分类编号 */ id: number; // 分类编号
id: number; name: string; // 分类名称
/** 分类名称 */ picUrl: string; // 分类图片
name: string; status: number; // 状态
/** 分类图片 */ sort: number; // 排序
picUrl: string;
/** 状态 */
status: number;
/** 排序 */
sort: number;
} }
} }

View File

@@ -7,62 +7,40 @@ import { requestClient } from '#/api/request';
export namespace MallBargainActivityApi { export namespace MallBargainActivityApi {
/** 砍价活动 */ /** 砍价活动 */
export interface BargainActivity { export interface BargainActivity {
/** 活动编号 */ id?: number; // 活动编号
id?: number; name?: string; // 活动名称
/** 活动名称 */ startTime?: Date; // 开始时间
name?: string; endTime?: Date; // 结束时间
/** 开始时间 */ status?: number; // 状态
startTime?: Date; helpMaxCount?: number; // 达到该人数,才能砍到低价
/** 结束时间 */ bargainCount?: number; // 最大帮砍次数
endTime?: Date; totalLimitCount?: number; // 最大购买次数
/** 状态 */ spuId: number; // 商品 SPU 编号
status?: number; skuId: number; // 商品 SKU 编号
/** 达到该人数,才能砍到低价 */ bargainFirstPrice: number; // 砍价起始价格,单位分
helpMaxCount?: number; bargainMinPrice: number; // 砍价底价
/** 最大帮砍次数 */ stock: number; // 活动库存
bargainCount?: number; randomMinPrice?: number; // 用户每次砍价的最小金额,单位:分
/** 最大购买次数 */ randomMaxPrice?: number; // 用户每次砍价的最大金额,单位:分
totalLimitCount?: number;
/** 商品 SPU 编号 */
spuId: number;
/** 商品 SKU 编号 */
skuId: number;
/** 砍价起始价格,单位分 */
bargainFirstPrice: number;
/** 砍价底价 */
bargainMinPrice: number;
/** 活动库存 */
stock: number;
/** 用户每次砍价的最小金额,单位:分 */
randomMinPrice?: number;
/** 用户每次砍价的最大金额,单位:分 */
randomMaxPrice?: number;
} }
/** 砍价活动所需属性。选择的商品和属性的时候使用方便使用活动的通用封装 */ /** 砍价活动所需属性。选择的商品和属性的时候使用方便使用活动的通用封装 */
export interface BargainProduct { export interface BargainProduct {
/** 商品 SPU 编号 */ spuId: number; // 商品 SPU 编号
spuId: number; skuId: number; // 商品 SKU 编号
/** 商品 SKU 编号 */ bargainFirstPrice: number; // 砍价起始价格,单位分
skuId: number; bargainMinPrice: number; // 砍价底价
/** 砍价起始价格,单位分 */ stock: number; // 活动库存
bargainFirstPrice: number;
/** 砍价底价 */
bargainMinPrice: number;
/** 活动库存 */
stock: number;
} }
/** 扩展 SKU 配置 */ /** 扩展 SKU 配置 */
export type SkuExtension = { export type SkuExtension = {
/** 砍价活动配置 */ productConfig: BargainProduct; // 砍价活动配置
productConfig: BargainProduct;
} & MallSpuApi.Sku; } & MallSpuApi.Sku;
/** 扩展 SPU 配置 */ /** 扩展 SPU 配置 */
export interface SpuExtension extends MallSpuApi.Spu { export interface SpuExtension extends MallSpuApi.Spu {
/** SKU 列表 */ skus: SkuExtension[]; // SKU 列表
skus: SkuExtension[];
} }
} }

View File

@@ -5,16 +5,11 @@ import { requestClient } from '#/api/request';
export namespace MallBargainHelpApi { export namespace MallBargainHelpApi {
/** 砍价记录 */ /** 砍价记录 */
export interface BargainHelp { export interface BargainHelp {
/** 记录编号 */ id: number; // 记录编号
id: number; record: number; // 砍价记录编号
/** 砍价记录编号 */ userId: number; // 用户编号
record: number; reducePrice: number; // 砍掉金额
/** 用户编号 */ endTime: Date; // 结束时间
userId: number;
/** 砍掉金额 */
reducePrice: number;
/** 结束时间 */
endTime: Date;
} }
} }

View File

@@ -5,26 +5,16 @@ import { requestClient } from '#/api/request';
export namespace MallBargainRecordApi { export namespace MallBargainRecordApi {
/** 砍价记录 */ /** 砍价记录 */
export interface BargainRecord { export interface BargainRecord {
/** 记录编号 */ id: number; // 记录编号
id: number; activityId: number; // 活动编号
/** 活动编号 */ userId: number; // 用户编号
activityId: number; spuId: number; // 商品 SPU 编号
/** 用户编号 */ skuId: number; // 商品 SKU 编号
userId: number; bargainFirstPrice: number; // 砍价起始价格
/** 商品 SPU 编号 */ bargainPrice: number; // 砍价价格
spuId: number; status: number; // 状态
/** 商品 SKU 编号 */ orderId: number; // 订单编号
skuId: number; endTime: Date; // 结束时间
/** 砍价起始价格 */
bargainFirstPrice: number;
/** 砍价价格 */
bargainPrice: number;
/** 状态 */
status: number;
/** 订单编号 */
orderId: number;
/** 结束时间 */
endTime: Date;
} }
} }

View File

@@ -7,59 +7,38 @@ import { requestClient } from '#/api/request';
export namespace MallCombinationActivityApi { export namespace MallCombinationActivityApi {
/** 拼团活动所需属性 */ /** 拼团活动所需属性 */
export interface CombinationProduct { export interface CombinationProduct {
/** 商品 SPU 编号 */ spuId: number; // 商品 SPU 编号
spuId: number; skuId: number; // 商品 SKU 编号
/** 商品 SKU 编号 */ combinationPrice: number; // 拼团价格
skuId: number;
/** 拼团价格 */
combinationPrice: number;
} }
/** 拼团活动 */ /** 拼团活动 */
export interface CombinationActivity { export interface CombinationActivity {
/** 活动编号 */ id?: number; // 活动编号
id?: number; name?: string; // 活动名称
/** 活动名称 */ spuId?: number; // 商品 SPU 编号
name?: string; totalLimitCount?: number; // 总限购数量
/** 商品 SPU 编号 */ singleLimitCount?: number; // 单次限购数量
spuId?: number; startTime?: Date; // 开始时间
/** 总限购数量 */ endTime?: Date; // 结束时间
totalLimitCount?: number; userSize?: number; // 用户数量
/** 单次限购数量 */ totalCount?: number; // 总数量
singleLimitCount?: number; successCount?: number; // 成功数量
/** 开始时间 */ orderUserCount?: number; // 订单用户数量
startTime?: Date; virtualGroup?: number; // 虚拟成团
/** 结束时间 */ status?: number; // 状态
endTime?: Date; limitDuration?: number; // 限制时长
/** 用户数量 */ combinationPrice?: number; // 拼团价格
userSize?: number; products: CombinationProduct[]; // 商品列表
/** 总数量 */
totalCount?: number;
/** 成功数量 */
successCount?: number;
/** 订单用户数量 */
orderUserCount?: number;
/** 虚拟成团 */
virtualGroup?: number;
/** 状态 */
status?: number;
/** 限制时长 */
limitDuration?: number;
/** 拼团价格 */
combinationPrice?: number;
/** 商品列表 */
products: CombinationProduct[];
} }
/** 扩展 SKU 配置 */ /** 扩展 SKU 配置 */
export type SkuExtension = { export type SkuExtension = {
/** 拼团活动配置 */ productConfig: CombinationProduct; // 拼团活动配置
productConfig: CombinationProduct;
} & MallSpuApi.Sku; } & MallSpuApi.Sku;
/** 扩展 SPU 配置 */ /** 扩展 SPU 配置 */
export interface SpuExtension extends MallSpuApi.Spu { export interface SpuExtension extends MallSpuApi.Spu {
/** SKU 列表 */ skus: SkuExtension[]; // SKU 列表
skus: SkuExtension[];
} }
} }

View File

@@ -5,44 +5,27 @@ import { requestClient } from '#/api/request';
export namespace MallCombinationRecordApi { export namespace MallCombinationRecordApi {
/** 拼团记录 */ /** 拼团记录 */
export interface CombinationRecord { export interface CombinationRecord {
/** 拼团记录编号 */ id: number; // 拼团记录编号
id: number; activityId: number; // 拼团活动编号
/** 拼团活动编号 */ nickname: string; // 用户昵称
activityId: number; avatar: string; // 用户头像
/** 用户昵称 */ headId: number; // 团长编号
nickname: string; expireTime: string; // 过期时间
/** 用户头像 */ userSize: number; // 可参团人数
avatar: string; userCount: number; // 已参团人数
/** 团长编号 */ status: number; // 拼团状态
headId: number; spuName: string; // 商品名字
/** 过期时间 */ picUrl: string; // 商品图片
expireTime: string; virtualGroup: boolean; // 是否虚拟成团
/** 可参团人数 */ startTime: string; // 开始时间 (订单付款后开始的时间)
userSize: number; endTime: string; // 结束时间(成团时间/失败时间)
/** 已参团人数 */
userCount: number;
/** 拼团状态 */
status: number;
/** 商品名字 */
spuName: string;
/** 商品图片 */
picUrl: string;
/** 是否虚拟成团 */
virtualGroup: boolean;
/** 开始时间 (订单付款后开始的时间) */
startTime: string;
/** 结束时间(成团时间/失败时间) */
endTime: string;
} }
/** 拼团记录概要信息 */ /** 拼团记录概要信息 */
export interface RecordSummary { export interface RecordSummary {
/** 待成团数量 */ pendingCount: number; // 待成团数量
pendingCount: number; successCount: number; // 已成团数量
/** 已成团数量 */ failCount: number; // 已失败数量
successCount: number;
/** 已失败数量 */
failCount: number;
} }
} }

View File

@@ -5,54 +5,32 @@ import { requestClient } from '#/api/request';
export namespace MallCouponTemplateApi { export namespace MallCouponTemplateApi {
/** 优惠券模板 */ /** 优惠券模板 */
export interface CouponTemplate { export interface CouponTemplate {
/** 模板编号 */ id: number; // 模板编号
id: number; name: string; // 模板名称
/** 模板名称 */ status: number; // 状态
name: string; totalCount: number; // 发放数量
/** 状态 */ takeLimitCount: number; // 每人限领个数
status: number; takeType: number; // 领取方式
/** 发放数量 */ usePrice: number; // 使用门槛
totalCount: number; productScope: number; // 商品范围
/** 每人限领个数 */ productScopeValues: number[]; // 商品范围值
takeLimitCount: number; validityType: number; // 有效期类型
/** 领取方式 */ validStartTime: Date; // 固定日期-生效开始时间
takeType: number; validEndTime: Date; // 固定日期-生效结束时间
/** 使用门槛 */ fixedStartTerm: number; // 领取日期-开始天数
usePrice: number; fixedEndTerm: number; // 领取日期-结束天数
/** 商品范围 */ discountType: number; // 优惠类型
productScope: number; discountPercent: number; // 折扣百分比
/** 商品范围值 */ discountPrice: number; // 优惠金额
productScopeValues: number[]; discountLimitPrice: number; // 折扣上限
/** 有效期类型 */ takeCount: number; // 已领取数量
validityType: number; useCount: number; // 已使用数量
/** 固定日期-生效开始时间 */
validStartTime: Date;
/** 固定日期-生效结束时间 */
validEndTime: Date;
/** 领取日期-开始天数 */
fixedStartTerm: number;
/** 领取日期-结束天数 */
fixedEndTerm: number;
/** 优惠类型 */
discountType: number;
/** 折扣百分比 */
discountPercent: number;
/** 优惠金额 */
discountPrice: number;
/** 折扣上限 */
discountLimitPrice: number;
/** 已领取数量 */
takeCount: number;
/** 已使用数量 */
useCount: number;
} }
/** 优惠券模板状态更新 */ /** 优惠券模板状态更新 */
export interface StatusUpdate { export interface StatusUpdate {
/** 模板编号 */ id: number; // 模板编号
id: number; status: 0 | 1; // 状态
/** 状态 */
status: 0 | 1;
} }
} }

View File

@@ -7,48 +7,33 @@ import { requestClient } from '#/api/request';
export namespace MallDiscountActivityApi { export namespace MallDiscountActivityApi {
/** 限时折扣相关属性 */ /** 限时折扣相关属性 */
export interface DiscountProduct { export interface DiscountProduct {
/** 商品 SPU 编号 */ spuId: number; // 商品 SPU 编号
spuId: number; skuId: number; // 商品 SKU 编号
/** 商品 SKU 编号 */ discountType: number; // 折扣类型
skuId: number; discountPercent: number; // 折扣百分比
/** 折扣类型 */ discountPrice: number; // 折扣价格
discountType: number;
/** 折扣百分比 */
discountPercent: number;
/** 折扣价格 */
discountPrice: number;
} }
/** 限时折扣活动 */ /** 限时折扣活动 */
export interface DiscountActivity { export interface DiscountActivity {
/** 活动编号 */ id?: number; // 活动编号
id?: number; spuId?: number; // 商品 SPU 编号
/** 商品 SPU 编号 */ name?: string; // 活动名称
spuId?: number; status?: number; // 状态
/** 活动名称 */ remark?: string; // 备注
name?: string; startTime?: Date; // 开始时间
/** 状态 */ endTime?: Date; // 结束时间
status?: number; products?: DiscountProduct[]; // 商品列表
/** 备注 */
remark?: string;
/** 开始时间 */
startTime?: Date;
/** 结束时间 */
endTime?: Date;
/** 商品列表 */
products?: DiscountProduct[];
} }
/** 扩展 SKU 配置 */ /** 扩展 SKU 配置 */
export type SkuExtension = { export type SkuExtension = {
/** 限时折扣配置 */ productConfig: DiscountProduct; // 限时折扣配置
productConfig: DiscountProduct;
} & MallSpuApi.Sku; } & MallSpuApi.Sku;
/** 扩展 SPU 配置 */ /** 扩展 SPU 配置 */
export interface SpuExtension extends MallSpuApi.Spu { export interface SpuExtension extends MallSpuApi.Spu {
/** SKU 列表 */ skus: SkuExtension[]; // SKU 列表
skus: SkuExtension[];
} }
} }

View File

@@ -5,18 +5,12 @@ import { requestClient } from '#/api/request';
export namespace MallDiyPageApi { export namespace MallDiyPageApi {
/** 装修页面 */ /** 装修页面 */
export interface DiyPage { export interface DiyPage {
/** 页面编号 */ id?: number; // 页面编号
id?: number; templateId?: number; // 模板编号
/** 模板编号 */ name: string; // 页面名称
templateId?: number; remark: string; // 备注
/** 页面名称 */ previewPicUrls: string[]; // 预览图片地址数组
name: string; property: string; // 页面属性
/** 备注 */
remark: string;
/** 预览图片地址数组 */
previewPicUrls: string[];
/** 页面属性 */
property: string;
} }
} }

View File

@@ -7,26 +7,18 @@ import { requestClient } from '#/api/request';
export namespace MallDiyTemplateApi { export namespace MallDiyTemplateApi {
/** 装修模板 */ /** 装修模板 */
export interface DiyTemplate { export interface DiyTemplate {
/** 模板编号 */ id?: number; // 模板编号
id?: number; name: string; // 模板名称
/** 模板名称 */ used: boolean; // 是否使用
name: string; usedTime?: Date; // 使用时间
/** 是否使用 */ remark: string; // 备注
used: boolean; previewPicUrls: string[]; // 预览图片地址数组
/** 使用时间 */ property: string; // 模板属性
usedTime?: Date;
/** 备注 */
remark: string;
/** 预览图片地址数组 */
previewPicUrls: string[];
/** 模板属性 */
property: string;
} }
/** 装修模板属性(包含页面列表) */ /** 装修模板属性(包含页面列表) */
export interface DiyTemplateProperty extends DiyTemplate { export interface DiyTemplateProperty extends DiyTemplate {
/** 页面列表 */ pages: MallDiyPageApi.DiyPage[]; // 页面列表
pages: MallDiyPageApi.DiyPage[];
} }
} }

View File

@@ -5,38 +5,24 @@ import { requestClient } from '#/api/request';
export namespace MallKefuConversationApi { export namespace MallKefuConversationApi {
/** 客服会话 */ /** 客服会话 */
export interface Conversation { export interface Conversation {
/** 编号 */ id: number; // 编号
id: number; userId: number; // 会话所属用户
/** 会话所属用户 */ userAvatar: string; // 会话所属用户头像
userId: number; userNickname: string; // 会话所属用户昵称
/** 会话所属用户头像 */ lastMessageTime: Date; // 最后聊天时间
userAvatar: string; lastMessageContent: string; // 最后聊天内容
/** 会话所属用户昵称 */ lastMessageContentType: number; // 最后发送的消息类型
userNickname: string; adminPinned: boolean; // 管理端置顶
/** 最后聊天时间 */ userDeleted: boolean; // 用户是否可见
lastMessageTime: Date; adminDeleted: boolean; // 管理员是否可见
/** 最后聊天内容 */ adminUnreadMessageCount: number; // 管理员未读消息数
lastMessageContent: string; createTime?: string; // 创建时间
/** 最后发送的消息类型 */
lastMessageContentType: number;
/** 管理端置顶 */
adminPinned: boolean;
/** 用户是否可见 */
userDeleted: boolean;
/** 管理员是否可见 */
adminDeleted: boolean;
/** 管理员未读消息数 */
adminUnreadMessageCount: number;
/** 创建时间 */
createTime?: string;
} }
/** 会话置顶请求 */ /** 会话置顶请求 */
export interface ConversationPinnedUpdate { export interface ConversationPinnedUpdate {
/** 会话编号 */ id: number; // 会话编号
id: number; pinned: boolean; // 是否置顶
/** 是否置顶 */
pinned: boolean;
} }
} }

View File

@@ -5,44 +5,29 @@ import { requestClient } from '#/api/request';
export namespace MallKefuMessageApi { export namespace MallKefuMessageApi {
/** 客服消息 */ /** 客服消息 */
export interface Message { export interface Message {
/** 编号 */ id: number; // 编号
id: number; conversationId: number; // 会话编号
/** 会话编号 */ senderId: number; // 发送人编号
conversationId: number; senderAvatar: string; // 发送人头像
/** 发送人编号 */ senderType: number; // 发送人类型
senderId: number; receiverId: number; // 接收人编号
/** 发送人头像 */ receiverType: number; // 接收人类型
senderAvatar: string; contentType: number; // 消息类型
/** 发送人类型 */ content: string; // 消息内容
senderType: number; readStatus: boolean; // 是否已读
/** 接收人编号 */ createTime: Date; // 创建时间
receiverId: number;
/** 接收人类型 */
receiverType: number;
/** 消息类型 */
contentType: number;
/** 消息内容 */
content: string;
/** 是否已读 */
readStatus: boolean;
/** 创建时间 */
createTime: Date;
} }
/** 发送消息请求 */ /** 发送消息请求 */
export interface MessageSend { export interface MessageSend {
/** 会话编号 */ conversationId: number; // 会话编号
conversationId: number; contentType: number; // 消息类型
/** 消息类型 */ content: string; // 消息内容
contentType: number;
/** 消息内容 */
content: string;
} }
/** 消息列表查询参数 */ /** 消息列表查询参数 */
export interface MessageQuery extends PageParam { export interface MessageQuery extends PageParam {
/** 会话编号 */ conversationId: number; // 会话编号
conversationId: number;
} }
} }

View File

@@ -7,80 +7,51 @@ import { requestClient } from '#/api/request';
export namespace MallPointActivityApi { export namespace MallPointActivityApi {
/** 积分商城商品 */ /** 积分商城商品 */
export interface PointProduct { export interface PointProduct {
/** 积分商城商品编号 */ id?: number; // 积分商城商品编号
id?: number; activityId?: number; // 积分商城活动 id
/** 积分商城活动 id */ spuId?: number; // 商品 SPU 编号
activityId?: number; skuId: number; // 商品 SKU 编号
/** 商品 SPU 编号 */ count: number; // 可兑换数量
spuId?: number; point: number; // 兑换积分
/** 商品 SKU 编号 */ price: number; // 兑换金额,单位:分
skuId: number; stock: number; // 积分商城商品库存
/** 可兑换数量 */ activityStatus?: number; // 积分商城商品状态
count: number;
/** 兑换积分 */
point: number;
/** 兑换金额,单位:分 */
price: number;
/** 积分商城商品库存 */
stock: number;
/** 积分商城商品状态 */
activityStatus?: number;
} }
/** 积分商城活动 */ /** 积分商城活动 */
export interface PointActivity { export interface PointActivity {
/** 积分商城活动编号 */ id: number; // 积分商城活动编号
id: number; spuId: number; // 积分商城活动商品
/** 积分商城活动商品 */ status: number; // 活动状态
spuId: number; stock: number; // 积分商城活动库存
/** 活动状态 */ totalStock: number; // 积分商城活动总库存
status: number; remark?: string; // 备注
/** 积分商城活动库存 */ sort: number; // 排序
stock: number; createTime: string; // 创建时间
/** 积分商城活动总库存 */ products: PointProduct[]; // 积分商城商品
totalStock: number; spuName: string; // 商品名称
/** 备注 */ picUrl: string; // 商品主图
remark?: string; marketPrice: number; // 商品市场价,单位:分
/** 排序 */ point: number; // 兑换积分
sort: number; price: number; // 兑换金额,单位:分
/** 创建时间 */
createTime: string;
/** 积分商城商品 */
products: PointProduct[];
/** 商品名称 */
spuName: string;
/** 商品主图 */
picUrl: string;
/** 商品市场价,单位:分 */
marketPrice: number;
/** 兑换积分 */
point: number;
/** 兑换金额,单位:分 */
price: number;
} }
/** 扩展 SKU 配置 */ /** 扩展 SKU 配置 */
export type SkuExtension = { export type SkuExtension = {
/** 积分商城商品配置 */ productConfig: PointProduct; // 积分商城商品配置
productConfig: PointProduct;
} & MallSpuApi.Sku; } & MallSpuApi.Sku;
/** 扩展 SPU 配置 */ /** 扩展 SPU 配置 */
export interface SpuExtension extends MallSpuApi.Spu { export interface SpuExtension extends MallSpuApi.Spu {
/** SKU 列表 */ skus: SkuExtension[]; // SKU 列表
skus: SkuExtension[];
} }
/** 扩展 SPU 配置(带积分信息) */ /** 扩展 SPU 配置(带积分信息) */
export interface SpuExtensionWithPoint extends MallSpuApi.Spu { export interface SpuExtensionWithPoint extends MallSpuApi.Spu {
/** 积分商城活动库存 */ pointStock: number; // 积分商城活动库存
pointStock: number; pointTotalStock: number; // 积分商城活动总库存
/** 积分商城活动总库存 */ point: number; // 兑换积分
pointTotalStock: number; pointPrice: number; // 兑换金额,单位:分
/** 兑换积分 */
point: number;
/** 兑换金额,单位:分 */
pointPrice: number;
} }
} }

View File

@@ -5,46 +5,29 @@ import { requestClient } from '#/api/request';
export namespace MallRewardActivityApi { export namespace MallRewardActivityApi {
/** 优惠规则 */ /** 优惠规则 */
export interface RewardRule { export interface RewardRule {
/** 满足金额 */ limit?: number; // 满足金额
limit?: number; discountPrice?: number; // 优惠金额
/** 优惠金额 */ freeDelivery?: boolean; // 是否包邮
discountPrice?: number; point: number; // 赠送积分
/** 是否包邮 */
freeDelivery?: boolean;
/** 赠送积分 */
point: number;
/** 赠送优惠券数量 */
giveCouponTemplateCounts?: { giveCouponTemplateCounts?: {
[key: number]: number; [key: number]: number;
}; }; // 赠送优惠券数量
} }
/** 满减送活动 */ /** 满减送活动 */
export interface RewardActivity { export interface RewardActivity {
/** 活动编号 */ id?: number; // 活动编号
id?: number; name?: string; // 活动名称
/** 活动名称 */ startTime?: Date; // 开始时间
name?: string; endTime?: Date; // 结束时间
/** 开始时间 */ startAndEndTime?: Date[]; // 开始和结束时间(仅前端使用)
startTime?: Date; remark?: string; // 备注
/** 结束时间 */ conditionType?: number; // 条件类型
endTime?: Date; productScope?: number; // 商品范围
/** 开始和结束时间(仅前端使用) */ rules: RewardRule[]; // 优惠规则列表
startAndEndTime?: Date[]; productScopeValues?: number[]; // 商品范围值(仅表单使用):值为品类编号列表、商品编号列表
/** 备注 */ productCategoryIds?: number[]; // 商品分类编号列表(仅表单使用)
remark?: string; productSpuIds?: number[]; // 商品 SPU 编号列表(仅表单使用)
/** 条件类型 */
conditionType?: number;
/** 商品范围 */
productScope?: number;
/** 优惠规则列表 */
rules: RewardRule[];
/** 商品范围值(仅表单使用):值为品类编号列表、商品编号列表 */
productScopeValues?: number[];
/** 商品分类编号列表(仅表单使用) */
productCategoryIds?: number[];
/** 商品 SPU 编号列表(仅表单使用) */
productSpuIds?: number[];
} }
} }

View File

@@ -7,66 +7,42 @@ import { requestClient } from '#/api/request';
export namespace MallSeckillActivityApi { export namespace MallSeckillActivityApi {
/** 秒杀商品 */ /** 秒杀商品 */
export interface SeckillProduct { export interface SeckillProduct {
/** 商品 SKU 编号 */ skuId: number; // 商品 SKU 编号
skuId: number; spuId: number; // 商品 SPU 编号
/** 商品 SPU 编号 */ seckillPrice: number; // 秒杀价格
spuId: number; stock: number; // 秒杀库存
/** 秒杀价格 */
seckillPrice: number;
/** 秒杀库存 */
stock: number;
} }
/** 秒杀活动 */ /** 秒杀活动 */
export interface SeckillActivity { export interface SeckillActivity {
/** 活动编号 */ id?: number; // 活动编号
id?: number; spuId?: number; // 商品 SPU 编号
/** 商品 SPU 编号 */ name?: string; // 活动名称
spuId?: number; status?: number; // 活动状态
/** 活动名称 */ remark?: string; // 备注
name?: string; startTime?: Date; // 开始时间
/** 活动状态 */ endTime?: Date; // 结束时间
status?: number; sort?: number; // 排序
/** 备注 */ configIds?: string; // 配置编号
remark?: string; orderCount?: number; // 订单数量
/** 开始时间 */ userCount?: number; // 用户数量
startTime?: Date; totalPrice?: number; // 总金额
/** 结束时间 */ totalLimitCount?: number; // 总限购数量
endTime?: Date; singleLimitCount?: number; // 单次限购数量
/** 排序 */ stock?: number; // 秒杀库存
sort?: number; totalStock?: number; // 秒杀总库存
/** 配置编号 */ seckillPrice?: number; // 秒杀价格
configIds?: string; products?: SeckillProduct[]; // 秒杀商品列表
/** 订单数量 */
orderCount?: number;
/** 用户数量 */
userCount?: number;
/** 总金额 */
totalPrice?: number;
/** 总限购数量 */
totalLimitCount?: number;
/** 单次限购数量 */
singleLimitCount?: number;
/** 秒杀库存 */
stock?: number;
/** 秒杀总库存 */
totalStock?: number;
/** 秒杀价格 */
seckillPrice?: number;
/** 秒杀商品列表 */
products?: SeckillProduct[];
} }
/** 扩展 SKU 配置 */ /** 扩展 SKU 配置 */
export type SkuExtension = { export type SkuExtension = {
/** 秒杀商品配置 */ productConfig: SeckillProduct; // 秒杀商品配置
productConfig: SeckillProduct;
} & MallSpuApi.Sku; } & MallSpuApi.Sku;
/** 扩展 SPU 配置 */ /** 扩展 SPU 配置 */
export interface SpuExtension extends MallSpuApi.Spu { export interface SpuExtension extends MallSpuApi.Spu {
/** SKU 列表 */ skus: SkuExtension[]; // SKU 列表
skus: SkuExtension[];
} }
} }

View File

@@ -5,26 +5,18 @@ import { requestClient } from '#/api/request';
export namespace MallSeckillConfigApi { export namespace MallSeckillConfigApi {
/** 秒杀时段 */ /** 秒杀时段 */
export interface SeckillConfig { export interface SeckillConfig {
/** 编号 */ id: number; // 编号
id: number; name: string; // 秒杀时段名称
/** 秒杀时段名称 */ startTime: string; // 开始时间点
name: string; endTime: string; // 结束时间点
/** 开始时间点 */ sliderPicUrls: string[]; // 秒杀轮播图
startTime: string; status: number; // 活动状态
/** 结束时间点 */
endTime: string;
/** 秒杀轮播图 */
sliderPicUrls: string[];
/** 活动状态 */
status: number;
} }
/** 时段配置状态更新 */ /** 时段配置状态更新 */
export interface StatusUpdate { export interface StatusUpdate {
/** 编号 */ id: number; // 编号
id: number; status: number; // 状态
/** 状态 */
status: number;
} }
} }

View File

@@ -7,67 +7,65 @@ import { requestClient } from '#/api/request';
export namespace MallMemberStatisticsApi { export namespace MallMemberStatisticsApi {
/** 会员分析 Request */ /** 会员分析 Request */
export interface AnalyseReq { export interface AnalyseReq {
times: Date[]; times: Date[]; // 时间范围
} }
/** 会员分析对照数据 Response */ /** 会员分析对照数据 Response */
export interface AnalyseComparison { export interface AnalyseComparison {
registerUserCount: number; registerUserCount: number; // 注册用户数
visitUserCount: number; visitUserCount: number; // 访问用户数
rechargeUserCount: number; rechargeUserCount: number; // 充值用户数
} }
/** 会员分析 Response */ /** 会员分析 Response */
export interface Analyse { export interface Analyse {
visitUserCount: number; visitUserCount: number; // 访问用户数
orderUserCount: number; orderUserCount: number; // 下单用户数
payUserCount: number; payUserCount: number; // 支付用户数
atv: number; atv: number; // 平均客单价
comparison: MallDataComparisonResp<AnalyseComparison>; comparison: MallDataComparisonResp<AnalyseComparison>; // 对照数据
} }
/** 会员地区统计 Response */ /** 会员地区统计 Response */
export interface AreaStatistics { export interface AreaStatistics {
areaId: number; areaId: number; // 地区ID
areaName: string; areaName: string; // 地区名称
userCount: number; userCount: number; // 用户数
orderCreateUserCount: number; orderCreateUserCount: number; // 下单用户数
orderPayUserCount: number; orderPayUserCount: number; // 支付用户数
orderPayPrice: number; orderPayPrice: number; // 支付金额
} }
/** 会员性别统计 Response */ /** 会员性别统计 Response */
export interface SexStatistics { export interface SexStatistics {
sex: number; sex: number; // 性别
userCount: number; userCount: number; // 用户数
} }
/** 会员统计 Response */ /** 会员统计 Response */
export interface Summary { export interface Summary {
userCount: number; userCount: number; // 用户数
rechargeUserCount: number; rechargeUserCount: number; // 充值用户数
rechargePrice: number; rechargePrice: number; // 充值金额
expensePrice: number; expensePrice: number; // 消费金额
} }
/** 会员终端统计 Response */ /** 会员终端统计 Response */
export interface TerminalStatistics { export interface TerminalStatistics {
terminal: number; terminal: number; // 终端
userCount: number; userCount: number; // 用户数
} }
/** 会员数量统计 Response */ /** 会员数量统计 Response */
export interface Count { export interface Count {
/** 用户访问量 */ visitUserCount: string; // 用户访问量
visitUserCount: string; registerUserCount: number; // 注册用户数量
/** 注册用户数量 */
registerUserCount: number;
} }
/** 会员注册数量 Response */ /** 会员注册数量 Response */
export interface RegisterCount { export interface RegisterCount {
date: string; date: string; // 日期
count: number; count: number; // 数量
} }
} }