BizKitHub
DocsAPI ReferenceImport/bff/import/detail
getImportAdmin BFF

/bff/import/detail

Returns full details of a single import job including progress counters, detected columns, and any error messages. Use this endpoint to poll import progress (recommended interval: 10 seconds).

ImportgetBffImportDetail

Parameters

1 query

Query parameters

· 1
importIdstringRequired

External ID of the import job.

ExampleaB3xKm9pQ2wLn4Yz

Response schema

1 status code documented

200SuccessFull import job detail with progress and metadata.
idnumberRequired

Internal database ID.

organisationIdnumberRequired

Organisation that owns this import.

externalIdstringRequired

Unique external identifier of the import job.

providerstringRequired

Import provider ("shoptet" or "manual").

dataTypestringRequired

Type of entity being imported.

sourceTypestringRequired

Source type ("file" or "url").

sourceNamestringRequired

Original filename or URL used as the import source.

sourceUrlstring | nullRequired
One of 2:
Variant 1
string

Remote feed URL (only for URL source type).

Variant 2
null
blobIdnumber | nullRequired
One of 2:
Variant 1
number

Internal blob ID of the uploaded file.

Variant 2
null
statusstringRequired

Current status of the import job.

totalRowsnumberRequired

Total number of rows in the source file.

importedRowsnumberRequired

Number of rows successfully imported so far.

failedRowsnumberRequired

Number of rows that failed to import.

columnsanyRequired

Array of detected column names.

errorsanyRequired

Array of error messages if the import failed.

insertedDatestringRequired

ISO timestamp when the import was created.

updatedDatestringRequired

ISO timestamp of the last status update.

Response example

application/json
{
  "id": 0,
  "organisationId": 0,
  "externalId": "example_externalId",
  "provider": "example_provider",
  "dataType": "example_dataType",
  "sourceType": "example_sourceType",
  "sourceName": "example_sourceName",
  "status": "example_status",
  "totalRows": 0,
  "importedRows": 0,
  "failedRows": 0,
  "insertedDate": "example_insertedDate",
  "updatedDate": "example_updatedDate"
}

Request example

GET /bff/import/detail

get
curl -X GET "https://api.bizkithub.com/bff/import/detail?importId=aB3xKm9pQ2wLn4Yz" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key