Skip to main content

ServiceProductImportResponse

successbooleanrequired

Always true on a 2xx response.

Example: true
data objectrequired

The import and its progress.

idstring<uuid>required

Import id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b
filenamestringnullablerequired

Name of the uploaded file.

Example: products.csv
modestringnullablerequired

Whether the import may update existing products.

Possible values: [CREATE_ONLY, UPSERT, null]

statusstringnullablerequired

Where the import is in its lifecycle.

Possible values: [UPLOADED, MAPPING, VALIDATING, PREVIEW, COMMITTING, COMPLETED, FAILED, ROLLED_BACK, null]

totalRowsnumbernullablerequired

Rows found in the file.

Example: 120
stagedRowsnumbernullablerequired

Rows staged so far.

Example: 120
validRowsnumbernullablerequired

Rows that passed validation.

Example: 118
warningRowsnumbernullablerequired

Rows that passed with a warning.

Example: 1
errorRowsnumbernullablerequired

Rows that failed validation and are excluded.

Example: 1
createCountnumbernullablerequired

Products the import created.

Example: 100
updateCountnumbernullablerequired

Products the import updated.

Example: 18
skipCountnumbernullablerequired

Rows skipped because they would change nothing.

Example: 0
failureReasonstringnullablerequired

Why the import failed, when it did.

createdAtstring<date-time>nullablerequired

When the import was created.

Example: 2026-01-15T09:30:00.000Z
startedAtstring<date-time>nullablerequired

When processing started.

Example: 2026-01-15T09:30:00.000Z
approvedAtstring<date-time>nullablerequired

When the import was approved.

Example: 2026-01-15T09:30:00.000Z
completedAtstring<date-time>nullablerequired

When the import finished.

Example: 2026-01-15T09:30:00.000Z
rolledBackAtstring<date-time>nullablerequired

When the import was rolled back.

Example: 2026-01-15T09:30:00.000Z
updatedAtstring<date-time>nullablerequired

When the import last changed.

Example: 2026-01-15T09:30:00.000Z
ServiceProductImportResponse
{
"success": true,
"data": {
"id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
"filename": "products.csv",
"mode": "CREATE_ONLY",
"status": "UPLOADED",
"totalRows": 120,
"stagedRows": 120,
"validRows": 118,
"warningRows": 1,
"errorRows": 1,
"createCount": 100,
"updateCount": 18,
"skipCount": 0,
"failureReason": "string",
"createdAt": "2026-01-15T09:30:00.000Z",
"startedAt": "2026-01-15T09:30:00.000Z",
"approvedAt": "2026-01-15T09:30:00.000Z",
"completedAt": "2026-01-15T09:30:00.000Z",
"rolledBackAt": "2026-01-15T09:30:00.000Z",
"updatedAt": "2026-01-15T09:30:00.000Z"
}
}