WEB/src/api/returnunpack/index.ts
2026-08-21 18:09:54 +08:00

497 lines
15 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 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
/** 幂等复用时携带 */
details?: ReturnUnpackDetailItem[]
videos?: any[]
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 = {
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
/** 原订单详情(仅原单退回时返回,非原单为 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
}
/** 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:拆包单分页列表(仓库隔离,服务端注入 warehouse_id) */
export function returnUnpackList(data: ReturnUnpackListParams = {}): Promise<any> {
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.detail ============
/** returnUnpack.detail 请求参数 */
export type ReturnUnpackDetailParams = {
/** 拆包单ID */
id: number
}
/** 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)
}
// ============ 模块导出 ============
export const returnUnpackModule = {
create: returnUnpackCreate,
addDetail: returnUnpackAddDetail,
updateDetail: returnUnpackUpdateDetail,
removeDetail: returnUnpackRemoveDetail,
cancel: returnUnpackCancel,
submit: returnUnpackSubmit,
list: returnUnpackList,
detailList: returnUnpackDetailList,
detail: returnUnpackDetail,
delete: returnUnpackDelete
}