WEB/src/api/returnunpack/index.ts
2026-08-31 19:48:07 +08:00

750 lines
23 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'
// ============ 通用数据类型 ============
/** 库存详情(识别命中商品时附加,由 stockWarehouse.getStockDetails 拉取) */
export type ReturnUnpackStockDetail = {
item_code?: string
item_name?: string
sku_property?: string
/** 条码数组 */
barcodes?: { id?: number; barcode?: string }[]
/** 图片数组 */
image_url?: string[]
packing_requirements?: string
stock_unit?: string
quantity?: number
locked_quantity?: number
[key: string]: any
}
/** 拆包明细行 */
export type ReturnUnpackDetailItem = {
id?: number
unpack_id?: number
stock_id?: number | null
barcode?: string
quantity?: number
product_status?: 'normal' | 'damaged'
/** 是否识别:1 识别到系统商品 / 0 非识别物品 */
is_recognized?: 0 | 1
item_code?: string
item_name?: string
spec?: string
product_snapshot?: any
remark?: string
created_at?: string
updated_at?: string
/** 识别命中时的库存详情对象 */
stock?: ReturnUnpackStockDetail
/** 识别命中时的 stockWarehouse 关联 */
stockWarehouse?: any
[key: string]: any
}
/** 拆包录像视频 */
export type ReturnUnpackVideo = {
id?: number
video_url?: string
/** recording 录制中 / completed 录制完成 / failed 录制失败 */
status?: 'recording' | 'completed' | 'failed' | string
camera_id?: number
camera_name?: string
[key: string]: any
}
/** 拆包单主表记录 */
export type ReturnUnpackRecord = {
id?: number
unpack_no?: string
waybill_code?: string
unpack_date?: string
start_time?: string
end_time?: string
unpacker_id?: number
unpacker_name?: string
status?: 'unpacking' | 'completed' | 'cancelled'
detail_status?: 'none_recognized' | 'partial_recognized' | 'all_recognized'
camera_ids?: number[]
order_express_id?: number
order_id?: number
store_id?: number
source_order_codes?: string
shop_name?: string
is_original_return?: boolean
total_items?: number
total_quantity?: number
/** 是否产生视频:1 有 / 2 无 */
has_video?: 1 | 2
/** 视频是否可查看:1 可查看 / 2 不可用 */
video_enable?: 1 | 2
/** 幂等复用时携带 */
details?: ReturnUnpackDetailItem[]
videos?: ReturnUnpackVideo[]
returnReceived?: any
[key: string]: any
}
/** 原订单商品明细行(order.items 的元素) */
export type ReturnUnpackOrderItem = {
/** 商品编码 */
item_code?: string
/** 商品名称 */
item_name?: string
/** 规格属性 */
sku_property?: string
/** 数量 */
quantity?: number
/** 计划数量 */
plan_qty?: number
/** 条码数组 */
barcodes?: { id?: number; barcode?: string }[]
/** 图片数组 */
image_url?: string[]
[key: string]: any
}
/** 原订单详情(原单退回时返回,含 items 明细) */
export type ReturnUnpackOriginalOrder = {
id?: number
/** 订单号(发货单号) */
delivery_order_code?: string
warehouse_id?: number
store_id?: number
wave_id?: number
wave_no?: string
platform_name?: string
create_channel?: string
create_channel_label?: string
items_count?: number
items_total?: number
total_amount?: string
recipient?: {
name?: string
tel?: string
mobile?: string
province?: string
city?: string
district?: string
town?: string
address?: string
[key: string]: any
}
items?: ReturnUnpackOrderItem[]
[key: string]: any
}
/** 分页信息 */
export type ReturnUnpackPagination = {
page: number
pageSize: number
total: number
totalPages: number
hasPrevious?: boolean
hasNext?: boolean
}
// ============ returnUnpack.create ============
/** returnUnpack.create 请求参数 */
export type ReturnUnpackCreateParams = {
/** 拆包的运单号(退回包裹运单号,必填,用于反查原单/货主信息) */
waybill_code: string
/** 摄像头ID列表,如 [1,2,3],关联 wms_camera.id(非正整数会被过滤) */
camera_ids?: number[]
/** 关联退回收到单ID(wms_return_received.id),非必填,允许独立拆包 */
return_received_id?: number
/** 备注(最长 500 字符,超出截断) */
remark?: string
}
/** returnUnpack.create 响应 */
export type ReturnUnpackCreateResponse = {
/** 拆包单主键ID(后续明细收录的依据) */
id: number
/** 拆包单主表记录(幂等复用时含 details/videos/returnReceived) */
record: ReturnUnpackRecord
/** 是否原单退回 */
is_original_return: boolean
/** 货主的合约货主备注名称,未命中时为空字符串 */
store_remark: string
/** 原订单详情(含 items 明细,仅原单退回时返回,非原单为 null) */
order?: ReturnUnpackOriginalOrder | null
/** 原订单商品明细数组(即 order.items 的顶层透出,仅原单退回时返回;非原单退回或原订单详情缺失时为 null) */
order_items?: ReturnUnpackOrderItem[] | null
/** 是否幂等复用已有拆包单 */
reused?: boolean
}
/** returnUnpack.create:开拆包单(明细不在此提交,由 returnUnpack.addDetail 逐件录入) */
export function returnUnpackCreate(data: ReturnUnpackCreateParams): Promise<ReturnUnpackCreateResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.create',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.addDetail ============
/** returnUnpack.addDetail 请求参数 */
export type ReturnUnpackAddDetailParams = {
/** 拆包单ID(returnUnpack.create 返回的依据) */
id: number
/** 系统商品ID(wms_stock_warehouse.id),为空即无关联货物(商品名称标注未知商品) */
stock_id?: number | null
/** 扫描条码(最长100字符,仅作记录,不参与商品匹配) */
barcode?: string
/** 数量,默认 1(小于 1 按 1 处理) */
quantity?: number
/** 产品状态:normal 正常(默认)/ damaged 破损 */
product_status?: 'normal' | 'damaged'
/** 备注(最长 500 字符,超出截断) */
remark?: string
}
/** returnUnpack.addDetail 响应 */
export type ReturnUnpackAddDetailResponse = {
/** 新增明细ID(供 updateDetail / removeDetail 使用) */
detail_id: number
/** 新增的明细行(识别到系统商品时附加 stock 库存详情对象) */
detail: ReturnUnpackDetailItem
/** 主表最新物品种类数(明细行数) */
total_items: number
/** 主表最新物品总数量(明细数量合计) */
total_quantity: number
/** 主表最新明细识别状态 */
detail_status: 'none_recognized' | 'partial_recognized' | 'all_recognized'
}
/** returnUnpack.addDetail:以拆包单ID为依据录入一条明细 */
export function returnUnpackAddDetail(data: ReturnUnpackAddDetailParams): Promise<ReturnUnpackAddDetailResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.addDetail',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.updateDetail ============
/** returnUnpack.updateDetail 请求参数 */
export type ReturnUnpackUpdateDetailParams = {
/** 拆包单ID */
id: number
/** 明细ID(returnUnpack.addDetail 返回) */
detail_id: number
/** 数量(小于 1 按 1 处理,变更时才触发主表重算) */
quantity?: number
/** 备注(最长 500 字符,超出截断) */
remark?: string
}
/** returnUnpack.updateDetail 响应 */
export type ReturnUnpackUpdateDetailResponse = {
/** 更新后的明细行(识别到系统商品时附加 stock 库存详情对象) */
detail: ReturnUnpackDetailItem
/** 主表最新物品种类数 */
total_items: number
/** 主表最新物品总数量(quantity 变更时重算) */
total_quantity: number
/** 主表最新明细识别状态 */
detail_status: 'none_recognized' | 'partial_recognized' | 'all_recognized'
}
/** returnUnpack.updateDetail:更新明细(仅允许更新 quantity/remark) */
export function returnUnpackUpdateDetail(data: ReturnUnpackUpdateDetailParams): Promise<ReturnUnpackUpdateDetailResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.updateDetail',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.removeDetail ============
/** returnUnpack.removeDetail 请求参数 */
export type ReturnUnpackRemoveDetailParams = {
/** 拆包单ID */
id: number
/** 明细ID(returnUnpack.addDetail 返回) */
detail_id: number
}
/** returnUnpack.removeDetail:删除拆包单下的一条明细(硬删除) */
export function returnUnpackRemoveDetail(data: ReturnUnpackRemoveDetailParams): Promise<any> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.removeDetail',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.cancel ============
/** returnUnpack.cancel 请求参数 */
export type ReturnUnpackCancelParams = {
/** 拆包单ID */
id: number
}
/** returnUnpack.cancel:取消拆包单(仅供未完成状态作业取消) */
export function returnUnpackCancel(data: ReturnUnpackCancelParams): Promise<any> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.cancel',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.submit ============
/** returnUnpack.submit 请求参数 */
export type ReturnUnpackSubmitParams = {
/** 拆包单ID */
id: number
}
/** returnUnpack.submit:提交确认(转 completed 终态并回写 end_time) */
export function returnUnpackSubmit(data: ReturnUnpackSubmitParams): Promise<any> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.submit',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.list ============
/** returnUnpack.list 的 where 筛选条件 */
export type ReturnUnpackListWhere = {
/** 拆包单号(模糊搜索,传 {operator:'like',value} 或直接值) */
unpack_no?: string | { operator: string; value: any }
/** 运单号(模糊搜索,传 {operator:'like',value} 或直接值) */
waybill_code?: string | { operator: string; value: any }
/** 拆包日期范围 { operator:'between'|'gte'|'lte'|'gt'|'lt', value:[start,end] 或单值 } */
unpack_date?: { operator: 'between' | 'gte' | 'lte' | 'gt' | 'lt'; value: [string, string] | string }
/** 拆包开始时间范围 */
start_time?: { operator: 'between' | 'gte' | 'lte' | 'gt' | 'lt'; value: [string, string] | string }
/** 拆包结束时间范围 */
end_time?: { operator: 'between' | 'gte' | 'lte' | 'gt' | 'lt'; value: [string, string] | string }
/** 拆包状态(等值):unpacking 拆包中 / completed 完成 / cancelled 作废 */
status?: 'unpacking' | 'completed' | 'cancelled'
/** 明细识别状态(等值):none_recognized / partial_recognized / all_recognized */
detail_status?: 'none_recognized' | 'partial_recognized' | 'all_recognized'
/** 拆包人员工号ID(等值) */
unpacker_id?: number
/** 关联退回收到单ID(等值) */
return_received_id?: number
/** 货主ID(等值) */
store_id?: number
/** 原运单ID(等值) */
order_express_id?: number
/** 原订单ID(等值) */
order_id?: number
/** 是否有视频记录(等值):1 有视频记录 / 2 无视频记录 */
has_video?: 1 | 2
/** 录像是否可用(等值):1 可用(存在 video_url 非空且 status!=failed 的记录) / 2 不可用 */
video_enable?: 1 | 2
}
/** returnUnpack.list 排序参数 */
export type ReturnUnpackListSort = {
/** 排序字段 */
sortField?:
| 'id'
| 'created_at'
| 'updated_at'
| 'unpack_date'
| 'start_time'
| 'end_time'
| 'unpack_no'
| 'waybill_code'
/** 排序方向:asc / desc */
sortOrder?: 'asc' | 'desc'
}
/** returnUnpack.list 请求参数 */
export type ReturnUnpackListParams = {
pagination?: { page?: number; pageSize?: number }
where?: ReturnUnpackListWhere
sort?: ReturnUnpackListSort
}
/** returnUnpack.list 响应 */
export type ReturnUnpackListResponse = {
/** 拆包单列表,每条含主表字段 + is_original_return 派生字段 + 格式化时间字段 + camera_ids 数组 + 视频派生字段 has_video(1=有视频记录/2=无)与 video_enable(1=录像可用/2=不可用)+ videos 视频数组(id/video_url/status/camera_id/camera_name) */
list: ReturnUnpackRecord[]
pagination: ReturnUnpackPagination
}
/** returnUnpack.list:拆包单分页列表(仓库隔离,服务端注入 warehouse_id) */
export function returnUnpackList(data: ReturnUnpackListParams = {}): Promise<ReturnUnpackListResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.list',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.detailList ============
/** returnUnpack.detailList 的 where 筛选条件 */
export type ReturnUnpackDetailListWhere = {
/** 拆包单ID(等值) */
unpack_id?: number
/** 系统商品ID(wms_stock_warehouse.id,等值) */
stock_id?: number
/** 扫描条码(模糊搜索,传 {operator:'like',value} 或直接值) */
barcode?: string | { operator: string; value: any }
/** 是否识别(等值):1 识别到系统商品 / 0 非识别物品 */
is_recognized?: 0 | 1
/** 产品状态(等值):normal 正常 / damaged 破损 */
product_status?: 'normal' | 'damaged'
}
/** returnUnpack.detailList 排序参数 */
export type ReturnUnpackDetailListSort = {
/** 排序字段 */
sortField?: 'id' | 'created_at' | 'updated_at' | 'quantity'
/** 排序方向:asc / desc */
sortOrder?: 'asc' | 'desc'
}
/** returnUnpack.detailList 请求参数 */
export type ReturnUnpackDetailListParams = {
pagination?: { page?: number; pageSize?: number }
where?: ReturnUnpackDetailListWhere
sort?: ReturnUnpackDetailListSort
}
/** returnUnpack.detailList 响应 */
export type ReturnUnpackDetailListResponse = {
/** 明细行列表(识别命中时含 stockWarehouse 关联与 stock 库存详情对象) */
list: ReturnUnpackDetailItem[]
pagination: ReturnUnpackPagination
}
/** returnUnpack.detailList:拆包明细分页列表(命中识别商品时含 stockWarehouse 关联) */
export function returnUnpackDetailList(data: ReturnUnpackDetailListParams = {}): Promise<ReturnUnpackDetailListResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.detailList',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.videoList ============
/** returnUnpack.videoList 的 where 筛选条件 */
export type ReturnUnpackVideoListWhere = {
/** 拆包单ID(必填,等值) */
unpack_id?: number
/** 摄像头设备ID(等值) */
camera_id?: number
/** 录像状态(等值):created / recording / completed / failed */
status?: string
}
/** returnUnpack.videoList 排序参数 */
export type ReturnUnpackVideoListSort = {
sortField?: 'id' | 'created_at' | 'updated_at' | 'camera_id'
sortOrder?: 'asc' | 'desc'
}
/** returnUnpack.videoList 请求参数 */
export type ReturnUnpackVideoListParams = {
pagination?: { page?: number; pageSize?: number }
where?: ReturnUnpackVideoListWhere
sort?: ReturnUnpackVideoListSort
}
/** returnUnpack.videoList:拆包录像分页列表 */
export function returnUnpackVideoList(data: ReturnUnpackVideoListParams = {}): Promise<any> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.videoList',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.detail ============
/** returnUnpack.detail 请求参数 */
export type ReturnUnpackDetailParams = {
/** 拆包单ID */
id: number
}
/** returnUnpack.detail 响应 */
export type ReturnUnpackDetailResponse = {
/** 主表完整记录(含 details 明细、videos 视频、returnReceived 退回收到单关联与格式化时间字段;videos 的 video_url 自动拼接 CDN 域名前缀 http://w{warehouseId}-c{recordingComputerId}.o.gztbyc.com{path}) */
record: ReturnUnpackRecord
/** 关联信息对象 */
related?: {
/** 原订单详情(含 items 明细,仅原单退回时返回,非原单为 null) */
order?: ReturnUnpackOriginalOrder | null
[key: string]: any
}
}
/** returnUnpack.detail:拆包单详情(主表 + 明细 + 视频副表 + 退回收到单) */
export function returnUnpackDetail(data: ReturnUnpackDetailParams): Promise<any> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.detail',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.delete ============
/** returnUnpack.delete 请求参数 */
export type ReturnUnpackDeleteParams = {
/** 拆包单ID */
id: number
}
/** returnUnpack.delete:删除拆包单(后台管理,不限制状态) */
export function returnUnpackDelete(data: ReturnUnpackDeleteParams): Promise<any> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.delete',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.forceRecord ============
/** returnUnpack.forceRecord 请求参数 */
export type ReturnUnpackForceRecordParams = {
/** 拆包单ID(必填) */
id: number
}
/** returnUnpack.forceRecord 响应 */
export type ReturnUnpackForceRecordResponse = {
/** 拆包单ID */
unpack_id: number
/** 录制电脑ID(wms_print_computer.id,is_recording=true) */
computer_id: number
/** 打印服务强制录制接口地址(POST {printService.url}/record/force) */
print_service_url: string
/** 推送给打印服务的请求体({ unpack_id }) */
print_service_request: { unpack_id: number }
/** 打印服务响应(status/headers/data) */
print_service_response?: {
status: number
headers: Record<string, unknown>
data: unknown
} | null
/** 打印服务通知异常信息(推送失败时返回) */
print_service_error?: string | null
}
/**
* returnUnpack.forceRecord:强制重新录制拆包视频。
* 校验仓库录制电脑在线后,将视频记录(wms_return_unpack_video)重置为 created 并清空 video_url,
* 再向打印服务 /record/force 推送 { unpack_id } 触发重新录制(仓库隔离,仅本仓库拆包单)。
*/
export function returnUnpackForceRecord(data: ReturnUnpackForceRecordParams): Promise<any> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.forceRecord',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.export ============
/** returnUnpack.export 请求参数(where/sort 语义与 returnUnpack.list 一致) */
export type ReturnUnpackExportParams = {
/** 查询条件,语义与 returnUnpack.list 的 where 一致;禁止传 warehouse_id/warehouseId(服务端注入) */
where?: Record<string, any>
/** 排序参数,语义与 returnUnpack.list 的 sort 一致 */
sort?: {
sortField?: string
sortOrder?: string
}
}
/** returnUnpack.export 响应(提交成功即返回任务受理信息) */
export type ReturnUnpackExportResponse = {
/** 任务 ID */
task_id: string
/** 任务状态:submitted/running/success/failed/not_found */
status: string
/** 当前进度百分比(0-100),提交时返回 0 */
progress: number
/** 当前已处理记录数(拆包单条数) */
current_count: number
/** 总记录数 */
total_count: number
/** 任务提示信息 */
message: string
/** 任务执行结果(提交时为 null;完成后为上传信息对象) */
result: Record<string, unknown> | null
/** 失败时的错误信息 */
error: string
/** 任务更新时间(Unix 毫秒时间戳) */
update_time: number
code?: number
}
/** returnUnpack.export:提交退回拆包导出任务(异步,返回 task_id) */
export function returnUnpackExport(data: ReturnUnpackExportParams = {}): Promise<ReturnUnpackExportResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.export',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ returnUnpack.exportTaskProgress ============
/** returnUnpack.exportTaskProgress 请求参数 */
export type ReturnUnpackExportTaskProgressParams = {
/** 任务 ID(下划线写法,与 taskId 二选一) */
task_id?: string
/** 任务 ID(驼峰写法,兼容) */
taskId?: string
}
/** returnUnpack.exportTaskProgress 响应 */
export type ReturnUnpackExportTaskProgressResponse = {
/** 任务 ID(缺失时为空字符串,status=not_found) */
task_id: string
/** 任务状态:submitted/running/success/failed/not_found */
status: string
/** 进度百分比(0-100) */
progress: number
/** 当前已处理记录数 */
current_count: number
/** 总记录数 */
total_count: number
/** 任务提示信息 */
message: string
/** 任务执行结果对象(完成后含 filename/url/fileKey/cdnUrl/cosUrl 等) */
result: Record<string, unknown> | null
/** 失败时的错误信息 */
error: string
/** 任务完成后下载链接;未完成或不存在时为空字符串 */
download_url: string
/** 最近一次状态更新时间(Unix 毫秒时间戳) */
update_time: number
code?: number
}
/** returnUnpack.exportTaskProgress:按 task_id 查询退回拆包导出任务进度 */
export function returnUnpackExportTaskProgress(data: ReturnUnpackExportTaskProgressParams): Promise<ReturnUnpackExportTaskProgressResponse> {
return request({
url: '/system',
method: 'post',
params: {
method: 'returnUnpack.exportTaskProgress',
v,
timestamp: new Date().getTime()
},
data,
isSystemApi: true
} as any)
}
// ============ 模块导出 ============
export const returnUnpackModule = {
create: returnUnpackCreate,
addDetail: returnUnpackAddDetail,
updateDetail: returnUnpackUpdateDetail,
removeDetail: returnUnpackRemoveDetail,
cancel: returnUnpackCancel,
submit: returnUnpackSubmit,
list: returnUnpackList,
detailList: returnUnpackDetailList,
detail: returnUnpackDetail,
delete: returnUnpackDelete,
forceRecord: returnUnpackForceRecord,
export: returnUnpackExport,
exportTaskProgress: returnUnpackExportTaskProgress
}