POST
/
deliveries
curl --request POST \
  --url https://api.truecold.io/v1/deliveries \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "id": "2381029e-7566-4ba4-b842-1c03dd13010a",
  "shipment_id": "103888",
  "code": "103888",
  "receiver_code": "103888",
  "receiver_name": "PharmaX Barcelona",
  "destinaton": "Barcelona",
  "carrier_code": "291",
  "carrier_name": "PharmaX",
  "route_code": "25-BCN-XA43N",
  "route_name": "Barcelona - Madrid",
  "transport_mode": "ROAD"
}'
{
  "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

Body

application/json
​
code
string
required

String that represents the internal delivery code

Example:

"103888"

​
id
string

String that represents the internal delivery id

Example:

"2381029e-7566-4ba4-b842-1c03dd13010a"

​
shipment_id
string

String that represents the attached shipment id. It must be a valid UUID of a shipment, if no shipment_id is provided, the delivery can be created without a shipment.

Example:

"103888"

​
receiver_code
string

String that represents receiver code

Example:

"103888"

​
receiver_name
string

String that represents receiver name

Example:

"PharmaX Barcelona"

​
destinaton
string

String that represents the destination of the delivery

Example:

"Barcelona"

​
carrier_code
string

String that represents the carrier code

Example:

"291"

​
carrier_name
string

String that represents the carrier name

Example:

"PharmaX"

​
route_code
string

String that represents the internal route code

Example:

"25-BCN-XA43N"

​
route_name
string

String that represents the route name

Example:

"Barcelona - Madrid"

​
transport_mode
string

String that represents the transport mode

Example:

"ROAD"

Response

200
application/json
​
error
boolean
Example:

false

​
data
object