About

GET

/shipping/order_schedules/about/v1/:order_schedule_id

GET

/shipping/order_schedules/about/v1/:order_schedule_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.orderSchedules.aboutV1("order_schedule_id");
8 }
9 main();

1 {
2   "order_schedule": {
3     "schema_version": 1,
4     "name": "Weekly Spare Parts Delivery",
5     "order_manifest": {
6       "coordinator_org_id": "org_12345abcde",
7       "shipper_org_id": "org_67890fghij",
8       "off_chrt_shipper_org_id": "external_shipper_001",
9       "off_chrt_reference_id": "SPAREPARTS_2024_01",
10       "cargos": [
11         {
12           "schema_version": 1,
13           "cargo_type": "spare_parts",
14           "quantity": 50,
15           "weight_pounds": 1200.5,
16           "length_inches": 48,
17           "width_inches": 40,
18           "height_inches": 36,
19           "turnable": true,
20           "stackable": true,
21           "description": "Assorted mechanical spare parts for maintenance."
22         }
23       ],
24       "task_groups": [
25         {
26           "task_group_type": "chrt_ground_provider",
27           "tasks": [
28             {
29               "schema_version": 1,
30               "location": {
31                 "type": "Feature",
32                 "geometry": {
33                   "type": "Point",
34                   "coordinates": [
35                     -122.4194,
36                     37.7749
37                   ]
38                 },
39                 "properties": {
40                   "address": "1234 Market St, San Francisco, CA 94103",
41                   "name": "San Francisco Warehouse"
42                 }
43               },
44               "action": "chrt_ground_provider__pickup",
45               "time_windows": [
46                 {
47                   "left_boundary_time": "08:00:00",
48                   "right_boundary_time": "10:00:00"
49                 }
50               ],
51               "order_placer_comments": "Handle with care, fragile items.",
52               "directory_entry_ids": [
53                 "dir_001",
54                 "dir_002"
55               ],
56               "cargo_template_indices": [
57                 0
58               ],
59               "task_artifact_types": [
60                 "image",
61                 "signature"
62               ]
63             }
64           ],
65           "vehicle_type": "cargo_van",
66           "executor_org_id": "org_98765zyxwv",
67           "driver_id": "driver_00123"
68         }
69       ],
70       "auto_stage": true
71     },
72     "schedule_spec": {
73       "calendars": [
74         {
75           "second": [
76             {
77               "start": 0,
78               "end": 0,
79               "step": 1
80             }
81           ],
82           "minute": [
83             {
84               "start": 0,
85               "end": 0,
86               "step": 1
87             }
88           ],
89           "hour": [
90             {
91               "start": 9,
92               "end": 9,
93               "step": 1
94             }
95           ],
96           "day_of_month": [
97             {
98               "start": 1,
99               "end": 31,
100               "step": 7
101             }
102           ],
103           "month": [
104             {
105               "start": 1,
106               "end": 12,
107               "step": 1
108             }
109           ],
110           "year": [],
111           "day_of_week": [
112             {
113               "start": 1,
114               "end": 5,
115               "step": 1
116             }
117           ],
118           "comment": "Weekdays at 9 AM"
119         }
120       ],
121       "intervals": [
122         {
123           "every": "P7D",
124           "offset": "PT0S"
125         }
126       ],
127       "cron_expressions": [
128         "0 9 * * 1-5"
129       ],
130       "skip": [
131         {
132           "day_of_month": [
133             {
134               "start": 25,
135               "end": 25,
136               "step": 1
137             }
138           ],
139           "month": [
140             {
141               "start": 12,
142               "end": 12,
143               "step": 1
144             }
145           ],
146           "comment": "Skip Christmas Day"
147         }
148       ],
149       "start_at": "2024-01-15T09:30:00Z",
150       "end_at": "2025-01-15T09:30:00Z",
151       "jitter": "PT15M",
152       "time_zone_name": "America/Los_Angeles"
153     },
154     "_id": "order_schedule_001",
155     "owned_by_user_id": "user_abc123xyz",
156     "owned_by_org_id": "org_12345abcde",
157     "owned_by_org_type": "provider",
158     "created_at_timestamp": "2024-01-01T08:00:00Z",
159     "last_edited_at_timestamp": "2024-04-01T12:00:00Z",
160     "orchestrator_schedule_id": "orch_sched_7890",
161     "description": "Schedule for weekly delivery of spare parts to regional warehouses.",
162     "status": "draft",
163     "orchestrator_schedule_status": "not_created",
164     "orchestrator_schedule_paused": true,
165     "orchestrator_schedule_created_at_timestamp": "2024-01-10T09:00:00Z"
166   },
167   "orders_created_count": 42,
168   "orchestrator_schedule_status": {
169     "status": "not_created",
170     "exists": true,
171     "paused": true,
172     "actions_count": 5,
173     "next_action_times": [
174       "2024-05-01T09:30:00Z",
175       "2024-05-08T09:30:00Z"
176     ],
177     "recent_actions": [
178       {
179         "scheduled_at": "2024-04-24T09:30:00Z",
180         "started_at": "2024-04-24T09:35:00Z",
181         "workflow_id": "workflow_12345"
182       },
183       {
184         "scheduled_at": "2024-04-17T09:30:00Z",
185         "started_at": "2024-04-17T09:32:00Z",
186         "workflow_id": "workflow_12344"
187       }
188     ]
189   }
190 }

Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)

Authentication

AuthorizationBearer

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

Path parameters

order_schedule_idstringRequired

Response

Successful Response

order_scheduleobject

orders_created_countinteger

orchestrator_schedule_statusobject

Errors

422

Order Schedules about V1request Unprocessable Entity Error