Retrieve (via POST) for executor operators

POST

/shipping/orders/expanded/for_executor_operators/v1/:order_ref

POST

/shipping/orders/expanded/for_executor_operators/v1/:order_ref

1 const url = 'https://localhost:8000/shipping/orders/expanded/for_executor_operators/v1/order_ref';
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   "order": {
3     "_id": "_id",
4     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
5     "schema_version": 1,
6     "short_id": "short_id",
7     "awb_numbers": [
8       "awb_numbers"
9     ],
10     "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
11     "completed_at_timestamp": "2024-01-15T09:30:00Z",
12     "exception_at_timestamp": "2024-01-15T09:30:00Z",
13     "executor_task_group_details": [
14       {
15         "task_group_id": "task_group_id",
16         "task_group_type": "chrt_ground_provider"
17       }
18     ],
19     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
20     "invoice_ids": [
21       "invoice_ids"
22     ],
23     "off_chrt_reference_id": "off_chrt_reference_id",
24     "order_classification_by_task_group_type": "chrt_ground_provider",
25     "service_line": "on_demand",
26     "staged_at_timestamp": "2024-01-15T09:30:00Z",
27     "status": "draft"
28   },
29   "coordinator_org_company_name": "coordinator_org_company_name",
30   "coordinator_org_handle": "coordinator_org_handle",
31   "notification_intents_ad_hoc": [
32     {
33       "_id": "_id",
34       "contact_id": "contact_id",
35       "created_at_timestamp": "2024-01-15T09:30:00Z",
36       "created_by_org_id": "created_by_org_id",
37       "created_by_user_id": "created_by_user_id",
38       "schema_version": 1,
39       "email_events": [
40         "shipping.order.staged"
41       ],
42       "order_id": "order_id",
43       "push_events": [
44         "shipping.order.staged"
45       ],
46       "session_id": "session_id",
47       "sms_events": [
48         "shipping.order.staged"
49       ]
50     }
51   ],
52   "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
53   "shipper_org_company_name": "shipper_org_company_name",
54   "task_groups_expanded": [
55     {
56       "task_group": {
57         "_id": "_id",
58         "created_by_org_id": "created_by_org_id",
59         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
60         "order_id": "order_id",
61         "order_short_id": "order_short_id",
62         "schema_version": 1,
63         "task_group_type": "chrt_ground_provider"
64       },
65       "awb_numbers": [
66         "awb_numbers"
67       ],
68       "coordinator_org_company_name": "coordinator_org_company_name",
69       "coordinator_org_handle": "coordinator_org_handle",
70       "coordinator_org_id": "coordinator_org_id",
71       "driver": {
72         "_id": "_id",
73         "org_id": "org_id",
74         "schema_version": 1,
75         "user_id": "user_id"
76       },
77       "executor_org_company_name": "executor_org_company_name",
78       "executor_org_handle": "executor_org_handle",
79       "executor_org_id": "executor_org_id",
80       "off_chrt_executor_org_company_name": "off_chrt_executor_org_company_name",
81       "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
82       "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
83       "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
84       "shipper_org_company_name": "shipper_org_company_name",
85       "shipper_org_id": "shipper_org_id",
86       "tasks_expanded": [
87         {
88           "task": {
89             "_id": "_id",
90             "created_by_org_id": "created_by_org_id",
91             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
92             "order_id": "order_id",
93             "order_short_id": "order_short_id",
94             "schema_version": 1,
95             "task_group_id": "task_group_id"
96           }
97         }
98       ]
99     }
100   ]
101 }

Retrieves an expanded order containing only task groups executed by the caller’s provider org. | authz_personas=[order_executor_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpandedForExecutor)

Authentication

AuthorizationBearer

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

Path parameters

order_refstringRequired

Order ID, short ID, or off-chrt reference ID

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

orderobject

Executor view: parties, provenance, and coordinator fields hidden; only the executor’s own task-group details.

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.

notification_intents_ad_hoclist of objectsOptional

off_chrt_shipper_org_company_namestringOptional

shipper_org_company_namestringOptional

task_groups_expandedlist of objectsOptional

Errors

422

Expanded for Executor Operators V1request Unprocessable Entity Error