Zum Hauptinhalt springen
GET
/
deliveries
/
{id}
/
components
Lieferkomponenten abrufen
curl --request GET \
  --url https://api.comstruct.com/v1/deliveries/{id}/components \
  --header 'X-API-Key: <api-key>'
{
  "groups": [
    {
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "distribution": {
        "Beton C30/37": 5.5
      },
      "components": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "component_id": 123,
          "component_title": "<string>",
          "component_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "component_type_title": "<string>"
        }
      ]
    }
  ]
}

​
Übersicht

Dieser Endpunkt liefert die einer Lieferung zugeordneten Projektkomponenten (Baustoff-/Leistungskomponenten aus dem Projekt), gruppiert nach group_id. Jede Gruppe teilt sich eine Verteilung der Mengen auf die Positionsbezeichnungen (title) der Lieferpositionen — dieselbe Logik wie in der comstruct Web-App für Massenbilanz und Komponentenübersicht.

​
Berechtigungen

ScopeBeschreibung
deliveries:readLieferdaten lesen

​
Response-Struktur

Die Antwort enthält ein Feld groups. Jede Gruppe umfasst:
FeldBeschreibung
group_idUUID der Gruppe
distributionObjekt mit Mengen je Positionsbezeichnung der Lieferung, z. B. { "Beton C30/37": 5.5 }, oder null
componentsListe der zugeordneten Projektkomponenten mit id, component_id, component_title, component_type_id, component_type_title

​
Response Codes

CodeBeschreibung
200Erfolg
403Keine Berechtigung — Lieferung gehört einem anderen Kunden
404Lieferung nicht gefunden

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.

Pfadparameter

​
id
string<uuid>
erforderlich

Lieferungs-ID (UUID)

Antwort

Komponentengruppen der Lieferung

​
groups
object[]
erforderlich