Retrieve for courier driver

POST

/shipping/task_groups/expanded/for_courier_driver/v1/:task_group_id

POST

/shipping/task_groups/expanded/for_courier_driver/v1/:task_group_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.taskGroups.expanded.forCourierDriverV1("task_group_id", {});
8 }
9 main();

1 {
2   "task_group": {
3     "schema_version": 1,
4     "_id": "_id",
5     "order_id": "order_id",
6     "order_short_id": "order_short_id",
7     "created_by_org_id": "created_by_org_id",
8     "created_by_user_id": "created_by_user_id",
9     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
10     "task_group_type": "chrt_ground_courier",
11     "task_ids": [
12       "task_ids"
13     ],
14     "courier_org_id": "courier_org_id",
15     "driver_id": "driver_id",
16     "service_type": "on_demand",
17     "task_group_s3_object_metadata_ids": [
18       "task_group_s3_object_metadata_ids"
19     ],
20     "status": "draft",
21     "staged_at_timestamp": "2024-01-15T09:30:00Z",
22     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
23     "completed_at_timestamp": "2024-01-15T09:30:00Z",
24     "skipped_at_timestamp": "2024-01-15T09:30:00Z",
25     "exception_at_timestamp": "2024-01-15T09:30:00Z",
26     "order_cancelled": true,
27     "tasks_mileage": 1.1,
28     "flight_number": "flight_number",
29     "fa_flight_ids": [
30       "fa_flight_ids"
31     ],
32     "messages": [
33       {
34         "message": "message",
35         "user_id": "user_id",
36         "org_id": "org_id",
37         "timestamp": "2024-01-15T09:30:00Z"
38       }
39     ],
40     "shipper_pay_forwarder_rate_sheet_id": "shipper_pay_forwarder_rate_sheet_id",
41     "shipper_pay_forwarder_line_item_group_id": "shipper_pay_forwarder_line_item_group_id",
42     "forwarder_pay_courier_rate_sheet_id": "forwarder_pay_courier_rate_sheet_id",
43     "forwarder_pay_courier_line_item_group_id": "forwarder_pay_courier_line_item_group_id",
44     "shipper_pay_courier_rate_sheet_id": "shipper_pay_courier_rate_sheet_id",
45     "shipper_pay_courier_line_item_group_id": "shipper_pay_courier_line_item_group_id",
46     "courier_pay_driver_rate_sheet_id": "courier_pay_driver_rate_sheet_id",
47     "courier_pay_driver_line_item_group_id": "courier_pay_driver_line_item_group_id"
48   },
49   "tasks_expanded": [
50     {
51       "task": {
52         "schema_version": 1,
53         "_id": "_id",
54         "order_id": "order_id",
55         "order_short_id": "order_short_id",
56         "task_group_id": "task_group_id",
57         "created_by_org_id": "created_by_org_id",
58         "created_by_user_id": "created_by_user_id",
59         "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
60       },
61       "cargos": [
62         {
63           "schema_version": 1,
64           "cargo_type": "spare_parts",
65           "_id": "_id",
66           "order_id": "order_id",
67           "order_short_id": "order_short_id",
68           "created_by_org_id": "created_by_org_id",
69           "created_by_user_id": "created_by_user_id",
70           "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
71         }
72       ],
73       "task_artifacts": [
74         {
75           "schema_version": 1,
76           "type": "image",
77           "_id": "_id",
78           "order_id": "order_id",
79           "order_short_id": "order_short_id",
80           "task_group_id": "task_group_id",
81           "task_id": "task_id",
82           "created_by_org_id": "created_by_org_id",
83           "created_by_user_id": "created_by_user_id",
84           "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
85         }
86       ],
87       "directory_entries": [
88         {
89           "schema_version": 1,
90           "created_by_org_id": "created_by_org_id",
91           "created_by_user_id": "created_by_user_id",
92           "_id": "_id"
93         }
94       ]
95     }
96   ],
97   "driver": {
98     "schema_version": 1,
99     "_id": "_id",
100     "org_id": "org_id",
101     "user_id": "user_id",
102     "email_address_primary": "email_address_primary",
103     "email_address_secondary": "email_address_secondary",
104     "phone_number_primary": "phone_number_primary",
105     "phone_number_secondary": "phone_number_secondary",
106     "first_name": "first_name",
107     "last_name": "last_name",
108     "vehicle_types": [
109       "sedan"
110     ],
111     "status": "unassigned",
112     "available_according_to_driver": true,
113     "available_according_to_operators": true,
114     "active_task_group_ids": [
115       "active_task_group_ids"
116     ],
117     "last_seen_at_location": {
118       "type": "Feature",
119       "geometry": {
120         "type": "GeometryCollection",
121         "geometries": [
122           {
123             "type": "LineString",
124             "coordinates": [
125               []
126             ]
127           }
128         ]
129       },
130       "id": 1
131     },
132     "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
133     "default_rate_sheet__routed": "default_rate_sheet__routed",
134     "default_rate_sheet__on_demand": "default_rate_sheet__on_demand"
135   },
136   "courier_org_company_name": "courier_org_company_name",
137   "courier_org_handle": "courier_org_handle",
138   "forwarder_org_company_name": "forwarder_org_company_name",
139   "forwarder_org_handle": "forwarder_org_handle",
140   "shipper_org_company_name": "shipper_org_company_name",
141   "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name"
142 }

Retrieves an expanded task group with optional related data for courier drivers. | authz_personas=[courier_driver] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Request

This endpoint expects an object.

expand_forwarder_org_company_namebooleanOptionalDefaults to false

expand_forwarder_org_handlebooleanOptionalDefaults to false

expand_shipper_org_company_namebooleanOptionalDefaults to false

expand_off_chrt_shipper_org_company_namebooleanOptionalDefaults to false

expand_notification_intents_ad_hocbooleanOptionalDefaults to false

expand_tasksbooleanOptionalDefaults to false

expand_cargosbooleanOptionalDefaults to false

expand_task_artifactsbooleanOptionalDefaults to false

expand_directory_entriesbooleanOptionalDefaults to false

expand_driverbooleanOptionalDefaults to false

expand_courier_org_company_namebooleanOptionalDefaults to false

expand_courier_org_handlebooleanOptionalDefaults to false

Response

Successful Response

task_groupobject

tasks_expandedlist of objects or null

driverobject or null

courier_org_company_namestring or null

courier_org_handlestring or null

forwarder_org_company_namestring or null

forwarder_org_handlestring or null

shipper_org_company_namestring or null

off_chrt_shipper_org_company_namestring or null

Authentication

Path parameters

Request

Response

Errors