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": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "delivery_number": "LS-2024-001234",
      "order_number": "PO-2024-001",
      "plant": {
        "title": "Betonwerk München-Nord"
      },
      "planned_arrival_time": "2024-01-15T08:30:00Z",
      "status": "COMPLETED",
      "marked": false,
      "project_number": "PRJ-2024-001",
      "created_at": "2024-01-15T08:30:00Z",
      "updated_at": "2024-01-15T09:00:00Z",
      "comment": "<string>",
      "supplier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_matched": false,
      "work_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "charged": false,
      "charging_number": "<string>",
      "received_at": "2023-11-07T05:31:56Z",
      "items": [
        {
          "title": "Beton C30/37",
          "quantity": 8.5,
          "product_number": "BET-C30-37",
          "unit": "m3",
          "type": "CONCRETE",
          "work_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "project": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "Neubau Bürogebäude",
        "project_number": "PRJ-2024-001",
        "external_id": "<string>"
      },
      "supplier": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "Beton GmbH"
      }
    }
  ],
  "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.

Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.

Query Parameters

limit
integer
default:25

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

Required range: 1 <= x <= 500
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"

to
string<date>

ISO-8601 formatiertes Endlieferdatum (inklusiv)

Example:

"2025-09-10"

updatedAtFrom
string<date-time>

Lieferungen filtern, die ab diesem ISO-8601-Datum aktualisiert wurden (inklusiv)

Example:

"2025-09-01T00:00:00Z"

updatedAtTo
string<date-time>

Lieferungen filtern, die bis zu diesem ISO-8601-Datum aktualisiert wurden (inklusiv)

Example:

"2025-09-10T23:59:59Z"

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