Create an import

post /api/imports

Creates a Import resource.

Uploads a CSV, TSV or XLSX file and creates an import job for it. The body is multipart/form-data with the file, the target type, and optional metadata (such as the locale, the XLSX sheetName, or reset). The upload is synchronous, but processing is asynchronous: the job is returned with its status, and its report stays null until processing ends. Requires the imports:write and imports:read scopes.

Reset replaces existing data

With metadata[reset]=true, all existing data of the import type is deleted before the file is imported, atomically. The number of deleted records per table is reported in report.reset.

Request body

Property	Type	Required	Description
file	string	required	CSV, TSV or XLSX file
metadata	object	-	Per-import options (e.g. locale, sheetName for XLSX)
Show metadata fields Property Type Required Description locale string - optionCount integer - Number of option columns (product import only, 1-3). reset boolean - When true, delete all existing data of this type before importing (atomic). sheetName string -
type	"collections" | "categories" | "attributes" | "suppliers" | "attribute_options" | "purchase_offer" | "sale_offer" | "metafield_value" | "product"	required	The resource type to import

Response

201 - Import resource created

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

400 - Invalid input

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}.

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	-

422 - An error occurred

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
description	string	-
detail	string	-
instance	string | null	-
status	integer	-
title	string | null	-
type	string	-
violations	object[]	-
Show violations fields Property Type Required Description code string - The code of the violation hint string - An extra hint to understand the violation message string required The message associated with the violation parameters object - Dynamic placeholder values for the violation message template (substitute into the code catalogue message). payload object - The serialized payload of the violation propertyPath string required The property path of the violation slug string - Stable centralized error-code slug for this violation (see /api/error-codes).