Retrieve for forwarder operators

POST

/shipping/task_groups/expanded/for_forwarder_operators/v1/:task_group_id

POST

/shipping/task_groups/expanded/for_forwarder_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.forForwarderOperatorsV1("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     "created_by_user_id": "created_by_user_id",
9     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
10     "task_group_type": "chrt_ground_courier",
11     "order_off_chrt_reference_id": "order_off_chrt_reference_id",
12     "task_ids": [
13       "task_ids"
14     ],
15     "courier_org_id": "courier_org_id",
16     "driver_id": "driver_id",
17     "service_type": "on_demand",
18     "task_group_s3_object_metadata_ids": [
19       "task_group_s3_object_metadata_ids"
20     ],
21     "status": "draft",
22     "staged_at_timestamp": "2024-01-15T09:30:00Z",
23     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
24     "completed_at_timestamp": "2024-01-15T09:30:00Z",
25     "skipped_at_timestamp": "2024-01-15T09:30:00Z",
26     "exception_at_timestamp": "2024-01-15T09:30:00Z",
27     "order_cancelled": true,
28     "tasks_mileage": 1.1,
29     "flight_number": "flight_number",
30     "fa_flight_ids": [
31       "fa_flight_ids"
32     ],
33     "messages": [
34       {
35         "message": "message",
36         "user_id": "user_id",
37         "org_id": "org_id",
38         "timestamp": "2024-01-15T09:30:00Z"
39       }
40     ],
41     "shipper_pay_forwarder_rate_sheet_id": "shipper_pay_forwarder_rate_sheet_id",
42     "shipper_pay_forwarder_line_item_group_id": "shipper_pay_forwarder_line_item_group_id",
43     "forwarder_pay_courier_rate_sheet_id": "forwarder_pay_courier_rate_sheet_id",
44     "forwarder_pay_courier_line_item_group_id": "forwarder_pay_courier_line_item_group_id",
45     "shipper_pay_courier_rate_sheet_id": "shipper_pay_courier_rate_sheet_id",
46     "shipper_pay_courier_line_item_group_id": "shipper_pay_courier_line_item_group_id",
47     "courier_pay_driver_rate_sheet_id": "courier_pay_driver_rate_sheet_id",
48     "courier_pay_driver_line_item_group_id": "courier_pay_driver_line_item_group_id"
49   },
50   "tasks_expanded": [
51     {
52       "task": {
53         "schema_version": 1,
54         "_id": "_id",
55         "order_id": "order_id",
56         "order_short_id": "order_short_id",
57         "task_group_id": "task_group_id",
58         "created_by_org_id": "created_by_org_id",
59         "created_by_user_id": "created_by_user_id",
60         "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
61       },
62       "cargos": [
63         {
64           "schema_version": 1,
65           "cargo_type": "spare_parts",
66           "_id": "_id",
67           "order_id": "order_id",
68           "order_short_id": "order_short_id",
69           "created_by_org_id": "created_by_org_id",
70           "created_by_user_id": "created_by_user_id",
71           "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
72         }
73       ],
74       "task_artifacts": [
75         {
76           "schema_version": 1,
77           "type": "image",
78           "_id": "_id",
79           "order_id": "order_id",
80           "order_short_id": "order_short_id",
81           "task_group_id": "task_group_id",
82           "task_id": "task_id",
83           "created_by_org_id": "created_by_org_id",
84           "created_by_user_id": "created_by_user_id",
85           "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
86         }
87       ],
88       "directory_entries": [
89         {
90           "schema_version": 1,
91           "created_by_org_id": "created_by_org_id",
92           "created_by_user_id": "created_by_user_id",
93           "_id": "_id"
94         }
95       ]
96     }
97   ],
98   "driver": {
99     "schema_version": 1,
100     "_id": "_id",
101     "org_id": "org_id",
102     "user_id": "user_id",
103     "email_address_primary": "email_address_primary",
104     "email_address_secondary": "email_address_secondary",
105     "phone_number_primary": "phone_number_primary",
106     "phone_number_secondary": "phone_number_secondary",
107     "first_name": "first_name",
108     "last_name": "last_name",
109     "vehicle_types": [
110       "sedan"
111     ],
112     "status": "unassigned",
113     "available_according_to_driver": true,
114     "available_according_to_operators": true,
115     "active_task_group_ids": [
116       "active_task_group_ids"
117     ],
118     "last_seen_at_location": {
119       "type": "Feature",
120       "geometry": {
121         "type": "GeometryCollection",
122         "geometries": [
123           {
124             "type": "LineString",
125             "coordinates": [
126               []
127             ]
128           }
129         ]
130       },
131       "id": 1
132     },
133     "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
134     "default_rate_sheet__routed": "default_rate_sheet__routed",
135     "default_rate_sheet__on_demand": "default_rate_sheet__on_demand"
136   },
137   "courier_org_company_name": "courier_org_company_name",
138   "courier_org_handle": "courier_org_handle",
139   "forwarder_org_company_name": "forwarder_org_company_name",
140   "forwarder_org_handle": "forwarder_org_handle",
141   "shipper_org_company_name": "shipper_org_company_name",
142   "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name"
143 }

Retrieves an expanded task group with optional related data for forwarder operators. | authz_personas=[forwarder_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_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

task_groupobject

tasks_expandedlist of objects

driverobject

courier_org_company_namestring

courier_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.

forwarder_org_company_namestring

forwarder_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_company_namestring

off_chrt_shipper_org_company_namestring

Errors

422

Expanded for Forwarder Operators V1request Unprocessable Entity Error