Übersicht
Dieser Leitfaden erklärt, wie Lieferanten sich mit comstruct integrieren können, um Lieferscheine und Rechnungen automatisch zu übermitteln. Durch die Anbindung an comstruct können Lieferanten ihre Logistikprozesse optimieren und Echtzeit-Lieferinformationen an ihre Auftraggeberkunden bereitstellen.Um Zugang zur comstruct API zu erhalten, wenden Sie sich an Ihren zuständigen Customer Success Manager. Unser Expertenteam unterstützt Sie gerne bei der optimalen Nutzung unserer API.
Was Lieferanten tun können
Als angebundener Lieferant bei comstruct können Sie:- Lieferscheine automatisch übermitteln aus Ihren Systemen
- Rechnungen hochladen zur Verarbeitung
- Lieferstatus verfolgen in Echtzeit
- Mit verschiedenen Lieferformaten integrieren (OpenTrans, PAHM, Q-Point, eigene Formate)
Voraussetzungen
Bevor Sie beginnen, stellen Sie sicher, dass Sie Folgendes haben:- Einen API-Schlüssel von comstruct
- Die entsprechenden Berechtigungen für Ihren API-Schlüssel:
deliveries:write- Zum Erstellen von Lieferscheineninvoices:write- Zum Einreichen von Rechnungen
- Ihre Lieferanten-ID in comstruct konfiguriert
Authentifizierung
Alle API-Anfragen erfordern eine Authentifizierung mittels eines API-Schlüssels imx-api-key-Header.
Lieferschein-Integration
Standard-Lieferformat
Der einfachste Weg, Lieferscheine zu übermitteln, ist das Standard-JSON-Format.OpenTrans-Format
Wenn Ihr System OpenTrans unterstützt, können Sie Lieferscheine in diesem standardisierten Format übermitteln.PAHM-Format
Für PAHM-kompatible Systeme:Q-Point-Integration
Wenn Sie Q-Point für Qualitätsmanagement verwenden:Eigenes Format mit KI-Verarbeitung
Für nicht-standardisierte Formate bietet comstruct KI-gestützte Analyse:Rechnungseinreichung
Standard-Rechnungs-Upload
Reichen Sie Rechnungen zur Verarbeitung mit KI-gestützter Datenextraktion ein:Lieferdaten-Schema
Pflichtfelder
| Feld | Typ | Beschreibung |
|---|---|---|
deliveryNumber | string | Eindeutige Lieferscheinnummer (pro Lieferant) |
deliveryDate | datetime | ISO 8601 formatiertes Lieferdatum |
Projektzuordnung (mindestens eines empfohlen)
| Feld | Typ | Beschreibung |
|---|---|---|
projectId | uuid | Direkte Projekt-ID (höchste Priorität) |
projectNumber | string | Projektnummer des Auftraggebers |
projectTitle | string | Projekttitel für Fuzzy-Matching |
customerName | string | Kundenname für Projektsuche |
Optionale Felder
| Feld | Typ | Beschreibung |
|---|---|---|
vehicleNumber | string | Kennzeichen des Lieferfahrzeugs |
plant | string | Werk/Anlage der Herkunft |
comment | string | Optionaler Kommentar |
documentUrl | string | Link zum Lieferschein-Dokument |
status | string | Lieferstatus (z.B. DELIVERED, IN_TRANSIT) |
Positionen (items)
| Feld | Typ | Beschreibung |
|---|---|---|
items[].title | string | Produktbeschreibung (Pflichtfeld) |
items[].productNumber | string | Ihre Produktreferenz |
items[].quantity | number | Gelieferte Menge |
items[].unit | string | Mengeneinheit (Standard: “pau”) |
items[].type | string | Produkttyp (wird automatisch ermittelt wenn nicht angegeben) |
Best Practices
Eindeutige Referenzen verwenden
Verwenden Sie immer eindeutige Referenznummern für jede Lieferung, um Nachverfolgung zu ermöglichen und Duplikate zu vermeiden.
Projektnummern angeben
Geben Sie immer die Projektnummer des Auftraggebers an, damit Lieferungen korrekt zugeordnet werden.
Vor dem Senden validieren
Validieren Sie Ihr Datenformat lokal, bevor Sie es übermitteln, um Verarbeitungsfehler zu vermeiden.
Fehler behandeln
Implementieren Sie ordnungsgemäße Fehlerbehandlung und Wiederholungslogik für vorübergehende Fehler.
Fehlerbehandlung
Die API verwendet Standard-HTTP-Statuscodes:| Status | Beschreibung |
|---|---|
200 | Erfolg |
400 | Ungültiger Anfragekörper oder Validierung fehlgeschlagen |
401 | Nicht autorisiert - ungültiger API-Schlüssel oder fehlende Berechtigung |
403 | Verboten - API-Schlüssel nicht mit Lieferant verknüpft |
500 | Interner Serverfehler |
Beispiel-Fehlerantwort
Ihre Integration testen
Test-Lieferung übermitteln
Übermitteln Sie einen Test-Lieferschein mit Beispieldaten, um Ihre Integration zu verifizieren.
Support
Bei Problemen oder Fragen:- Kontaktieren Sie Ihren Customer Success Manager
- E-Mail: [email protected]
- Sehen Sie sich die API-Referenz für detaillierte Endpunkt-Dokumentation an