BizKitHub
DocsAPI ReferenceImport/bff/import/analyze
postImportAdmin BFF

/bff/import/analyze

Accepts a CSV/JSON/XML file upload or a remote URL, recognises the format (Shopify, Shoptet, WooCommerce, Heureka, Google Merchant, generic), maps columns to internal fields and creates an import job in "ready" status. A recognised format overrides the requested provider and data type. 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/XML 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.

formatobjectRequired

File format recognised from the header row / XML root.

idstringRequired

Recognised format id (e.g. "shoptet-orders-xml", "shopify-products-csv", "generic-csv").

labelstringRequired

Human-readable format name.

providerstringRequired

Provider actually used (a recognised format overrides the requested one).

dataTypestringRequired

Data type actually used (a recognised format overrides the requested one).

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",
  "format": {
    "id": "example_id",
    "label": "example_label"
  },
  "provider": "example_provider",
  "dataType": "example_dataType",
  "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