Retrieve for provider operators

POST

/shipping/task_groups/expanded/for_provider_operators/v1/:task_group_id

POST

/shipping/task_groups/expanded/for_provider_operators/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.forProviderOperatorsV1("task_group_id", {});
8 }
9 main();

1 {
2   "task_group": {
3     "_id": "_id",
4     "created_by_org_id": "created_by_org_id",
5     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
6     "order_id": "order_id",
7     "order_short_id": "order_short_id",
8     "schema_version": 1,
9     "task_group_type": "chrt_ground_provider",
10     "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
11     "completed_at_timestamp": "2024-01-15T09:30:00Z",
12     "coordinator_org_id": "coordinator_org_id",
13     "coordinator_setup_notes": "coordinator_setup_notes",
14     "created_by_user_id": "created_by_user_id",
15     "driver_id": "driver_id",
16     "exception_at_timestamp": "2024-01-15T09:30:00Z",
17     "executor_org_id": "executor_org_id",
18     "flight_leg_ids": [
19       "flight_leg_ids"
20     ],
21     "flight_setup_notes": "flight_setup_notes",
22     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
23     "messages": [
24       {
25         "message": "message",
26         "org_id": "org_id",
27         "timestamp": "2024-01-15T09:30:00Z",
28         "user_id": "user_id"
29       }
30     ],
31     "mileage_estimated": 1.1,
32     "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
33     "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
34     "order_off_chrt_reference_id": "order_off_chrt_reference_id",
35     "shipper_org_id": "shipper_org_id",
36     "skipped_at_timestamp": "2024-01-15T09:30:00Z",
37     "staged_at_timestamp": "2024-01-15T09:30:00Z",
38     "status": "draft",
39     "task_group_s3_object_metadata_ids": [
40       "task_group_s3_object_metadata_ids"
41     ],
42     "task_ids": [
43       "task_ids"
44     ],
45     "vehicle_type": "sedan",
46     "wait_time_total_minutes": 1.1
47   },
48   "awb_numbers": [
49     "awb_numbers"
50   ],
51   "coordinator_org_company_name": "coordinator_org_company_name",
52   "coordinator_org_handle": "coordinator_org_handle",
53   "coordinator_org_id": "coordinator_org_id",
54   "driver": {
55     "_id": "_id",
56     "org_id": "org_id",
57     "schema_version": 1,
58     "user_id": "user_id",
59     "auto_assign_enabled": true,
60     "available_according_to_driver": true,
61     "available_according_to_operators": true,
62     "email_address_primary": "email_address_primary",
63     "email_address_secondary": "email_address_secondary",
64     "first_name": "first_name",
65     "last_name": "last_name",
66     "last_seen_at_location": {
67       "geometry": {
68         "type": "GeometryCollection",
69         "geometries": [
70           {
71             "type": "LineString",
72             "coordinates": [
73               []
74             ]
75           }
76         ]
77       },
78       "type": "Feature",
79       "id": 1
80     },
81     "last_seen_at_location_city": "last_seen_at_location_city",
82     "last_seen_at_location_large_city": "last_seen_at_location_large_city",
83     "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
84     "phone_number_primary": "phone_number_primary",
85     "phone_number_secondary": "phone_number_secondary",
86     "status": "unassigned",
87     "vehicle_types": [
88       "sedan"
89     ],
90     "waiting": true
91   },
92   "executor_department": {
93     "_id": "_id",
94     "created_at": "2024-01-15T09:30:00Z",
95     "created_by_user_id": "created_by_user_id",
96     "department_type": "aerospace",
97     "name": "name",
98     "org_id": "org_id",
99     "schema_version": 1,
100     "short_id": "short_id",
101     "location": {
102       "geometry": {
103         "type": "GeometryCollection",
104         "geometries": [
105           {
106             "type": "LineString",
107             "coordinates": [
108               []
109             ]
110           }
111         ]
112       },
113       "type": "Feature",
114       "id": 1
115     },
116     "operator_user_ids": [
117       "operator_user_ids"
118     ]
119   },
120   "executor_org_company_name": "executor_org_company_name",
121   "executor_org_handle": "executor_org_handle",
122   "executor_org_id": "executor_org_id",
123   "off_chrt_executor_org_company_name": "off_chrt_executor_org_company_name",
124   "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
125   "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
126   "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
127   "shipper_org_company_name": "shipper_org_company_name",
128   "shipper_org_id": "shipper_org_id",
129   "tasks_expanded": [
130     {
131       "task": {
132         "_id": "_id",
133         "created_by_org_id": "created_by_org_id",
134         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
135         "order_id": "order_id",
136         "order_short_id": "order_short_id",
137         "schema_version": 1,
138         "task_group_id": "task_group_id"
139       },
140       "cargos": [
141         {
142           "_id": "_id",
143           "cargo_type": "spare_parts",
144           "created_by_org_id": "created_by_org_id",
145           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
146           "order_id": "order_id",
147           "order_short_id": "order_short_id",
148           "schema_version": 1
149         }
150       ],
151       "contacts": [
152         {
153           "_id": "_id",
154           "created_by_org_id": "created_by_org_id",
155           "name": "name",
156           "schema_version": 1
157         }
158       ],
159       "task_artifacts": [
160         {
161           "_id": "_id",
162           "created_by_org_id": "created_by_org_id",
163           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
164           "order_id": "order_id",
165           "order_short_id": "order_short_id",
166           "schema_version": 1,
167           "task_group_id": "task_group_id",
168           "task_id": "task_id",
169           "type": "image"
170         }
171       ]
172     }
173   ]
174 }

