WEB/src/api/aftersale/index.ts
2026-09-01 19:26:55 +08:00

557 lines
13 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'
// ============================================================
// 售后模块 V2 API
// ============================================================
// ==================== 类型定义 ====================
/** 售后类型 */
export type AfterSaleType = 'order' | 'receiving' | 'entry' | 'stockout'
/** 售后状态 */
export type AfterSaleStatus = 'pending' | 'pending_feedback' | 'processing' | 'completed' | 'closed' | 'cancelled'
/** 角色组 */
export type AfterSaleRoleGroup = 'customer_service' | 'warehouse' | 'finance'
/** 理赔状态 */
export type ClaimStatus = 'pending' | 'reviewing' | 'approved' | 'paid' | 'monthly' | 'rejected'
/** 步骤状态: 0=待开始 1=进行中 2=已完成 3=已跳过 */
export type StepStatus = 0 | 1 | 2 | 3
/** 售后单对象 */
export interface AfterSale {
id: number
warehouse_id: number
store_id: number | null
after_sale_no: string
type: AfterSaleType
sub_type: string
status: AfterSaleStatus
priority: number
title: string
description: string | null
creator_id: number
inbox_message_id: number | null
role_group: AfterSaleRoleGroup | null
resolution: string | null
resolved_at: string | null
followup_at: string | null
// 仓库理赔
claim_needed: 0 | 1
claim_amount: number | null
claim_status: ClaimStatus | null
// 运方理赔
carrier_claim_needed: 0 | 1
carrier_claim_amount: number | null
carrier_claim_status: ClaimStatus | null
// 关联单据
waybill_id: number | null
waybill_no: string | null
order_delivery_id: number | null
order_delivery_no: string | null
entry_order_id: number | null
entry_order_no: string | null
order_stockout_id: number | null
order_stockout_no: string | null
receiving_id: number | null
receiving_no: string | null
// 关联详情(detail 接口返回)
related?: AfterSaleRelated
created_at: string
updated_at: string
deleted_at: string | null
started_at: string | null
completed_at: string | null
}
// ==================== 关联数据类型 ====================
/** 关联订单 - 收货人 */
export interface RelatedRecipient {
name: string
tel: string
mobile: string
email: string
zip_code: string
country: string
province: string
city: string
district: string
town: string
address: string
}
/** 关联订单 - 商品条码 */
export interface RelatedItemBarcode {
id: number
barcode: string
}
/** 关联订单 - 商品行 */
export interface RelatedOrderItem {
id: number
order_line_no: string
item_code: string
item_name: string
sku_property: string
quantity: number
locked_quantity: number
is_batch_mgmt: string
is_shelf_life_mgmt: string
is_images: string
store_id: number
packing_requirements: string
stock_unit: string
image_url: string[]
barcodes: RelatedItemBarcode[]
plan_qty: number
stock_id: number
order_item_id: number
order_id: number
}
/** 关联订单 */
export interface RelatedOrder {
id: number
delivery_order_code: string
warehouse_id: number
store_id: number
items_weight: number
wave_id: number
wave_no: string
source_platform_code: string
source_platform_name: string
source_order_codes: string
sync_status: string
inspection_status: string
storage_status: string
post_status: string
print_status: string
pick_status: string
pack_status: string
intercept_status: string
items_count: number
items_total: number
recipient: RelatedRecipient | null
sender: any
items: RelatedOrderItem[]
pack_videos: any[]
}
/** 关联运单 */
export interface RelatedWaybill {
id: number
waybill_code: string
order_id: number
logistics_code: string
logistics_name: string
logistics_interface_id: number
logistics_interface_name: string
status: number
is_back: string
is_intercept: string
warehouse_id: number
create_at: string
}
/** 关联店铺合同 */
export interface RelatedStoreContract {
contract_id: number
store_remask: string
warehouse_remask: string
store_use_status: number
warehouse_use_status: number
}
/** 售后关联数据 */
export interface AfterSaleRelated {
order?: RelatedOrder | null
waybill?: RelatedWaybill | null
store_contract?: RelatedStoreContract | null
}
/** 售后步骤对象 */
export interface AfterSaleStep {
/** 步骤ID(虚拟步骤为 null) */
id: number | null
after_sale_id: number
step_status: StepStatus
operator_id: number | null
operator_snapshot: string | null
action: string | null
remark: string | null
started_at: string | null
completed_at: string | null
created_at: string
attachments: FileReference[]
/** 是否虚拟步骤(主表 description 非空时列表第一条,不落库) */
is_virtual?: boolean
}
/** 文件引用 */
export interface FileReference {
id?: number
file_id?: number
file_name?: string
file_url?: string
file_key?: string
file_size?: number
mime_type?: string
}
// ==================== 响应类型 ====================
/** 售后工作列表项(主表字段 + detail_count + store_name) */
export interface AfterSaleWorkListItem extends AfterSale {
/** 售后单关联计数 */
detail_count: number
/** 货主名称:取合约表 store_remask,无合约或备注为空时回退公司全称,无货主时为空字符串 */
store_name: string
}
/** 分页信息 */
export interface AfterSalePagination {
page: number
pageSize: number
total: number
totalPages: number
}
/** afterSale.workList 响应 */
export interface AfterSaleWorkListResponse {
list: AfterSaleWorkListItem[]
pagination: AfterSalePagination
}
/** afterSale.detail 响应 */
export interface AfterSaleDetailResponse {
/** 售后主表完整记录(含格式化时间字段) */
after_sale: AfterSale
/** 售后进度步骤列表(含附件),按创建时间升序 */
steps: AfterSaleStep[]
/** 关联单据详情(订单/运单/货主合约),无关联时为空对象 */
related: AfterSaleRelated
}
// ==================== 请求参数类型 ====================
/** 列表查询参数 */
export interface AfterSaleListParams {
pagination?: { page?: number; pageSize?: number }
where?: Record<string, any>
sort?: { sortField?: string; sortOrder?: 'asc' | 'desc' | 'ASC' | 'DESC' }
}
/** 创建售后单参数 */
export interface AfterSaleCreateParams {
type: AfterSaleType
sub_type: string
title: string
description?: string
priority?: number
store_id?: number
waybill_id?: number
order_id?: number
order_delivery_no?: string
entry_order_id?: number
entry_order_no?: string
order_stockout_id?: number
order_stockout_no?: string
receiving_id?: number
receiving_no?: string
}
/** 更新售后单参数 */
export interface AfterSaleUpdateParams extends Partial<AfterSaleCreateParams> {
id: number
}
/** 转单参数 */
export interface AfterSaleTransferParams {
id: number
role_group: AfterSaleRoleGroup
remark?: string
}
/** 处理工单参数 */
export interface AfterSaleHandleWorkOrderParams {
id: number
status?: AfterSaleStatus
remark?: string
attachment_ids?: number[]
}
/** afterSale.handleWorkOrder 响应 */
export interface AfterSaleHandleWorkOrderResponse {
/** 本次写入的步骤ID(wms_after_sale_detail.id) */
detail_id: number
/** 售后工单ID */
after_sale_id: number
/** 处理备注发送到的货主售后群数量(未填写备注或未找到货主售后群时为0) */
notified_groups?: number
}
/** 登记理赔参数 */
export interface AfterSaleRegisterClaimParams {
id: number
// 仓库理赔
claim_needed?: 0 | 1
claim_amount?: number
claim_status?: ClaimStatus
// 运方理赔
carrier_claim_needed?: 0 | 1
carrier_claim_amount?: number
carrier_claim_status?: ClaimStatus
// 步骤
action: string
remark?: string
attachment_ids?: number[]
}
/** 导出参数 */
export interface AfterSaleExportParams {
where?: Record<string, any>
sort?: { sortField?: string; sortOrder?: 'asc' | 'desc' }
}
/** 导出进度参数 */
export interface AfterSaleExportTaskProgressParams {
task_id?: string
taskId?: string
}
/** 批量设置待反馈参数 */
export interface AfterSaleBatchSetPendingFeedbackParams {
ids: number[]
remark?: string
}
/** 批量设置待反馈结果项 */
export interface AfterSaleBatchSetPendingFeedbackFailedItem {
id: number
reason: string
}
/** 批量关闭/完结参数 */
export interface AfterSaleBatchCloseParams {
ids: number[]
status: 'completed' | 'closed'
resolution?: string
remark?: string
}
/** 批量关闭/完结结果项 */
export interface AfterSaleBatchCloseFailedItem {
id: number
reason: string
}
// ==================== API 方法 ====================
/** 2.1 工作列表 afterSale.workList */
export function afterSaleWorkList(data: AfterSaleListParams = {}): Promise<AfterSaleWorkListResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.workList',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.2 审计列表 afterSale.auditList */
export function afterSaleAuditList(data: AfterSaleListParams = {}) {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.auditList',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.3 售后明细 afterSale.detail */
export function afterSaleDetail(id: number): Promise<AfterSaleDetailResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.detail',
v,
timestamp: Date.now()
},
data: { id },
isSystemApi: true
} as any)
}
/** 2.4 创建售后单 afterSale.create */
export function afterSaleCreate(data: AfterSaleCreateParams) {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.create',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.5 更新售后单 afterSale.update */
export function afterSaleUpdate(data: AfterSaleUpdateParams) {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.update',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.6 转单 afterSale.transfer */
export function afterSaleTransfer(data: AfterSaleTransferParams) {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.transfer',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.7 处理工单 afterSale.handleWorkOrder */
export function afterSaleHandleWorkOrder(
data: AfterSaleHandleWorkOrderParams
): Promise<AfterSaleHandleWorkOrderResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.handleWorkOrder',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.8 登记理赔 afterSale.registerClaim */
export function afterSaleRegisterClaim(data: AfterSaleRegisterClaimParams) {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.registerClaim',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.9 导出 afterSale.export */
export function afterSaleExport(data: AfterSaleExportParams = {}) {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.export',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.10 导出进度 afterSale.exportTaskProgress */
export function afterSaleExportTaskProgress(data: AfterSaleExportTaskProgressParams) {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.exportTaskProgress',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.11 角标快速查询 afterSale.workCount */
export function afterSaleWorkCount(): Promise<any> {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.workCount',
v,
timestamp: Date.now()
},
data: {},
isSystemApi: true
} as any)
}
/** 2.12 批量设置待反馈 afterSale.batchSetPendingFeedback */
export function afterSaleBatchSetPendingFeedback(data: AfterSaleBatchSetPendingFeedbackParams) {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.batchSetPendingFeedback',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}
/** 2.13 批量关闭/完结 afterSale.batchClose */
export function afterSaleBatchClose(data: AfterSaleBatchCloseParams) {
return request({
url: '/system',
method: 'post',
params: {
method: 'afterSale.batchClose',
v,
timestamp: Date.now()
},
data,
isSystemApi: true
} as any)
}