Introduction - Connector API

Connector API is used for batch upload of client data (receipts, products, stock, catalogs, and more). Data is sent in separate packages within a single upload session. After all packages are collected, you start data loading with a separate request.

Core concepts

Concept	Description
Upload session (`upload_uuid`)	Logical container for one upload. A client can have only one active session at a time.
Entity (`entity_name`)	Data type (e.g. `receipt`, `product`, `stock`). Each entity has a fixed set of columns.
Data loading	Processing of the data collected in the session. Started via `start-upload`; completion is reported automatically.

Before integration, agree with support which data sources (API vs other sources) apply to each step, and review entity dependencies for parent/child upload order.

Session lifecycle

                         ┌────────── (terminate) ──────────┐
                         ▼                                 │
initialize-session ──► UPLOADING ──(start-upload)──► STARTED ──► DONE
        ▲                  │
        │  (delete)        │
        └──────────────────┘

See Session states for details.

Typical flow

POST /uploading/initialize-session → get upload_uuid
POST /uploading/:upload_uuid/:entity_name → upload data packages
GET /uploading/:upload_uuid/status → wait for can_start_upload = true
POST /uploading/:upload_uuid/start-upload → start data loading
GET /uploading/:upload_uuid/status → wait for session_status = DONE

Status is tracked through that same GET /status endpoint. Optionally, support can enable an email when data loading finishes; you can also review status in data-console.datawiz.io. Step-by-step guide: Integration flow.