Skip to content

Validate Import (GraphQL)

Runs validation over the uploaded file without importing any data. This is the second step of the import lifecycle — run it after the import is created (over REST), before start.

Operation

OperationTypePurpose
validateAdminSettingsDataTransferImportValidateMutationValidate the uploaded file

Quirks

  • The input takes the import's importId and an id (the validate IRI) — API Platform requires the id field on every non-create mutation.
  • The response carries an isValid flag. When isValid is false, read errorsCount / invalidRowsCount, or download the error report over REST to see which rows failed.
  • Select _id for the numeric import id; the payload id IRI does not resolve on mutation results.

Prerequisites

The example uses an illustrative import. Replace it with an import that exists in your store — use the adminSettingsDataTransferImports query to discover valid ids.

Permission: settings.data_transfer.imports.edit. All operations require an admin Bearer token — see Authentication.

Released under the MIT License.