Skip to main content
GET /v1/org/shipments/imports/{importId}
Reports where the import is and what it did.
Imports run on a queue, one at a time per organisation, so a push typically finishes in one to three minutes. Poll every 30 seconds or so — a tight loop will just spend your rate limit.

Authorization

string
required
Your organisation API key (dzk_live_…).

Path parameters

string
required
The importId returned when the import was accepted.

Status values

Counts

completed with failures is the normal case, not an exception: valid shipments are never held back because other rows were wrong. errorReportUrl is a short-lived signed link to a spreadsheet of the rejected rows with their reasons, available once the import finishes. It expires after an hour — read the import again for a fresh one.

Recovering from failed

A failed import wrote nothing. Re-send the same batch — shipments are matched on shipmentId, so replaying a push is always safe, even if an earlier attempt got part way.

Errors