Retrieve (via POST) by driver expanded

POST

/oort/task_groups/by_driver/expanded/v1

POST

/oort/task_groups/by_driver/expanded/v1

1 curl -X POST https://localhost:8000/oort/task_groups/by_driver/expanded/v1 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "task_group_statuses": [
6     "not_started"
7   ]
8 }'

Try it

1 {
2   "task_groups_expanded": [
3     {
4       "task_group": {
5         "schema_version": 1,
6         "_id": "string",
7         "order_id": "string",
8         "order_short_id": "string",
9         "task_ids": [
10           "string"
11         ],
12         "courier_org_id": "string",
13         "order_cancelled": false,
14         "status": "not_started",
15         "driver_id": "string",
16         "started_at": "2024-01-15T09:30:00Z",
17         "completed_at": "2024-01-15T09:30:00Z",
18         "completed": false,
19         "paused": false
20       },
21       "tasks_expanded": [
22         {
23           "task": {
24             "schema_version": 1,
25             "_id": "string",
26             "order_id": "string",
27             "order_short_id": "string",
28             "created_by_org_id": "string",
29             "created_by_user_id": "string",
30             "location": {
31               "type": "string",
32               "geometry": {
33                 "bbox": [
34                   "string"
35                 ],
36                 "type": "string",
37                 "coordinates": [
38                   "string"
39                 ]
40               },
41               "bbox": [
42                 "string"
43               ],
44               "properties": {
45                 "address": "string",
46                 "name": "string",
47                 "mapbox_id": "string"
48               },
49               "id": 1
50             },
51             "action": "pickup",
52             "shipper_contact_info_ids": [
53               "string"
54             ],
55             "arrive_by": "2024-01-15T09:30:00Z",
56             "arrive_at": "2024-01-15T09:30:00Z",
57             "comments": "string",
58             "flight_number": "string",
59             "order_cancelled": false,
60             "completed": false,
61             "completed_at": "2024-01-15T09:30:00Z",
62             "cargo_ids": [
63               "string"
64             ],
65             "milestone_ids": [
66               "string"
67             ]
68           },
69           "cargos": [
70             {
71               "schema_version": 1,
72               "cargo_type": "spare_parts",
73               "_id": "string",
74               "order_id": "string",
75               "order_short_id": "string",
76               "quantity": 1,
77               "weight_pounds": 1.1,
78               "length_inches": 1.1,
79               "width_inches": 1.1,
80               "height_inches": 1.1,
81               "device_ids": [
82                 "string"
83               ],
84               "status": "awaiting_pickup"
85             }
86           ],
87           "milestones": [
88             {
89               "schema_version": 1,
90               "type": "image",
91               "_id": "string",
92               "order_id": "string",
93               "order_short_id": "string",
94               "task_id": "string",
95               "completed": true,
96               "requested_by_shipper": true,
97               "requestor_comments": "string",
98               "completed_at_timestamp": "2024-01-15T09:30:00Z",
99               "completed_at_geojson_feature": {
100                 "type": "string",
101                 "geometry": {
102                   "bbox": [
103                     "string"
104                   ],
105                   "type": "string",
106                   "coordinates": [
107                     "string"
108                   ]
109                 },
110                 "bbox": [
111                   "string"
112                 ],
113                 "properties": {
114                   "address": "string",
115                   "name": "string",
116                   "mapbox_id": "string"
117                 },
118                 "id": 1
119               },
120               "completed_by_user_id": "string",
121               "milestone_s3_object_metadata_ids": [
122                 "string"
123               ],
124               "decoded_scans": [
125                 "string"
126               ],
127               "completor_comments": "string",
128               "chrt_comments": "string",
129               "notification_email_ids": [
130                 "string"
131               ],
132               "notification_sms_ids": [
133                 "string"
134               ],
135               "notification_push_ids": [
136                 "string"
137               ],
138               "notification_voice_ids": [
139                 "string"
140               ]
141             }
142           ],
143           "shipper_contact_info": [
144             {
145               "schema_version": 1,
146               "created_by_org_id": "string",
147               "created_by_user_id": "string",
148               "_id": "string",
149               "company_name": "string",
150               "industry": "string",
151               "street_address": {
152                 "type": "string",
153                 "geometry": {
154                   "bbox": [
155                     "string"
156                   ],
157                   "type": "string",
158                   "coordinates": [
159                     "string"
160                   ]
161                 },
162                 "bbox": [
163                   "string"
164                 ],
165                 "properties": {
166                   "address": "string",
167                   "name": "string",
168                   "mapbox_id": "string"
169                 },
170                 "id": 1
171               },
172               "contact_first_name": "string",
173               "contact_last_name": "string",
174               "phone_number_primary": "string",
175               "phone_number_secondary": "string",
176               "email_address_primary": "string",
177               "email_address_secondary": "string",
178               "job_title": "string",
179               "notes": "string",
180               "shipper_org_id": "string",
181               "shipper_user_id": "string",
182               "off_chrt_shipper_org_info_id": "string"
183             }
184           ]
185         }
186       ],
187       "order_org_company_name": "string",
188       "order_org_handle": "string",
189       "task_group_mileage": 1.1,
190       "courier_pay_driver_line_item_groups": [
191         {
192           "schema_version": 1,
193           "driver_id": "string",
194           "task_group_id": "string",
195           "courier_org_id": "string",
196           "line_items": [
197             {
198               "schema_version": 1,
199               "item": "base_rate",
200               "quantity": 1.1,
201               "rate": 1.1,
202               "comment": "string",
203               "created_at": "2024-01-15T09:30:00Z",
204               "uuid_str": "string"
205             }
206           ],
207           "rate_sheet_id": "string",
208           "_id": "string",
209           "order_cancelled": false
210         }
211       ],
212       "courier_pay_driver_rate_sheet": {
213         "schema_version": 1,
214         "courier_org_id": "string",
215         "base_mileage_distance_miles": 1.1,
216         "base_mileage_rate_usd_per_instance": 1.1,
217         "additional_mileage_rate_usd_per_mile": 1.1,
218         "long_distance_surcharge_miles_before_surcharge": 1.1,
219         "long_distance_surcharge_rate_usd_per_mile": 1.1,
220         "fuel_surcharge_rate_usd_per_mile": 1.1,
221         "wait_time_before_charge_minutes": 1.1,
222         "wait_time_rate_usd_per_minute": 1.1,
223         "extra_stop_rate_usd": 1.1,
224         "dangerous_goods_rate_usd_per_instance": 1.1,
225         "after_hours": 1.1,
226         "weekend": 1.1,
227         "holiday": 1.1,
228         "_id": "string",
229         "name": "string",
230         "cargo_types": [
231           "spare_parts"
232         ],
233         "vehicle_types": [
234           "sedan"
235         ],
236         "route_types": [
237           "routed"
238         ],
239         "driver_ids": [
240           "string"
241         ],
242         "comments": "string"
243       },
244       "courier_pay_driver_payout": {
245         "schema_version": 1,
246         "courier_pay_driver_line_item_group_ids": [
247           "string"
248         ],
249         "_id": "string",
250         "driver_id": "string",
251         "courier_org_id": "string",
252         "task_group_ids": [
253           "string"
254         ],
255         "payout_amount": 1.1,
256         "payout_created_at": "2024-01-15T09:30:00Z",
257         "payout_created_by_user_id": "string",
258         "payout_status": "created",
259         "payout_completed_at": "2024-01-15T09:30:00Z",
260         "payout_completed_by_user_id": "string"
261       }
262     }
263   ]
264 }

Fetches task groups by driver with optional expanded data for tasks, milestones, cargo, and payment information.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

task_group_statuseslist of enumsRequired

Allowed values:

driver_idstring or nullOptional

expand_tasksbooleanOptionalDefaults to false

expand_cargosbooleanOptionalDefaults to false

expand_milestonesbooleanOptionalDefaults to false

expand_shipper_contact_infobooleanOptionalDefaults to false

expand_order_org_company_namebooleanOptionalDefaults to false

expand_order_org_handlebooleanOptionalDefaults to false

expand_task_group_mileagebooleanOptionalDefaults to false

expand_courier_pay_driver_line_item_groupsbooleanOptionalDefaults to false

expand_courier_pay_driver_rate_sheetbooleanOptionalDefaults to false

expand_courier_pay_driver_payoutbooleanOptionalDefaults to false

Response

Successful Response

task_groups_expandedlist of objects

Authentication

Request

Response

Errors