Get

GET

/shipping/order_templates/v1/:order_template_id

GET

/shipping/order_templates/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.getByIdV1("order_template_id");
8 }
9 main();

1 {
2   "_id": "_id",
3   "created_at_timestamp": "2024-01-15T09:30:00Z",
4   "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
5   "name": "name",
6   "owned_by_org_id": "owned_by_org_id",
7   "owned_by_user_id": "owned_by_user_id",
8   "schema_version": 1,
9   "archived_at_timestamp": "2024-01-15T09:30:00Z",
10   "coordinator_org_id": "coordinator_org_id",
11   "department_id": "department_id",
12   "description": "description",
13   "directory_entry_ids": [
14     "directory_entry_ids"
15   ],
16   "driver_ids": [
17     "driver_ids"
18   ],
19   "executor_org_ids": [
20     "executor_org_ids"
21   ],
22   "off_chrt_reference_id_str": "off_chrt_reference_id_str",
23   "off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
24   "shipper_org_id": "shipper_org_id",
25   "task_list_ids": [
26     "task_list_ids"
27   ],
28   "text": "text"
29 }

Retrieves an order template by ID. | authz: min_org_role=operator | () -> (OrderTemplate1)

Authentication

AuthorizationBearer

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

Path parameters

order_template_idstringRequired

Response

Successful Response

_idstring

created_at_timestampdatetime

last_edited_at_timestampdatetime

namestring

owned_by_org_idstring

Must be a string starting with org_

owned_by_user_idstring

Must be a string starting with user_

schema_versioninteger

archived_at_timestampdatetime

coordinator_org_idstring

Must be a string starting with org_

department_idstring

descriptionstring

directory_entry_idslist of strings

driver_idslist of strings

executor_org_idslist of strings

off_chrt_reference_id_strstring

off_chrt_shipper_org_idstring

shipper_org_idstring

Must be a string starting with org_

task_list_idslist of strings

textstring

Errors

422

Order Templates Get by ID V1request Unprocessable Entity Error