List

GET

/shipping/order_templates/list/v1

GET

/shipping/order_templates/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.orderTemplates.listV1({
8         sort_by: "created_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         search: "search",
13         filter_archived: true,
14         filter_owned_by_user_id: "filter_owned_by_user_id",
15         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
16         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
17         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
18         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
19     });
20 }
21 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       "coordinator_org_id": "coordinator_org_id",
13       "department_id": "department_id",
14       "description": "description",
15       "directory_entry_ids": [
16         "directory_entry_ids"
17       ],
18       "driver_ids": [
19         "driver_ids"
20       ],
21       "executor_org_ids": [
22         "executor_org_ids"
23       ],
24       "off_chrt_reference_id_str": "off_chrt_reference_id_str",
25       "off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
26       "shipper_org_id": "shipper_org_id",
27       "task_list_ids": [
28         "task_list_ids"
29       ],
30       "text": "text"
31     }
32   ],
33   "total_count": 1
34 }

Lists order templates for the caller’s organization with filtering, sorting, pagination, and optional full-text search (name, description, text, off_chrt_reference_id_str). | authz: min_org_role=operator | () -> (OrderTemplateListRes)

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

filter_archivedbooleanOptional

Filter by archived (True) vs active (False) templates.

filter_owned_by_user_idstringOptional

Filter by the user who owns the order template.

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).

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Order Templates List V1request Unprocessable Entity Error