Retrieve an import

get /api/imports/{id}

Retrieves a Import resource.

Returns a single import job by id. Poll it to follow processing: its status moves from pending to processing, then to completed or failed, and its report gives the row counts (totalRows, imported, failed) and the per-line errors once processing is done.

Path parameters

Name	Type	Required	Description
id	string	required	Import identifier

Query parameters

Name	Type	Required	Description
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

Response

200 - Import resource

Content-Type: application/ld+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
createdAt	string | null	-
format	"csv" | "tsv" | "xlsx" | null	-
id	string	-
metadata	object	-
report	object | null	-	Per-row processing report. Null until the import has been processed.
Show report fields Property Type Required Description error string - Present only when the import failed systemically. errors object[] required Show errors fields Property Type Required Description line integer required messages string[] required failed integer required imported integer required reset object - Records deleted per table, present only when metadata[reset]=true. totalRows integer required
status	"pending" | "processing" | "completed" | "failed" | null	-
type	"collections" | "categories" | "attributes" | "suppliers" | "attribute_options" | "purchase_offer" | "sale_offer" | "metafield_value" | "product" | null	required
updatedAt	string | null	-

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-

404 - Not found

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.