Skip to main content
GET
Get Import Job

Authorizations

Authorization
string
header
required

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Path Parameters

jobId
string<uuid>
required

Job id returned by the batch POST (also in its Location header)

Response

The import job

Async batch import job. completed and failed are terminal — stop polling. The staged input payload is freed ~24 h after the job finishes and the job row itself is deleted ~30 days after creation; poll and persist the result within that window.

jobId
string<uuid>
kind
enum<string>
Available options:
articles,
suppliers,
orders
status
enum<string>
Available options:
queued,
running,
completed,
failed
progress
object
result
object | null

Entity-native merged batch result, present once status is completed. Orders additionally carry skippedOrders and autoCreated; articles carry skippedRows; suppliers carry inferredCountryCount.

error
string | null

Stable machine key when status is failed — e.g. workerError, dispatchFailed, or a JSON string for structured failures: {"key":"lineReplacementRequired","orderNumbers":[…]} or {"key":"invalidPayload","issues":[{"path","code"}]}. Never contains payload values.

createdAt
string<date-time>
finishedAt
string<date-time> | null