Introduction - Connector API

Connector API is used for batch upload of client data (receipts, products, stock, catalogs, and more) followed by Connector processing. Data is sent in separate packages within a single upload session; after uploading is complete, processing is started 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.
Workflow (Connector)	Processing of uploaded data. Started via `start-upload`; completion is reported by Connector automatically.

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

Session lifecycle

                         ┌────────── (terminate) ──────────┐
                         ▼                                 │
initialize-session ──► UPLOADING ──(start-upload)──► STARTED ──(Connector)──► 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 Connector
GET /uploading/:upload_uuid/status → wait for session_status = DONE

Step-by-step guide: Integration flow.

​Core concepts

​Session lifecycle

​Typical flow

Core concepts

Session lifecycle

Typical flow