Update a delivery
curl --request PATCH \
--url https://api.demo.cula.earth/tracking/v1/deliveries/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Cula-Organisation-Id: <cula-organisation-id>' \
--data '
{
"status": "finished",
"occurred_at": "2026-01-15T08:00:00Z",
"legs": [
{
"sender_site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446"
},
"receiver_site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446"
},
"id": "dll_01kjjkhkr6azkf10qx8te8ztv6"
}
],
"external_id": "MY-CUSTOM-ID",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
],
"payload_containers": [
{
"id": "mcn_01kqz4g5cjzvwsnnps6q7183q3",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
]
}
'import requests
url = "https://api.demo.cula.earth/tracking/v1/deliveries/{id}"
payload = {
"status": "finished",
"occurred_at": "2026-01-15T08:00:00Z",
"legs": [
{
"sender_site": { "id": "ste_01k8g7aec6dt5zrtamc72ww446" },
"receiver_site": { "id": "ste_01k8g7aec6dt5zrtamc72ww446" },
"id": "dll_01kjjkhkr6azkf10qx8te8ztv6"
}
],
"external_id": "MY-CUSTOM-ID",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
],
"payload_containers": [
{
"id": "mcn_01kqz4g5cjzvwsnnps6q7183q3",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
]
}
headers = {
"Cula-Organisation-Id": "<cula-organisation-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Cula-Organisation-Id': '<cula-organisation-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
status: 'finished',
occurred_at: '2026-01-15T08:00:00Z',
legs: [
{
sender_site: {id: 'ste_01k8g7aec6dt5zrtamc72ww446'},
receiver_site: {id: 'ste_01k8g7aec6dt5zrtamc72ww446'},
id: 'dll_01kjjkhkr6azkf10qx8te8ztv6'
}
],
external_id: 'MY-CUSTOM-ID',
data_points: [
{
config_id: 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
value: '<string>',
input_value: '<string>'
}
],
payload_containers: [
{
id: 'mcn_01kqz4g5cjzvwsnnps6q7183q3',
data_points: [
{
config_id: 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
value: '<string>',
input_value: '<string>'
}
]
}
]
})
};
fetch('https://api.demo.cula.earth/tracking/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.demo.cula.earth/tracking/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([
'status' => 'finished',
'occurred_at' => '2026-01-15T08:00:00Z',
'legs' => [
[
'sender_site' => [
'id' => 'ste_01k8g7aec6dt5zrtamc72ww446'
],
'receiver_site' => [
'id' => 'ste_01k8g7aec6dt5zrtamc72ww446'
],
'id' => 'dll_01kjjkhkr6azkf10qx8te8ztv6'
]
],
'external_id' => 'MY-CUSTOM-ID',
'data_points' => [
[
'config_id' => 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
'value' => '<string>',
'input_value' => '<string>'
]
],
'payload_containers' => [
[
'id' => 'mcn_01kqz4g5cjzvwsnnps6q7183q3',
'data_points' => [
[
'config_id' => 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
'value' => '<string>',
'input_value' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Cula-Organisation-Id: <cula-organisation-id>"
],
]);
$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.demo.cula.earth/tracking/v1/deliveries/{id}"
payload := strings.NewReader("{\n \"status\": \"finished\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"legs\": [\n {\n \"sender_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"receiver_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"id\": \"dll_01kjjkhkr6azkf10qx8te8ztv6\"\n }\n ],\n \"external_id\": \"MY-CUSTOM-ID\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ],\n \"payload_containers\": [\n {\n \"id\": \"mcn_01kqz4g5cjzvwsnnps6q7183q3\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Cula-Organisation-Id", "<cula-organisation-id>")
req.Header.Add("Authorization", "Bearer <token>")
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.demo.cula.earth/tracking/v1/deliveries/{id}")
.header("Cula-Organisation-Id", "<cula-organisation-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"finished\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"legs\": [\n {\n \"sender_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"receiver_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"id\": \"dll_01kjjkhkr6azkf10qx8te8ztv6\"\n }\n ],\n \"external_id\": \"MY-CUSTOM-ID\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ],\n \"payload_containers\": [\n {\n \"id\": \"mcn_01kqz4g5cjzvwsnnps6q7183q3\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.demo.cula.earth/tracking/v1/deliveries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Cula-Organisation-Id"] = '<cula-organisation-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"finished\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"legs\": [\n {\n \"sender_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"receiver_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"id\": \"dll_01kjjkhkr6azkf10qx8te8ztv6\"\n }\n ],\n \"external_id\": \"MY-CUSTOM-ID\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ],\n \"payload_containers\": [\n {\n \"id\": \"mcn_01kqz4g5cjzvwsnnps6q7183q3\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "dlv_01k204p7hghzdtwjb3n48s5fs5",
"config_id": "dlvc_01kkygy9cxxqhhr93aw74aycbr",
"config_version_id": "dlvcv_01kkw6g3ayad6f092rbkbjcaxq",
"external_id": "MY-CUSTOM-ID",
"display_id": "D-148",
"status": "finished",
"site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446",
"external_id": "SITE-EXT-0001"
},
"legs": [
{
"id": "dll_01kjjkhkr6azkf10qx8te8ztv6",
"sender_site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446",
"external_id": "SITE-EXT-0001"
},
"receiver_site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446",
"external_id": "SITE-EXT-0001"
}
}
],
"occurred_at": "2026-01-15T08:00:00Z",
"created_at": "2026-01-15T08:00:00Z",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"config_version_id": "dptcv_01kfxe6xgmw15gsf204jwj90g5",
"name": "Weight gross",
"error": null,
"type": "short_text",
"value": "<string>",
"input_value": "<string>",
"result_value": "<string>"
}
],
"payload_containers": [
{
"id": "mcn_01kqz4g5cjzvwsnnps6q7183q3",
"config_id": "mcnc_01k102qfrwthwk6dsggr9y8evn",
"config_version_id": "mcncv_01kxs8mt2y4711mz04rqs14t0a",
"status": "available",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"config_version_id": "dptcv_01kfxe6xgmw15gsf204jwj90g5",
"name": "Weight gross",
"error": null,
"type": "short_text",
"value": "<string>",
"input_value": "<string>",
"result_value": "<string>"
}
]
}
],
"payload": [
{
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"config_version_id": "dptcv_01kfxe6xgmw15gsf204jwj90g5",
"name": "Weight gross",
"error": null,
"type": "short_text",
"value": "<string>",
"input_value": "<string>",
"result_value": "<string>"
}
]
}
],
"files": [
{
"id": "fle_01kw9grq4tecva35wdpstzcj5z",
"external_id": "MY-CUSTOM-ID",
"name": "weighing-slip.pdf"
}
]
}{
"code": "bad_request",
"message": "The field limit must not be greater than 50."
}{
"code": "unauthorized",
"message": "Invalid or expired token"
}{
"code": "not_found",
"message": "Object with ID xyz_01k56g7aec6dt5zrtamc72vw446 could not be found."
}{
"code": "conflict",
"message": "There exists already an object with external ID MY-CUSTOM-ID within this organisation."
}{
"code": "too_many_requests",
"message": "Too many requests. Try again after the time given in the Retry-After header."
}{
"code": "internal_server_error",
"message": "Internal server error."
}{
"code": "bad_request",
"message": "The field limit must not be greater than 50."
}{
"code": "service_unavailable",
"message": "Machine data could not be read for data point config(s): dptc_01jxdp05c8r7dp4xf89pxcw28q. This is temporary; retry the request."
}Deliveries
Update a delivery
PATCH
/
deliveries
/
{id}
Update a delivery
curl --request PATCH \
--url https://api.demo.cula.earth/tracking/v1/deliveries/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Cula-Organisation-Id: <cula-organisation-id>' \
--data '
{
"status": "finished",
"occurred_at": "2026-01-15T08:00:00Z",
"legs": [
{
"sender_site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446"
},
"receiver_site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446"
},
"id": "dll_01kjjkhkr6azkf10qx8te8ztv6"
}
],
"external_id": "MY-CUSTOM-ID",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
],
"payload_containers": [
{
"id": "mcn_01kqz4g5cjzvwsnnps6q7183q3",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
]
}
'import requests
url = "https://api.demo.cula.earth/tracking/v1/deliveries/{id}"
payload = {
"status": "finished",
"occurred_at": "2026-01-15T08:00:00Z",
"legs": [
{
"sender_site": { "id": "ste_01k8g7aec6dt5zrtamc72ww446" },
"receiver_site": { "id": "ste_01k8g7aec6dt5zrtamc72ww446" },
"id": "dll_01kjjkhkr6azkf10qx8te8ztv6"
}
],
"external_id": "MY-CUSTOM-ID",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
],
"payload_containers": [
{
"id": "mcn_01kqz4g5cjzvwsnnps6q7183q3",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
]
}
headers = {
"Cula-Organisation-Id": "<cula-organisation-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Cula-Organisation-Id': '<cula-organisation-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
status: 'finished',
occurred_at: '2026-01-15T08:00:00Z',
legs: [
{
sender_site: {id: 'ste_01k8g7aec6dt5zrtamc72ww446'},
receiver_site: {id: 'ste_01k8g7aec6dt5zrtamc72ww446'},
id: 'dll_01kjjkhkr6azkf10qx8te8ztv6'
}
],
external_id: 'MY-CUSTOM-ID',
data_points: [
{
config_id: 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
value: '<string>',
input_value: '<string>'
}
],
payload_containers: [
{
id: 'mcn_01kqz4g5cjzvwsnnps6q7183q3',
data_points: [
{
config_id: 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
value: '<string>',
input_value: '<string>'
}
]
}
]
})
};
fetch('https://api.demo.cula.earth/tracking/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.demo.cula.earth/tracking/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([
'status' => 'finished',
'occurred_at' => '2026-01-15T08:00:00Z',
'legs' => [
[
'sender_site' => [
'id' => 'ste_01k8g7aec6dt5zrtamc72ww446'
],
'receiver_site' => [
'id' => 'ste_01k8g7aec6dt5zrtamc72ww446'
],
'id' => 'dll_01kjjkhkr6azkf10qx8te8ztv6'
]
],
'external_id' => 'MY-CUSTOM-ID',
'data_points' => [
[
'config_id' => 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
'value' => '<string>',
'input_value' => '<string>'
]
],
'payload_containers' => [
[
'id' => 'mcn_01kqz4g5cjzvwsnnps6q7183q3',
'data_points' => [
[
'config_id' => 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
'value' => '<string>',
'input_value' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Cula-Organisation-Id: <cula-organisation-id>"
],
]);
$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.demo.cula.earth/tracking/v1/deliveries/{id}"
payload := strings.NewReader("{\n \"status\": \"finished\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"legs\": [\n {\n \"sender_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"receiver_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"id\": \"dll_01kjjkhkr6azkf10qx8te8ztv6\"\n }\n ],\n \"external_id\": \"MY-CUSTOM-ID\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ],\n \"payload_containers\": [\n {\n \"id\": \"mcn_01kqz4g5cjzvwsnnps6q7183q3\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Cula-Organisation-Id", "<cula-organisation-id>")
req.Header.Add("Authorization", "Bearer <token>")
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.demo.cula.earth/tracking/v1/deliveries/{id}")
.header("Cula-Organisation-Id", "<cula-organisation-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"finished\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"legs\": [\n {\n \"sender_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"receiver_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"id\": \"dll_01kjjkhkr6azkf10qx8te8ztv6\"\n }\n ],\n \"external_id\": \"MY-CUSTOM-ID\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ],\n \"payload_containers\": [\n {\n \"id\": \"mcn_01kqz4g5cjzvwsnnps6q7183q3\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.demo.cula.earth/tracking/v1/deliveries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Cula-Organisation-Id"] = '<cula-organisation-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"finished\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"legs\": [\n {\n \"sender_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"receiver_site\": {\n \"id\": \"ste_01k8g7aec6dt5zrtamc72ww446\"\n },\n \"id\": \"dll_01kjjkhkr6azkf10qx8te8ztv6\"\n }\n ],\n \"external_id\": \"MY-CUSTOM-ID\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ],\n \"payload_containers\": [\n {\n \"id\": \"mcn_01kqz4g5cjzvwsnnps6q7183q3\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "dlv_01k204p7hghzdtwjb3n48s5fs5",
"config_id": "dlvc_01kkygy9cxxqhhr93aw74aycbr",
"config_version_id": "dlvcv_01kkw6g3ayad6f092rbkbjcaxq",
"external_id": "MY-CUSTOM-ID",
"display_id": "D-148",
"status": "finished",
"site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446",
"external_id": "SITE-EXT-0001"
},
"legs": [
{
"id": "dll_01kjjkhkr6azkf10qx8te8ztv6",
"sender_site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446",
"external_id": "SITE-EXT-0001"
},
"receiver_site": {
"id": "ste_01k8g7aec6dt5zrtamc72ww446",
"external_id": "SITE-EXT-0001"
}
}
],
"occurred_at": "2026-01-15T08:00:00Z",
"created_at": "2026-01-15T08:00:00Z",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"config_version_id": "dptcv_01kfxe6xgmw15gsf204jwj90g5",
"name": "Weight gross",
"error": null,
"type": "short_text",
"value": "<string>",
"input_value": "<string>",
"result_value": "<string>"
}
],
"payload_containers": [
{
"id": "mcn_01kqz4g5cjzvwsnnps6q7183q3",
"config_id": "mcnc_01k102qfrwthwk6dsggr9y8evn",
"config_version_id": "mcncv_01kxs8mt2y4711mz04rqs14t0a",
"status": "available",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"config_version_id": "dptcv_01kfxe6xgmw15gsf204jwj90g5",
"name": "Weight gross",
"error": null,
"type": "short_text",
"value": "<string>",
"input_value": "<string>",
"result_value": "<string>"
}
]
}
],
"payload": [
{
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"config_version_id": "dptcv_01kfxe6xgmw15gsf204jwj90g5",
"name": "Weight gross",
"error": null,
"type": "short_text",
"value": "<string>",
"input_value": "<string>",
"result_value": "<string>"
}
]
}
],
"files": [
{
"id": "fle_01kw9grq4tecva35wdpstzcj5z",
"external_id": "MY-CUSTOM-ID",
"name": "weighing-slip.pdf"
}
]
}{
"code": "bad_request",
"message": "The field limit must not be greater than 50."
}{
"code": "unauthorized",
"message": "Invalid or expired token"
}{
"code": "not_found",
"message": "Object with ID xyz_01k56g7aec6dt5zrtamc72vw446 could not be found."
}{
"code": "conflict",
"message": "There exists already an object with external ID MY-CUSTOM-ID within this organisation."
}{
"code": "too_many_requests",
"message": "Too many requests. Try again after the time given in the Retry-After header."
}{
"code": "internal_server_error",
"message": "Internal server error."
}{
"code": "bad_request",
"message": "The field limit must not be greater than 50."
}{
"code": "service_unavailable",
"message": "Machine data could not be read for data point config(s): dptc_01jxdp05c8r7dp4xf89pxcw28q. This is temporary; retry the request."
}Authorizations
OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.
Headers
ID of the organisation the request operates on behalf of (e.g. org_...). Must be an organisation the API client has access to.
Example:
"org_01k83mfmhgchya944v86ryvhpq"
Path Parameters
Example:
"dlv_01k204p7hghzdtwjb3n48s5fs5"
Body
application/json
Target lifecycle status: finished finishes a draft delivery. Finished deliveries cannot be changed back to draft.
Available options:
finished Example:
"finished"
When the delivery took place: an ISO 8601 date-time with an explicit UTC offset (Z or ±hh:mm). Requires the delivery to be a draft. Setting this re-reads every machine-fed data point over the new time window.
Example:
"2026-01-15T08:00:00Z"
The transport legs of the delivery, in full and in travel order — reconciled by leg id: a named leg is updated in place, an entry without id adds a leg, and a leg absent from the array is removed. Requires the delivery to be a draft.
Required array length:
1 elementShow child attributes
Show child attributes
An optional custom ID that can be set to an internal ID from your system. This ID must be unique within all objects of the organisation you operate in. You can later use this external ID to reference and query this object. Be aware that you can update this ID later. If you need an immutable ID, use the object ID returned when creating the object. Pass null to remove it.
Required string length:
1 - 100Pattern:
^[A-Za-z0-9\-_]+$Example:
"MY-CUSTOM-ID"
Data points to be patched, based on the delivery config's data_point_configs list. Updating data points might also affect existing payload containers. Only the listed data points change, providing null as value clears the data point. Requires the delivery to be draft.
Maximum array length:
100Show child attributes
Show child attributes
Full list of payload containers to be used for the delivery, based on the delivery config's payload_configs list. Keep or update existing containers by passing their id. Create new ones the same way as when creating the delivery. Previous payload containers absent from the list will be deleted. Requires the delivery to be a draft.
Maximum array length:
100References an existing payload container by its ID, optionally updating the listed data points.
- Existing Container
- New Container
Show child attributes
Show child attributes
Response
The updated delivery.
The ID of the delivery.
Example:
"dlv_01k204p7hghzdtwjb3n48s5fs5"
The ID of the delivery config the delivery was created from.
Example:
"dlvc_01kkygy9cxxqhhr93aw74aycbr"
The ID of the exact delivery config version the delivery was created from.
Example:
"dlvcv_01kkw6g3ayad6f092rbkbjcaxq"
Optional external ID of the delivery.
Example:
"MY-CUSTOM-ID"
Human-readable, server-generated identifier scoped to the issuing site.
Example:
"D-148"
Lifecycle status. draft deliveries are still being prepared and may be missing data point values, payload or leg sites; finished deliveries are complete.
Available options:
draft, finished Example:
"finished"
The site that issued the delivery (owns its config).
Show child attributes
Show child attributes
The transport legs of the delivery, in order.
Show child attributes
Show child attributes
When the delivery took place.
Example:
"2026-01-15T08:00:00Z"
When the delivery was recorded in Cula.
Example:
"2026-01-15T08:00:00Z"
data_points
(short_text · object | long_text · object | multi_text · object | number · object | percentage · object | amount · object | timestamp · object | duration · object | boolean · object | material · object | material_batch · object | container_type · object | material_pool · object)[]
required
Data points set on the delivery itself.
Data point holding a single line of text.
- short_text
- long_text
- multi_text
- number
- percentage
- amount
- timestamp
- duration
- boolean
- material
- material_batch
- container_type
- material_pool
Show child attributes
Show child attributes
The material containers carried by the delivery.
Show child attributes
Show child attributes
Deprecated: use payload_containers instead.
Show child attributes
Show child attributes
Files attached to the delivery. Lists only the files your organisation can access: a counterparty of the delivery does not see the files you attached, and vice versa.
Show child attributes
Show child attributes
Was this page helpful?