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>"
}
}
'import requests
url = "https://api.comstruct.com/v1/deliveries/{id}"
payload = {
"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>" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'}
})
};
fetch('https://api.comstruct.com/v1/deliveries/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.comstruct.com/v1/deliveries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.comstruct.com/v1/deliveries/{id}"
payload := strings.NewReader("{\n \"comment\": \"<string>\",\n \"planned_arrival_time\": \"2023-11-07T05:31:56Z\",\n \"order_number\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"project_number\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"delivery_number\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"charging_number\": \"<string>\",\n \"received_at\": \"2023-11-07T05:31:56Z\",\n \"invoice_matched\": true,\n \"marked\": true,\n \"charged\": true,\n \"items\": [\n {\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"unit\": \"<string>\",\n \"product_number\": \"<string>\",\n \"type\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"marked\": true,\n \"invoice_matched\": true,\n \"charged\": true,\n \"purchase_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"properties\": {},\n \"plant\": {\n \"title\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.comstruct.com/v1/deliveries/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"comment\": \"<string>\",\n \"planned_arrival_time\": \"2023-11-07T05:31:56Z\",\n \"order_number\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"project_number\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"delivery_number\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"charging_number\": \"<string>\",\n \"received_at\": \"2023-11-07T05:31:56Z\",\n \"invoice_matched\": true,\n \"marked\": true,\n \"charged\": true,\n \"items\": [\n {\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"unit\": \"<string>\",\n \"product_number\": \"<string>\",\n \"type\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"marked\": true,\n \"invoice_matched\": true,\n \"charged\": true,\n \"purchase_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"properties\": {},\n \"plant\": {\n \"title\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.comstruct.com/v1/deliveries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"comment\": \"<string>\",\n \"planned_arrival_time\": \"2023-11-07T05:31:56Z\",\n \"order_number\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"project_number\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"delivery_number\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"charging_number\": \"<string>\",\n \"received_at\": \"2023-11-07T05:31:56Z\",\n \"invoice_matched\": true,\n \"marked\": true,\n \"charged\": true,\n \"items\": [\n {\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"unit\": \"<string>\",\n \"product_number\": \"<string>\",\n \"type\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"marked\": true,\n \"invoice_matched\": true,\n \"charged\": true,\n \"purchase_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"properties\": {},\n \"plant\": {\n \"title\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}
Deliveries
Update delivery
Erforderliche Berechtigungen: deliveries:patch
Aktualisiert eine bestehende Lieferung und ihre Positionen. Ä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.
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>"
}
}
'import requests
url = "https://api.comstruct.com/v1/deliveries/{id}"
payload = {
"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>" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'}
})
};
fetch('https://api.comstruct.com/v1/deliveries/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.comstruct.com/v1/deliveries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.comstruct.com/v1/deliveries/{id}"
payload := strings.NewReader("{\n \"comment\": \"<string>\",\n \"planned_arrival_time\": \"2023-11-07T05:31:56Z\",\n \"order_number\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"project_number\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"delivery_number\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"charging_number\": \"<string>\",\n \"received_at\": \"2023-11-07T05:31:56Z\",\n \"invoice_matched\": true,\n \"marked\": true,\n \"charged\": true,\n \"items\": [\n {\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"unit\": \"<string>\",\n \"product_number\": \"<string>\",\n \"type\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"marked\": true,\n \"invoice_matched\": true,\n \"charged\": true,\n \"purchase_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"properties\": {},\n \"plant\": {\n \"title\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.comstruct.com/v1/deliveries/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"comment\": \"<string>\",\n \"planned_arrival_time\": \"2023-11-07T05:31:56Z\",\n \"order_number\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"project_number\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"delivery_number\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"charging_number\": \"<string>\",\n \"received_at\": \"2023-11-07T05:31:56Z\",\n \"invoice_matched\": true,\n \"marked\": true,\n \"charged\": true,\n \"items\": [\n {\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"unit\": \"<string>\",\n \"product_number\": \"<string>\",\n \"type\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"marked\": true,\n \"invoice_matched\": true,\n \"charged\": true,\n \"purchase_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"properties\": {},\n \"plant\": {\n \"title\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.comstruct.com/v1/deliveries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"comment\": \"<string>\",\n \"planned_arrival_time\": \"2023-11-07T05:31:56Z\",\n \"order_number\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"project_number\": \"<string>\",\n \"invoice_number\": \"<string>\",\n \"delivery_number\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"charging_number\": \"<string>\",\n \"received_at\": \"2023-11-07T05:31:56Z\",\n \"invoice_matched\": true,\n \"marked\": true,\n \"charged\": true,\n \"items\": [\n {\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"unit\": \"<string>\",\n \"product_number\": \"<string>\",\n \"type\": \"<string>\",\n \"work_type_id\": \"<string>\",\n \"marked\": true,\n \"invoice_matched\": true,\n \"charged\": true,\n \"purchase_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"properties\": {},\n \"plant\": {\n \"title\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}
Overview
This endpoint allows customers to update existing deliveries. Changes are recorded in the delivery history. Only deliveries belonging to the API key’s customer can be patched.Marked (locked) deliveries cannot be edited. To update a marked delivery, unmark it first via the web app.
Permissions
| Scope | Tenant type |
|---|---|
deliveries:patch | Customer only (CUSTOMER_ONLY) |
Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | API key with scope deliveries:patch |
x-change-reason | No | Reason for the change (stored in delivery history) |
Editable fields
Delivery
| Field | Type | Description |
|---|---|---|
comment | string | Free-text comment |
planned_arrival_time | string (ISO 8601) | Planned arrival time |
order_number | string | Order number |
project_id | uuid | Project assignment |
project_number | string | Project number |
invoice_number | string | Invoice number |
delivery_number | string | Delivery note number |
work_type_id | string | Work type ID |
charging_number | string | Charging number |
received_at | string (ISO 8601) | Received timestamp |
invoice_matched | boolean | Invoice matching confirmed |
marked | boolean | Mark delivery as verified |
charged | boolean | Mark delivery as charged |
properties | object | Additional properties (merged with existing) |
plant | object | Plant ({ "title": "..." }) |
Items
| Field | Type | Description |
|---|---|---|
title | string | Item description |
quantity | number | Quantity |
unit | string | Unit of measure |
product_number | string | Product number |
type | string | Item type |
work_type_id | string | Work type ID |
marked | boolean | Mark item as verified |
invoice_matched | boolean | Invoice matching confirmed |
charged | boolean | Mark item as charged |
purchase_order_item_id | uuid | Link to a purchase order item |
Behavior
- Only changed fields are updated. Fields not included in the body remain unchanged.
- If no changes are detected, the existing delivery is returned unchanged.
- When boolean fields (
marked,invoice_matched,charged) are changed at the delivery level, all items are synchronized. - Setting
marked: trueautomatically setsreceived_atto the current timestamp. - Changes to
propertiesare merged with existing properties.
Response codes
| Code | Description |
|---|---|
200 | Delivery successfully updated (or returned unchanged) |
400 | Invalid input or delivery is marked/locked |
403 | Forbidden — delivery belongs to another customer |
404 | Delivery not found |
422 | Update failed |
Authorizations
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.
Headers
Grund für die Änderung (wird in der Lieferhistorie gespeichert)
Path Parameters
Lieferungs-ID (UUID)
Body
application/json
Alle Felder sind optional. Nur angegebene Felder werden aktualisiert.
Freitext-Kommentar
Geplante Ankunftszeit (ISO 8601)
Bestellnummer
Projektzuordnung
Projektnummer
Rechnungsnummer
Lieferscheinnummer
Leistungsart-ID
Verrechnungsnummer
Empfangszeitpunkt (ISO 8601)
Rechnungszuordnung bestätigt
Lieferung als verifiziert markieren
Lieferung als berechnet markieren
Positionen der Lieferung
Show child attributes
Show child attributes
Zusätzliche Eigenschaften (wird mit bestehenden zusammengeführt)
Show child attributes
Show child attributes
Response
Lieferung erfolgreich aktualisiert (oder unverändert zurückgegeben)
Lieferungs-ID
Lieferscheinnummer
Kommentar
Geplante Ankunftszeit
Ob die Lieferung markiert/verifiziert wurde
Rechnungszuordnung bestätigt
Lieferung als berechnet markiert
Empfangszeitpunkt
Show child attributes
Show child attributes
⌘I