Skip to main content
GET
/
deliveries
Lieferungen auflisten
curl --request GET \
  --url https://api.comstruct.com/v1/deliveries \
  --header 'X-API-Key: <api-key>'
{
  "deliveries": [
    {
      "deliveryNumber": "1234'23",
      "deliveryDate": "2024-01-15T08:30:00Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectNumber": "PRJ-2024-001",
      "projectTitle": "Highway Construction A1",
      "project": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "EXT-001",
        "title": "Example Site",
        "project_number": "23423420",
        "description": "<string>",
        "region": "Bavaria",
        "project_region_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "active": true,
        "status": "<string>",
        "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "address": {
          "address": "<string>",
          "city": "<string>",
          "zip": "<string>"
        },
        "project_invites": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "email": "[email protected]",
            "role": "<string>",
            "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerName": "Bauunternehmen Müller GmbH",
      "vehicleNumber": "M-AB 1234",
      "plant": "Werk München-Nord",
      "documentUrl": "https://example.com/delivery-note.pdf",
      "comment": "<string>",
      "status": "DELIVERED",
      "items": [
        {
          "title": "Beton C30/37",
          "productNumber": "1234",
          "type": "CONCRETE",
          "quantity": 15.5,
          "unit": "m3"
        }
      ]
    }
  ],
  "total": 150,
  "limit": 25,
  "offset": 0,
  "hasNext": true,
  "hasPrevious": false,
  "totalPages": 6,
  "currentPage": 0
}

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.

Erforderliche Berechtigungen:

  • deliveries:read - Lieferdaten lesen
  • deliveries:write - Lieferungen erstellen und ändern
  • invoices:read - Rechnungsdaten lesen
  • invoices:write - Rechnungen erstellen und ändern
  • projects:read - Projektdaten lesen
  • projects:write - Projekte erstellen und ändern
  • project_regions:read - Projektregionsdaten lesen
  • project_regions:write - Projektregionen erstellen und ändern
  • accounts:read - Kontodaten lesen
  • accounts:write - Konten erstellen und ändern
  • payment_terms:read - Zahlungsbedingungsdaten lesen
  • payment_terms:write - Zahlungsbedingungen erstellen und ändern
  • tax_codes:read - Steuercodedaten lesen
  • tax_codes:write - Steuercodes erstellen und ändern
  • users:read - Benutzerdaten lesen (erforderlich für Projekt-Benutzerverwaltung)
  • roles:read - Rollendaten lesen (erforderlich für Projekt-Rollenzuweisung)
  • tenant_settings:read - Mandanteneinstellungen lesen (erforderlich für Projekterstellung)
  • suppliers:write - Lieferanten erstellen und ändern
  • purchase_orders:write - Bestellungen erstellen

Query Parameters

limit
integer
default:25

Anzahl der Einträge pro Seite (max. 100, Standard 25)

Required range: 1 <= x <= 100
Example:

25

offset
integer
default:0

Anzahl der zu überspringenden Einträge für die Paginierung

Required range: x >= 0
Example:

0

marked
boolean

Ob der Lieferschein markiert wurde oder nicht

from
string<date>

ISO-8601 formatiertes Startlieferdatum (inklusiv)

Example:

"2025-09-01"

till
string<date>

ISO-8601 formatiertes Endlieferdatum (inklusiv)

Example:

"2025-09-10"

supplierId
string<uuid>

Nach Lieferanten-ID filtern

projectId
string<uuid>

Nach Projekt-ID filtern

Response

Erfolgreich

deliveries
object[]
total
integer

Gesamtanzahl der Lieferungen

Example:

150

limit
integer | null

Anzahl der Einträge pro Seite

Example:

25

offset
integer

Anzahl der übersprungenen Einträge

Example:

0

hasNext
boolean

Ob weitere Seiten verfügbar sind

Example:

true

hasPrevious
boolean

Ob vorherige Seiten verfügbar sind

Example:

false

totalPages
integer

Gesamtanzahl der Seiten

Example:

6

currentPage
integer

Aktuelle Seitennummer (0-basiert)

Example:

0