BAbagisto
Admin Settings: Data Transfer

Create an import

Changed on

Creates a new import. Send as multipart/form-data with the binary file part plus type / action / validation_strategy / allowed_errors / field_separator. Binary upload is REST-only. Permission: settings.data_transfer.imports.create.

post/settings/data-transfer/imports

Request

Request body multipart/form-data

typestring required
action'append' | 'delete' required
validation_strategy'stop-on-errors' | 'skip-errors' required
allowed_errorsinteger required
field_separatorstring required
process_in_queueboolean
images_directory_pathstring
image_source'url' | 'upload' | 'directory'
upload_imagesstring binary

ZIP of images, required when image_source is upload.

filestring binary required

Example request

{
  "type": "products",
  "action": "append",
  "validation_strategy": "stop-on-errors",
  "field_separator": ",",
  "image_source": "directory"
}

Response

Import created.

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 new optional request property

    • info

      added the new optional request property

    • 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)