Upload delivery PDF
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.
Overview
Uploads a delivery-note PDF and starts asynchronous segmentation and extraction (staple-scan). Suitable for single delivery notes as well as PDF bundles that contain multiple delivery notes and optional order sheets. The PDF is streamed to storage and enqueued on the segmentation queue. After segmentation, one delivery in statusPROCESSING is created per detected delivery note; extraction then runs asynchronously. The response returns fileId and jobId immediately — delivery rows appear only after segmentation completes.
delivery-async-processing feature flag. Without it, the API responds with 403.Permissions
Headers
Query parameters
Behavior
- The request body is the raw PDF (not multipart, not Base64).
- Metadata is passed only via query parameters.
- For project-scoped API keys,
projectIdmay be omitted — the key’s project is used. - After a successful upload: segmentation → fan-out → extraction. Poll
GET /deliveriesfor the resulting rows. fileIdis the uploaded bundle document id, not a delivery id.
Example
Successful response
Response codes
Authorizations
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.
Query Parameters
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.