Skip to content

Update Import

EndpointMethod
/api/admin/settings/data-transfer/imports/{id}PUT

Re-saves an import's configuration. The import is reset back to pending and any earlier processing counts and error report are cleared. The {id} is the import id.

Send the request as multipart/form-data. The file field is optional — when a new file is sent it replaces the previous source file; when omitted the existing file is kept.

FieldRequiredDescription
typeyesThe importer to use, e.g. products, customers, tax_rates.
actionyesappend or delete.
validation_strategyyesstop-on-errors or skip-errors.
allowed_errorsyesInteger ≥ 0.
field_separatoryesThe column delimiter, e.g. ,.
process_in_queuenoWhen true, large imports are processed asynchronously.
images_directory_pathnoFolder containing referenced product images.
filenoA replacement import file (csv, xls, xlsx, or xml).

Returns the updated import detail.

Permission: settings.data_transfer.imports.edit.

Released under the MIT License.