Skip to content

Import Detail (GraphQL)

Returns a single import job with the full set of fields — including the heavy errors[] list and summary object that the listing leaves null.

Operation

OperationTypePurpose
adminSettingsDataTransferImport(id:)QueryFetch one import with every field

Field meanings

  • code — the entity being imported (products, customers, tax_rates, …).
  • actionappend (insert/update rows) or delete (remove rows).
  • state — where the job sits in its lifecycle (pending, validated, processing, processed, linked, indexed, completed, cancelled, …).
  • validationStrategystop-on-errors or skip-errors; allowedErrors is the error budget for skip-errors.
  • processedRowsCount / invalidRowsCount / errorsCount — progress and validation counters.
  • errors — the list of validation messages (null until validation has run).
  • summary — created/updated/deleted counts after a run (null until the run completes).
  • filePath / errorFilePath / imagesDirectoryPath — storage paths; the source file and error report are downloadable over REST only.
  • startedAt / completedAt / createdAt / updatedAt — lifecycle timestamps.

Quirks

  • errors and summary are returned as raw JSON values — query them bare (no sub-selection).
  • errorFilePath and summary stay null until a run has actually produced output.

Prerequisites

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

All operations require an admin Bearer token — see Authentication.

Released under the MIT License.