Skip to main content
POST
Lieferschein-PDF hochladen (asynchrone Segmentierung)

Übersicht

Lädt ein Lieferschein-PDF hoch und startet die asynchrone Segmentierung und Extraktion (Stapel-/Heftscan). Geeignet für einzelne Lieferscheine sowie PDF-Bundles mit mehreren Lieferscheinen und optionalen Bestellscheinen. Das PDF wird gestreamt gespeichert und in die Segmentierungs-Queue eingereiht. Pro erkanntem Lieferschein entsteht danach eine Lieferung im Status PROCESSING; die Extraktion läuft asynchron. Die Antwort enthält sofort fileId und jobId — die Lieferzeilen erscheinen erst nach der Segmentierung.
Dieser Endpunkt erfordert das Feature-Flag delivery-async-processing. Ohne aktiviertes Flag antwortet die API mit 403.

Berechtigungen

Der API-Schlüssel muss mit einem Kunden verknüpft sein. Lieferanten-API-Schlüssel werden abgelehnt.

Query-Parameter

Verhalten

  • Der Request-Body ist das rohe PDF (kein multipart, kein Base64).
  • Metadaten werden ausschließlich über Query-Parameter übergeben.
  • Bei projektgebundenen API-Schlüsseln kann projectId weggelassen werden — das Projekt des Schlüssels wird verwendet.
  • Nach erfolgreichem Upload: Segmentierung → Fan-out → Extraktion. Abfragen Sie GET /deliveries, um die erstellten Zeilen zu sehen.
  • fileId ist die ID des hochgeladenen Bundle-Dokuments, keine Lieferungs-ID.

Beispiel

Erfolgreiche Antwort

Response Codes

Autorisierungen

X-API-Key
string
header
erforderlich

API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten.

Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.

Abfrageparameter

projectId
string<uuid>

Projekt-UUID. Pflicht, sofern der API-Schlüssel nicht projektgebunden ist (dann wird das Projekt des Schlüssels verwendet) oder der Aufrufer kein Admin ist.

supplierId
string<uuid>

Optionale Lieferanten-UUID, falls zum Upload-Zeitpunkt bekannt

sourceType
enum<string>
Standard:COMSTRUCT_API

Quelle der Lieferung. Standard für öffentliche API-Uploads: COMSTRUCT_API.

Verfügbare Optionen:
WEB_APP_IMPORT,
MAIL,
GENERAL_MAIL,
COMSTRUCT_API,
EXTERNAL_API,
PORTAL,
APP_SCAN

Body

application/pdf

Rohes PDF (binär)

The body is of type file.

Antwort

PDF hochgeladen und Segmentierung eingereiht

fileId
string<uuid>
erforderlich

ID des hochgeladenen Bundle-Dokuments (keine Lieferungs-ID)

Beispiel:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

success
boolean
erforderlich
Beispiel:

true

jobId
string

ID des Segmentierungs-Jobs in der Queue

Beispiel:

"42"