Skip to main content
GET
Check import status

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Path Parameters

job_id
string<uuid>
required

The import job ID returned from Upload a product catalog.

Response

The import job's status.

job_id
string<uuid>
required

Unique import job identifier.

status
enum<string>
required

The current job status.

  • pending — the job is queued and waiting for a worker.
  • processing — a worker is actively processing the file.
  • done — the import completed.
  • failed — the import failed.
Available options:
pending,
processing,
done,
failed
total
integer
required

The total number of products in the uploaded file.

indexed_count
integer
required

The number of products successfully indexed so far.

failed_count
integer
required

The number of products that failed validation or indexing.

skipped_count
integer
required

The number of products that remained unchanged since the last import and were not reprocessed.

progress
integer
required

The number of products processed so far out of total: the sum of indexed_count and failed_count.

started_at
string<date-time> | null
required

The timestamp when processing started, or null if processing hasn't started.

completed_at
string<date-time> | null
required

The timestamp when processing finished, or null if processing hasn't finished.