List for driver

POST

/shipping/task_groups/expanded/list/for_driver/v1

POST

/shipping/task_groups/expanded/list/for_driver/v1

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.listForDriverV1({
8         filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
9         filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
10         filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
11         filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
12         filter_coordinator_org_id: "filter_coordinator_org_id",
13         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
14         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
15         filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
16         filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
17         filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
18         filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
19         filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
20         filter_shipper_org_id: "filter_shipper_org_id",
21         filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
22         filter_skipped_at_timestamp_lte: "2024-01-15T09:30:00Z",
23         filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
24         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
25         filter_status: [
26             "draft",
27         ],
28         page: 1,
29         page_size: 1,
30         search: "search",
31         sort_by: "draft_started_at_timestamp",
32         sort_order: "asc",
33         body: {},
34     });
35 }
36 main();

1 {
2   "items": [
3     {
4       "task_group": {
5         "_id": "_id",
6         "created_by_org_id": "created_by_org_id",
7         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
8         "order_id": "order_id",
9         "order_short_id": "order_short_id",
10         "schema_version": 1,
11         "task_group_type": "chrt_ground_provider"
12       },
13       "awb_numbers": [
14         "awb_numbers"
15       ],
16       "coordinator_org_company_name": "coordinator_org_company_name",
17       "coordinator_org_handle": "coordinator_org_handle",
18       "coordinator_org_id": "coordinator_org_id",
19       "driver": {
20         "_id": "_id",
21         "org_id": "org_id",
22         "schema_version": 1,
23         "user_id": "user_id"
24       },
25       "executor_department": {
26         "_id": "_id",
27         "created_at": "2024-01-15T09:30:00Z",
28         "created_by_user_id": "created_by_user_id",
29         "department_type": "aerospace",
30         "name": "name",
31         "org_id": "org_id",
32         "schema_version": 1,
33         "short_id": "short_id"
34       },
35       "executor_org_company_name": "executor_org_company_name",
36       "executor_org_handle": "executor_org_handle",
37       "executor_org_id": "executor_org_id",
38       "off_chrt_executor_org_company_name": "off_chrt_executor_org_company_name",
39       "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
40       "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
41       "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
42       "shipper_org_company_name": "shipper_org_company_name",
43       "shipper_org_id": "shipper_org_id",
44       "tasks_expanded": [
45         {
46           "task": {
47             "_id": "_id",
48             "created_by_org_id": "created_by_org_id",
49             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
50             "order_id": "order_id",
51             "order_short_id": "order_short_id",
52             "schema_version": 1,
53             "task_group_id": "task_group_id"
54           }
55         }
56       ]
57     }
58   ],
59   "total_count": 1
60 }

Lists expanded task groups assigned to the caller (a driver of the executor provider) with filtering, sorting, pagination, and optional full-text search. | authz_personas=[driver_for_executor] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpandedListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenumOptional

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Full-text search query (searches order_short_id, order_off_chrt_reference_id)

filter_statusenumOptional

filter_draft_started_at_timestamp_ltedatetimeOptional

filter_draft_started_at_timestamp_gtedatetimeOptional

filter_staged_at_timestamp_ltedatetimeOptional

filter_staged_at_timestamp_gtedatetimeOptional

filter_in_progress_at_timestamp_ltedatetimeOptional

filter_in_progress_at_timestamp_gtedatetimeOptional

filter_completed_at_timestamp_ltedatetimeOptional

filter_completed_at_timestamp_gtedatetimeOptional

filter_skipped_at_timestamp_ltedatetimeOptional

filter_skipped_at_timestamp_gtedatetimeOptional

filter_cancelled_at_timestamp_ltedatetimeOptional

filter_cancelled_at_timestamp_gtedatetimeOptional

filter_exception_at_timestamp_ltedatetimeOptional

filter_exception_at_timestamp_gtedatetimeOptional

filter_coordinator_org_idstringOptional

filter_shipper_org_idstringOptional

filter_off_chrt_shipper_org_data_idstringOptional

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

itemslist of objects

total_countinteger

Errors

422

Expanded List for Driver V1request Unprocessable Entity Error