Get

GET

/shipping/order_schedules/v1/:order_schedule_id

GET

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

1 {
2   "schema_version": 1,
3   "name": "Weekly Spare Parts Delivery",
4   "order_manifest": {
5     "coordinator_org_id": "org_12345coordinator",
6     "shipper_org_id": "org_67890shipper",
7     "off_chrt_shipper_org_id": "external_shipper_001",
8     "off_chrt_reference_id": "SPAREPARTS_202406",
9     "cargos": [
10       {
11         "schema_version": 1,
12         "cargo_type": "spare_parts",
13         "quantity": 150,
14         "weight_pounds": 1200.5,
15         "length_inches": 48,
16         "width_inches": 40,
17         "height_inches": 36,
18         "turnable": true,
19         "stackable": false,
20         "description": "Assorted mechanical spare parts for assembly lines."
21       }
22     ],
23     "task_groups": [
24       {
25         "task_group_type": "chrt_ground_provider",
26         "tasks": [
27           {
28             "schema_version": 1,
29             "location": {
30               "type": "Feature",
31               "geometry": {
32                 "type": "Point",
33                 "coordinates": [
34                   -122.4194,
35                   37.7749
36                 ]
37               },
38               "properties": {
39                 "address": "1234 Warehouse Rd, San Francisco, CA 94107",
40                 "name": "SF Regional Warehouse"
41               }
42             },
43             "action": "chrt_ground_provider__pickup",
44             "time_windows": [
45               {
46                 "left_boundary_time": "08:00:00",
47                 "right_boundary_time": "10:00:00"
48               }
49             ],
50             "order_placer_comments": "Handle with care, fragile items.",
51             "directory_entry_ids": [
52               "dir_001",
53               "dir_002"
54             ],
55             "cargo_template_indices": [
56               0
57             ],
58             "task_artifact_types": [
59               "image"
60             ]
61           }
62         ],
63         "vehicle_type": "cargo_van",
64         "executor_org_id": "org_54321executor",
65         "driver_id": "driver_98765"
66       }
67     ],
68     "auto_stage": true
69   },
70   "schedule_spec": {
71     "calendars": [
72       {
73         "second": [
74           {
75             "start": 0,
76             "end": 0,
77             "step": 1
78           }
79         ],
80         "minute": [
81           {
82             "start": 30,
83             "end": 30,
84             "step": 1
85           }
86         ],
87         "hour": [
88           {
89             "start": 9,
90             "end": 9,
91             "step": 1
92           }
93         ],
94         "day_of_month": [
95           {
96             "start": 1,
97             "end": 31,
98             "step": 1
99           }
100         ],
101         "month": [
102           {
103             "start": 1,
104             "end": 12,
105             "step": 1
106           }
107         ],
108         "year": [],
109         "day_of_week": [
110           {
111             "start": 1,
112             "end": 5,
113             "step": 1
114           }
115         ],
116         "comment": "Weekdays at 9:30 AM"
117       }
118     ],
119     "intervals": [
120       {
121         "every": "P1W",
122         "offset": "PT0S"
123       }
124     ],
125     "cron_expressions": [
126       "30 9 * * 1-5"
127     ],
128     "skip": [
129       {
130         "day_of_week": [
131           {
132             "start": 6,
133             "end": 6,
134             "step": 1
135           },
136           {
137             "start": 0,
138             "end": 0,
139             "step": 1
140           }
141         ],
142         "comment": "Skip weekends"
143       }
144     ],
145     "start_at": "2024-06-01T09:30:00Z",
146     "end_at": "2025-06-01T09:30:00Z",
147     "jitter": "PT15M",
148     "time_zone_name": "America/Los_Angeles"
149   },
150   "_id": "order_schedule_abc123xyz",
151   "owned_by_user_id": "user_78910operator",
152   "owned_by_org_id": "org_67890shipper",
153   "owned_by_org_type": "provider",
154   "created_at_timestamp": "2024-05-01T12:00:00Z",
155   "last_edited_at_timestamp": "2024-05-15T15:45:00Z",
156   "orchestrator_schedule_id": "orch_sched_456def",
157   "description": "Scheduled delivery of spare parts to regional warehouses.",
158   "status": "active",
159   "orchestrator_schedule_status": "created",
160   "orchestrator_schedule_paused": false,
161   "orchestrator_schedule_created_at_timestamp": "2024-05-01T12:05:00Z"
162 }

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

Authentication

AuthorizationBearer

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

Path parameters

order_schedule_idstringRequired

Response

Successful Response

schema_versioninteger

namestring

order_manifestobject

Template used by an order schedule to generate each order occurrence.

schedule_specobject

_idstring

owned_by_user_idstring

Must be a string starting with user_

owned_by_org_idstring

Must be a string starting with org_

owned_by_org_typeenum

created_at_timestampdatetime

last_edited_at_timestampdatetime

orchestrator_schedule_idstring

descriptionstring

statusenum

orchestrator_schedule_statusenum

orchestrator_schedule_pausedboolean

orchestrator_schedule_created_at_timestampdatetime

Errors

422

Order Schedules Get by ID V1request Unprocessable Entity Error