Get order full details

GET

/oort/orders/v1/:order_id_or_short_id/full

GET

/oort/orders/v1/:order_id_or_short_id/full

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

Try it

200Retrieved

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

(DEPRECATED) Retrieves an order with all related task groups, tasks, milestones, and cargo information.

Authentication

AuthorizationBearer

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

Path Parameters

order_id_or_short_idstringRequired

Response

Successful Response

orderobject

task_groupslist of objects

taskslist of objects

milestoneslist of objects

cargoslist of objects

Authentication

Path Parameters

Response

Errors