Skip to main content
POST
/
delivery
Create delivery
curl --request POST \
  --url https://api.truecold.io/delivery \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "code": "<string>",
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shipment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receiver_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "route_code": "<string>",
  "route_name": "<string>",
  "transport_mode": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://api.truecold.io/delivery"

payload = {
    "code": "<string>",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "shipment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "receiver_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "route_code": "<string>",
    "route_name": "<string>",
    "transport_mode": "<string>",
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    site_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    shipment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    carrier_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    receiver_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    route_code: '<string>',
    route_name: '<string>',
    transport_mode: '<string>',
    started_at: '2023-11-07T05:31:56Z',
    ended_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.truecold.io/delivery', 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.truecold.io/delivery",
  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([
    'code' => '<string>',
    'site_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'shipment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'carrier_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'receiver_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'route_code' => '<string>',
    'route_name' => '<string>',
    'transport_mode' => '<string>',
    'started_at' => '2023-11-07T05:31:56Z',
    'ended_at' => '2023-11-07T05:31:56Z'
  ]),
  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.truecold.io/delivery"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"site_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"shipment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"carrier_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"receiver_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"route_code\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"transport_mode\": \"<string>\",\n  \"started_at\": \"2023-11-07T05:31:56Z\",\n  \"ended_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.truecold.io/delivery")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"site_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"shipment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"carrier_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"receiver_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"route_code\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"transport_mode\": \"<string>\",\n  \"started_at\": \"2023-11-07T05:31:56Z\",\n  \"ended_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.truecold.io/delivery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"site_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"shipment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"carrier_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"receiver_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"route_code\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"transport_mode\": \"<string>\",\n  \"started_at\": \"2023-11-07T05:31:56Z\",\n  \"ended_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "code": "<string>",
  "shipment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receiver_code": "<string>",
  "receiver_name": "<string>",
  "carrier_code": "<string>",
  "carrier_name": "<string>",
  "route_code": "<string>",
  "route_name": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transport_mode": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "soft_deleted": "2023-11-07T05:31:56Z",
  "soft_deleted_by": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "temperature_range_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "emails_to_notify": [
    "<string>"
  ],
  "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receiver_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "risk_score": 123
}
{
  "message": "An error occurred",
  "code": "ERROR_CODE",
  "details": {}
}
{
  "message": "An error occurred",
  "code": "ERROR_CODE",
  "details": {}
}
{
  "message": "An error occurred",
  "code": "ERROR_CODE",
  "details": {}
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Contact your administrator to get an API key.

Body

application/json

Delivery input data for creation/update

​
code
string
required

Delivery code

​
site_id
string<uuid>
required

Site ID

​
shipment_id
string<uuid> | null

Shipment ID (optional)

​
carrier_id
string<uuid> | null

Carrier ID (optional)

​
receiver_id
string<uuid> | null

Receiver ID (optional)

​
route_code
string

Route code (optional)

​
route_name
string

Route name (optional)

​
transport_mode
string

Transport mode (optional)

​
started_at
string<date-time>

Start timestamp (optional)

​
ended_at
string<date-time>

End timestamp (optional)

Response

Successfully created delivery

Delivery entity (API response)

​
id
string<uuid>

Unique identifier

​
created_at
string<date-time>

Creation timestamp

​
code
string

code code

​
shipment_id
string<uuid>

Shipment ID

​
receiver_code
string

receiver code

​
receiver_name
string

receiver name

​
carrier_code
string

carrier code

​
carrier_name
string

carrier name

​
route_code
string

route code

​
route_name
string

route name

​
account_id
string<uuid>

Account ID

​
site_id
string<uuid>

Site ID

​
transport_mode
string

Transport Mode

​
started_at
string<date-time>

started timestamp

​
ended_at
string<date-time>

ended timestamp

​
soft_deleted
string<date-time>

Soft deletion timestamp

​
soft_deleted_by
string

User who soft deleted the record

​
updated_at
string<date-time>

Last update timestamp

​
temperature_range_id
string<uuid>

Temperature range ID

​
emails_to_notify
string[]

Email address

​
carrier_id
string<uuid>

Carrier ID

​
receiver_id
string<uuid>

Receiver ID

​
risk_score
number | null

Risk score