Get expanded

GET

/shipping/order_templates/expanded/v1/:order_template_id

GET

/shipping/order_templates/expanded/v1/:order_template_id

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.orderTemplates.getExpandedByIdV1("order_template_id");
8 }
9 main();

1 {
2   "order_template": {
3     "_id": "_id",
4     "created_at_timestamp": "2024-01-15T09:30:00Z",
5     "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
6     "name": "name",
7     "owned_by_org_id": "owned_by_org_id",
8     "owned_by_user_id": "owned_by_user_id",
9     "schema_version": 1,
10     "archived_at_timestamp": "2024-01-15T09:30:00Z",
11     "coordinator_org_id": "coordinator_org_id",
12     "department_id": "department_id",
13     "description": "description",
14     "directory_entry_ids": [
15       "directory_entry_ids"
16     ],
17     "driver_ids": [
18       "driver_ids"
19     ],
20     "executor_org_ids": [
21       "executor_org_ids"
22     ],
23     "off_chrt_reference_id_str": "off_chrt_reference_id_str",
24     "off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
25     "shipper_org_id": "shipper_org_id",
26     "task_list_ids": [
27       "task_list_ids"
28     ],
29     "text": "text"
30   },
31   "directory_entries": [
32     {
33       "_id": "_id",
34       "created_by_org_id": "created_by_org_id",
35       "created_by_user_id": "created_by_user_id",
36       "schema_version": 1,
37       "company_name": "company_name",
38       "contact_first_name": "contact_first_name",
39       "contact_last_name": "contact_last_name",
40       "email_address_primary": "email_address_primary",
41       "email_address_secondary": "email_address_secondary",
42       "entry_off_chrt_shipper_org_id": "entry_off_chrt_shipper_org_id",
43       "entry_org_id": "entry_org_id",
44       "industry": "industry",
45       "job_title": "job_title",
46       "location": {
47         "geometry": {
48           "type": "GeometryCollection",
49           "geometries": [
50             {
51               "type": "LineString",
52               "coordinates": [
53                 []
54               ]
55             }
56           ]
57         },
58         "type": "Feature"
59       },
60       "notes": "notes",
61       "phone_number_primary": "phone_number_primary",
62       "phone_number_secondary": "phone_number_secondary"
63     }
64   ],
65   "drivers": [
66     {
67       "_id": "_id",
68       "org_id": "org_id",
69       "schema_version": 1,
70       "user_id": "user_id",
71       "auto_assign_enabled": true,
72       "available_according_to_driver": true,
73       "available_according_to_operators": true,
74       "email_address_primary": "email_address_primary",
75       "email_address_secondary": "email_address_secondary",
76       "first_name": "first_name",
77       "last_name": "last_name",
78       "last_seen_at_location": {
79         "geometry": {
80           "type": "GeometryCollection",
81           "geometries": [
82             {
83               "type": "LineString",
84               "coordinates": [
85                 []
86               ]
87             }
88           ]
89         },
90         "type": "Feature"
91       },
92       "last_seen_at_location_city": "last_seen_at_location_city",
93       "last_seen_at_location_large_city": "last_seen_at_location_large_city",
94       "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
95       "phone_number_primary": "phone_number_primary",
96       "phone_number_secondary": "phone_number_secondary",
97       "status": "unassigned",
98       "vehicle_types": [
99         "sedan"
100       ],
101       "waiting": true
102     }
103   ],
104   "executor_orgs": [
105     {
106       "org_id": "org_id",
107       "company_name": "company_name",
108       "handle": "handle"
109     }
110   ],
111   "off_chrt_shipper_org": {
112     "_id": "_id",
113     "created_by_org_id": "created_by_org_id",
114     "created_by_user_id": "created_by_user_id",
115     "email_address_primary": "email_address_primary",
116     "schema_version": 1,
117     "company_name": "company_name",
118     "contact_first_name": "contact_first_name",
119     "contact_last_name": "contact_last_name",
120     "email_address_secondary": "email_address_secondary",
121     "industry": "industry",
122     "job_title": "job_title",
123     "notes": "notes",
124     "phone_number_primary": "phone_number_primary",
125     "phone_number_secondary": "phone_number_secondary",
126     "shipper_customer_id_for_stripe_connect_account": "shipper_customer_id_for_stripe_connect_account",
127     "street_address": {
128       "geometry": {
129         "type": "GeometryCollection",
130         "geometries": [
131           {
132             "type": "LineString",
133             "coordinates": [
134               []
135             ]
136           }
137         ]
138       },
139       "type": "Feature",
140       "id": 1
141     }
142   },
143   "shipper_org": {
144     "org_id": "org_id",
145     "company_name": "company_name",
146     "handle": "handle"
147   }
148 }

Retrieves an order template with its reference columns resolved (shipper, executor orgs, drivers, directory entries). Unresolvable list references are omitted so the caller can detect dangling ids. | authz: min_org_role=operator | () -> (OrderTemplateExpanded1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

order_template_idstringRequired

Response

Successful Response

order_templateobject

directory_entrieslist of objects

driverslist of objects

executor_orgslist of objects

off_chrt_shipper_orgobject

shipper_orgobject

Errors

422

Order Templates Get Expanded by ID V1request Unprocessable Entity Error