/** * Namespace Api * * All backend api type */ declare namespace Api { namespace Common { /** common params of paginating */ interface PaginatingCommonParams { /** current page number */ current: number; /** page size */ size: number; /** total count */ total: number; } /** common params of paginating query list data */ interface PaginatingQueryRecord extends PaginatingCommonParams { records: T[]; } /** common search params of table */ type CommonSearchParams = Pick; /** * enable status * * - "1": enabled * - "0": disabled */ type EnableStatus = '0' | '1'; /** common record */ type CommonRecord = { /** record id */ id: number; /** record creator */ createBy: string; /** record create time */ createTime: string; /** record updater */ updateBy: string; /** record update time */ updateTime: string; /** record status */ status: EnableStatus | null; } & T; /** * 通用状态 */ type commonStatus = 0 | 1; } /** * namespace Auth * * backend api module: "auth" */ namespace Auth { interface LoginToken { token: string; refreshToken: string; } interface UserInfo { userId: string; username: string; roles: string[]; buttons: string[]; email: string; mobile: string; } interface UserPassWord { password: string; newPassword: string; } } /** * namespace Route * * backend api module: "route" */ namespace Route { // type ElegantConstRoute = import('@elegant-router/types').ElegantConstRoute; interface MenuRoute extends ElegantConstRoute { id: string; } interface UserRoute { [x: string]: any; routes: MenuRoute[]; home: import('@elegant-router/types').LastLevelRouteKey; } } /** * 商品管理模块 */ namespace goods { interface ShopCategory { children?: ShopCategory[]; /** * 编码 */ code?: string; /** * 前台类目模板id(一级时有) */ frontCategoryId?: number; /** * 主键 */ id?: number; /** * 是否删除(0 正常 1 已被删除) */ isDelete?: number; /** * 是否叶子(1-是,2-不是) */ isLeaves?: number; /** * 类目等级 */ level?: number; /** * 类目名称 */ name?: string; /** * 序号 */ num: number; /** * 操作人 */ operateUser?: string; /** * 父级分类编码 */ parentCode?: string; /** * 父级分类名称 */ parentName?: string; /** * 门店ID */ shopId?: number; [property: string]: any; } interface tag { /** * 创建日期 */ creationDate?: string; /** * 主键 */ id?: number; /** * 是否删除(0-未删除,1-已删除) */ isDelete?: number; /** * 标签名称 */ name?: string; /** * 标签类型 */ type?: number; [property: string]: any; } interface ChannelProd { /** * 渠道ID */ channelId?: number; /** * 渠道对应商品售价 */ channelProdPrice?: number; /** * 出货价 */ deliveryPrice?: number; /** * 海博商品ID */ hbSkuId?: string; /** * 主键 */ id?: number; /** * 删除状态(0-正常,1-删除) */ isDelete?: number; /** * 进货价 */ purchasePrice?: number; /** * 记录时间 */ recTime?: string; /** * 门店ID */ shopId?: number; /** * 门店名称 */ shopName?: string; /** * 单品ID */ skuId?: number; /** * 修改时间 */ updateTime?: string; /** * 渠道名称 */ channelName?: string; [property: string]: any; } interface Sku { /** * 实际库存 */ actualStocks?: number; /** * 单品编码(海博) */ hbSkuId?: number; /** * 商品编码(海博) */ hbSpuId?: number; /** * 0 正常 1 已被删除 */ isDelete?: number; /** * 商品条形码 */ modelId?: string; /** * 原价 */ oriPrice?: number; /** * 商家编码 */ partyCode?: string; /** * sku图片 */ pic: string; /** * 价格 */ price?: number; /** * 商品ID */ prodId?: number; /** * 商品名称 */ prodName?: string; /** * 销售属性组合字符串,格式是p1:v1;p2:v2 */ properties?: string; /** * 记录时间 */ recTime?: string; skuCode?: string; /** * 单品ID */ skuId?: number; /** * sku名称 */ skuName?: string; /** * 积分价格 */ skuScore?: number; /** * 状态:0禁用 1 启用 */ status?: number; /** * 库存 */ stocks?: number; /** * 修改时间 */ updateTime?: string; version?: number; /** * 体积 */ volume?: number; /** * 重量 */ weight?: number; weightUnit?: string; [property: string]: any; } interface ShopSku { /** * 渠道商品 */ channelProdList?: ChannelProd[]; /** * 门店商品表ID */ id?: number; /** * 0 正常 1 已被删除 */ isDelete?: number; /** * 记录时间 */ recTime?: string; /** * 门店ID */ shopId?: number; /** * 商品对应门店价格 */ shopSkuPrice?: number; /** * 商品对应门店库存 */ shopSkuStocks?: number; /** * 单品ID */ skuId?: number; /** * 商品详细 */ sku: Sku; /** * 修改时间 */ updateTime?: string; [property: string]: any; } interface Channel { /** * 渠道名称 */ channelName?: string; /** * 主键 */ id?: number; /** * 渠道类型(1-企业用户,2-B端用户,3-C端用户) */ type?: string; [property: string]: any; } } /** * 门店管理模块 */ namespace Store { interface ShopDetail { /** * 店铺所在区域(描述) */ area?: string; /** * 店铺所在区域Id */ areaId?: number; /** * 营业执照 */ businessLicense?: string; /** * 物品类型 */ category?: string; /** * 店铺所在城市(描述) */ city?: string; /** * 店铺所在城市Id */ cityId?: number; /** * 创建时间 */ createTime?: string; /** * 海博门店ID */ hbStationId?: string; /** * 海博门店编码 */ hbStationNo?: string; /** * 身份证正面 */ identityCardFront?: string; /** * 身份证反面 */ identityCardLater?: string; /** * 店铺简介(可修改) */ intro?: string; /** * 分销设置(0关闭 1开启) */ isDistribution?: number; /** * 坐标类型 1 高德|腾讯 2 百度 */ mapType?: string; /** * 店铺绑定的手机(登录账号:唯一) */ mobile?: string; /** * ERP门店编码 */ outStationNo?: string; /** * 登录密码 */ password?: string; /** * 店铺所在省份(描述) */ province?: string; /** * 店铺所在省份Id */ provinceId?: number; /** * 店铺详细地址 */ shopAddress?: string; /** * 配送平台店铺编码 */ shopCode?: string; /** * 店铺id */ shopId?: number; /** * 店铺所在纬度(可修改) */ shopLat?: string; /** * 店铺所在经度(可修改) */ shopLng?: string; /** * 店铺logo(可修改) */ shopLogo?: string; /** * 店铺名称(数字、中文,英文(可混合,不可有特殊字符),可修改)、不唯一 */ shopName?: string; /** * 店长 */ shopOwner?: string; /** * 店铺状态(-1:未开通 0: 停业中 1:营业中),可修改 */ shopStatus?: Api.Common.commonStatus; /** * 是否同步到配送平台 */ sync?: boolean; /** * 店铺联系电话 */ tel?: string; /** * 第三方id */ thirdPartyCode?: string; /** * 更新时间 */ updateTime?: string; /** * 店长用户id */ userId?: string; /** * 经营状态(0:停业,1正常) */ runStatus?: Api.Common.commonStatus; /** * 营业状态(0:营业,1:打烊) */ businessTime?: { startTime: string; endTime: string }[]; [property: string]: any; } } /** * 政企管理模块 */ namespace government { /** * 积分充值实体类 * * PointsRecharge */ interface PointsRecharge { /** * 渠道(企业ID) */ channelId?: number; /** * 渠道(企业)名称 */ channelName?: string; /** * 创建者 */ createBy?: string; /** * 创建时间 */ createTime?: string; /** * 过期日期 */ expiryDate?: string; /** * 主键 */ id?: number; /** * 充值积分 */ points?: number; /** * 充值单号 */ rechargeNumber?: string; /** * 积分状态(1-未过期,2-过期) */ rechargeStatus?: number; /** * 备注 */ remark?: string; /** * 充值类型 */ type?: number; /** * 更新时间 */ updateTime?: string; /** * 用户ID */ userId?: number; /** * 员工名称 */ userName?: string; /** * 电话号码 */ userPhone?: string; [property: string]: any; } /** * 充值积分记录统计列表 * * PointsRechargeVO */ interface PointsRechargeVO { /** * 渠道(企业)名称 */ channelName?: string; /** * 操作时间 */ createTime?: string; /** * 总充值积分 */ totalPoints?: number; /** * 总充值人数 */ totalUserCount?: number; [property: string]: any; } /** * 积分任务执行失败记录列表 */ interface PointsFailureRecordVO { /** * 操作人 */ createBy?: string; /** * 时间 */ createTime?: string; /** * 失败状态数量 */ failureStatus?: number; /** * 任务名称 */ name?: string; /** * 成功状态数量 */ successStatus?: number; [property: string]: any; } /** * 渠道统计 * * ChannelVO */ interface ChannelVO { /** * 渠道名称 */ channelName?: string; /** * 企业编号 */ channelNo?: string; /** * 创建日期 */ createTime?: { [key: string]: any }; /** * 正常员工数 */ normalCount?: number; /** * 总员工数 */ staffCount?: number; /** * 企业状态(1-正常,0-停用) */ status: Api.Common.commonStatus; /** * 渠道类型(1-企业用户,2-B端用户,3-C端用户) */ type?: number; [property: string]: any; } /** * 员工列表 */ interface userList { /** * 可用 */ available: number; /** * 所属企业 */ channelName: string; /** * 已过期积分 */ expired: number; /** * 真实姓名 */ realName: string; /** * 状态 1正常 ,0 无效 */ status: Common.commonStatus; /** * 总积分 */ total: number; /** * 使用积分 */ used: number; /** * 手机号 */ userMobile: string; /** * 员工id */ userId: number; } /** * 员工导入记录 */ interface importRecordList { batchNo: string; channel: string; completeTime: string; createTime: string; error: number; id: number; operator: string; phone: string; realName: string; success: number; taskName: string; total: number; } } namespace operation { interface HotSearch { /** * 创建时间 */ createTime: string; /** * 有效时间 */ effectiveTime: string; /** * 结束时间 */ endTime: string; /** * id */ id: number; /** * 跳转参数 */ jumpUrl: string; /** * 落地页名称 */ reachName: string; /** * 搜索名称 */ searchName: string; /** * 状态 1正常 0关闭 */ status: Common.commonStatus; /** * 类型 1-关键词 2-热门搜索词 3-推荐搜索词 */ type: number; [property: string]: any; } /** * 广告 */ interface AdvertInfo { /** * 背景图 */ advertBack?: string; /** * 广告图片 */ advertImg?: string; /** * 广告名称 */ advertName?: string; /** * 排序 */ advertSort?: number; createTime?: string; deleted?: number; id?: number; /** * 跳转路径 */ jumpUrl?: string; /** * 状态 1正常 2删除 */ status?: Api.Common.commonStatus; [property: string]: any; } } namespace userManagement { interface userList { userId: string; /** * 账户名 */ userName: string; /** * 昵称 */ nickName: string; /** * 真实姓名 */ realName: string; /** * 邮箱 */ userMail: string; /** * 登录密码 */ loginPassword: string; /** * 支付密码 */ payPassword: string; /** * 手机号 */ userMobile: string; modifyTime: string; userRegtime: string; userRegip: string; userMemo: string; sex: string; birthDate: string; /** * 用户头像 */ pic: string; /** * 状态 1正常 0禁用 */ status: Common.commonStatus; growth: string; level: number; levelType: number; vipEndTime: string; levelName: string; /** * 平台1企业用户,2夫妻店,3市民请集合 */ platform: number; /** * 渠道id */ channelId: number; } } namespace delivery { interface devList { /** * 公司主页 */ companyHomeUrl?: string; /** * ID */ dvyId?: number; /** * 物流公司名称 */ dvyName?: string; /** * 物流公司编号 */ dvyNo?: string; /** * 修改时间 */ modifyTime?: string; /** * 物流查询接口 */ queryUrl?: string; /** * 建立时间 */ recTime?: string; [property: string]: any; } interface deliveryOrder { /** * 实际总值 */ actualTotal?: number; /** * 用户订单地址Id */ addrOrderId?: number; /** * 取消时间 */ cancelTime?: string; /** * 渠道ID */ channelId?: number; /** * 订单关闭原因 (1:超时未支付 2:退款关闭 4:买家取消 15:已通过货到付款交易) */ closeType?: number; /** * 订购时间 */ createTime?: string; /** * 用户订单删除状态,0:没有删除, 1:回收站, 2:永久删除 */ deleteStatus?: number; /** * 物流单号 */ dvyFlowId?: string; /** * 配送方式ID */ dvyId?: number; /** * 麦芽条状态 0 失败 1 成功 null为暂未创建 */ dvyStatus?: number; /** * 发货时间 */ dvyTime?: string; /** * 配送类型(1:快递 2:自提 3:及时配送) */ dvyType?: number; /** * 完成时间 */ finallyTime?: string; /** * 订单运费 */ freightAmount?: number; /** * 海博物流状态 * 20:已抢单,30:配送员到店,40:取货完成,50:配送单取消,100:已送达 */ hbLogisticStatus: number; /** * 海博订单状态 * 0-待支付 1-待发货,20-订单已接单(待拣货),30-订单待配送(拣货完成/自提类订单为待自提),40-订单配送中 * ,50-订单取消待审核,60-订单已取消,70-订单已送达,80-订单已完成 */ hbOrderStatus?: number; /** * 是否已经支付,1:已经支付过,0:,没有支付过 */ isPayed?: number; /** * 亏损金额 */ lossAmount?: number; nextPay?: boolean; /** * 买家昵称 * 买家名称 */ nickName?: string; /** * 积分 */ offsetPoints?: number; /** * 订单ID */ orderId?: number; orderItems?: OrderItemElement[]; /** * 订购流水号 */ orderNumber?: string; /** * 订单类型参考orderType ,1团购订单 2秒杀订单,3积分订单 */ orderType?: number; payScore?: number; /** * 付款时间 */ payTime?: string; /** * 支付方式 1 微信支付 2 支付宝 */ payType?: number; /** * 平台优惠总额 */ platformAmount?: number; /** * 产品名称,多个产品将会以逗号隔开 */ prodName?: string; /** * 订单商品总数 */ productNums?: number; /** * 牵牛花订单id */ qnhOrderId?: string; /** * 牵牛花订单状态 0 失败 1 成功 null为暂未创建 */ qnhOrderStatus?: string; /** * 收货人 */ receiver?: string; /** * 优惠总额 */ reduceAmount?: number; /** * 退款订单编号 */ refundSn?: string; /** * 订单退款状态(1:申请退款 2:退款成功 3:部分退款成功 4:退款失败) */ refundStatus?: number; /** * 退款类型 */ refundType?: number; /** * 用户备注 */ remarks?: string; /** * 退款状态 */ returnMoneySts?: number; /** * 订单所用积分 */ score?: number; /** * 店铺id */ shopId?: number; /** * 店铺名称 */ shopName?: string; /** * 卖家备注 */ shopRemarks?: string; /** * 总值 */ total?: number; /** * 订单更新时间 */ updateTime?: string; /** * 用户订单地址 */ userAddrOrder?: UserAddrOrder; /** * 订购用户ID */ userId?: string; /** * 买家手机号 */ userMobile?: string; [property: string]: any; } interface OrderItemElement { /** * 商品实际金额 = 商品总金额 - 分摊的优惠金额 */ actualTotal?: number; /** * 加入购物车的时间 */ basketDate?: string; /** * 订单减少金额 */ chageAmount?: number; /** * 发货改变的数量 */ changeNum?: number; /** * 评论状态: 0 未评价 1 已评价 */ commSts?: number; /** * 分销佣金 */ distributionAmount?: number; /** * 推广员使用的推销卡号 */ distributionCardNo?: string; /** * 上级分销佣金 */ distributionParentAmount?: number; /** * 单个orderItem的配送类型 1:快递 2:自提 3:无需快递 */ dvyType?: number; /** * 订单确认收货获取的积分 */ gainScore?: number; goodsTotal?: number; /** * 订单项ID */ orderItemId?: number; /** * 订单orderNumber */ orderNumber?: string; /** * 产品主图片路径 */ pic?: string; /** * 平台补贴的优惠金额 */ platformShareReduce?: number; /** * 产品价格 */ price?: number; /** * 购物车产品个数 */ prodCount?: number; /** * 产品ID */ prodId?: number; /** * 产品名称 */ prodName?: string; productCount?: number; /** * 商品总金额 */ productTotalAmount?: number; /** * 购物时间 */ recTime?: string; /** * 退款编号(退款编号为null时,说明订单为正常状态) */ refundSn?: string; /** * 退款状态 */ returnMoneySts?: number; /** * 分摊的优惠金额 */ shareReduce?: number; shopId?: number; /** * 产品SkuID */ skuId?: number; /** * sku名称 */ skuName?: string; /** * 状态 -1待发货 0全部发货 其他数量为剩余待发货数量 */ status?: number; /** * 用户Id */ userId?: string; /** * 使用积分 */ useScore?: number; [property: string]: any; } interface UserAddrOrder { /** * 地址 */ addr?: string; /** * 地址详情 */ addrDetail?: string; /** * 地址名称 */ address?: string; /** * 地址名称 */ addressName?: string; /** * 地址ID */ addrId?: number; /** * ID */ addrOrderId?: number; /** * 区 */ area?: string; /** * 区域ID */ areaId?: number; /** * 城市 */ city?: string; /** * 城市ID */ cityId?: number; /** * 建立时间 */ createTime?: string; /** * 纬度 */ latitude?: number; /** * 经度 */ longitude?: number; /** * 手机 */ mobile?: string; /** * 邮编 */ postCode?: string; /** * 省 */ province?: string; /** * 省ID */ provinceId?: number; /** * 收货人 */ receiver?: string; /** * 用户ID */ userId?: string; /** * 版本号 */ version?: number; [property: string]: any; } interface DeliveryStatusNum { all: number; paddingPay: number; paddingShipped: number; paddingReceived: number; completed: number; cancel: number; } interface OrderRefund { /** * 申请时间 */ applyTime?: string; /** * 申请类型:1,仅退款,2退款退货,5差价退款 */ applyType?: number; /** * 申请说明 */ buyerDesc?: string; /** * 联系方式 */ buyerMobile?: string; /** * 申请原因 */ buyerReason?: string; /** * 撤销时间 */ cancelTime?: string; /** * 同意退款时间 */ decisionTime?: string; /** * 退款单总分销金额 */ distributionTotalAmount?: number; freightAmount?: number; /** * 退货数量(0:为全部订单项) */ goodsNum?: number; /** * 受理时间 */ handelTime?: string; handler?: boolean; /** * 是否接收到商品(1:已收到,0:未收到) */ isReceiver?: boolean; /** * 是否填写了退货物流信息(1:已填写,0:未填写) */ isReturnLogistics?: boolean; offsetPoints?: number; /** * 订单ID */ orderId?: number; /** * 订单项ID */ orderItemId?: number; /** * 订单编号 */ orderNumber: string; /** * 退款商品详情 */ orderRefundSkuList?: OrderRefundSku[]; /** * 文件凭证json */ photoFiles?: string; /** * 平台退款金额(退款时将这部分钱退回给平台,所以商家要扣除从平台这里获取的金额) */ platformRefundAmount?: number; /** * 收货时间 */ receiveTime?: string; /** * 退款金额 */ refundAmount?: number; /** * 过期的积分 */ refundExpiredScore?: number; /** * 记录ID */ refundId?: number; /** * 退还积分 */ refundScore?: number; /** * 退款编号 */ refundSn: string; /** * 退款时间 */ refundTime?: string; /** * 退款单类型(1:整单退款,2:单个物品退款) */ refundType?: number; /** * 拒绝原因 */ rejectMessage?: string; /** * 拒绝时间 */ rejectTime?: string; /** * 退款单状态 10:待审核 20:处理中 30:驳回退款 40:撤销退款 60:待退货(一审同意) 65:待确认收货(二审待审核) 70:退款完成 */ returnMoneySts?: number; /** * 卖家备注 */ sellerMsg?: string; /** * 发货时间 */ shipTime?: string; /** * 店铺ID */ shopId?: number; /** * 更新时间 */ updateTime?: string; /** * 买家ID */ userId?: string; [property: string]: any; } /** * OrderRefundSku */ interface OrderRefundSku { /** * 记录ID */ id?: number; /** * 订单项id */ orderItemId?: number; /** * 退款单ID */ orderRefundId?: number; /** * 退款商品数量 */ productCount?: number; /** * 退款商品ID */ skuId?: number; /** * 商品单价 */ skuPrice?: number; /** * 规格 */ spec: string; [property: string]: any; } interface OrderRefundCountParam { /** * 全部数量 */ allCount?: number; /** * 买家发货(65) */ buyerDeliveryCount?: number; /** * 退款完成(70) */ refundCompleteCount?: number; /** * 卖家接受(60) */ sellerAcceptCount?: number; /** * 卖家申请(10) */ sellerApplyCount?: number; /** * 卖家拒绝(30) */ sellerRejectCount?: number; /** * 配送中数量(40) */ shippingCount?: number; /** * 撤回申请(40) */ withdrawApplyCount?: number; [property: string]: any; } } }