Skip to content

List Data Transfer Imports

EndpointMethod
/api/admin/settings/data-transfer/importsGET

Returns every data transfer import across entity types and actions in the { data, meta } envelope, newest first. Each row is one import job — the file uploaded, the entity it targets, and how far it has run.

Pagination

ParameterDescription
pagePage number, 1-based. Default 1.
per_pageItems per page. Default 10, max 50.

Filters

Query parameters that narrow the result. Supplying more than one narrows further — they combine with logical AND. They mirror the admin Imports datagrid filters.

ParameterMatchExample
codeEntity type (exact).?code=products
typeSynonym for code (kept for spec compatibility).?type=products
actionExact — append or delete.?action=append
stateExact.?state=completed
created_at_fromcreatedAt >= the given ISO date.?created_at_from=2026-01-01
created_at_tocreatedAt <= the given ISO date.?created_at_to=2026-12-31

Sorting

ParameterValues
sortid (default), state, created_at
orderasc, desc (default desc)

Notes

  • The heavy errors and summary blobs are left null on listing rows to keep the response light — fetch a single import with the detail endpoint 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.

See the Imports overview for field meanings and behaviour.

Released under the MIT License.