Get

GET

/tracking/devices/get/v1

GET

/tracking/devices/get/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.tracking.devices.getV1({
8         device_id: "device_id",
9     });
10 }
11 main();

1 {
2   "device": {
3     "_id": "dev_9f8b7c6d5e4a3b2c1d0e",
4     "schema_version": 1,
5     "org_id": "org_1234567890abcdef",
6     "device_mac_address": "00:1A:7D:DA:71:13",
7     "device_token": "a1b2c3d4e5f67890",
8     "type": "D15N-tag",
9     "comments": "Installed on pallet #42 for tracking",
10     "off_chrt_reference_id": "ref_20240420_001",
11     "registered_at_timestamp": "2024-01-15T09:30:00Z",
12     "first_seen_at_timestamp": "2024-01-15T09:30:00Z",
13     "last_seen_at_location": {
14       "type": "Feature",
15       "geometry": {
16         "type": "GeometryCollection",
17         "geometries": [
18           {
19             "type": "LineString",
20             "coordinates": [
21               [
22                 -122.4194,
23                 37.7749
24               ],
25               [
26                 -118.2437,
27                 34.0522
28               ]
29             ]
30           }
31         ]
32       },
33       "id": 1
34     },
35     "last_seen_at_timestamp": "2024-04-19T16:45:00Z",
36     "last_seen_battery_level": "85%",
37     "archived": true,
38     "paused": true,
39     "pause_windows": [
40       {
41         "start_timestamp": "2024-04-10T08:00:00Z",
42         "end_timestamp": "2024-04-12T18:00:00Z"
43       }
44     ],
45     "shared_with_org_ids": [
46       "org_abcdef1234567890"
47     ],
48     "off_chrt_shipper_org_id": "org_shipper001",
49     "active_session_id": "sess_abcdef1234567890",
50     "active_cargo_id": "cargo_123456abcdef7890"
51   },
52   "active_session": {
53     "schema_version": 1,
54     "device_id": "dev_9f8b7c6d5e4a3b2c1d0e",
55     "device_mac_address": "00:1A:7D:DA:71:13",
56     "org_id": "org_1234567890abcdef",
57     "created_at_timestamp": "2024-04-15T10:00:00Z",
58     "_id": "sess_abcdef1234567890",
59     "off_chrt_reference_id": "sess_ref_20240419",
60     "comments": "Flight tracking session for shipment #1234",
61     "public": true,
62     "off_chrt_shipper_org_id": "org_shipper001",
63     "termination_scheduled_for_timestamp": "2024-04-25T23:59:59Z",
64     "flight_numbers": [
65       "UA1234"
66     ],
67     "fa_flight_ids": [
68       "fa_56789"
69     ],
70     "shared_with_org_ids": [
71       "org_abcdef1234567890"
72     ],
73     "terminated": true,
74     "terminated_at_timestamp": "2024-04-19T16:00:00Z",
75     "fa_alert_ids": [
76       101
77     ],
78     "flight_loaded_statuses": [
79       "loaded"
80     ],
81     "fa_alert_id_by_flight_number": {
82       "UA1234": 101
83     },
84     "flight_status_by_fa_flight_id": {
85       "fa_56789": "landed"
86     },
87     "flight_loaded_status_by_fa_flight_id": {
88       "fa_56789": "loaded"
89     }
90   },
91   "active_cargo": {
92     "schema_version": 1,
93     "cargo_type": "spare_parts",
94     "_id": "cargo_123456abcdef7890",
95     "order_id": "order_7890abcdef1234",
96     "order_short_id": "ORD7890",
97     "created_by_org_id": "org_1234567890abcdef",
98     "created_by_user_id": "user_9876543210fedcba",
99     "draft_started_at_timestamp": "2024-04-10T09:00:00Z",
100     "quantity": 50,
101     "weight_pounds": 120.5,
102     "length_inches": 48,
103     "width_inches": 40,
104     "height_inches": 36,
105     "turnable": true,
106     "stackable": false,
107     "description": "Replacement engine parts for aircraft maintenance",
108     "device_ids": [
109       "dev_9f8b7c6d5e4a3b2c1d0e"
110     ],
111     "status": "draft",
112     "staged_at_timestamp": "2024-04-12T12:00:00Z",
113     "in_transit_at_timestamp": "2024-04-15T14:00:00Z",
114     "delivered_at_timestamp": "2024-04-19T15:30:00Z"
115   },
116   "past_sessions": [
117     {
118       "schema_version": 1,
119       "device_id": "dev_9f8b7c6d5e4a3b2c1d0e",
120       "device_mac_address": "00:1A:7D:DA:71:13",
121       "org_id": "org_1234567890abcdef",
122       "created_at_timestamp": "2024-02-25T08:00:00Z",
123       "_id": "sess_123456abcdef7890",
124       "off_chrt_reference_id": "sess_ref_20240301",
125       "comments": "Previous shipment session",
126       "public": true,
127       "off_chrt_shipper_org_id": "org_shipper002",
128       "termination_scheduled_for_timestamp": "2024-03-10T23:59:59Z",
129       "flight_numbers": [
130         "AA5678"
131       ],
132       "fa_flight_ids": [
133         "fa_12345"
134       ],
135       "shared_with_org_ids": [
136         "org_abcdef1234567890"
137       ],
138       "terminated": true,
139       "terminated_at_timestamp": "2024-03-05T18:00:00Z",
140       "fa_alert_ids": [
141         99
142       ],
143       "flight_loaded_statuses": [
144         "unloaded"
145       ],
146       "fa_alert_id_by_flight_number": {
147         "AA5678": 99
148       },
149       "flight_status_by_fa_flight_id": {
150         "fa_12345": "arrived_at_gate"
151       }
152     }
153   ],
154   "past_cargos": [
155     {
156       "schema_version": 1,
157       "cargo_type": "spare_parts",
158       "_id": "cargo_abcdef1234567890",
159       "order_id": "order_1234abcd5678efgh",
160       "order_short_id": "ORD1234",
161       "created_by_org_id": "org_1234567890abcdef",
162       "created_by_user_id": "user_abcdef9876543210",
163       "draft_started_at_timestamp": "2024-02-20T07:00:00Z",
164       "quantity": 30,
165       "weight_pounds": 75,
166       "length_inches": 36,
167       "width_inches": 24,
168       "height_inches": 18,
169       "turnable": false,
170       "stackable": true,
171       "description": "Old batch of spare parts",
172       "device_ids": [
173         "dev_9f8b7c6d5e4a3b2c1d0e"
174       ],
175       "status": "delivered",
176       "staged_at_timestamp": "2024-02-22T10:00:00Z",
177       "in_transit_at_timestamp": "2024-02-25T12:00:00Z",
178       "delivered_at_timestamp": "2024-03-01T16:00:00Z"
179     }
180   ]
181 }

Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller’s organization or shared organizations. | authz: min_org_role=operator | () -> (DeviceExpandedRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

device_idstringRequired

Response

Successful Response

deviceobject

Response model for list/search views.

Excludes historical relationship fields:

past_session_ids
past_cargo_ids

active_sessionobject

active_cargoobject

past_sessionslist of objects

past_cargoslist of objects

Errors

422

Devices Get V1request Unprocessable Entity Error