Lieferschein-PDF hochladen
Erforderliche Berechtigungen: deliveries:patch
Öffentlicher API-Einstieg für den asynchronen Lieferschein-PDF-Upload (Stapel-/Heftscan).
Erfordert das Feature-Flag delivery-async-processing und einen kundengebundenen API-Schlüssel
(CUSTOMER_ONLY) mit Scope deliveries:patch. Lieferanten-API-Schlüssel werden abgelehnt.
Senden Sie das rohe PDF als Request-Body (Content-Type: application/pdf).
Der Header Content-Length ist Pflicht. Metadaten werden als Query-Parameter übergeben.
Das PDF wird gestreamt in den Speicher geschrieben und in die Queue delivery-segmentation
eingereiht. Nach der Segmentierung wird pro erkannter Lieferschein-Seite eine Lieferung
im Status PROCESSING angelegt und die Extraktion über delivery-processing gestartet.
Die Antwort enthält sofort fileId und jobId — die Lieferzeilen erscheinen erst nach
Abschluss der Segmentierung. Abfragen Sie anschließend GET /deliveries.
Maximale PDF-Größe: 16 MiB.
Ü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 StatusPROCESSING; die Extraktion läuft asynchron. Die Antwort enthält sofort fileId und jobId — die Lieferzeilen erscheinen erst nach der Segmentierung.
delivery-async-processing. Ohne aktiviertes Flag antwortet die API mit 403.Berechtigungen
Header
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
projectIdweggelassen 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. fileIdist die ID des hochgeladenen Bundle-Dokuments, keine Lieferungs-ID.
Beispiel
Erfolgreiche Antwort
Response Codes
Autorisierungen
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
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.
Optionale Lieferanten-UUID, falls zum Upload-Zeitpunkt bekannt
Quelle der Lieferung. Standard für öffentliche API-Uploads: COMSTRUCT_API.
WEB_APP_IMPORT, MAIL, GENERAL_MAIL, COMSTRUCT_API, EXTERNAL_API, PORTAL, APP_SCAN Body
Rohes PDF (binär)
The body is of type file.