GET
/
delivery
/
:id
Get delivery by ID
curl --request GET \
  --url https://api.truecold.io/delivery/:id \
  --header 'x-api-key: <api-key>'
{
  "code": "<string>",
  "shipment": {
    "value": "550e8400-e29b-41d4-a716-446655440000",
    "label": "SHIP-001"
  },
  "carrier": {
    "value": "550e8400-e29b-41d4-a716-446655440001",
    "label": "DHL Express"
  },
  "receiver": {
    "value": "550e8400-e29b-41d4-a716-446655440002",
    "label": "Customer Inc."
  },
  "route_code": "<string>",
  "route_name": "<string>",
  "transport_mode": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "site_id": "<string>"
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
id
string
required

Delivery ID

Response

Successfully retrieved delivery

​
code
string

Delivery identifier

​
shipment
object

Shipment details

Example:
{
  "value": "550e8400-e29b-41d4-a716-446655440000",
  "label": "SHIP-001"
}
​
carrier
object

Carrier details

Example:
{
  "value": "550e8400-e29b-41d4-a716-446655440001",
  "label": "DHL Express"
}
​
receiver
object

Receiver details

Example:
{
  "value": "550e8400-e29b-41d4-a716-446655440002",
  "label": "Customer Inc."
}
​
route_code
string

Route code for the delivery

​
route_name
string

Route name for the delivery

​
transport_mode
string

Transport mode for the delivery

​
started_at
string<date-time>

Delivery start timestamp

​
ended_at
string<date-time>

Delivery end timestamp

​
site_id
string

Related site ID