Retrieve for executor operators

POST

/shipping/task_groups/expanded/for_executor_operators/v1/:task_group_id

POST

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

1 {
2   "task_group": {
3     "schema_version": 1,
4     "_id": "_id",
5     "order_id": "order_id",
6     "order_short_id": "order_short_id",
7     "created_by_org_id": "created_by_org_id",
8     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
9     "task_group_type": "chrt_ground_provider",
10     "order_off_chrt_reference_id": "order_off_chrt_reference_id",
11     "task_ids": [
12       "task_ids"
13     ],
14     "order_schedule_id": "order_schedule_id",
15     "order_schedule_run_idempotency_key": "order_schedule_run_idempotency_key",
16     "order_schedule_template_path": "order_schedule_template_path",
17     "created_by_user_id": "created_by_user_id",
18     "shipper_org_id": "shipper_org_id",
19     "off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
20     "coordinator_org_id": "coordinator_org_id",
21     "executor_org_id": "executor_org_id",
22     "off_chrt_executor_org_id": "off_chrt_executor_org_id",
23     "driver_id": "driver_id",
24     "task_group_s3_object_metadata_ids": [
25       "task_group_s3_object_metadata_ids"
26     ],
27     "status": "draft",
28     "order_cancelled": true,
29     "staged_at_timestamp": "2024-01-15T09:30:00Z",
30     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
31     "completed_at_timestamp": "2024-01-15T09:30:00Z",
32     "skipped_at_timestamp": "2024-01-15T09:30:00Z",
33     "exception_at_timestamp": "2024-01-15T09:30:00Z",
34     "mileage_estimated": 1.1,
35     "mileage_observed": 1.1,
36     "mileage_asserted": true,
37     "flight_number": "flight_number",
38     "fa_flight_ids": [
39       "fa_flight_ids"
40     ],
41     "messages": [
42       {
43         "message": "message",
44         "user_id": "user_id",
45         "org_id": "org_id",
46         "timestamp": "2024-01-15T09:30:00Z"
47       }
48     ],
49     "shipper_pay_provider_rate_sheet_id": "shipper_pay_provider_rate_sheet_id",
50     "shipper_pay_provider_line_item_group_id": "shipper_pay_provider_line_item_group_id",
51     "shipper_pay_provider_billing_ledger_period_id": "shipper_pay_provider_billing_ledger_period_id",
52     "provider_pay_provider_rate_sheet_id": "provider_pay_provider_rate_sheet_id",
53     "provider_pay_provider_line_item_group_id": "provider_pay_provider_line_item_group_id",
54     "provider_pay_provider_billing_ledger_period_id": "provider_pay_provider_billing_ledger_period_id",
55     "provider_pay_driver_rate_sheet_id": "provider_pay_driver_rate_sheet_id",
56     "provider_pay_driver_line_item_group_id": "provider_pay_driver_line_item_group_id",
57     "provider_pay_driver_billing_ledger_period_id": "provider_pay_driver_billing_ledger_period_id"
58   },
59   "tasks_expanded": [
60     {
61       "task": {
62         "schema_version": 1,
63         "_id": "_id",
64         "order_id": "order_id",
65         "order_short_id": "order_short_id",
66         "task_group_id": "task_group_id",
67         "created_by_org_id": "created_by_org_id",
68         "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
69       },
70       "cargos": [
71         {
72           "schema_version": 1,
73           "cargo_type": "spare_parts",
74           "_id": "_id",
75           "order_id": "order_id",
76           "order_short_id": "order_short_id",
77           "created_by_org_id": "created_by_org_id",
78           "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
79         }
80       ],
81       "task_artifacts": [
82         {
83           "schema_version": 1,
84           "type": "image",
85           "_id": "_id",
86           "order_id": "order_id",
87           "order_short_id": "order_short_id",
88           "task_group_id": "task_group_id",
89           "task_id": "task_id",
90           "created_by_org_id": "created_by_org_id",
91           "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
92         }
93       ],
94       "directory_entries": [
95         {
96           "schema_version": 1,
97           "created_by_org_id": "created_by_org_id",
98           "created_by_user_id": "created_by_user_id",
99           "_id": "_id"
100         }
101       ]
102     }
103   ],
104   "driver": {
105     "schema_version": 1,
106     "_id": "_id",
107     "org_id": "org_id",
108     "user_id": "user_id",
109     "email_address_primary": "email_address_primary",
110     "email_address_secondary": "email_address_secondary",
111     "phone_number_primary": "phone_number_primary",
112     "phone_number_secondary": "phone_number_secondary",
113     "first_name": "first_name",
114     "last_name": "last_name",
115     "vehicle_types": [
116       "sedan"
117     ],
118     "status": "unassigned",
119     "available_according_to_driver": true,
120     "available_according_to_operators": true,
121     "auto_assign_enabled": true,
122     "active_task_group_ids": [
123       "active_task_group_ids"
124     ],
125     "last_seen_at_location": {
126       "type": "Feature",
127       "geometry": {
128         "type": "GeometryCollection",
129         "geometries": [
130           {
131             "type": "LineString",
132             "coordinates": [
133               []
134             ]
135           }
136         ]
137       },
138       "id": 1
139     },
140     "last_seen_at_timestamp": "2024-01-15T09:30:00Z"
141   },
142   "executor_org_id": "executor_org_id",
143   "executor_org_company_name": "executor_org_company_name",
144   "executor_org_handle": "executor_org_handle",
145   "coordinator_org_id": "coordinator_org_id",
146   "coordinator_org_company_name": "coordinator_org_company_name",
147   "coordinator_org_handle": "coordinator_org_handle",
148   "shipper_org_id": "shipper_org_id",
149   "shipper_org_company_name": "shipper_org_company_name",
150   "off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
151   "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name"
152 }

Retrieves an expanded task group with optional related data for executor operators (the provider org doing the work on this task group). | authz_personas=[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_coordinator_org_company_namebooleanOptionalDefaults to false

expand_coordinator_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_executor_org_company_namebooleanOptionalDefaults to false

expand_executor_org_handlebooleanOptionalDefaults to false

Response

Successful Response

task_groupobject

tasks_expandedlist of objects

driverobject

executor_org_idstring

Must be a string starting with org_

executor_org_company_namestring

executor_org_handlestringformat: "^@[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_idstring

Must be a string starting with org_

coordinator_org_company_namestring

coordinator_org_handlestringformat: "^@[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.

shipper_org_idstring

Must be a string starting with org_

shipper_org_company_namestring

off_chrt_shipper_org_idstring

off_chrt_shipper_org_company_namestring

Errors

422

Expanded for Executor Operators V1request Unprocessable Entity Error