Skip to main content
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>"
        }
      ]
    }
  ]
}

​
Overview

Returns project components linked to a delivery, grouped by group_id. Each group shares one distribution of quantities across delivery line item titles — the same model as the comstruct web app for mass balance and component overview.

​
Permissions

ScopeDescription
deliveries:readRead delivery data

​
Response shape

The payload has a groups array. Each group includes:
FieldDescription
group_idUUID for the group
distributionMap from delivery line item title to quantity, e.g. { "Concrete C30/37": 5.5 }, or null
componentsAssigned project components with id, component_id, component_title, component_type_id, component_type_title

​
Response codes

CodeDescription
200Success
403Forbidden — delivery belongs to another customer
404Delivery not found

Authorizations

​
X-API-Key
string
header
required

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.

Path Parameters

​
id
string<uuid>
required

Lieferungs-ID (UUID)

Response

Komponentengruppen der Lieferung

​
groups
object[]
required