List expanded drafts

POST

/oort/order_drafts/expanded/list/v1

POST

/oort/order_drafts/expanded/list/v1

1 import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         environment: ChrtEnvironment.Local,
6         token: "YOUR_TOKEN_HERE",
7     });
8     await client.orderDrafts.expanded.listV1({
9         body: {},
10     });
11 }
12 main();

Try it

1 {
2   "order_drafts_expanded": [
3     {
4       "order": {
5         "schema_version": 1,
6         "_id": "order_1234567890abcdef",
7         "short_id": "ORD-20240115-001",
8         "created_by_org_type": "forwarder",
9         "created_by_org_id": "org_forwarder_001",
10         "created_by_user_id": "user_12345",
11         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
12         "task_group_ids": [
13           "tg_abcdef1234567890"
14         ],
15         "forwarder_org_id": "org_forwarder_001",
16         "shipper_org_id": "org_shipper_001",
17         "off_chrt_shipper_org_id": "offchrt_shipper_001",
18         "status": "draft",
19         "staged_at_timestamp": "2024-01-16T10:00:00Z",
20         "in_progress_at_timestamp": "2024-01-17T08:00:00Z",
21         "completed_at_timestamp": "2024-01-18T15:30:00Z",
22         "exception_at_timestamp": "2024-01-19T12:00:00Z",
23         "order_cancelled": false,
24         "order_cancelled_at_timestamp": "2024-01-20T09:00:00Z"
25       },
26       "forwarder_org_company_name": "FastForward Logistics",
27       "forwarder_org_handle": "fastforward",
28       "shipper_org_company_name": "Global Shippers Inc.",
29       "off_chrt_shipper_org_company_name": "OffChrt Shippers Ltd.",
30       "notification_intents_ad_hoc": [
31         {
32           "schema_version": 1,
33           "created_at_timestamp": "2024-01-15T09:35:00Z",
34           "created_by_org_id": "org_forwarder_001",
35           "created_by_user_id": "user_12345",
36           "order_id": "order_1234567890abcdef",
37           "directory_entry_id": "direntry_9876543210fedcba",
38           "_id": "notif_001",
39           "email_events": [
40             "shipping.order.staged"
41           ],
42           "push_events": [
43             "shipping.order.staged"
44           ],
45           "sms_events": [
46             "shipping.order.staged"
47           ]
48         }
49       ],
50       "task_groups_expanded": [
51         {
52           "task_group": {
53             "schema_version": 1,
54             "_id": "tg_abcdef1234567890",
55             "order_id": "order_1234567890abcdef",
56             "order_short_id": "ORD-20240115-001",
57             "created_by_org_id": "org_forwarder_001",
58             "created_by_user_id": "user_12345",
59             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
60             "task_group_type": "chrt_ground_courier",
61             "task_ids": [
62               "task_001"
63             ],
64             "courier_org_id": "org_courier_001",
65             "driver_id": "driver_001",
66             "service_type": "on_demand",
67             "task_group_s3_object_metadata_ids": [
68               "s3meta_001"
69             ],
70             "status": "draft",
71             "staged_at_timestamp": "2024-01-16T10:00:00Z",
72             "in_progress_at_timestamp": "2024-01-17T08:00:00Z",
73             "completed_at_timestamp": "2024-01-18T15:30:00Z",
74             "skipped_at_timestamp": "2024-01-19T12:00:00Z",
75             "exception_at_timestamp": "2024-01-20T09:00:00Z",
76             "order_cancelled": false,
77             "tasks_mileage": 12.5,
78             "flight_number": "FF1234",
79             "fa_flight_ids": [
80               "flight_001"
81             ],
82             "messages": [
83               {
84                 "message": "Package picked up and en route.",
85                 "user_id": "user_12345",
86                 "org_id": "org_forwarder_001",
87                 "timestamp": "2024-01-15T10:00:00Z"
88               }
89             ],
90             "shipper_pay_forwarder_rate_sheet_id": "rate_sheet_001",
91             "shipper_pay_forwarder_line_item_group_id": "line_item_group_001",
92             "forwarder_pay_courier_rate_sheet_id": "rate_sheet_002",
93             "forwarder_pay_courier_line_item_group_id": "line_item_group_002",
94             "shipper_pay_courier_rate_sheet_id": "rate_sheet_003",
95             "shipper_pay_courier_line_item_group_id": "line_item_group_003",
96             "courier_pay_driver_rate_sheet_id": "rate_sheet_004",
97             "courier_pay_driver_line_item_group_id": "line_item_group_004"
98           },
99           "tasks_expanded": [
100             {
101               "task": {
102                 "schema_version": 1,
103                 "_id": "task_001",
104                 "order_id": "order_1234567890abcdef",
105                 "order_short_id": "ORD-20240115-001",
106                 "task_group_id": "tg_abcdef1234567890",
107                 "created_by_org_id": "org_forwarder_001",
108                 "created_by_user_id": "user_12345",
109                 "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
110                 "location": {
111                   "type": "Feature",
112                   "geometry": {
113                     "bbox": [
114                       "-122.4194",
115                       "37.7749",
116                       "-122.4180",
117                       "37.7760"
118                     ],
119                     "type": "Point",
120                     "coordinates": [
121                       "-122.4194",
122                       "37.7749"
123                     ]
124                   },
125                   "bbox": [
126                     "-122.4194",
127                     "37.7749",
128                     "-122.4180",
129                     "37.7760"
130                   ],
131                   "properties": {
132                     "address": "123 Market St, San Francisco, CA 94103",
133                     "name": "Warehouse A"
134                   },
135                   "id": 101
136                 },
137                 "action": "chrt_ground_courier__pickup",
138                 "time_windows": [
139                   {
140                     "left_boundary_timestamp": "2024-01-15T09:00:00Z",
141                     "right_boundary_timestamp": "2024-01-15T11:00:00Z"
142                   }
143                 ],
144                 "order_placer_comments": "Handle with care, fragile items.",
145                 "directory_entry_ids": [
146                   "direntry_001"
147                 ],
148                 "completed_by_org_id": "org_courier_001",
149                 "completed_by_user_id": "user_67890",
150                 "cargo_ids": [
151                   "cargo_001"
152                 ],
153                 "task_artifact_ids": [
154                   "artifact_001"
155                 ],
156                 "status": "draft",
157                 "staged_at_timestamp": "2024-01-16T10:00:00Z",
158                 "completed_at_timestamp": "2024-01-17T12:00:00Z",
159                 "skipped_at_timestamp": "2024-01-18T08:00:00Z",
160                 "exception_at_timestamp": "2024-01-19T09:00:00Z",
161                 "order_cancelled": false
162               },
163               "cargos": [
164                 {
165                   "schema_version": 1,
166                   "cargo_type": "spare_parts",
167                   "_id": "cargo_001",
168                   "order_id": "order_1234567890abcdef",
169                   "order_short_id": "ORD-20240115-001",
170                   "created_by_org_id": "org_forwarder_001",
171                   "created_by_user_id": "user_12345",
172                   "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
173                   "quantity": 10,
174                   "weight_pounds": 25.5,
175                   "length_inches": 40,
176                   "width_inches": 30,
177                   "height_inches": 20,
178                   "turnable": true,
179                   "stackable": false,
180                   "description": "Engine spare parts for model X",
181                   "device_ids": [
182                     "device_001"
183                   ],
184                   "status": "draft",
185                   "staged_at_timestamp": "2024-01-16T10:00:00Z",
186                   "in_transit_at_timestamp": "2024-01-17T08:00:00Z",
187                   "delivered_at_timestamp": "2024-01-18T15:30:00Z",
188                   "skipped_at_timestamp": "2024-01-19T12:00:00Z",
189                   "exception_at_timestamp": "2024-01-20T09:00:00Z"
190                 }
191               ],
192               "task_artifacts": [
193                 {
194                   "schema_version": 1,
195                   "type": "image",
196                   "_id": "artifact_001",
197                   "order_id": "order_1234567890abcdef",
198                   "order_short_id": "ORD-20240115-001",
199                   "task_group_id": "tg_abcdef1234567890",
200                   "task_id": "task_001",
201                   "created_by_org_id": "org_forwarder_001",
202                   "created_by_user_id": "user_12345",
203                   "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
204                   "task_artifact_s3_object_metadata_ids": [
205                     "s3obj_001"
206                   ],
207                   "requested_by_org_id": "org_forwarder_001",
208                   "requested_by_user_id": "user_12345",
209                   "completed_by_org_id": "org_courier_001",
210                   "completed_by_user_id": "user_67890",
211                   "status": "draft",
212                   "staged_at_timestamp": "2024-01-16T10:00:00Z",
213                   "completed_at_timestamp": "2024-01-17T12:00:00Z",
214                   "skipped_at_timestamp": "2024-01-18T08:00:00Z",
215                   "exception_at_timestamp": "2024-01-19T09:00:00Z"
216                 }
217               ],
218               "directory_entries": [
219                 {
220                   "schema_version": 1,
221                   "created_by_org_id": "org_shipper_001",
222                   "created_by_user_id": "user_54321",
223                   "_id": "direntry_001",
224                   "entry_org_id": "org_shipper_001",
225                   "entry_off_chrt_shipper_org_id": "offchrt_shipper_001",
226                   "company_name": "Global Shippers Inc.",
227                   "industry": "Logistics",
228                   "location": {
229                     "type": "Feature",
230                     "geometry": {
231                       "bbox": {},
232                       "type": "Point",
233                       "coordinates": {}
234                     },
235                     "bbox": [
236                       "-122.4194",
237                       "37.7749",
238                       "-122.4180",
239                       "37.7760"
240                     ],
241                     "properties": {
242                       "address": {},
243                       "name": {}
244                     },
245                     "id": 101
246                   },
247                   "contact_first_name": "John",
248                   "contact_last_name": "Doe",
249                   "phone_number_primary": "+14155552671",
250                   "phone_number_secondary": "+14155552672",
251                   "email_address_primary": "john.doe@globalshippers.com",
252                   "email_address_secondary": "j.doe@globalshippers.com",
253                   "job_title": "Logistics Manager",
254                   "notes": "Primary contact for order coordination."
255                 }
256               ]
257             }
258           ],
259           "driver": {
260             "schema_version": 1,
261             "_id": "driver_001",
262             "org_id": "org_courier_001",
263             "user_id": "user_67890",
264             "email_address_primary": "driver.jane@example.com",
265             "email_address_secondary": "jane.driver@backupmail.com",
266             "phone_number_primary": "+14155551234",
267             "phone_number_secondary": "+14155551235",
268             "first_name": "Jane",
269             "last_name": "Smith",
270             "vehicle_types": [
271               "cargo_van",
272               "box_truck"
273             ],
274             "status": "assigned",
275             "available_according_to_driver": true,
276             "available_according_to_operators": true,
277             "active_task_group_ids": [
278               "tg_abcdef1234567890"
279             ],
280             "last_seen_at_location": {
281               "type": "Feature",
282               "geometry": {
283                 "bbox": [
284                   "-122.4194",
285                   "37.7749",
286                   "-122.4180",
287                   "37.7760"
288                 ],
289                 "type": "Point",
290                 "coordinates": [
291                   "-122.4194",
292                   "37.7749"
293                 ]
294               },
295               "bbox": [
296                 "-122.4194",
297                 "37.7749",
298                 "-122.4180",
299                 "37.7760"
300               ],
301               "properties": {
302                 "address": "123 Market St, San Francisco, CA 94103",
303                 "name": "Warehouse A"
304               },
305               "id": 101
306             },
307             "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
308             "default_rate_sheet__routed": "rate_sheet_routed_001",
309             "default_rate_sheet__on_demand": "rate_sheet_ondemand_001"
310           },
311           "courier_org_company_name": "City Couriers LLC",
312           "courier_org_handle": "citycouriers",
313           "forwarder_org_company_name": "FastForward Logistics",
314           "forwarder_org_handle": "fastforward",
315           "shipper_org_company_name": "Global Shippers Inc.",
316           "off_chrt_shipper_org_company_name": "OffChrt Shippers Ltd."
317         }
318       ],
319       "cargos": [
320         {
321           "schema_version": 1,
322           "cargo_type": "spare_parts",
323           "_id": "cargo_001",
324           "order_id": "order_1234567890abcdef",
325           "order_short_id": "ORD-20240115-001",
326           "created_by_org_id": "org_forwarder_001",
327           "created_by_user_id": "user_12345",
328           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
329           "quantity": 10,
330           "weight_pounds": 25.5,
331           "length_inches": 40,
332           "width_inches": 30,
333           "height_inches": 20,
334           "turnable": true,
335           "stackable": false,
336           "description": "Engine spare parts for model X",
337           "device_ids": [
338             "device_001"
339           ],
340           "status": "draft",
341           "staged_at_timestamp": "2024-01-16T10:00:00Z",
342           "in_transit_at_timestamp": "2024-01-17T08:00:00Z",
343           "delivered_at_timestamp": "2024-01-18T15:30:00Z",
344           "skipped_at_timestamp": "2024-01-19T12:00:00Z",
345           "exception_at_timestamp": "2024-01-20T09:00:00Z"
346         }
347       ]
348     }
349   ],
350   "total_count": 1
351 }

Lists expanded draft orders for the organization with filtering, sorting, and pagination. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenum or nullOptional

Allowed values:

sort_orderenumOptionalDefaults to descending

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_draft_started_at_timestamp_ltestring or nullOptionalformat: "date-time"

filter_draft_started_at_timestamp_gtestring or nullOptionalformat: "date-time"

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

order_drafts_expandedlist of objects

total_countinteger

Authentication

Query parameters

Request

Response

Errors