expanded for shipper

POST

/oort/task_groups/expanded/for_shipper/v1/:id

POST

/oort/task_groups/expanded/for_shipper/v1/:id

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         environment: "https://localhost:8000",
6         token: "YOUR_TOKEN_HERE",
7     });
8     await client.taskGroups.expanded.forShipperByIdV1("id", {});
9 }
10 main();

Try it

200Successful

1 {
2   "task_group": {
3     "schema_version": 1,
4     "_id": "string",
5     "order_id": "string",
6     "order_short_id": "string",
7     "created_by_org_id": "string",
8     "created_by_user_id": "string",
9     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
10     "task_group_type": "chrt_ground_courier",
11     "task_ids": [
12       "string"
13     ],
14     "courier_org_id": "string",
15     "driver_id": "string",
16     "task_group_s3_object_metadata_ids": [
17       "string"
18     ],
19     "status": "draft",
20     "staged_at_timestamp": "2024-01-15T09:30:00Z",
21     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
22     "completed_at_timestamp": "2024-01-15T09:30:00Z",
23     "exception_at_timestamp": "2024-01-15T09:30:00Z",
24     "order_cancelled": false,
25     "task_group_mileage": {
26       "tasks_mileage": 1.1,
27       "deadhead_mileage": 1.1
28     },
29     "messages": [
30       {
31         "message": "string",
32         "user_id": "string",
33         "org_id": "string",
34         "timestamp": "2024-01-15T09:30:00Z"
35       }
36     ]
37   },
38   "tasks_expanded": [
39     {
40       "task": {
41         "schema_version": 1,
42         "_id": "string",
43         "order_id": "string",
44         "order_short_id": "string",
45         "task_group_id": "string",
46         "created_by_org_id": "string",
47         "created_by_user_id": "string",
48         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
49         "location": {
50           "type": "string",
51           "geometry": {
52             "bbox": [
53               "string"
54             ],
55             "type": "string",
56             "coordinates": [
57               "string"
58             ]
59           },
60           "bbox": [
61             "string"
62           ],
63           "properties": {
64             "address": "string",
65             "name": "string"
66           },
67           "id": 1
68         },
69         "action": "chrt_ground_courier__pickup",
70         "time_windows": [
71           {
72             "left_boundary_timestamp": "2024-01-15T09:30:00Z",
73             "right_boundary_timestamp": "2024-01-15T09:30:00Z"
74           }
75         ],
76         "order_placer_comments": "string",
77         "shipper_contact_info_ids": [
78           "string"
79         ],
80         "flight_number": "string",
81         "completed_by_org_id": "string",
82         "completed_by_user_id": "string",
83         "cargo_ids": [
84           "string"
85         ],
86         "task_artifact_ids": [
87           "string"
88         ],
89         "status": "draft",
90         "staged_at_timestamp": "2024-01-15T09:30:00Z",
91         "completed_at_timestamp": "2024-01-15T09:30:00Z",
92         "exception_at_timestamp": "2024-01-15T09:30:00Z",
93         "order_cancelled": false,
94         "task_notification_email_ids": [
95           "string"
96         ],
97         "task_notification_sms_ids": [
98           "string"
99         ],
100         "task_notification_push_ids": [
101           "string"
102         ],
103         "task_notification_voice_ids": [
104           "string"
105         ]
106       },
107       "cargos": [
108         {
109           "schema_version": 1,
110           "cargo_type": "spare_parts",
111           "_id": "string",
112           "order_id": "string",
113           "order_short_id": "string",
114           "created_by_org_id": "string",
115           "created_by_user_id": "string",
116           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
117           "quantity": 1,
118           "weight_pounds": 1.1,
119           "length_inches": 1.1,
120           "width_inches": 1.1,
121           "height_inches": 1.1,
122           "turnable": true,
123           "stackable": true,
124           "description": "string",
125           "device_ids": [
126             "string"
127           ],
128           "status": "draft",
129           "staged_at_timestamp": "2024-01-15T09:30:00Z",
130           "in_transit_at_timestamp": "2024-01-15T09:30:00Z",
131           "delivered_at_timestamp": "2024-01-15T09:30:00Z",
132           "exception_at_timestamp": "2024-01-15T09:30:00Z"
133         }
134       ],
135       "task_artifacts": [
136         {
137           "schema_version": 1,
138           "type": "image",
139           "_id": "string",
140           "order_id": "string",
141           "order_short_id": "string",
142           "task_group_id": "string",
143           "task_id": "string",
144           "created_by_org_id": "string",
145           "created_by_user_id": "string",
146           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
147           "task_artifact_s3_object_metadata_ids": [
148             "string"
149           ],
150           "requested_by_org_id": "string",
151           "requested_by_user_id": "string",
152           "completed_by_org_id": "string",
153           "completed_by_user_id": "string",
154           "status": "draft",
155           "staged_at_timestamp": "2024-01-15T09:30:00Z",
156           "completed_at_timestamp": "2024-01-15T09:30:00Z",
157           "exception_at_timestamp": "2024-01-15T09:30:00Z"
158         }
159       ],
160       "shipper_contact_info": [
161         {
162           "schema_version": 1,
163           "created_by_org_id": "string",
164           "created_by_user_id": "string",
165           "_id": "string",
166           "shipper_org_id": "string",
167           "shipper_user_id": "string",
168           "off_chrt_shipper_org_id": "string",
169           "company_name": "string",
170           "industry": "string",
171           "street_address": {
172             "type": "string",
173             "geometry": {
174               "bbox": [
175                 "string"
176               ],
177               "type": "string",
178               "coordinates": [
179                 "string"
180               ]
181             },
182             "bbox": [
183               "string"
184             ],
185             "properties": {
186               "address": "string",
187               "name": "string"
188             },
189             "id": 1
190           },
191           "contact_first_name": "string",
192           "contact_last_name": "string",
193           "phone_number_primary": "string",
194           "phone_number_secondary": "string",
195           "email_address_primary": "string",
196           "email_address_secondary": "string",
197           "job_title": "string",
198           "notes": "string"
199         }
200       ]
201     }
202   ],
203   "courier_org_company_name": "string",
204   "courier_org_handle": "string",
205   "task_group_mileage": 1.1,
206   "driver": {
207     "schema_version": 1,
208     "_id": "string",
209     "org_id": "string",
210     "user_id": "string",
211     "active": true,
212     "email_address_primary": "string",
213     "email_address_secondary": "string",
214     "phone_number_primary": "string",
215     "phone_number_secondary": "string",
216     "first_name": "string",
217     "last_name": "string",
218     "vehicle_types": [
219       "sedan"
220     ],
221     "status": "not_assigned",
222     "last_seen_at_location": {
223       "type": "string",
224       "geometry": {
225         "bbox": [
226           "string"
227         ],
228         "type": "string",
229         "coordinates": [
230           "string"
231         ]
232       },
233       "bbox": [
234         "string"
235       ],
236       "properties": {
237         "address": "string",
238         "name": "string"
239       },
240       "id": 1
241     },
242     "last_seen_at_timestamp": "2024-01-15T09:30:00Z"
243   },
244   "shipper_pay_courier_line_item_groups": [
245     {
246       "schema_version": 1,
247       "task_group_id": "string",
248       "courier_org_id": "string",
249       "rate_sheet_id": "string",
250       "line_items": [
251         {
252           "schema_version": 1,
253           "item": "base_rate",
254           "quantity": 1.1,
255           "rate": 1.1,
256           "comment": "string",
257           "created_at_timestamp": "2024-01-15T09:30:00Z",
258           "uuid_str": "string"
259         }
260       ],
261       "_id": "string",
262       "shipper_org_id": "string",
263       "off_chrt_shipper_org_id": "string",
264       "order_cancelled": false
265     }
266   ],
267   "shipper_pay_courier_rate_sheet": {
268     "schema_version": 1,
269     "base_mileage_distance_miles": 1.1,
270     "base_mileage_rate_usd_per_instance": 1.1,
271     "additional_mileage_rate_usd_per_mile": 1.1,
272     "long_distance_surcharge_miles_before_surcharge": 1.1,
273     "long_distance_surcharge_rate_usd_per_mile": 1.1,
274     "fuel_surcharge_rate_usd_per_mile": 1.1,
275     "wait_time_before_charge_minutes": 1.1,
276     "wait_time_rate_usd_per_minute": 1.1,
277     "extra_stop_rate_usd": 1.1,
278     "dangerous_goods_rate_usd_per_instance": 1.1,
279     "after_hours": 1.1,
280     "weekend": 1.1,
281     "holiday": 1.1,
282     "courier_org_id": "string",
283     "_id": "string",
284     "name": "string",
285     "cargo_types": [
286       "spare_parts"
287     ],
288     "vehicle_types": [
289       "sedan"
290     ],
291     "route_types": [
292       "routed"
293     ],
294     "shipper_org_id": "string",
295     "off_chrt_shipper_org_id": "string",
296     "comments": "string"
297   },
298   "shipper_pay_courier_payment": {
299     "schema_version": 1,
300     "shipper_pay_courier_line_item_group_ids": [
301       "string"
302     ],
303     "task_group_ids": [
304       "string"
305     ],
306     "courier_org_id": "string",
307     "statement_amount": 1.1,
308     "_id": "string",
309     "off_chrt_shipper_org_id": "string",
310     "shipper_org_id": "string",
311     "shipper_customer_id_for_courier_stripe_connect_account": "string",
312     "stripe_invoice_id": "string",
313     "stripe_invoice_url": "string",
314     "stripe_invoice_created_timestamp": "2024-01-15T09:30:00Z",
315     "stripe_invoice_created_by_user_id": "string",
316     "stripe_invoice_status": "invoice_not_yet_created",
317     "stripe_invoice_completed_timestamp": "2024-01-15T09:30:00Z"
318   }
319 }

