List

GET

/shipping/order_templates_new/list/v1

GET

/shipping/order_templates_new/list/v1

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.orderTemplatesNew.listV1({
8         filter_archived: true,
9         filter_coordinator_shipper_account_ids: [
10             "filter_coordinator_shipper_account_ids",
11         ],
12         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
13         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
14         filter_executor_org_id: "filter_executor_org_id",
15         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
16         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
17         filter_last_used_at_timestamp_gte: "2024-01-15T09:30:00Z",
18         filter_last_used_at_timestamp_lte: "2024-01-15T09:30:00Z",
19         filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
20         filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
21         filter_owned_by_user_id: "filter_owned_by_user_id",
22         filter_shipper_org_id: "filter_shipper_org_id",
23         page: 1,
24         page_size: 1,
25         search: "search",
26         sort_by: "created_at_timestamp",
27         sort_order: "asc",
28     });
29 }
30 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "created_at_timestamp": "2024-01-15T09:30:00Z",
6       "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
7       "name": "name",
8       "owned_by_org_id": "owned_by_org_id",
9       "owned_by_user_id": "owned_by_user_id",
10       "schema_version": 1,
11       "archived_at_timestamp": "2024-01-15T09:30:00Z",
12       "cargos": [
13         {
14           "cargo_key": "cargo_key",
15           "cargo_type": "spare_parts"
16         }
17       ],
18       "coordinator_assigned_user_ids": [
19         "coordinator_assigned_user_ids"
20       ],
21       "coordinator_department_id": "coordinator_department_id",
22       "coordinator_label": "coordinator_label",
23       "coordinator_org": {
24         "_id": "_id",
25         "name": "name",
26         "org_id": "org_id",
27         "org_type": "provider",
28         "schema_version": 1
29       },
30       "coordinator_org_id": "coordinator_org_id",
31       "description": "description",
32       "last_used_at_timestamp": "2024-01-15T09:30:00Z",
33       "off_chrt_reference_id": "off_chrt_reference_id",
34       "off_chrt_shipper_org": {
35         "_id": "_id",
36         "created_by_user_id": "created_by_user_id",
37         "name": "name",
38         "org_type": "provider",
39         "owned_by_org_id": "owned_by_org_id",
40         "schema_version": 1
41       },
42       "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
43       "service_line": "on_demand",
44       "shipper_org": {
45         "_id": "_id",
46         "name": "name",
47         "org_id": "org_id",
48         "org_type": "provider",
49         "schema_version": 1
50       },
51       "shipper_org_id": "shipper_org_id",
52       "task_groups": [
53         {
54           "task_group_key": "task_group_key",
55           "task_group_type": "chrt_ground_provider",
56           "tasks": [
57             {
58               "task_key": "task_key",
59               "datetime_windows_dateparser_str": [
60                 {
61                   "time_zone_name": "America/New_York"
62                 }
63               ]
64             }
65           ]
66         }
67       ],
68       "task_groups_expanded": [
69         {
70           "task_group": {
71             "task_group_key": "task_group_key",
72             "task_group_type": "chrt_ground_provider",
73             "tasks": [
74               {
75                 "task_key": "task_key",
76                 "datetime_windows_dateparser_str": [
77                   {
78                     "time_zone_name": "America/New_York"
79                   }
80                 ]
81               }
82             ]
83           }
84         }
85       ],
86       "task_lists_to_apply_at_order_creation": [
87         {
88           "task_list_id": "task_list_id"
89         }
90       ],
91       "task_lists_to_apply_at_order_staging": [
92         {
93           "task_list_id": "task_list_id"
94         }
95       ]
96     }
97   ],
98   "total_count": 1
99 }

Lists order templates with filtering, sorting, pagination, full-text search, and party/account expansion. | authz: min_org_role=operator | () -> (OrderTemplateNewListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenumOptional

Field to sort by.

Allowed values:

sort_orderenumOptional

Sort order (asc or desc).

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Full-text search query for template name or description.

filter_archivedbooleanOptionalDefaults to false

Include archived templates instead of active templates.

filter_owned_by_user_idstringOptional

Filter by the user that created the template.

filter_executor_org_idstringOptional

Filter by an on-CHRT executor organization ID.

filter_off_chrt_executor_org_data_idstringOptional

Filter by an off-CHRT executor organization data ID.

filter_shipper_org_idstringOptional

Filter by an on-CHRT shipper organization ID.

filter_off_chrt_shipper_org_data_idstringOptional

Filter by an off-CHRT shipper organization data ID.

filter_coordinator_shipper_account_idsstringOptional

Filter by coordinator shipper account ID(s) assigned to template tasks.

filter_created_at_timestamp_gtedatetimeOptional

Filter created_at_timestamp >= value (inclusive).

filter_created_at_timestamp_ltedatetimeOptional

Filter created_at_timestamp <= value (inclusive).

filter_last_edited_at_timestamp_gtedatetimeOptional

Filter last_edited_at_timestamp >= value (inclusive).

filter_last_edited_at_timestamp_ltedatetimeOptional

Filter last_edited_at_timestamp <= value (inclusive).

filter_last_used_at_timestamp_gtedatetimeOptional

Filter last_used_at_timestamp >= value (inclusive).

filter_last_used_at_timestamp_ltedatetimeOptional

Filter last_used_at_timestamp <= value (inclusive).

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Order Templates New List V1request Unprocessable Entity Error