BAbagisto
Admin Settings: Data Transfer

List imports

Changed on

Paginated listing of all imports across entity types and actions. Filters: code (entity type), type (synonym for code), action, state, created_at_from, created_at_to. Sort: id (default desc), state, created_at.

get/settings/data-transfer/imports

Request

Query parameters

pageinteger
Example:1

Page number.

per_pageinteger
Example:10

Items per page (default 10, max 50).

codestring
Example:product

Filter by entity type (e.g. product, customer).

typestring
Example:product

Alias for code (kept for spec compatibility).

actionstring
Example:append

Filter by action (append / update / delete).

statestring
Example:pending

Filter by state.

created_at_fromstring
Example:2026-01-01

Filter by created_at >= (ISO date).

created_at_tostring
Example:2026-12-31

Filter by created_at <= (ISO date).

sort'id' | 'state' | 'created_at'
Example:id

Sort column.

order'asc' | 'desc'
Example:desc

Sort direction.

Response

Paginated imports in the { data, meta } envelope.

idinteger nullable
codestring nullable
actionstring nullable
statestring nullable
processInQueueboolean nullable
validationStrategystring nullable
allowedErrorsinteger nullable
processedRowsCountinteger nullable
invalidRowsCountinteger nullable
errorsCountinteger nullable
fieldSeparatorstring nullable
filePathstring nullable
imagesDirectoryPathstring nullable
imageSourcestring nullable

Where a product import reads its images from: url, upload or directory.

imagesArchiveNamestring nullable

Name of the images archive uploaded for this import, when its images came from an upload.

errorFilePathstring nullable
summaryobject nullable
startedAtstring nullable
completedAtstring nullable
createdAtstring nullable
updatedAtstring nullable
successboolean nullable
isValidboolean nullable
statsobject nullable
messagestring nullable

Example response

[
  {
    "id": 1,
    "code": "products",
    "action": "append",
    "state": "pending",
    "validationStrategy": "stop-on-errors",
    "fieldSeparator": ",",
    "filePath": "imports/6f1a_products.csv",
    "imagesDirectoryPath": "product/images",
    "summary": {
      "created": 0,
      "updated": 0,
      "deleted": 0
    },
    "createdAt": "2026-05-25T08:15:00+00:00",
    "updatedAt": "2026-05-25T08:20:00+00:00",
    "success": true,
    "isValid": true,
    "stats": {
      "processed": 120,
      "total": 120,
      "invalid": 0
    },
    "message": "Import deleted successfully."
  }
]

Changes

  • 3c859f92343fRevision changes
    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/html)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/html)