Lieferung aktualisieren

curl --request PATCH \
  --url https://api.comstruct.com/v1/deliveries/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "comment": "<string>",
  "planned_arrival_time": "2023-11-07T05:31:56Z",
  "order_number": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_number": "<string>",
  "invoice_number": "<string>",
  "delivery_number": "<string>",
  "work_type_id": "<string>",
  "charging_number": "<string>",
  "received_at": "2023-11-07T05:31:56Z",
  "invoice_matched": true,
  "marked": true,
  "charged": true,
  "items": [
    {
      "title": "<string>",
      "quantity": 123,
      "unit": "<string>",
      "product_number": "<string>",
      "type": "<string>",
      "work_type_id": "<string>",
      "marked": true,
      "invoice_matched": true,
      "charged": true,
      "purchase_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "properties": {},
  "plant": {
    "title": "<string>"
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "delivery_number": "<string>",
  "comment": "<string>",
  "planned_arrival_time": "2023-11-07T05:31:56Z",
  "marked": true,
  "invoice_matched": true,
  "charged": true,
  "received_at": "2023-11-07T05:31:56Z",
  "items": [
    {
      "title": "<string>",
      "quantity": 123,
      "unit": "<string>",
      "product_number": "<string>",
      "work_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "marked": true,
      "invoice_matched": true,
      "charged": true
    }
  ]
}

PATCH

deliveries

{id}

Lieferung aktualisieren

curl --request PATCH \
  --url https://api.comstruct.com/v1/deliveries/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "comment": "<string>",
  "planned_arrival_time": "2023-11-07T05:31:56Z",
  "order_number": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_number": "<string>",
  "invoice_number": "<string>",
  "delivery_number": "<string>",
  "work_type_id": "<string>",
  "charging_number": "<string>",
  "received_at": "2023-11-07T05:31:56Z",
  "invoice_matched": true,
  "marked": true,
  "charged": true,
  "items": [
    {
      "title": "<string>",
      "quantity": 123,
      "unit": "<string>",
      "product_number": "<string>",
      "type": "<string>",
      "work_type_id": "<string>",
      "marked": true,
      "invoice_matched": true,
      "charged": true,
      "purchase_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "properties": {},
  "plant": {
    "title": "<string>"
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "delivery_number": "<string>",
  "comment": "<string>",
  "planned_arrival_time": "2023-11-07T05:31:56Z",
  "marked": true,
  "invoice_matched": true,
  "charged": true,
  "received_at": "2023-11-07T05:31:56Z",
  "items": [
    {
      "title": "<string>",
      "quantity": 123,
      "unit": "<string>",
      "product_number": "<string>",
      "work_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "marked": true,
      "invoice_matched": true,
      "charged": true
    }
  ]
}

Übersicht

Mit diesem Endpunkt können Kunden bestehende Lieferungen aktualisieren. Änderungen werden in der Lieferhistorie protokolliert. Nur Lieferungen, die dem Kunden des API-Schlüssels gehören, können bearbeitet werden.

Markierte (gesperrte) Lieferungen können nicht bearbeitet werden. Um eine markierte Lieferung zu aktualisieren, muss sie zuerst über die Web-App entmarkiert werden.

Berechtigungen

Scope	Tenant-Typ
`deliveries:patch`	Nur Kunden (`CUSTOMER_ONLY`)

Der API-Schlüssel muss mit einem Kunden verknüpft sein. Lieferanten-API-Schlüssel können diesen Endpunkt nicht verwenden.

Header	Pflicht	Beschreibung
`x-api-key`	Ja	API-Schlüssel mit Scope `deliveries:patch`
`x-change-reason`	Nein	Grund für die Änderung (wird in der Lieferhistorie gespeichert)

Editierbare Felder

Lieferung

Feld	Typ	Beschreibung
`comment`	`string`	Freitext-Kommentar
`planned_arrival_time`	`string` (ISO 8601)	Geplante Ankunftszeit
`order_number`	`string`	Bestellnummer
`project_id`	`uuid`	Projektzuordnung
`project_number`	`string`	Projektnummer
`invoice_number`	`string`	Rechnungsnummer
`delivery_number`	`string`	Lieferscheinnummer
`work_type_id`	`string`	Leistungsart-ID
`charging_number`	`string`	Verrechnungsnummer
`received_at`	`string` (ISO 8601)	Empfangszeitpunkt
`invoice_matched`	`boolean`	Rechnungszuordnung bestätigt
`marked`	`boolean`	Lieferung als verifiziert markieren
`charged`	`boolean`	Lieferung als berechnet markieren
`properties`	`object`	Zusätzliche Eigenschaften (wird mit bestehenden zusammengeführt)
`plant`	`object`	Werk (`{ "title": "..." }`)

Positionen (Items)

Feld	Typ	Beschreibung
`title`	`string`	Positionsbezeichnung
`quantity`	`number`	Menge
`unit`	`string`	Mengeneinheit
`product_number`	`string`	Produktnummer
`type`	`string`	Positionstyp
`work_type_id`	`string`	Leistungsart-ID
`marked`	`boolean`	Position als verifiziert markieren
`invoice_matched`	`boolean`	Rechnungszuordnung bestätigt
`charged`	`boolean`	Position als berechnet markieren
`purchase_order_item_id`	`uuid`	Zuordnung zu einer Bestellposition

Verhalten

Nur geänderte Felder werden aktualisiert. Felder, die nicht im Body enthalten sind, bleiben unverändert.
Wenn keine Änderungen erkannt werden, wird die bestehende Lieferung unverändert zurückgegeben.
Bei Änderung von Boolean-Feldern (marked, invoice_matched, charged) auf Lieferungsebene werden alle Positionen synchronisiert.
Beim Setzen von marked: true wird received_at automatisch auf den aktuellen Zeitpunkt gesetzt.
Änderungen an properties werden mit den bestehenden Eigenschaften zusammengeführt.

Response Codes

Code	Beschreibung
`200`	Lieferung erfolgreich aktualisiert (oder unverändert zurückgegeben)
`400`	Ungültige Eingabe oder Lieferung ist markiert/gesperrt
`403`	Keine Berechtigung — Lieferung gehört einem anderen Kunden
`404`	Lieferung nicht gefunden
`422`	Aktualisierung fehlgeschlagen

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.

Header

x-change-reason

string

Grund für die Änderung (wird in der Lieferhistorie gespeichert)

Pfadparameter

string<uuid>

erforderlich

Lieferungs-ID (UUID)

Body

application/json

Alle Felder sind optional. Nur angegebene Felder werden aktualisiert.

comment

string

Freitext-Kommentar

planned_arrival_time

string<date-time>

Geplante Ankunftszeit (ISO 8601)

order_number

string

Bestellnummer

project_id

string<uuid>

Projektzuordnung

project_number

string

Projektnummer

invoice_number

string

Rechnungsnummer

delivery_number

string

Lieferscheinnummer

work_type_id

string

Leistungsart-ID

charging_number

string

Verrechnungsnummer

received_at

string<date-time>

Empfangszeitpunkt (ISO 8601)

invoice_matched

boolean

Rechnungszuordnung bestätigt

marked

boolean

Lieferung als verifiziert markieren

charged

boolean

Lieferung als berechnet markieren

items

object[]

Positionen der Lieferung

Show child attributes

properties

object

Zusätzliche Eigenschaften (wird mit bestehenden zusammengeführt)

plant

object

Show child attributes

Antwort

Lieferung erfolgreich aktualisiert (oder unverändert zurückgegeben)

string<uuid>

Lieferungs-ID

delivery_number

string

Lieferscheinnummer

comment

string

Kommentar

planned_arrival_time

string<date-time>

Geplante Ankunftszeit

marked

boolean

Ob die Lieferung markiert/verifiziert wurde

invoice_matched

boolean

Rechnungszuordnung bestätigt

charged

boolean

Lieferung als berechnet markiert

received_at

string<date-time>

Empfangszeitpunkt

items

object[]

Show child attributes

Lieferung erstellen Lieferung nach ID abrufen

​Übersicht

​Berechtigungen

​Header

​Editierbare Felder

​Lieferung

​Positionen (Items)

​Verhalten

​Response Codes

Autorisierungen

Header

Pfadparameter

Body

Antwort

Übersicht

Berechtigungen

Header

Editierbare Felder

Lieferung

Positionen (Items)

Verhalten

Response Codes