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"
}{
"success": true,
"message": "Delivery note uploaded successfully",
"deliveryNumber": "LS-2024-001"
}{
"success": false,
"message": "<string>",
"statusCode": 400
}Lieferungen
Eigene Lieferung erstellen
Erforderliche Berechtigungen: deliveries:write
Verarbeitet Lieferscheine in benutzerdefinierten Formaten. Der Inhalt wird anhand der lieferantenspezifischen Konfiguration automatisch verarbeitet und in comstruct-Lieferungen umgewandelt.
Der Anfragekörper kann entweder als JSON-Objekt mit den Feldern xmlContent oder jsonContent gesendet werden, oder als roher XML- bzw. JSON-String. Die automatische Erkennung des Formats erfolgt über den Content-Type-Header.
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"
}{
"success": true,
"message": "Delivery note uploaded successfully",
"deliveryNumber": "LS-2024-001"
}{
"success": false,
"message": "<string>",
"statusCode": 400
}Ü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:| Variante | Content-Type | Body |
|---|---|---|
| JSON-Wrapper | application/json | { "jsonContent": { ... } } oder { "xmlContent": "<xml>...</xml>" } |
| Roher XML-String | application/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"
}
]
}
}'
{
"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>"
}'
{
"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
| Code | Beschreibung |
|---|---|
201 | Lieferschein erfolgreich verarbeitet und erstellt |
200 | Lieferschein empfangen, aber keine Änderungen (z.B. Duplikat) |
400 | Ungültige Eingabe oder fehlende Lieferanten-ID |
401 | Nicht autorisiert - fehlender oder ungültiger API-Schlüssel |
403 | Keine Berechtigung - fehlender Scope deliveries:write |
500 | Interner Serverfehler |
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.
Body
application/jsonapplication/xml
Lieferscheindaten im JSON- oder XML-Format