Skip to main content

TypeAlias.ProductImportProgress

type ProductImportProgress = {
completed: number;
createdCount: number;
errorCount: number;
errors: {
externalId?: string;
field?: string;
lineNumber: number;
message: string;
}[];
results: {
action: "error" | "created" | "updated" | "unchanged";
error?: {
externalId?: string;
field?: string;
lineNumber: number;
message: string;
};
externalId?: string;
productId?: string;
success: boolean;
}[];
successCount: number;
total: number;
totalRows: number;
unchangedCount: number;
updatedCount: number;
};

Real-time progress tracking for bulk import operation.

Streamed via SSE to provide live updates during import processing.

Type Declaration

NameType
completednumber
createdCountnumber
errorCountnumber
errors{ externalId?: string; field?: string; lineNumber: number; message: string; }[]
results{ action: "error" | "created" | "updated" | "unchanged"; error?: { externalId?: string; field?: string; lineNumber: number; message: string; }; externalId?: string; productId?: string; success: boolean; }[]
successCountnumber
totalnumber
totalRowsnumber
unchangedCountnumber
updatedCountnumber

Example

const progress: ProductImportProgress = {
total: 100,
completed: 75,
successCount: 70,
errorCount: 5,
createdCount: 50,
updatedCount: 20,
unchangedCount: 0,
errors: [{ lineNumber: 12, message: "Missing required field: name" }]
};