Retrieve (via POST) for coordinator operators

POST

/shipping/orders/expanded/for_coordinator_operators/v1/:order_ref

POST

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

1 {
2   "order": {
3     "schema_version": 1,
4     "_id": "_id",
5     "short_id": "short_id",
6     "created_by_org_id": "created_by_org_id",
7     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
8     "task_group_ids": [
9       "task_group_ids"
10     ],
11     "off_chrt_reference_id": "off_chrt_reference_id",
12     "order_schedule_id": "order_schedule_id",
13     "order_schedule_run_idempotency_key": "order_schedule_run_idempotency_key",
14     "created_by_user_id": "created_by_user_id",
15     "shipper_org_id": "shipper_org_id",
16     "off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
17     "coordinator_org_id": "coordinator_org_id",
18     "executor_org_ids": [
19       "executor_org_ids"
20     ],
21     "off_chrt_executor_org_ids": [
22       "off_chrt_executor_org_ids"
23     ],
24     "status": "draft",
25     "staged_at_timestamp": "2024-01-15T09:30:00Z",
26     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
27     "completed_at_timestamp": "2024-01-15T09:30:00Z",
28     "exception_at_timestamp": "2024-01-15T09:30:00Z",
29     "order_cancelled": true,
30     "order_cancelled_at_timestamp": "2024-01-15T09:30:00Z"
31   },
32   "coordinator_org_company_name": "coordinator_org_company_name",
33   "coordinator_org_handle": "coordinator_org_handle",
34   "shipper_org_company_name": "shipper_org_company_name",
35   "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
36   "notification_intents_ad_hoc": [
37     {
38       "schema_version": 1,
39       "created_at_timestamp": "2024-01-15T09:30:00Z",
40       "created_by_org_id": "created_by_org_id",
41       "created_by_user_id": "created_by_user_id",
42       "order_id": "order_id",
43       "directory_entry_id": "directory_entry_id",
44       "_id": "_id",
45       "email_events": [
46         "shipping.order.staged"
47       ],
48       "push_events": [
49         "shipping.order.staged"
50       ],
51       "sms_events": [
52         "shipping.order.staged"
53       ]
54     }
55   ],
56   "task_groups_expanded": [
57     {
58       "task_group": {
59         "schema_version": 1,
60         "_id": "_id",
61         "order_id": "order_id",
62         "order_short_id": "order_short_id",
63         "created_by_org_id": "created_by_org_id",
64         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
65         "task_group_type": "chrt_ground_provider"
66       },
67       "tasks_expanded": [
68         {
69           "task": {
70             "schema_version": 1,
71             "_id": "_id",
72             "order_id": "order_id",
73             "order_short_id": "order_short_id",
74             "task_group_id": "task_group_id",
75             "created_by_org_id": "created_by_org_id",
76             "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
77           }
78         }
79       ],
80       "driver": {
81         "schema_version": 1,
82         "_id": "_id",
83         "org_id": "org_id",
84         "user_id": "user_id"
85       },
86       "executor_org_id": "executor_org_id",
87       "executor_org_company_name": "executor_org_company_name",
88       "executor_org_handle": "executor_org_handle",
89       "coordinator_org_id": "coordinator_org_id",
90       "coordinator_org_company_name": "coordinator_org_company_name",
91       "coordinator_org_handle": "coordinator_org_handle",
92       "shipper_org_id": "shipper_org_id",
93       "shipper_org_company_name": "shipper_org_company_name",
94       "off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
95       "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name"
96     }
97   ]
98 }

Retrieves an expanded order with optional related data for coordinator operators (the provider org coordinating the order). | authz_personas=[coordinator_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

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_coordinator_org_company_namebooleanOptionalDefaults to false

expand_coordinator_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_executor_org_company_namebooleanOptionalDefaults to false

expand_executor_org_handlebooleanOptionalDefaults to false

Response

Successful Response

orderobject

coordinator_org_company_namestring

coordinator_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

notification_intents_ad_hoclist of objects

task_groups_expandedlist of objects

Errors

422

Expanded for Coordinator Operators V1request Unprocessable Entity Error