List

GET

/shipping/order_schedules/list/v1

GET

/shipping/order_schedules/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.orderSchedules.listV1({
8         sort_by: "created_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_owned_by_user_id: "filter_owned_by_user_id",
13         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
14         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
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     });
18 }
19 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "name": "Weekly Medical Supplies Delivery",
6       "order_manifest": {
7         "coordinator_org_id": "org_12345abcde",
8         "shipper_org_id": "org_67890fghij",
9         "off_chrt_shipper_org_id": null,
10         "off_chrt_reference_id": "medsupplies_202401",
11         "cargos": [
12           {
13             "schema_version": 1,
14             "cargo_type": "medical_supplies",
15             "quantity": 150,
16             "weight_pounds": 1200.5,
17             "length_inches": 48,
18             "width_inches": 40,
19             "height_inches": 36,
20             "turnable": true,
21             "stackable": true,
22             "description": "Boxes of assorted medical supplies including gloves, masks, and sanitizers."
23           }
24         ],
25         "task_groups": [
26           {
27             "task_group_type": "chrt_ground_provider",
28             "tasks": [
29               {
30                 "schema_version": 1,
31                 "location": {
32                   "type": "Feature",
33                   "geometry": {
34                     "type": "Point",
35                     "coordinates": [
36                       -122.4194,
37                       37.7749
38                     ]
39                   },
40                   "properties": {
41                     "address": "1234 Market St, San Francisco, CA 94103",
42                     "name": "Main Warehouse"
43                   },
44                   "id": "loc_001"
45                 },
46                 "action": "chrt_ground_provider__pickup",
47                 "time_windows": [
48                   {
49                     "left_boundary_time": "08:00:00",
50                     "right_boundary_time": "10:00:00"
51                   }
52                 ],
53                 "order_placer_comments": "Handle with care, fragile items.",
54                 "directory_entry_ids": [
55                   "dir_1001",
56                   "dir_1002"
57                 ],
58                 "cargo_template_indices": [
59                   0
60                 ],
61                 "task_artifact_types": [
62                   "image"
63                 ]
64               },
65               {
66                 "schema_version": 1,
67                 "location": {
68                   "type": "Feature",
69                   "geometry": {
70                     "type": "Point",
71                     "coordinates": [
72                       -121.8863,
73                       37.3382
74                     ]
75                   },
76                   "properties": {
77                     "address": "5678 Health Ave, San Jose, CA 95112",
78                     "name": "Regional Clinic"
79                   },
80                   "id": "loc_002"
81                 },
82                 "action": "chrt_ground_provider__deliver",
83                 "time_windows": [
84                   {
85                     "left_boundary_time": "11:00:00",
86                     "right_boundary_time": "13:00:00"
87                   }
88                 ],
89                 "order_placer_comments": null,
90                 "directory_entry_ids": [],
91                 "cargo_template_indices": [
92                   0
93                 ],
94                 "task_artifact_types": [
95                   "signature"
96                 ]
97               }
98             ],
99             "vehicle_type": "cargo_van",
100             "executor_org_id": "org_54321zyxwv",
101             "driver_id": "driver_98765"
102           }
103         ],
104         "auto_stage": true
105       },
106       "schedule_spec": {
107         "calendars": [
108           {
109             "second": [
110               {
111                 "start": 0,
112                 "end": 0,
113                 "step": 1
114               }
115             ],
116             "minute": [
117               {
118                 "start": 0,
119                 "end": 0,
120                 "step": 1
121               }
122             ],
123             "hour": [
124               {
125                 "start": 9,
126                 "end": 9,
127                 "step": 1
128               }
129             ],
130             "day_of_month": [
131               {
132                 "start": 1,
133                 "end": 31,
134                 "step": 7
135               }
136             ],
137             "month": [
138               {
139                 "start": 1,
140                 "end": 12,
141                 "step": 1
142               }
143             ],
144             "year": [],
145             "day_of_week": [
146               {
147                 "start": 1,
148                 "end": 5,
149                 "step": 1
150               }
151             ],
152             "comment": "Every weekday at 9 AM, weekly interval"
153           }
154         ],
155         "intervals": [
156           {
157             "every": "P7D",
158             "offset": null
159           }
160         ],
161         "cron_expressions": [],
162         "skip": [],
163         "start_at": "2024-01-01T09:00:00Z",
164         "end_at": null,
165         "jitter": "PT15M",
166         "time_zone_name": "America/Los_Angeles"
167       },
168       "_id": "order_sched_001",
169       "owned_by_user_id": "user_abc123xyz",
170       "owned_by_org_id": "org_12345abcde",
171       "owned_by_org_type": "provider",
172       "created_at_timestamp": "2024-01-15T09:30:00Z",
173       "last_edited_at_timestamp": "2024-01-20T14:45:00Z",
174       "orchestrator_schedule_id": "orch_sched_789",
175       "description": "Scheduled delivery of medical supplies to regional clinics.",
176       "status": "active",
177       "orchestrator_schedule_status": "created",
178       "orchestrator_schedule_paused": false,
179       "orchestrator_schedule_created_at_timestamp": "2024-01-15T10:00:00Z"
180     }
181   ],
182   "total_count": 1
183 }

Lists order schedules for the caller’s organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)

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

filter_statusenumOptional

Filter by order schedule status(es).

Allowed values:

filter_orchestrator_schedule_statusenumOptional

Filter by orchestrator schedule status(es).

Allowed values:

filter_owned_by_user_idstringOptional

Filter by the user who owns the order schedule.

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 Schedules List V1request Unprocessable Entity Error