List by courier org full

GET

/oort/orders/list/by_courier_org_id/full/v1

GET

/oort/orders/list/by_courier_org_id/full/v1

1 curl https://localhost:8000/oort/orders/list/by_courier_org_id/full/v1 \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 [
2   {
3     "order": {
4       "schema_version": 1,
5       "_id": "string",
6       "short_id": "string",
7       "order_created_by_type": "chrt",
8       "order_dispatch_type": "dtc",
9       "transport_type": "ground_only",
10       "created_by_org_id": "string",
11       "created_by_user_id": "string",
12       "draft_started_at": "2024-01-15T09:30:00Z",
13       "task_group_ids": [
14         "string"
15       ],
16       "shipper_org_id": "string",
17       "shipper_user_id": "string",
18       "off_chrt_shipper_org_info_id": "string",
19       "order_level_expenses_ids": [
20         "string"
21       ],
22       "order_level_receivables_line_items": [
23         {
24           "schema_version": 1,
25           "item": "base_rate",
26           "quantity": 1.1,
27           "rate": 1.1,
28           "comment": "string",
29           "created_at": "2024-01-15T09:30:00Z",
30           "uuid_str": "string"
31         }
32       ],
33       "status": "not_started",
34       "order_cancelled": false
35     },
36     "task_groups": [
37       {
38         "schema_version": 1,
39         "_id": "string",
40         "order_id": "string",
41         "order_short_id": "string",
42         "task_ids": [
43           "string"
44         ],
45         "courier_org_id": "string",
46         "order_cancelled": false,
47         "status": "not_started",
48         "driver_id": "string",
49         "started_at": "2024-01-15T09:30:00Z",
50         "completed_at": "2024-01-15T09:30:00Z",
51         "completed": false,
52         "paused": false
53       }
54     ],
55     "tasks": [
56       {
57         "schema_version": 1,
58         "_id": "string",
59         "order_id": "string",
60         "order_short_id": "string",
61         "created_by_org_id": "string",
62         "created_by_user_id": "string",
63         "location": {
64           "type": "string",
65           "geometry": {
66             "bbox": [
67               "string"
68             ],
69             "type": "string",
70             "coordinates": [
71               "string"
72             ]
73           },
74           "bbox": [
75             "string"
76           ],
77           "properties": {
78             "address": "string",
79             "name": "string",
80             "mapbox_id": "string"
81           },
82           "id": 1
83         },
84         "action": "pickup",
85         "shipper_contact_info_ids": [
86           "string"
87         ],
88         "arrive_by": "2024-01-15T09:30:00Z",
89         "arrive_at": "2024-01-15T09:30:00Z",
90         "comments": "string",
91         "flight_number": "string",
92         "order_cancelled": false,
93         "completed": false,
94         "completed_at": "2024-01-15T09:30:00Z",
95         "cargo_ids": [
96           "string"
97         ],
98         "milestone_ids": [
99           "string"
100         ]
101       }
102     ],
103     "milestones": [
104       {
105         "schema_version": 1,
106         "type": "image",
107         "_id": "string",
108         "order_id": "string",
109         "order_short_id": "string",
110         "task_id": "string",
111         "completed": true,
112         "requested_by_shipper": true,
113         "requestor_comments": "string",
114         "completed_at_timestamp": "2024-01-15T09:30:00Z",
115         "completed_at_geojson_feature": {
116           "type": "string",
117           "geometry": {
118             "bbox": [
119               "string"
120             ],
121             "type": "string",
122             "coordinates": [
123               "string"
124             ]
125           },
126           "bbox": [
127             "string"
128           ],
129           "properties": {
130             "address": "string",
131             "name": "string",
132             "mapbox_id": "string"
133           },
134           "id": 1
135         },
136         "completed_by_user_id": "string",
137         "milestone_s3_object_metadata_ids": [
138           "string"
139         ],
140         "decoded_scans": [
141           "string"
142         ],
143         "completor_comments": "string",
144         "chrt_comments": "string",
145         "notification_email_ids": [
146           "string"
147         ],
148         "notification_sms_ids": [
149           "string"
150         ],
151         "notification_push_ids": [
152           "string"
153         ],
154         "notification_voice_ids": [
155           "string"
156         ]
157       }
158     ],
159     "cargos": [
160       {
161         "schema_version": 1,
162         "cargo_type": "spare_parts",
163         "_id": "string",
164         "order_id": "string",
165         "order_short_id": "string",
166         "quantity": 1,
167         "weight_pounds": 1.1,
168         "length_inches": 1.1,
169         "width_inches": 1.1,
170         "height_inches": 1.1,
171         "device_ids": [
172           "string"
173         ],
174         "status": "awaiting_pickup"
175       }
176     ]
177   }
178 ]

Lists all orders assigned to the authenticated courier organization with complete task groups, tasks, milestones, and cargo details.

Authentication

AuthorizationBearer

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

Response

Successful Response

orderobject

task_groupslist of objects

taskslist of objects

milestoneslist of objects

cargoslist of objects