Skip to main content

TypeAlias.ProductImportJobStatus

type ProductImportJobStatus = {
fileName: string;
jobId: string;
options: {
applicationId: string;
fileName?: string;
network: | "EthereumAnvil"
| "PolygonAmoy"
| "StarknetDevnet"
| "StarknetSepolia"
| "StarknetMainnet"
| "StellarQuickstart"
| "StellarTestnet"
| "StellarMainnet";
upsertMode: boolean;
};
progress: {
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;
};
status: "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED";
};

Full status of a bulk import job including progress and options.

Type Declaration

NameTypeDefault value
fileNamestring-
jobIdstring-
options{ applicationId: string; fileName?: string; network: | "EthereumAnvil" | "PolygonAmoy" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarQuickstart" | "StellarTestnet" | "StellarMainnet"; upsertMode: boolean; }productImportOptionsSchema
options.applicationIdstring-
options.fileName?string-
options.network| "EthereumAnvil" | "PolygonAmoy" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarQuickstart" | "StellarTestnet" | "StellarMainnet"-
options.upsertModeboolean-
progress{ 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; }productImportProgressSchema
progress.completednumber-
progress.createdCountnumber-
progress.errorCountnumber-
progress.errors{ externalId?: string; field?: string; lineNumber: number; message: string; }[]-
progress.results{ action: "error" | "created" | "updated" | "unchanged"; error?: { externalId?: string; field?: string; lineNumber: number; message: string; }; externalId?: string; productId?: string; success: boolean; }[]-
progress.successCountnumber-
progress.totalnumber-
progress.totalRowsnumber-
progress.unchangedCountnumber-
progress.updatedCountnumber-
status"PENDING" | "PROCESSING" | "COMPLETED" | "FAILED"-