PATCH
/
shipments
/
{id}
/
sensor-link
curl --request PATCH \
  --url https://api.truecold.io/v1/shipments/{id}/sensor-link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "sensor_id": "382bc9c0-6a3b-4255-97f4-98e91ceab047",
  "status": "ACTIVE"
}'
{
  "error": false,
  "data": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "sensor_id": "<string>",
      "handling_unit_id": "<string>",
      "delivery_id": "<string>",
      "shipment_id": "<string>",
      "scope": "<string>",
      "status": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

UUID of the shipment

Example:

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

Body

application/json
​
sensor_id
string

UUID of the sensor linked to the shipment

Example:

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

​
status
enum<string>

Status of the sensor linked to the shipment

Available options:
ACTIVE,
INACTIVE,
STOPPED
Example:

"ACTIVE"

Response

200
application/json
Shipment linked to sensor successfully
​
error
boolean
Example:

false

​
data
object[]