Zum Hauptinhalt springen
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 } ] }

Documentation Index

Fetch the complete documentation index at: https://developer.comstruct.com/llms.txt

Use this file to discover all available pages before exploring further.

Ü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

ScopeTenant-Typ
deliveries:patchNur Kunden (CUSTOMER_ONLY)
Der API-Schlüssel muss mit einem Kunden verknüpft sein. Lieferanten-API-Schlüssel können diesen Endpunkt nicht verwenden.
HeaderPflichtBeschreibung
x-api-keyJaAPI-Schlüssel mit Scope deliveries:patch
x-change-reasonNeinGrund für die Änderung (wird in der Lieferhistorie gespeichert)

Editierbare Felder

Lieferung

FeldTypBeschreibung
commentstringFreitext-Kommentar
planned_arrival_timestring (ISO 8601)Geplante Ankunftszeit
order_numberstringBestellnummer
project_iduuidProjektzuordnung
project_numberstringProjektnummer
invoice_numberstringRechnungsnummer
delivery_numberstringLieferscheinnummer
work_type_idstringLeistungsart-ID
charging_numberstringVerrechnungsnummer
received_atstring (ISO 8601)Empfangszeitpunkt
invoice_matchedbooleanRechnungszuordnung bestätigt
markedbooleanLieferung als verifiziert markieren
chargedbooleanLieferung als berechnet markieren
propertiesobjectZusätzliche Eigenschaften (wird mit bestehenden zusammengeführt)
plantobjectWerk ({ "title": "..." })

Positionen (Items)

FeldTypBeschreibung
titlestringPositionsbezeichnung
quantitynumberMenge
unitstringMengeneinheit
product_numberstringProduktnummer
typestringPositionstyp
work_type_idstringLeistungsart-ID
markedbooleanPosition als verifiziert markieren
invoice_matchedbooleanRechnungszuordnung bestätigt
chargedbooleanPosition als berechnet markieren
purchase_order_item_iduuidZuordnung 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

CodeBeschreibung
200Lieferung erfolgreich aktualisiert (oder unverändert zurückgegeben)
400Ungültige Eingabe oder Lieferung ist markiert/gesperrt
403Keine Berechtigung — Lieferung gehört einem anderen Kunden
404Lieferung nicht gefunden
422Aktualisierung 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

id
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

properties
object

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

plant
object

Antwort

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

id
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[]