Retrieve (via POST) for provider operators

POST

/shipping/orders/expanded/for_provider_operators/v1/:order_ref

POST

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

1 {
2   "order": {
3     "_id": "_id",
4     "created_by_org_id": "created_by_org_id",
5     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
6     "schema_version": 1,
7     "short_id": "short_id",
8     "awb_numbers": [
9       "awb_numbers"
10     ],
11     "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
12     "completed_at_timestamp": "2024-01-15T09:30:00Z",
13     "coordinator_assigned_user_ids": [
14       "coordinator_assigned_user_ids"
15     ],
16     "coordinator_department_id": "coordinator_department_id",
17     "coordinator_label": "coordinator_label",
18     "coordinator_org_id": "coordinator_org_id",
19     "coordinator_shipper_account_ids": [
20       "coordinator_shipper_account_ids"
21     ],
22     "coordinator_task_lists_to_apply_at_order_staging": [
23       {
24         "task_list_id": "task_list_id"
25       }
26     ],
27     "created_by_user_id": "created_by_user_id",
28     "creation_idempotency_key": "creation_idempotency_key",
29     "exception_at_timestamp": "2024-01-15T09:30:00Z",
30     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
31     "invoice_ids": [
32       "invoice_ids"
33     ],
34     "off_chrt_reference_id": "off_chrt_reference_id",
35     "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
36     "order_classification_by_task_group_type": "chrt_ground_provider",
37     "order_schedule_id": "order_schedule_id",
38     "order_schedule_run_idempotency_key": "order_schedule_run_idempotency_key",
39     "order_template_id": "order_template_id",
40     "service_line": "on_demand",
41     "shipper_org_id": "shipper_org_id",
42     "staged_at_timestamp": "2024-01-15T09:30:00Z",
43     "status": "draft",
44     "task_group_details": [
45       {
46         "task_group_id": "task_group_id",
47         "task_group_type": "chrt_ground_provider"
48       }
49     ]
50   },
51   "provider_roles": [
52     "coordinator"
53   ],
54   "coordinator_org_company_name": "coordinator_org_company_name",
55   "coordinator_org_handle": "coordinator_org_handle",
56   "notification_intents_ad_hoc": [
57     {
58       "_id": "_id",
59       "contact_id": "contact_id",
60       "created_at_timestamp": "2024-01-15T09:30:00Z",
61       "created_by_org_id": "created_by_org_id",
62       "created_by_user_id": "created_by_user_id",
63       "schema_version": 1,
64       "email_events": [
65         "shipping.order.staged"
66       ],
67       "order_id": "order_id",
68       "push_events": [
69         "shipping.order.staged"
70       ],
71       "session_id": "session_id",
72       "sms_events": [
73         "shipping.order.staged"
74       ]
75     }
76   ],
77   "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
78   "shipper_org_company_name": "shipper_org_company_name",
79   "task_groups_expanded": [
80     {
81       "task_group": {
82         "_id": "_id",
83         "created_by_org_id": "created_by_org_id",
84         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
85         "order_id": "order_id",
86         "order_short_id": "order_short_id",
87         "schema_version": 1,
88         "task_group_type": "chrt_ground_provider"
89       },
90       "awb_numbers": [
91         "awb_numbers"
92       ],
93       "coordinator_org_company_name": "coordinator_org_company_name",
94       "coordinator_org_handle": "coordinator_org_handle",
95       "coordinator_org_id": "coordinator_org_id",
96       "driver": {
97         "_id": "_id",
98         "org_id": "org_id",
99         "schema_version": 1,
100         "user_id": "user_id"
101       },
102       "executor_org_company_name": "executor_org_company_name",
103       "executor_org_handle": "executor_org_handle",
104       "executor_org_id": "executor_org_id",
105       "off_chrt_executor_org_company_name": "off_chrt_executor_org_company_name",
106       "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
107       "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
108       "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
109       "shipper_org_company_name": "shipper_org_company_name",
110       "shipper_org_id": "shipper_org_id",
111       "tasks_expanded": [
112         {
113           "task": {
114             "_id": "_id",
115             "created_by_org_id": "created_by_org_id",
116             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
117             "order_id": "order_id",
118             "order_short_id": "order_short_id",
119             "schema_version": 1,
120             "task_group_id": "task_group_id"
121           }
122         }
123       ]
124     }
125   ]
126 }

Retrieves an expanded order for a provider org that is the coordinator, an executor, or both, with role-filtered task-group details. Mirrors the per-item projection of the for_provider_operators list route. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpandedForProvider)

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

Provider view: full order when coordinator; when executor only, task groups are filtered to the provider’s own and other executors’ operational fields are redacted.

provider_roleslist of enums

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