List imports

get /api/imports

Retrieves the collection of Import resources.

Returns a paginated collection of the import jobs of the current tenant. Filter by status, type or id[], and sort by createdAt, updatedAt, status, type or format. Requires the imports:read scope.

Query parameters

Name	Type	Required	Description
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page
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}
id[]	string[]	-	Only the items with one of these ids, each a UUID or the item IRI.
status	string	-	Import status
status[]	string[]	-	Import status
type	string	-	Import type
type[]	string[]	-	Import type
order[createdAt]	string	-	Import order[createdAt]
order[updatedAt]	string	-	Import order[updatedAt]
order[status]	string	-	Import order[status]
order[type]	string	-	Import order[type]
order[format]	string	-	Import order[format]

Response

200 - Import collection

Content-Type: application/ld+json

Property	Type	Required	Description
search	object	-
Show search fields Property Type Required Description @type string - mapping object[] - Show mapping fields Property Type Required Description @type string - property string | null - required boolean - variable string - template string - variableRepresentation string -
totalItems	integer	-
view	object	-
Show view fields Property Type Required Description @id string - @type string - first string | null - last string | null - next string | null - previous string | null -
member	Import[]	required
Show member fields 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 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	-