Zum Hauptinhalt springen
POST
/
deliveries
/
custom
curl --request POST \
  --url https://api.comstruct.com/v1/deliveries/custom \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "jsonContent": {
    "deliveryNumber": "LS-2024-001",
    "customerName": "Musterbau GmbH",
    "items": [
      {
        "title": "Beton C30/37",
        "quantity": 25.5,
        "unit": "m3"
      }
    ]
  }
}
'
{
  "success": true,
  "message": "Delivery note has no changes"
}

​
Übersicht

Mit diesem Endpunkt können Lieferanten Lieferscheine in eigenen, nicht-standardisierten Formaten an comstruct übermitteln. Die Daten werden automatisch von system-spezifischen Prozessoren verarbeitet und in comstruct-Lieferungen umgewandelt. Der Endpunkt akzeptiert entweder JSON oder XML als Eingabeformat.

​
Eingabeformat

Der Anfragekörper kann auf zwei Arten gesendet werden:
VarianteContent-TypeBody
JSON-Wrapperapplication/json{ "jsonContent": { ... } } oder { "xmlContent": "<xml>...</xml>" }
Roher XML-Stringapplication/xml<delivery>...</delivery>
Wenn Sie rohen JSON- oder XML-Inhalt als String senden, erkennt comstruct das Format automatisch anhand des Inhalts.

​
Beispiel-Aufrufe

​
JSON-Lieferschein senden

curl -X POST "https://api.comstruct.com/v1/deliveries/custom" \
  -H "x-api-key: IHR_API_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonContent": {
      "deliveryNumber": "LS-2024-001",
      "customerName": "Musterbau GmbH",
      "projectNumber": "PRJ-001",
      "deliveryDate": "2024-06-15T08:30:00Z",
      "items": [
        {
          "title": "Beton C30/37",
          "productNumber": "BETON-C30",
          "quantity": 25.5,
          "unit": "m3"
        },
        {
          "title": "Bewehrungsstahl B500S",
          "productNumber": "STAHL-B500S",
          "quantity": 3.2,
          "unit": "t"
        }
      ]
    }
  }'

​
XML-Lieferschein senden

curl -X POST "https://api.comstruct.com/v1/deliveries/custom" \
  -H "x-api-key: IHR_API_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  -d '{
    "xmlContent": "<delivery><number>LS-2024-002</number><customer>Musterbau GmbH</customer><date>2024-06-15</date><items><item><title>Beton C30/37</title><quantity>25.5</quantity><unit>m3</unit></item></items></delivery>"
  }'

​
Erfolgreiche Antwort

{
  "success": true,
  "message": "Delivery note uploaded successfully",
  "deliveryNumber": "LS-2024-001"
}

​
Response Codes

CodeBeschreibung
201Lieferschein erfolgreich verarbeitet und erstellt
200Lieferschein empfangen, aber keine Änderungen (z.B. Duplikat)
400Ungültige Eingabe oder fehlende Lieferanten-ID
401Nicht autorisiert - fehlender oder ungültiger API-Schlüssel
403Keine Berechtigung - fehlender Scope deliveries:write
500Interner Serverfehler

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

Lieferscheindaten im JSON- oder XML-Format

​
xmlContent
string

XML-Inhalt des Lieferscheins (alternativ zu jsonContent)

​
jsonContent

JSON-Inhalt des Lieferscheins (alternativ zu xmlContent)

Antwort

Lieferschein wurde empfangen, aber nicht erstellt (z.B. Duplikat oder keine Änderungen).

​
success
boolean
Beispiel:

true

​
message
string
Beispiel:

"Delivery note has no changes"