List (via POST) for executor operators

POST

/shipping/orders/expanded/list/for_executor_operators/v1

POST

/shipping/orders/expanded/list/for_executor_operators/v1

1 const url = 'https://localhost:8000/shipping/orders/expanded/list/for_executor_operators/v1?filter_awb_number=filter_awb_number&filter_cancelled_at_timestamp_gte=2024-01-15T09%3A30%3A00Z&filter_cancelled_at_timestamp_lte=2024-01-15T09%3A30%3A00Z&filter_completed_at_timestamp_gte=2024-01-15T09%3A30%3A00Z&filter_completed_at_timestamp_lte=2024-01-15T09%3A30%3A00Z&filter_coordinator_org_id=filter_coordinator_org_id&filter_draft_started_at_timestamp_gte=2024-01-15T09%3A30%3A00Z&filter_draft_started_at_timestamp_lte=2024-01-15T09%3A30%3A00Z&filter_exception_at_timestamp_gte=2024-01-15T09%3A30%3A00Z&filter_exception_at_timestamp_lte=2024-01-15T09%3A30%3A00Z&filter_has_invoice=true&filter_in_progress_at_timestamp_gte=2024-01-15T09%3A30%3A00Z&filter_in_progress_at_timestamp_lte=2024-01-15T09%3A30%3A00Z&filter_off_chrt_shipper_org_data_id=filter_off_chrt_shipper_org_data_id&filter_order_classification_by_task_group_type=%5B%22chrt_ground_provider%22%5D&filter_service_line=%5B%22on_demand%22%5D&filter_shipper_org_id=filter_shipper_org_id&filter_staged_at_timestamp_gte=2024-01-15T09%3A30%3A00Z&filter_staged_at_timestamp_lte=2024-01-15T09%3A30%3A00Z&filter_status=%5B%22draft%22%5D&page=1&page_size=1&search=search&sort_by=draft_started_at_timestamp&sort_order=asc';
2 const options = {
3   method: 'POST',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "items": [
3     {
4       "order": {
5         "_id": "_id",
6         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
7         "schema_version": 1,
8         "short_id": "short_id"
9       },
10       "coordinator_org_company_name": "coordinator_org_company_name",
11       "coordinator_org_handle": "coordinator_org_handle",
12       "notification_intents_ad_hoc": [
13         {
14           "_id": "_id",
15           "contact_id": "contact_id",
16           "created_at_timestamp": "2024-01-15T09:30:00Z",
17           "created_by_org_id": "created_by_org_id",
18           "created_by_user_id": "created_by_user_id",
19           "schema_version": 1
20         }
21       ],
22       "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
23       "shipper_org_company_name": "shipper_org_company_name",
24       "task_groups_expanded": [
25         {
26           "task_group": {
27             "_id": "_id",
28             "created_by_org_id": "created_by_org_id",
29             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
30             "order_id": "order_id",
31             "order_short_id": "order_short_id",
32             "schema_version": 1,
33             "task_group_type": "chrt_ground_provider"
34           }
35         }
36       ]
37     }
38   ],
39   "total_count": 1
40 }

Lists expanded orders where the caller’s provider org executes at least one task group. Each result contains only that org’s task groups. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListForExecutorRes)

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, off-CHRT reference ID, and AWB)

filter_statusenumOptional

filter_service_lineenumOptional

Filter by service line

Allowed values:

filter_order_classification_by_task_group_typeenumOptional

Filter by global order classification (OBC takes precedence over flight, then ground)

Allowed values:

filter_awb_numberstringOptionalformat: "^\d{3}-\d{8}$"

Filter by exact AWB number

filter_has_invoicebooleanOptional

Filter by whether the order has any invoice

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_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_cargosbooleanOptionalDefaults to false

expand_contactsbooleanOptionalDefaults to false

expand_coordinator_org_company_namebooleanOptionalDefaults to false

expand_coordinator_org_handlebooleanOptionalDefaults to false

expand_driverbooleanOptionalDefaults 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 Executor Operators V1request Unprocessable Entity Error