Create a material sourcing
curl --request POST \
--url https://api.demo.cula.earth/tracking/v1/material-sourcings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Cula-Organisation-Id: <cula-organisation-id>' \
--data '
{
"config_id": "mscc_01kpteg39rde1m80740h6p2wb2",
"occurred_at": "2026-01-15T08:00:00Z",
"external_id": "MY-CUSTOM-ID",
"output_containers": [
{
"config_id": "mcnc_01k102qfrwthwk6dsggr9y8evn",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
],
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
'import requests
url = "https://api.demo.cula.earth/tracking/v1/material-sourcings"
payload = {
"config_id": "mscc_01kpteg39rde1m80740h6p2wb2",
"occurred_at": "2026-01-15T08:00:00Z",
"external_id": "MY-CUSTOM-ID",
"output_containers": [
{
"config_id": "mcnc_01k102qfrwthwk6dsggr9y8evn",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
],
"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.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Cula-Organisation-Id': '<cula-organisation-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
config_id: 'mscc_01kpteg39rde1m80740h6p2wb2',
occurred_at: '2026-01-15T08:00:00Z',
external_id: 'MY-CUSTOM-ID',
output_containers: [
{
config_id: 'mcnc_01k102qfrwthwk6dsggr9y8evn',
data_points: [
{
config_id: 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
value: '<string>',
input_value: '<string>'
}
]
}
],
data_points: [
{
config_id: 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
value: '<string>',
input_value: '<string>'
}
]
})
};
fetch('https://api.demo.cula.earth/tracking/v1/material-sourcings', 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/material-sourcings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'config_id' => 'mscc_01kpteg39rde1m80740h6p2wb2',
'occurred_at' => '2026-01-15T08:00:00Z',
'external_id' => 'MY-CUSTOM-ID',
'output_containers' => [
[
'config_id' => 'mcnc_01k102qfrwthwk6dsggr9y8evn',
'data_points' => [
[
'config_id' => 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
'value' => '<string>',
'input_value' => '<string>'
]
]
]
],
'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/material-sourcings"
payload := strings.NewReader("{\n \"config_id\": \"mscc_01kpteg39rde1m80740h6p2wb2\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"external_id\": \"MY-CUSTOM-ID\",\n \"output_containers\": [\n {\n \"config_id\": \"mcnc_01k102qfrwthwk6dsggr9y8evn\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ],\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.demo.cula.earth/tracking/v1/material-sourcings")
.header("Cula-Organisation-Id", "<cula-organisation-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config_id\": \"mscc_01kpteg39rde1m80740h6p2wb2\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"external_id\": \"MY-CUSTOM-ID\",\n \"output_containers\": [\n {\n \"config_id\": \"mcnc_01k102qfrwthwk6dsggr9y8evn\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ],\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.demo.cula.earth/tracking/v1/material-sourcings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cula-Organisation-Id"] = '<cula-organisation-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config_id\": \"mscc_01kpteg39rde1m80740h6p2wb2\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"external_id\": \"MY-CUSTOM-ID\",\n \"output_containers\": [\n {\n \"config_id\": \"mcnc_01k102qfrwthwk6dsggr9y8evn\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ],\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "msc_01k2rkq2yav2zev1b6f2ngzkqv",
"config_id": "mscc_01kpteg39rde1m80740h6p2wb2",
"config_version_id": "msccv_01kym9dwvb8naj2qn8nv5vh331",
"external_id": "MY-CUSTOM-ID",
"display_id": "SRC-2026-01-15-1",
"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>"
}
],
"output_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>"
}
]
}
],
"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": "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": "service_unavailable",
"message": "Machine data could not be read for data point config(s): dptc_01jxdp05c8r7dp4xf89pxcw28q. This is temporary; retry the request."
}Material Sourcings
Create a material sourcing
POST
/
material-sourcings
Create a material sourcing
curl --request POST \
--url https://api.demo.cula.earth/tracking/v1/material-sourcings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Cula-Organisation-Id: <cula-organisation-id>' \
--data '
{
"config_id": "mscc_01kpteg39rde1m80740h6p2wb2",
"occurred_at": "2026-01-15T08:00:00Z",
"external_id": "MY-CUSTOM-ID",
"output_containers": [
{
"config_id": "mcnc_01k102qfrwthwk6dsggr9y8evn",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
],
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
'import requests
url = "https://api.demo.cula.earth/tracking/v1/material-sourcings"
payload = {
"config_id": "mscc_01kpteg39rde1m80740h6p2wb2",
"occurred_at": "2026-01-15T08:00:00Z",
"external_id": "MY-CUSTOM-ID",
"output_containers": [
{
"config_id": "mcnc_01k102qfrwthwk6dsggr9y8evn",
"data_points": [
{
"config_id": "dptc_01jxdp05c8r7dp4xf89pxcw28q",
"value": "<string>",
"input_value": "<string>"
}
]
}
],
"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.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Cula-Organisation-Id': '<cula-organisation-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
config_id: 'mscc_01kpteg39rde1m80740h6p2wb2',
occurred_at: '2026-01-15T08:00:00Z',
external_id: 'MY-CUSTOM-ID',
output_containers: [
{
config_id: 'mcnc_01k102qfrwthwk6dsggr9y8evn',
data_points: [
{
config_id: 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
value: '<string>',
input_value: '<string>'
}
]
}
],
data_points: [
{
config_id: 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
value: '<string>',
input_value: '<string>'
}
]
})
};
fetch('https://api.demo.cula.earth/tracking/v1/material-sourcings', 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/material-sourcings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'config_id' => 'mscc_01kpteg39rde1m80740h6p2wb2',
'occurred_at' => '2026-01-15T08:00:00Z',
'external_id' => 'MY-CUSTOM-ID',
'output_containers' => [
[
'config_id' => 'mcnc_01k102qfrwthwk6dsggr9y8evn',
'data_points' => [
[
'config_id' => 'dptc_01jxdp05c8r7dp4xf89pxcw28q',
'value' => '<string>',
'input_value' => '<string>'
]
]
]
],
'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/material-sourcings"
payload := strings.NewReader("{\n \"config_id\": \"mscc_01kpteg39rde1m80740h6p2wb2\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"external_id\": \"MY-CUSTOM-ID\",\n \"output_containers\": [\n {\n \"config_id\": \"mcnc_01k102qfrwthwk6dsggr9y8evn\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ],\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.demo.cula.earth/tracking/v1/material-sourcings")
.header("Cula-Organisation-Id", "<cula-organisation-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config_id\": \"mscc_01kpteg39rde1m80740h6p2wb2\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"external_id\": \"MY-CUSTOM-ID\",\n \"output_containers\": [\n {\n \"config_id\": \"mcnc_01k102qfrwthwk6dsggr9y8evn\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ],\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.demo.cula.earth/tracking/v1/material-sourcings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cula-Organisation-Id"] = '<cula-organisation-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config_id\": \"mscc_01kpteg39rde1m80740h6p2wb2\",\n \"occurred_at\": \"2026-01-15T08:00:00Z\",\n \"external_id\": \"MY-CUSTOM-ID\",\n \"output_containers\": [\n {\n \"config_id\": \"mcnc_01k102qfrwthwk6dsggr9y8evn\",\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n }\n ],\n \"data_points\": [\n {\n \"config_id\": \"dptc_01jxdp05c8r7dp4xf89pxcw28q\",\n \"value\": \"<string>\",\n \"input_value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "msc_01k2rkq2yav2zev1b6f2ngzkqv",
"config_id": "mscc_01kpteg39rde1m80740h6p2wb2",
"config_version_id": "msccv_01kym9dwvb8naj2qn8nv5vh331",
"external_id": "MY-CUSTOM-ID",
"display_id": "SRC-2026-01-15-1",
"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>"
}
],
"output_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>"
}
]
}
],
"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": "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": "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"
Body
application/json
The ID of the material sourcing config that defines the sourcing to create.
Example:
"mscc_01kpteg39rde1m80740h6p2wb2"
When the sourcing took place: an ISO 8601 date-time with an explicit UTC offset (Z or ±hh:mm). Defaults to now if omitted.
Example:
"2026-01-15T08:00:00Z"
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.
Required string length:
1 - 100Pattern:
^[A-Za-z0-9\-_]+$Example:
"MY-CUSTOM-ID"
If the config version's output_configs field contains items, you can pass containers that reference a listed config and should be used as outputs here. Several items may name the same config.
Maximum array length:
100Describes a new container to create, based on one of the container configs listed by the config of the object you create.
- New Container
- Existing Container
Show child attributes
Show child attributes
Data points to be set on the material sourcing, based on the data_point_configs list of the material sourcing config. Included values might affect output containers.
Maximum array length:
100Show child attributes
Show child attributes
Response
Material sourcing created.
The ID of the material sourcing.
Example:
"msc_01k2rkq2yav2zev1b6f2ngzkqv"
The ID of the config the sourcing was created from.
Example:
"mscc_01kpteg39rde1m80740h6p2wb2"
The ID of the exact config version the sourcing was created from.
Example:
"msccv_01kym9dwvb8naj2qn8nv5vh331"
Optional external ID of the sourcing.
Example:
"MY-CUSTOM-ID"
Human-readable identifier.
Example:
"SRC-2026-01-15-1"
The site the sourcing was executed at.
Show child attributes
Show child attributes
When the sourcing took place.
Example:
"2026-01-15T08:00:00Z"
When the sourcing 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 sourcing step 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 the sourcing produced.
Show child attributes
Show child attributes
Files attached to the material sourcing.
Show child attributes
Show child attributes
Was this page helpful?