Retrieve expanded draft order

POST

/shipping/order_drafts/expanded/retrieve/v1/:order_ref

POST

/shipping/order_drafts/expanded/retrieve/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.orderDrafts.expanded.retrieveV1("order_ref", {});
8 }
9 main();

1 {
2   "order": {
3     "schema_version": 1,
4     "_id": "ord_9f8e7d6c5b4a3",
5     "short_id": "ORD12345",
6     "created_by_org_id": "org_1234abcd",
7     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
8     "task_group_ids": [
9       "tg_001122334455"
10     ],
11     "off_chrt_reference_id": "REF_20240610_001",
12     "order_schedule_id": "sched_20240610_01",
13     "order_schedule_run_idempotency_key": "runkey_abc123xyz",
14     "created_by_user_id": "user_7890abcd",
15     "shipper_org_id": "org_shipper5678",
16     "off_chrt_shipper_org_id": "offchrt_shipper_001",
17     "coordinator_org_id": "org_coord_4321",
18     "executor_org_ids": [
19       "org_exec_9876"
20     ],
21     "off_chrt_executor_org_ids": [
22       "offchrt_exec_0099"
23     ],
24     "status": "draft",
25     "staged_at_timestamp": "2024-01-16T10:00:00Z",
26     "in_progress_at_timestamp": "2024-01-17T11:15:00Z",
27     "completed_at_timestamp": "2024-01-18T15:45:00Z",
28     "exception_at_timestamp": "2024-01-19T08:20:00Z",
29     "order_cancelled": true,
30     "order_cancelled_at_timestamp": "2024-01-20T12:00:00Z"
31   },
32   "coordinator_org_company_name": "Global Logistics Coordinators Inc.",
33   "coordinator_org_handle": "@GlobalLogiCoord",
34   "shipper_org_company_name": "Acme Shipping Co.",
35   "off_chrt_shipper_org_company_name": "OffChrt Acme Shipping",
36   "notification_intents_ad_hoc": [
37     {
38       "schema_version": 1,
39       "created_at_timestamp": "2024-01-15T09:35:00Z",
40       "created_by_org_id": "org_1234abcd",
41       "created_by_user_id": "user_7890abcd",
42       "order_id": "ord_9f8e7d6c5b4a3",
43       "directory_entry_id": "dirent_55667788",
44       "_id": "notif_00112233",
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": "tg_001122334455",
61         "order_id": "ord_9f8e7d6c5b4a3",
62         "order_short_id": "ORD12345",
63         "created_by_org_id": "org_1234abcd",
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": "task_abc123def456",
72             "order_id": "ord_9f8e7d6c5b4a3",
73             "order_short_id": "ORD12345",
74             "task_group_id": "tg_001122334455",
75             "created_by_org_id": "org_1234abcd",
76             "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
77           }
78         }
79       ],
80       "driver": {
81         "schema_version": 1,
82         "_id": "drv_99887766",
83         "org_id": "org_exec_9876",
84         "user_id": "user_drv_1234"
85       },
86       "executor_org_id": "org_exec_9876",
87       "executor_org_company_name": "Express Delivery Services",
88       "executor_org_handle": "@ExpressDelivery",
89       "coordinator_org_id": "org_coord_4321",
90       "coordinator_org_company_name": "Global Logistics Coordinators Inc.",
91       "coordinator_org_handle": "@GlobalLogiCoord",
92       "shipper_org_id": "org_shipper5678",
93       "shipper_org_company_name": "Acme Shipping Co.",
94       "off_chrt_shipper_org_id": "offchrt_shipper_001",
95       "off_chrt_shipper_org_company_name": "OffChrt Acme Shipping"
96     }
97   ],
98   "cargos": [
99     {
100       "schema_version": 1,
101       "cargo_type": "spare_parts",
102       "_id": "cargo_44556677",
103       "order_id": "ord_9f8e7d6c5b4a3",
104       "order_short_id": "ORD12345",
105       "created_by_org_id": "org_1234abcd",
106       "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
107       "quantity": 10,
108       "weight_pounds": 25.5,
109       "length_inches": 40,
110       "width_inches": 30,
111       "height_inches": 20,
112       "turnable": true,
113       "stackable": true,
114       "description": "Replacement engine spare parts for model X-2000",
115       "order_schedule_id": "sched_20240610_01",
116       "order_schedule_run_idempotency_key": "runkey_abc123xyz",
117       "order_schedule_template_path": "/templates/standard_schedule.yaml",
118       "created_by_user_id": "user_7890abcd",
119       "device_ids": [
120         "device_00112233"
121       ],
122       "status": "draft",
123       "staged_at_timestamp": "2024-01-16T10:00:00Z",
124       "in_transit_at_timestamp": "2024-01-17T11:15:00Z",
125       "delivered_at_timestamp": "2024-01-18T15:45:00Z",
126       "skipped_at_timestamp": "2024-01-19T08:00:00Z",
127       "exception_at_timestamp": "2024-01-19T08:20:00Z"
128     }
129   ]
130 }

Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)

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

cargoslist of objects

Errors

422

Expanded Retrieve V1request Unprocessable Entity Error