curl --request POST \
  --url https://api.comstruct.com/v1/deliveries \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "deliveryNumber": "LS-2024-001234",
  "deliveryDate": "2024-01-15T08:30:00Z",
  "projectNumber": "PRJ-2024-001",
  "items": [
    {
      "title": "Beton C30/37",
      "quantity": 8.5,
      "unit": "m3",
      "productNumber": "BET-C30-37"
    }
  ]
}
'

{
  "success": true,
  "message": "Delivery note has no changes"
}

Lieferungen

Lieferung erstellen

Erforderliche Berechtigungen: deliveries:write

Erstellt einen neuen Lieferschein im System. Dieser Endpunkt wird typischerweise von Lieferanten verwendet, um Lieferinformationen zu übermitteln.

Erforderliche Felder:

deliveryNumber: Eindeutige Lieferscheinnummer vom Lieferanten
deliveryDate: Datum und Uhrzeit der Lieferung (ISO 8601-Format)

Projektzuordnung: Die Lieferung kann mit einem Projekt verknüpft werden, indem einer der folgenden Werte verwendet wird (in Reihenfolge der Priorität):

projectId: Direkte UUID-Referenz zum Projekt
projectNumber: Projektnummer für automatischen Abgleich
projectTitle: Projekttitel für Fuzzy-Matching
customerName: Kundenname für Projektsuche

Positionen: Jede Lieferung sollte mindestens eine Position mit einem title enthalten. Das type-Feld ist optional und wird automatisch basierend auf Titel und Einheit bestimmt, wenn nicht angegeben.

POST

deliveries

curl --request POST \
  --url https://api.comstruct.com/v1/deliveries \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "deliveryNumber": "LS-2024-001234",
  "deliveryDate": "2024-01-15T08:30:00Z",
  "projectNumber": "PRJ-2024-001",
  "items": [
    {
      "title": "Beton C30/37",
      "quantity": 8.5,
      "unit": "m3",
      "productNumber": "BET-C30-37"
    }
  ]
}
'

{
  "success": true,
  "message": "Delivery note has no changes"
}

Übersicht

Mit diesem Endpunkt können Lieferanten Lieferscheine in comstruct erstellen. Der Lieferschein wird automatisch dem entsprechenden Projekt zugeordnet, sofern eine Zuordnung möglich ist.

Pflichtfelder

Feld	Beschreibung
`deliveryNumber`	Eindeutige Lieferscheinnummer des Lieferanten
`deliveryDate`	Datum und Uhrzeit der Lieferung (ISO 8601 Format)

Projektzuordnung

Die Lieferung kann über verschiedene Felder einem Projekt zugeordnet werden (in Prioritätsreihenfolge):

projectId: Direkte UUID-Referenz zum Projekt
projectNumber: Projektnummer für automatischen Abgleich
projectTitle: Projekttitel für Fuzzy-Matching
customerName: Kundenname für Projektsuche

Positionen (Items)

Jede Lieferung sollte mindestens eine Position mit einem title enthalten. Das type-Feld ist optional und wird automatisch basierend auf Titel und Einheit bestimmt, wenn nicht angegeben.

Unterstützte Einheiten

Einheit	Beschreibung
`m3`	Kubikmeter
`t`	Tonnen
`kg`	Kilogramm
`stk`	Stück
`h`	Stunden
`pau`	Pauschale (Standard)

PDF-Dokument

Ein PDF-Lieferschein kann optional im Feld documentUrl übermittelt werden. Das Feld akzeptiert beide Base64-Formate:

Format	Beispiel
Rohes Base64	`"documentUrl": "JVBERi0xLjcK..."`
Data-URI	`"documentUrl": "data:application/pdf;base64,JVBERi0xLjcK..."`

Trotz des Feldnamens akzeptiert documentUrl keine HTTP(S)-URL. Übermitteln Sie den PDF-Inhalt direkt als rohes Base64 oder als Data-URI.

Response Codes

Code	Beschreibung
`201`	Lieferschein erfolgreich erstellt
`200`	Lieferschein empfangen, aber keine Änderungen (Duplikat oder unverändert)
`400`	Ungültige Eingabe - Validierung fehlgeschlagen
`403`	Keine Berechtigung - fehlender Scope `deliveries:write`

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.

Body

application/json

deliveryNumber

string

erforderlich

Die Referenznummer für die Lieferung. Muss für den Lieferanten eindeutig sein.

Beispiel:

"1234'23"

deliveryDate

string<date-time>

erforderlich

Datum und Uhrzeit der Lieferung. Muss im ISO 8601-Format sein.

Beispiel:

"2024-01-15T08:30:00Z"

projectNumber

string

Die Projektnummer, zu der die Lieferung gehört. Wird für die Zuordnung der Lieferung zu einem Projekt verwendet.

Beispiel:

"PRJ-2024-001"

projectTitle

string

Der Titel des Projekts. Kann als Alternative zur projectNumber für die Projektzuordnung verwendet werden.

Beispiel:

"Highway Construction A1"

supplierId

string<uuid>

write-only

Die ID des Lieferanten, zu dem die Lieferung gehört.

projectId

string<uuid>

Die ID des Projekts, zu dem die Lieferung gehört. Wenn angegeben, hat diese Vorrang vor projectNumber.

customerName

string

Der Name des Kunden, der die Lieferung erhält. Kann für die Projektzuordnung verwendet werden.

Beispiel:

"Bauunternehmen Müller GmbH"

vehicleNumber

string

Das Kennzeichen des Fahrzeugs, mit dem die Lieferung transportiert wird.

Beispiel:

"M-AB 1234"

plant

string

Der Name oder die Kennung des Werks/der Anlage, von der die Lieferung stammt.

Beispiel:

"Werk München-Nord"

documentUrl

string

Optionales, Base64-kodiertes PDF des Lieferscheins. Beide Formate werden unterstützt: rohes Base64 (z. B. JVBERi0xLjcK...) und eine vollständige Data-URI (z. B. data:application/pdf;base64,JVBERi0xLjcK...). HTTP(S)-URLs werden trotz des Feldnamens nicht unterstützt.

Beispiel:

"data:application/pdf;base64,JVBERi0xLjcK..."

comment

string

Ein optionaler Kommentar zur Lieferung.

status

string

Der Status der Lieferung (z.B. DELIVERED, IN_TRANSIT, PENDING).

Beispiel:

"DELIVERED"

items

object[]

Eine Liste der in der Lieferung enthaltenen Positionen.

Show child attributes

Antwort

Lieferschein empfangen, aber keine Änderungen vorgenommen (Duplikat oder unverändert)

success

boolean

Beispiel:

true

message

string

Beispiel:

"Delivery note has no changes"

Übersicht

Projekte

Lieferungen

Rechnungen

Rechnungs-Dimensionen

Lieferanten

Bestellungen

Bestellungen (Lieferanten)

Stammdaten

Q-Point Integration

Workflows

Kalender

IDS Aufträge

Lieferung erstellen

Übersicht

Pflichtfelder

Projektzuordnung

Positionen (Items)

Unterstützte Einheiten

PDF-Dokument

Response Codes

Autorisierungen

Body

Antwort

​Übersicht

​Pflichtfelder

​Projektzuordnung

​Positionen (Items)

​Unterstützte Einheiten

​PDF-Dokument

​Response Codes

Autorisierungen

Body

Antwort

Übersicht

Pflichtfelder

Projektzuordnung

Positionen (Items)

Unterstützte Einheiten

PDF-Dokument

Response Codes