Get

GET

/shipping/drivers/v1/:driver_id

GET

/shipping/drivers/v1/:driver_id

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.shipping.drivers.getByDriverIdV1("driver_id");
8 }
9 main();

1 {
2   "_id": "_id",
3   "org_id": "org_id",
4   "schema_version": 1,
5   "user_id": "user_id",
6   "active_task_group_ids": [
7     "active_task_group_ids"
8   ],
9   "auto_assign_enabled": true,
10   "available_according_to_driver": true,
11   "available_according_to_operators": true,
12   "email_address_primary": "email_address_primary",
13   "email_address_secondary": "email_address_secondary",
14   "first_name": "first_name",
15   "last_name": "last_name",
16   "last_seen_at_location": {
17     "geometry": {
18       "type": "GeometryCollection",
19       "geometries": [
20         {
21           "type": "LineString",
22           "coordinates": [
23             []
24           ]
25         }
26       ]
27     },
28     "type": "Feature",
29     "bbox": [
30       {
31         "key": "value"
32       }
33     ],
34     "id": 1,
35     "properties": {
36       "address": "address",
37       "name": "name"
38     }
39   },
40   "last_seen_at_location_city": "last_seen_at_location_city",
41   "last_seen_at_location_large_city": "last_seen_at_location_large_city",
42   "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
43   "phone_number_primary": "phone_number_primary",
44   "phone_number_secondary": "phone_number_secondary",
45   "status": "unassigned",
46   "vehicle_types": [
47     "sedan"
48   ],
49   "waiting": true
50 }

Retrieves detailed driver information by driver ID within the organization. | () -> (DriverWithActiveTaskGroupIds1)

Authentication

AuthorizationBearer

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

Path parameters

driver_idstringRequired

Response

Successful Response

_idstring

org_idstring

Must be a string starting with org_

schema_versioninteger

user_idstring

Must be a string starting with user_

active_task_group_idslist of strings

auto_assign_enabledbooleanDefaults to true

available_according_to_driverbooleanDefaults to true

available_according_to_operatorsbooleanDefaults to true

email_address_primarystringformat: "email"

email_address_secondarystringformat: "email"

first_namestring

last_namestring

last_seen_at_locationobject

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

last_seen_at_location_citystring

last_seen_at_location_large_citystring

last_seen_at_timestampdatetime

phone_number_primarystring

phone_number_secondarystring

statusenum

vehicle_typeslist of enums

waitingbooleanDefaults to false

Errors

422

Drivers Get by Driver ID V1request Unprocessable Entity Error