Fetches an expanded task group for the shipper org with expanded related data. | (TaskGroupExpandedForShipperReq) -> (TaskGroupExpandedForShipper)

Authentication

AuthorizationBearer

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

Path Parameters

idstringRequired

Request

This endpoint expects an object.

expand_tasksbooleanOptionalDefaults to false

expand_cargosbooleanOptionalDefaults to false

expand_task_artifactsbooleanOptionalDefaults to false

expand_shipper_contact_infobooleanOptionalDefaults to false

expand_courier_org_company_namebooleanOptionalDefaults to false

expand_courier_org_handlebooleanOptionalDefaults to false

expand_task_group_mileagebooleanOptionalDefaults to false

expand_driverbooleanOptionalDefaults to false

expand_shipper_pay_courier_line_item_groupsbooleanOptionalDefaults to false

expand_shipper_pay_courier_rate_sheetbooleanOptionalDefaults to false

expand_shipper_pay_courier_paymentbooleanOptionalDefaults to false

Response

Successful Response

task_groupobject

tasks_expandedlist of objects or null

courier_org_company_namestring or null

courier_org_handlestring or null

task_group_mileagedouble or null

driverobject or null

shipper_pay_courier_line_item_groupslist of objects or null

shipper_pay_courier_rate_sheetobject or null

shipper_pay_courier_paymentobject or null

Authentication

Path Parameters

Request

Response

Errors