WEB/src/api/dashboard/dashboard.ts
2026-09-25 17:59:55 +08:00

183 lines
5.7 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import request from '@/utils/request'
const v = "1.0"
export function getDashboardData(method: string, data: any) {
return request({
url: '/system',
method: 'post',
params: {
method,
v,
timestamp: new Date().getTime()
},
data: data,
isSystemApi: true
} as any)
}
/** dashboard.* 通用响应信封(业务字段与信封同级:flag/code/message/data/timestamp) */
export type DashboardEnvelope<T> = {
/** 结果标记,成功为 success */
flag?: string
/** 业务码,成功为 200 */
code?: number
message?: string
/** 服务器时间戳(秒) */
timestamp?: number
data: T
}
/** dashboard.storeStats 的 data(仓库发货统计;货主端自动跨已签约仓库汇总) */
export type DashboardStoreStatsData = {
/** 今日订单数(待处理 + 今日已出库) */
todayOrders: number
/** 今日新增较昨日增长率(%),昨日为 0 时按 100 或 0 计算 */
orderTrend: number
/** 未分配快递号订单数 */
unassignedOrders: number
/** 未打印订单数 */
unprintedOrders: number
/** 未拣货订单数 */
unpickedOrders: number
/** 待发货订单数 */
pendingShipments: number
/** 发货进度(%),(待处理-待发货)/待处理 */
shipmentProgress: number
/** 今日已出库订单数 */
todayOutbound: number
/** 出库完成率(%),今日出库/(待发货+今日出库) */
outboundRate: number
/** 拦截订单数 */
interceptedOrders: number
/** 异常订单数(step=3) */
exceptionOrders: number
/** 已复核订单数 */
recheckedOrders: number
/** 已打包订单数 */
packedOrders: number
}
/**
* dashboard.warehouseStats 的 data(**固定演示数据**,非实时查询结果,仅供前端展示与调试)。
* ⚠️ 字段少于 storeStats:**不含** recheckedOrders / packedOrders。
*/
export type DashboardWarehouseStatsData = {
todayOrders: number
orderTrend: number
unassignedOrders: number
unprintedOrders: number
unpickedOrders: number
pendingShipments: number
shipmentProgress: number
todayOutbound: number
outboundRate: number
interceptedOrders: number
exceptionOrders: number
}
/** dashboard.express_ratio / platform_distribution 的 data 元素(饼图,按订单数降序) */
export type DashboardPieItem = {
/** 快递公司名称(未填写时为「未指定快递」)/ 平台名称(未填写时为「未指定平台」) */
name: string
/** 该名称下的待处理订单数 */
value: number
/** 图表配色 */
itemStyle?: { color?: string }
}
/** dashboard.hot_order_rank 的 data 元素(今日销量 Top10,name 已脱敏) */
export type DashboardHotOrderRankItem = {
/** 排行序号(从 1 开始) */
id: number
/** 脱敏后商品名称(前 2 字符 + *** + 后 2 字符;长度不足 4 字符时为 ***) */
name: string
/** 库存商品ID(stock_warehouse.id);极端情况下回退商品编码字符串 */
sku: number | string
/** 今日销量(件数) */
value: number
/** 环比昨日百分比(1 位小数;昨日为 0 且今日 >0 时为 100) */
trend: number
}
/** dashboard.order_trend 的 data(按小时统计当日 08:00 至当前小时) */
export type DashboardOrderTrendData = {
/** 统计范围,固定为 day */
range: string
/** 统计日期(YYYY-MM-DD) */
date: string
summary: {
/** 当日订单总数 */
total_orders: number
/** 当日发货总数 */
total_shipments: number
/** 发货率(%,1 位小数) */
shipment_rate: number
/** 订单峰值时段(如 08:00) */
peak_hour: string
/** 峰值时段订单数 */
peak_orders: number
}
/** 时段列表(08:00 至当前小时,如 ['08:00','09:00']) */
categories: string[]
/** 各时段订单数(与 categories 一一对应) */
orders: number[]
/** 各时段发货数(与 categories 一一对应) */
shipments: number[]
}
/**
* 获取仓库发货统计(**演示数据**:固定演示值,非实时查询;无业务入参)
*/
export function getWarehouseStats(
data: Record<string, unknown> = {}
): Promise<DashboardEnvelope<DashboardWarehouseStatsData>> {
return getDashboardData('dashboard.warehouseStats', data)
}
/**
* 获取门店/仓库发货统计(真实查询;无业务入参,依据登录用户上下文区分仓库端与货主端)
*/
export function getStoreStats(
data: Record<string, unknown> = {}
): Promise<DashboardEnvelope<DashboardStoreStatsData>> {
return getDashboardData('dashboard.storeStats', data)
}
export type OrderTrendData = DashboardOrderTrendData
export type OrderTrendResponse = DashboardEnvelope<OrderTrendData>
/**
* 获取订单趋势数据(无业务入参,依据当前用户绑定仓库统计)
*/
export function getOrderTrend(data: Record<string, unknown> = {}): Promise<OrderTrendResponse> {
return getDashboardData('dashboard.order_trend', data)
}
/**
* 获取平台分布数据(饼图;无业务入参,货主端跨已签约仓库汇总)
*/
export function getPlatformDist(
data: Record<string, unknown> = {}
): Promise<DashboardEnvelope<DashboardPieItem[]>> {
return getDashboardData('dashboard.platform_distribution', data)
}
/**
* 获取热销商品排行(今日销量 Top10;无业务入参)
*/
export function getHotOrderRank(
data: Record<string, unknown> = {}
): Promise<DashboardEnvelope<DashboardHotOrderRankItem[]>> {
return getDashboardData('dashboard.hot_order_rank', data)
}
/**
* 获取快递占比数据(饼图;无业务入参,货主端跨已签约仓库汇总)
*/
export function getExpressRatio(
data: Record<string, unknown> = {}
): Promise<DashboardEnvelope<DashboardPieItem[]>> {
return getDashboardData('dashboard.express_ratio', data)
}