Retrieve (via POST) for shipper operators

POST

/shipping/orders/expanded/for_shipper_operators/v1/:order_ref

POST

/shipping/orders/expanded/for_shipper_operators/v1/:order_ref

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.orders.expanded.forShipperOperatorsV1("order_ref", {});
8 }
9 main();

1 {
2   "order": {
3     "_id": "_id",
4     "created_by_org_id": "created_by_org_id",
5     "created_by_user_id": "created_by_user_id",
6     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
7     "schema_version": 1,
8     "short_id": "short_id",
9     "awb_numbers": [
10       "awb_numbers"
11     ],
12     "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
13     "completed_at_timestamp": "2024-01-15T09:30:00Z",
14     "coordinator_org_id": "coordinator_org_id",
15     "creation_idempotency_key": "creation_idempotency_key",
16     "exception_at_timestamp": "2024-01-15T09:30:00Z",
17     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
18     "invoice_ids": [
19       "invoice_ids"
20     ],
21     "off_chrt_reference_id": "off_chrt_reference_id",
22     "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
23     "order_classification_by_task_group_type": "chrt_ground_provider",
24     "order_schedule_id": "order_schedule_id",
25     "order_schedule_run_idempotency_key": "order_schedule_run_idempotency_key",
26     "order_template_new_id": "order_template_new_id",
27     "service_line": "on_demand",
28     "shipper_org_id": "shipper_org_id",
29     "staged_at_timestamp": "2024-01-15T09:30:00Z",
30     "status": "draft",
31     "task_group_details": [
32       {
33         "task_group_id": "task_group_id",
34         "task_group_type": "chrt_ground_provider"
35       }
36     ]
37   },
38   "coordinator_org_company_name": "coordinator_org_company_name",
39   "coordinator_org_handle": "coordinator_org_handle",
40   "coordinator_shipper_accounts": [
41     {
42       "_id": "_id",
43       "created_by_org_id": "created_by_org_id",
44       "created_by_user_id": "created_by_user_id",
45       "name": "name",
46       "schema_version": 1,
47       "location": {
48         "geometry": {
49           "type": "GeometryCollection",
50           "geometries": [
51             {
52               "type": "LineString",
53               "coordinates": [
54                 []
55               ]
56             }
57           ]
58         },
59         "type": "Feature"
60       },
61       "off_chrt_org_data_id": "off_chrt_org_data_id",
62       "org_id": "org_id"
63     }
64   ],
65   "notification_intents_ad_hoc": [
66     {
67       "_id": "_id",
68       "contact_id": "contact_id",
69       "created_at_timestamp": "2024-01-15T09:30:00Z",
70       "created_by_org_id": "created_by_org_id",
71       "created_by_user_id": "created_by_user_id",
72       "schema_version": 1,
73       "email_events": [
74         "shipping.order.staged"
75       ],
76       "order_id": "order_id",
77       "push_events": [
78         "shipping.order.staged"
79       ],
80       "session_id": "session_id",
81       "sms_events": [
82         "shipping.order.staged"
83       ]
84     }
85   ],
86   "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
87   "shipper_org_company_name": "shipper_org_company_name",
88   "task_groups_expanded": [
89     {
90       "task_group": {
91         "_id": "_id",
92         "created_by_org_id": "created_by_org_id",
93         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
94         "order_id": "order_id",
95         "order_short_id": "order_short_id",
96         "schema_version": 1,
97         "task_group_type": "chrt_ground_provider"
98       },
99       "awb_numbers": [
100         "awb_numbers"
101       ],
102       "coordinator_org_company_name": "coordinator_org_company_name",
103       "coordinator_org_handle": "coordinator_org_handle",
104       "coordinator_org_id": "coordinator_org_id",
105       "driver": {
106         "_id": "_id",
107         "org_id": "org_id",
108         "schema_version": 1,
109         "user_id": "user_id"
110       },
111       "executor_department": {
112         "_id": "_id",
113         "created_at": "2024-01-15T09:30:00Z",
114         "created_by_user_id": "created_by_user_id",
115         "department_type": "aerospace",
116         "name": "name",
117         "org_id": "org_id",
118         "schema_version": 1,
119         "short_id": "short_id"
120       },
121       "executor_org_company_name": "executor_org_company_name",
122       "executor_org_handle": "executor_org_handle",
123       "executor_org_id": "executor_org_id",
124       "off_chrt_executor_org_company_name": "off_chrt_executor_org_company_name",
125       "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
126       "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
127       "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
128       "shipper_org_company_name": "shipper_org_company_name",
129       "shipper_org_id": "shipper_org_id",
130       "tasks_expanded": [
131         {
132           "task": {
133             "_id": "_id",
134             "created_by_org_id": "created_by_org_id",
135             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
136             "order_id": "order_id",
137             "order_short_id": "order_short_id",
138             "schema_version": 1,
139             "task_group_id": "task_group_id"
140           }
141         }
142       ]
143     }
144   ],
145   "unassigned_cargos": [
146     {
147       "_id": "_id",
148       "cargo_type": "spare_parts",
149       "created_by_org_id": "created_by_org_id",
150       "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
151       "order_id": "order_id",
152       "order_short_id": "order_short_id",
153       "schema_version": 1,
154       "awb_number": "awb_number",
155       "awb_number_line_items_generated": true,
156       "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
157       "created_by_user_id": "created_by_user_id",
158       "delivered_at_timestamp": "2024-01-15T09:30:00Z",
159       "description": "description",
160       "device_ids": [
161         "device_ids"
162       ],
163       "exception_at_timestamp": "2024-01-15T09:30:00Z",
164       "girth_inches": 1.1,
165       "height_inches": 1.1,
166       "in_transit_at_timestamp": "2024-01-15T09:30:00Z",
167       "length_inches": 1.1,
168       "quantity": 1,
169       "skipped_at_timestamp": "2024-01-15T09:30:00Z",
170       "stackable": true,
171       "staged_at_timestamp": "2024-01-15T09:30:00Z",
172       "status": "draft",
173       "turnable": true,
174       "weight_pounds": 1.1,
175       "width_inches": 1.1
176     }
177   ]
178 }

Retrieves an expanded order with optional related data for shipper operators. Drafts are visible only to operators in the creating shipper org; when expand_cargos is requested, the response includes unassigned_cargos. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpandedForShipper)

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_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

orderobject

Shipper view: coordinator operational fields hidden; task groups reduced to shared executor identifiers.

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.

coordinator_shipper_accountslist of objectsOptional

notification_intents_ad_hoclist of objectsOptional

off_chrt_shipper_org_company_namestringOptional

shipper_org_company_namestringOptional

task_groups_expandedlist of objectsOptional

unassigned_cargoslist of objectsOptional

Errors

422

Expanded for Shipper Operators V1request Unprocessable Entity Error