Skip to navigation

Get image import status

Poll an import with the same API credential that submitted it. Product access must still be available. queued and processing are non-terminal; completed and failed are terminal. A failed batch can contain successful image results, which remain available. Failures are reported per entry; resubmit failed entries with a new Idempotency-Key. Revoked permissions stop processing. Abandoned queued/processing imports expire after seven days; completed results are preserved and staged originals are removed.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"
Import ID returned by a batch submission.

Response

Current import state and finished entry results.
idstringformat: "uuid"
stateenum
completed means every entry succeeded. failed may contain successful entries alongside failures.
Allowed values:
totalinteger1-25
completedinteger>=0
failedinteger>=0
resultslist of objects

Finished entries only; pending entries have no result yet.

statusUrlstring
Relative URL to poll with the same API credential that submitted the batch.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error