Skip to content

Index Import (GraphQL)

Runs the indexing stage — the final step. It makes the imported records searchable and visible on the storefront. Runs after link.

This example runs against an import whose linking has completed. Calling it on an import that has not finished linking returns an error.

Operation

OperationTypePurpose
indexAdminSettingsDataTransferImportIndexMutationRun the indexing stage (final step)

Quirks

  • The input takes the import's importId and an id (the index 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 an import in your store that has finished linking.

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

Released under the MIT License.