Retrieves an expanded task group when the caller’s provider org is its coordinator, executor, or both. Coordinator-only callers receive empty executor_org_notes; executor-only callers receive empty coordinator_shipper_account_ids. Executor notes are limited to the caller’s org. | authz_personas=[coordinator_org_operators, executor_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)

Retrieves an expanded task group when the caller's provider org is its coordinator, executor, or both. Coordinator-only callers receive empty executor_org_notes; executor-only callers receive empty coordinator_shipper_account_ids. Executor notes are limited to the caller's org. | authz_personas=[coordinator_org_operators, executor_org_operators] | (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_accountsbooleanOptionalDefaults to false

expand_cargosbooleanOptionalDefaults to false

expand_contactsbooleanOptionalDefaults to false

expand_coordinator_departmentbooleanOptionalDefaults to false

expand_coordinator_org_company_namebooleanOptionalDefaults to false

expand_coordinator_org_handlebooleanOptionalDefaults to false

expand_coordinator_task_lists_to_apply_at_order_stagingbooleanOptionalDefaults to false

expand_driverbooleanOptionalDefaults to false

expand_executor_departmentbooleanOptionalDefaults to false

expand_executor_org_company_namebooleanOptionalDefaults to false

expand_executor_org_handlebooleanOptionalDefaults to false

expand_notification_intents_ad_hocbooleanOptionalDefaults to false

expand_off_chrt_shipper_org_company_namebooleanOptionalDefaults to false

expand_shipper_org_company_namebooleanOptionalDefaults to false

expand_task_artifactsbooleanOptionalDefaults to false

expand_tasksbooleanOptionalDefaults to false

Response

Successful Response

task_groupobject

awb_numberslist of stringsOptional

coordinator_org_company_namestringOptional

coordinator_org_handlestringOptionalformat: "^@[a-zA-Z0-9_-]+$"2-30 characters

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

coordinator_org_idstringOptional

Must be a string starting with org_

driverobjectOptional

executor_departmentobjectOptional

executor_org_company_namestringOptional

executor_org_handlestringOptionalformat: "^@[a-zA-Z0-9_-]+$"2-30 characters

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

executor_org_idstringOptional

Must be a string starting with org_

off_chrt_executor_org_company_namestringOptional

off_chrt_executor_org_data_idstringOptional

off_chrt_shipper_org_company_namestringOptional

off_chrt_shipper_org_data_idstringOptional

shipper_org_company_namestringOptional

shipper_org_idstringOptional

Must be a string starting with org_

tasks_expandedlist of objectsOptional

Errors

422

Expanded for Provider Operators V1request Unprocessable Entity Error