Skip to main content

Import Based On Configuration

POST /v1/integration/:id/file/import

Imports data from an external source using a predefined configuration. The service applies field mappings and validations, then returns a concise summary indicating how many items were processed, succeeded, skipped, and failed, along with lists of any failed or skipped items.

Query Parameters​

  • filename - Parameter for filename
  • ~print - Parameter for ~print

Request Example​

POST /v1/integration/:id/file/import?filename=4_pro.csv

Request Body​

{
    "resource": "products",
    "provider": "csv",
    "name": "Globalfiber prisliste innpriser 3.csv",
    "importOptions": {
      "isSubscription": false,
      "isActive": true,
      "salesChannels": ["marketplace"]
    },
    "csvOptions": {
      "fieldDelimiter": ",",
      "valueDelimiter": ","
    },
    "fieldMapping": {
      "sku": "sku",
      "name": "name",
      "description": "description",
      "id": "id"
    },
    "propertyMapping": {},
    "filter": {
      "all": true,
      "ids": [0, 1, 2, 3, 4]
    }
  }

Response Example​

{
  "status": true,
  "message": "Successfully imported all 4 item(s).",
  "data": {
    "id": "import-id-1",
    "status": true,
    "message": "Successfully imported all 4 item(s).",
    "total": 4,
    "successCount": 4,
    "skippedCount": 0,
    "failedCount": 0,
    "failed": [],
    "skipped": []
  }
}