GET
/
deliveries
List deliveries
curl --request GET \
  --url https://api.truecold.io/v1/deliveries \
  --header 'x-api-key: <api-key>'
{
  "error": false,
  "data": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "code": "<string>",
      "shipment_id": "<string>",
      "receiver_code": "<string>",
      "receiver_name": "<string>",
      "destination": "<string>",
      "carrier_code": "<string>",
      "carrier_name": "<string>",
      "route_code": "<string>",
      "route_name": "<string>",
      "account_id": "<string>",
      "transport_mode": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
id
string

UUID of the delivery

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
code
string

String that represents the internal delivery code

Example:

"25-BCN-XA43N"

​
sort
enum<string>

Sort the deliveries by created_at date

Available options:
asc,
desc

Response

200
application/json

The response is of type object.