/bff/import/analyze

Accepts a CSV/JSON file upload or a remote URL, parses the content, detects columns, and creates an import job in "ready" status. For the Shoptet provider, Czech column names are automatically mapped to English equivalents. Returns a preview of the first 10 rows.

ImportpostBffImportAnalyze

Parameters

JSON body

Request body

application/json

providerstringOptional

Import provider ("shoptet" or "manual"). Default: "manual".

dataTypestringOptional

Type of entity being imported (e.g. "product", "contact").

sourceTypestringOptional

Source type ("file" or "url"). Default: "file".

filestringOptionalbinary

CSV/JSON file upload (required when sourceType="file").

Default: File

urlstringOptional

Remote feed URL (required when sourceType="url").

Response schema

1 status code documented

200SuccessAnalysis result with preview data and import job reference.

successbooleanRequired

Whether the analysis completed successfully.

importIdstringRequired

External ID of the created import job. Use this to start the import.

totalRowsnumberRequired

Total number of data rows detected in the source file.

columnsstring[]Required

List of detected column names (after provider mapping if applicable).

previewany[]Required

Preview of the first 10 rows as objects keyed by column name.

errorsstring[]Required

Parsing errors encountered during analysis. Empty if parsing succeeded.

Response example

application/json

{
  "success": false,
  "importId": "example_importId",
  "totalRows": 0,
  "columns": [
    "string"
  ],
  "preview": [],
  "errors": [
    "string"
  ]
}

Request example

POST /bff/import/analyze

post

curl -X POST "https://api.bizkithub.com/bff/import/analyze" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "provider": "example_provider",
  "dataType": "example_dataType",
  "sourceType": "example_sourceType",
  "file": "File",
  "url": "example_url"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key