Retrieve (via POST) for forwarder operators

POST

/oort/orders/expanded/for_forwarder_operators/v1/:order_id_or_short_id

POST

/oort/orders/expanded/for_forwarder_operators/v1/:order_id_or_short_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.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {});
9 }
10 main();

Try it

200Successful

1 {
2   "order": {
3     "schema_version": 1,
4     "_id": "string",
5     "short_id": "string",
6     "created_by_org_type": "courier",
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_ids": [
11       "string"
12     ],
13     "forwarder_org_id": "string",
14     "shipper_org_id": "string",
15     "off_chrt_shipper_org_id": "string",
16     "status": "draft",
17     "staged_at_timestamp": "2024-01-15T09:30:00Z",
18     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
19     "completed_at_timestamp": "2024-01-15T09:30:00Z",
20     "exception_at_timestamp": "2024-01-15T09:30:00Z",
21     "order_cancelled": false,
22     "order_cancelled_at_timestamp": "2024-01-15T09:30:00Z"
23   },
24   "forwarder_org_company_name": "string",
25   "forwarder_org_handle": "string",
26   "shipper_org_company_name": "string",
27   "off_chrt_shipper_org_company_name": "string",
28   "task_groups_expanded": [
29     {
30       "task_group": {
31         "schema_version": 1,
32         "_id": "string",
33         "order_id": "string",
34         "order_short_id": "string",
35         "created_by_org_id": "string",
36         "created_by_user_id": "string",
37         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
38         "task_group_type": "chrt_ground_courier",
39         "task_ids": [
40           "string"
41         ],
42         "courier_org_id": "string",
43         "driver_id": "string",
44         "task_group_s3_object_metadata_ids": [
45           "string"
46         ],
47         "status": "draft",
48         "staged_at_timestamp": "2024-01-15T09:30:00Z",
49         "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
50         "completed_at_timestamp": "2024-01-15T09:30:00Z",
51         "skipped_at_timestamp": "2024-01-15T09:30:00Z",
52         "exception_at_timestamp": "2024-01-15T09:30:00Z",
53         "order_cancelled": false,
54         "task_group_mileage": {
55           "tasks_mileage": 1.1,
56           "deadhead_mileage": 1.1
57         },
58         "flight_number": "string",
59         "fa_flight_id": "string",
60         "messages": [
61           {
62             "message": "string",
63             "user_id": "string",
64             "org_id": "string",
65             "timestamp": "2024-01-15T09:30:00Z"
66           }
67         ]
68       },
69       "tasks_expanded": [
70         {
71           "task": {
72             "schema_version": 1,
73             "_id": "string",
74             "order_id": "string",
75             "order_short_id": "string",
76             "task_group_id": "string",
77             "created_by_org_id": "string",
78             "created_by_user_id": "string",
79             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
80             "location": {
81               "type": "string",
82               "geometry": {
83                 "bbox": [
84                   "string"
85                 ],
86                 "type": "string",
87                 "coordinates": [
88                   "string"
89                 ]
90               },
91               "bbox": [
92                 "string"
93               ],
94               "properties": {
95                 "address": "string",
96                 "name": "string"
97               },
98               "id": 1
99             },
100             "action": "chrt_ground_courier__pickup",
101             "time_windows": [
102               {
103                 "left_boundary_timestamp": "2024-01-15T09:30:00Z",
104                 "right_boundary_timestamp": "2024-01-15T09:30:00Z"
105               }
106             ],
107             "order_placer_comments": "string",
108             "shipper_contact_ids": [
109               "string"
110             ],
111             "completed_by_org_id": "string",
112             "completed_by_user_id": "string",
113             "cargo_ids": [
114               "string"
115             ],
116             "task_artifact_ids": [
117               "string"
118             ],
119             "status": "draft",
120             "staged_at_timestamp": "2024-01-15T09:30:00Z",
121             "completed_at_timestamp": "2024-01-15T09:30:00Z",
122             "skipped_at_timestamp": "2024-01-15T09:30:00Z",
123             "exception_at_timestamp": "2024-01-15T09:30:00Z",
124             "order_cancelled": false,
125             "task_notification_email_ids": [
126               "string"
127             ],
128             "task_notification_sms_ids": [
129               "string"
130             ],
131             "task_notification_push_ids": [
132               "string"
133             ],
134             "task_notification_voice_ids": [
135               "string"
136             ]
137           },
138           "cargos": [
139             {
140               "schema_version": 1,
141               "cargo_type": "spare_parts",
142               "_id": "string",
143               "order_id": "string",
144               "order_short_id": "string",
145               "created_by_org_id": "string",
146               "created_by_user_id": "string",
147               "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
148               "quantity": 1,
149               "weight_pounds": 1.1,
150               "length_inches": 1.1,
151               "width_inches": 1.1,
152               "height_inches": 1.1,
153               "turnable": true,
154               "stackable": true,
155               "description": "string",
156               "device_ids": [
157                 "string"
158               ],
159               "status": "draft",
160               "staged_at_timestamp": "2024-01-15T09:30:00Z",
161               "in_transit_at_timestamp": "2024-01-15T09:30:00Z",
162               "delivered_at_timestamp": "2024-01-15T09:30:00Z",
163               "skipped_at_timestamp": "2024-01-15T09:30:00Z",
164               "exception_at_timestamp": "2024-01-15T09:30:00Z"
165             }
166           ],
167           "task_artifacts": [
168             {
169               "schema_version": 1,
170               "type": "image",
171               "_id": "string",
172               "order_id": "string",
173               "order_short_id": "string",
174               "task_group_id": "string",
175               "task_id": "string",
176               "created_by_org_id": "string",
177               "created_by_user_id": "string",
178               "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
179               "task_artifact_s3_object_metadata_ids": [
180                 "string"
181               ],
182               "requested_by_org_id": "string",
183               "requested_by_user_id": "string",
184               "completed_by_org_id": "string",
185               "completed_by_user_id": "string",
186               "status": "draft",
187               "staged_at_timestamp": "2024-01-15T09:30:00Z",
188               "completed_at_timestamp": "2024-01-15T09:30:00Z",
189               "skipped_at_timestamp": "2024-01-15T09:30:00Z",
190               "exception_at_timestamp": "2024-01-15T09:30:00Z"
191             }
192           ],
193           "shipper_contacts": [
194             {
195               "schema_version": 1,
196               "created_by_org_id": "string",
197               "created_by_user_id": "string",
198               "_id": "string",
199               "shipper_org_id": "string",
200               "shipper_user_id": "string",
201               "off_chrt_shipper_org_id": "string",
202               "company_name": "string",
203               "industry": "string",
204               "street_address": {
205                 "type": "string",
206                 "geometry": {
207                   "bbox": [
208                     "string"
209                   ],
210                   "type": "string",
211                   "coordinates": [
212                     "string"
213                   ]
214                 },
215                 "bbox": [
216                   "string"
217                 ],
218                 "properties": {
219                   "address": "string",
220                   "name": "string"
221                 },
222                 "id": 1
223               },
224               "contact_first_name": "string",
225               "contact_last_name": "string",
226               "phone_number_primary": "string",
227               "phone_number_secondary": "string",
228               "email_address_primary": "string",
229               "email_address_secondary": "string",
230               "job_title": "string",
231               "notes": "string"
232             }
233           ]
234         }
235       ],
236       "driver": {
237         "schema_version": 1,
238         "_id": "string",
239         "org_id": "string",
240         "user_id": "string",
241         "email_address_primary": "string",
242         "email_address_secondary": "string",
243         "phone_number_primary": "string",
244         "phone_number_secondary": "string",
245         "first_name": "string",
246         "last_name": "string",
247         "vehicle_types": [
248           "sedan"
249         ],
250         "status": "unassigned",
251         "available_according_to_driver": true,
252         "available_according_to_operators": true,
253         "active_task_group_ids": [
254           "string"
255         ],
256         "last_seen_at_location": {
257           "type": "string",
258           "geometry": {
259             "bbox": [
260               "string"
261             ],
262             "type": "string",
263             "coordinates": [
264               "string"
265             ]
266           },
267           "bbox": [
268             "string"
269           ],
270           "properties": {
271             "address": "string",
272             "name": "string"
273           },
274           "id": 1
275         },
276         "last_seen_at_timestamp": "2024-01-15T09:30:00Z"
277       },
278       "courier_org_company_name": "string",
279       "courier_org_handle": "string",
280       "forwarder_org_company_name": "string",
281       "forwarder_org_handle": "string",
282       "shipper_org_company_name": "string",
283       "off_chrt_shipper_org_company_name": "string"
284     }
285   ]
286 }

Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

Authentication

AuthorizationBearer

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

Path parameters

order_id_or_short_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_tasksbooleanOptionalDefaults to false

expand_cargosbooleanOptionalDefaults to false

expand_task_artifactsbooleanOptionalDefaults to false

expand_shipper_contactsbooleanOptionalDefaults to false

expand_driverbooleanOptionalDefaults to false

expand_courier_org_company_namebooleanOptionalDefaults to false

expand_courier_org_handlebooleanOptionalDefaults to false

Response

Successful Response

orderobject

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

task_groups_expandedlist of objects or null

Authentication

Path parameters

Request

Response

Errors