BAbagisto
Admin Settings: Data Transfer

Link an import batch

Changed on

Links the next processed batch and returns stats + the refreshed import. Permission: settings.data_transfer.imports.import.

post/settings/data-transfer/imports/{id}/link

Request

Path parameters

idstring required

Settings data transfer import link ID

Request body

object required

Response

Batch linked; stats + refreshed import.

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)