Get Oort Orders Order Id Or Short Id Full

GET

/oort/orders/:order_id_or_short_id/full

GET

/oort/orders/:order_id_or_short_id/full

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

Try it

200Retrieved

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

Accepts both order_id and order_short_id values and returns the Order with all its Task Groups, Tasks, Milestones, and Cargos

Path parameters

order_id_or_short_idstringRequired

Response

Successful Response

cargoslist of objects

milestoneslist of objects

orderobject

task_groupslist of objects

taskslist of objects

Get Oort Orders Order Id Or Short Id Full

Path parameters

Headers

Response

Errors