Retrieve expanded draft for shipper operators

POST

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

POST

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

1 {
2   "order": {
3     "_id": "order_123abc456def",
4     "created_by_org_id": "org_123456789",
5     "draft_started_at_timestamp": "2024-01-10T08:00:00Z",
6     "schema_version": 1,
7     "short_id": "ORD12345",
8     "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
9     "completed_at_timestamp": "2024-01-15T09:30:00Z",
10     "coordinator_org_id": "org_987654321",
11     "created_by_user_id": "user_987654321",
12     "creation_idempotency_key": "idempkey_20240115_0930",
13     "exception_at_timestamp": "2024-01-15T09:30:00Z",
14     "in_progress_at_timestamp": "2024-01-12T14:00:00Z",
15     "off_chrt_reference_id": "offchrt_ref_001",
16     "off_chrt_shipper_org_data_id": "offchrt_data_001",
17     "order_schedule_id": "sched_20240115",
18     "order_schedule_run_idempotency_key": "runidemp_20240115",
19     "order_template_id": "template_001",
20     "shipper_org_id": "org_123456789",
21     "staged_at_timestamp": "2024-01-11T10:00:00Z",
22     "status": "draft",
23     "task_group_details": [
24       {
25         "task_group_id": "tg_00123456789"
26       }
27     ]
28   },
29   "coordinator_org_company_name": "Global Logistics Inc.",
30   "coordinator_org_handle": "@GlobalLogistics",
31   "notification_intents_ad_hoc": [
32     {
33       "_id": "notif_1234567890",
34       "created_at_timestamp": "2024-01-15T09:30:00Z",
35       "created_by_org_id": "org_987654321",
36       "created_by_user_id": "user_123456789",
37       "directory_entry_id": "dir_456789123",
38       "schema_version": 1,
39       "email_events": [
40         "shipping.order.staged"
41       ],
42       "order_id": "order_123abc456def",
43       "push_events": [
44         "shipping.order.staged"
45       ],
46       "session_id": "sess_789456123",
47       "sms_events": [
48         "shipping.order.staged"
49       ]
50     }
51   ],
52   "off_chrt_shipper_org_company_name": "OffChrt Shippers LLC",
53   "shipper_org_company_name": "Acme Shipping Co.",
54   "task_groups_expanded": [
55     {
56       "task_group": {
57         "_id": "tg_00123456789",
58         "created_by_org_id": "org_123456789",
59         "draft_started_at_timestamp": "2024-01-10T08:00:00Z",
60         "order_id": "order_123abc456def",
61         "order_short_id": "ORD12345",
62         "schema_version": 1,
63         "task_group_type": "chrt_ground_provider"
64       },
65       "awb_numbers": [
66         "123-45678901"
67       ],
68       "coordinator_org_company_name": "Global Logistics Inc.",
69       "coordinator_org_handle": "@GlobalLogistics",
70       "coordinator_org_id": "org_987654321",
71       "driver": {
72         "_id": "driver_001",
73         "org_id": "org_123456789",
74         "schema_version": 1,
75         "user_id": "user_555666777"
76       },
77       "executor_org_company_name": "Fast Delivery Ltd.",
78       "executor_org_handle": "@FastDelivery",
79       "executor_org_id": "org_555666777",
80       "off_chrt_shipper_org_company_name": "OffChrt Shippers LLC",
81       "off_chrt_shipper_org_data_id": "offchrt_data_001",
82       "shipper_org_company_name": "Acme Shipping Co.",
83       "shipper_org_id": "org_123456789",
84       "tasks_expanded": [
85         {
86           "task": {
87             "_id": "task_001",
88             "created_by_org_id": "org_123456789",
89             "draft_started_at_timestamp": "2024-01-10T08:30:00Z",
90             "order_id": "order_123abc456def",
91             "order_short_id": "ORD12345",
92             "schema_version": 1,
93             "task_group_id": "tg_00123456789"
94           }
95         }
96       ]
97     }
98   ],
99   "unassigned_cargos": [
100     {
101       "_id": "cargo_001",
102       "cargo_type": "spare_parts",
103       "created_by_org_id": "org_123456789",
104       "draft_started_at_timestamp": "2024-01-10T08:00:00Z",
105       "order_id": "order_123abc456def",
106       "order_short_id": "ORD12345",
107       "schema_version": 1,
108       "awb_number": "789-12345678",
109       "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
110       "created_by_user_id": "user_987654321",
111       "delivered_at_timestamp": "2024-01-15T09:30:00Z",
112       "description": "Replacement engine parts for aircraft maintenance",
113       "device_ids": [
114         "device_abc123"
115       ],
116       "exception_at_timestamp": "2024-01-15T09:30:00Z",
117       "height_inches": 12.5,
118       "in_transit_at_timestamp": "2024-01-12T14:00:00Z",
119       "length_inches": 24,
120       "quantity": 10,
121       "skipped_at_timestamp": "2024-01-14T16:00:00Z",
122       "stackable": true,
123       "staged_at_timestamp": "2024-01-11T10:00:00Z",
124       "status": "draft",
125       "turnable": true,
126       "weight_pounds": 150,
127       "width_inches": 18
128     }
129   ]
130 }

Fetches a single draft order with optional expanded related data for shipper operators in the creating org. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedForShipper)

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

expand_coordinator_org_handlebooleanOptionalDefaults to false

expand_directory_entriesbooleanOptionalDefaults 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

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

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.

notification_intents_ad_hoclist of objects

off_chrt_shipper_org_company_namestring

shipper_org_company_namestring

task_groups_expandedlist of objects

unassigned_cargoslist of objects

Errors

422

Expanded for Shipper Operators V1request Unprocessable Entity Error