List by courier org full

GET

/oort/task_groups/by_courier_org_id/list/full/v1

GET

/oort/task_groups/by_courier_org_id/list/full/v1

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

Try it

200Retrieved

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

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

Authentication

AuthorizationBearer

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

Response

Successful Response

task_groupslist of objects