Skip to content

List Imports (GraphQL)

Lists every data transfer import, newest first, as a cursor-paginated connection. Each node is one import job — the file uploaded, the entity it targets, and how far it has run.

Operation

OperationTypePurpose
adminSettingsDataTransferImportsQueryCollectionList import jobs (cursor pagination)

Arguments

All arguments are optional and combine in a single query — filter, sort and paginate together.

Pagination

ArgumentDescription
firstNumber of records to return.
afterCursor to fetch the page after (from pageInfo.endCursor).

Filters

Each filter narrows the result; supplying more than one combines with logical AND. They mirror the admin Imports datagrid filters.

ArgumentTypeMatchExample
codeStringEntity type (exact)."products"
typeStringSynonym for code (kept for spec compatibility)."products"
actionStringExact — append or delete."append"
stateStringExact."validated"
created_at_fromStringcreated_at >= the given ISO date."2026-01-01"
created_at_toStringcreated_at <= the given ISO date."2026-12-31"

Sorting

ArgumentTypeValues
sortStringid (default), state, created_at
orderStringasc, desc (default desc)

Quirks

  • The heavy errors and summary fields are left null on listing rows to keep the response light — fetch a single import with the detail query to read them.
  • code is the entity being imported (products, customers, tax_rates, …). action is append or delete.
  • processedRowsCount advances as the import runs; errorsCount / invalidRowsCount reflect validation outcomes.

All operations require an admin Bearer token — see Authentication.

Released under the MIT License.