Create a delivery
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.
"org_01k83mfmhgchya944v86ryvhpq"
Body
The ID of the delivery config that defines the delivery to create.
"dlvc_01kkygy9cxxqhhr93aw74aycbr"
Whether to create the delivery as an editable draft or as a finished delivery. Drafts may still be incomplete: mandatory data point values, the payload, and legs or their sites can be omitted and added later.
draft, finished When the delivery took place: an ISO 8601 date-time with an explicit UTC offset (Z or ±hh:mm). Defaults to now if omitted.
"2026-01-15T08:00:00Z"
A 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.
1 - 100^[A-Za-z0-9\-_]+$"MY-CUSTOM-ID"
The transport legs of the delivery, in order. For incoming configs, the last leg must be received by the config's site; for outgoing configs, the first leg must be sent by the config's site. Required for finished deliveries.
1 elementThe payload containers of the delivery. Only applicable to non-unified configs (unified: false): describe each container against one of the config's payload_configs via config_id.
100Describes a new container to create, based on one of the container configs the flow's config lists.
- New Container
- Existing Container
Use data_points or payload_containers instead.
Values for the delivery's data points. When the config is unified (unified: true), the flat array spans the whole flow (delivery and payload container); when unified is false, only the delivery's own data points — payload values belong to the payload_containers items.
100Response
Delivery created.
The ID of the delivery.
"dlv_01k204p7hghzdtwjb3n48s5fs5"
The ID of the delivery config the delivery was created from.
"dlvc_01kkygy9cxxqhhr93aw74aycbr"
The ID of the exact delivery config version the delivery was created from.
"dlvcv_01kkw6g3ayad6f092rbkbjcaxq"
Optional external ID of the delivery.
"MY-CUSTOM-ID"
Human-readable, server-generated identifier scoped to the issuing site.
"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.
draft, finished "finished"
The site that issued the delivery (owns its config).
The transport legs of the delivery, in order.
When the delivery took place.
"2026-01-15T08:00:00Z"
When the delivery was recorded in Cula.
"2026-01-15T08:00:00Z"
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
The material containers carried by the delivery.
Use payload_containers instead.