Skip to content

Start Import (GraphQL)

Processes the next pending batch of rows. Call it repeatedly — each call advances the import — until stats reports remaining: 0. Runs only after the import has been validated.

This example runs against a validated, mid-pipeline import. A freshly-created import with validation errors returns There is nothing to import. instead.

Operation

OperationTypePurpose
startAdminSettingsDataTransferImportStartMutationProcess the next batch of rows

After processing

When all batches are processed, run the link stage, then the index stage to finish the import.

Errors

The mutation reports an error when there is nothing left to import, when the import has not been validated, or when asynchronous processing is requested but the queue is not configured.

Quirks

  • The input takes the import's importId and an id (the start IRI) — API Platform requires the id field on every non-create mutation.
  • 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 a validated import in your store.

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

Released under the MIT License.