Fetch Order

GET

/api/v3/order/:orderId

GET

/api/v3/order/:orderId

1 curl https://app.impiloplatform.com/api/v3/order/42 \
2      -H "Impilo-API-Key: <Impilo-API-Key>"

Try it

200fetchOrderExample

1 {
2   "currentStatus": "reconfirmAddress",
3   "devices": [
4     {
5       "currentPatient": {
6         "firstName": "John",
7         "lastName": "Doe",
8         "address": {
9           "city": "foo",
10           "country": "foo",
11           "lineOne": "foo",
12           "state": "foo",
13           "zipCode": "foo",
14           "lineThree": "foo",
15           "lineTwo": "foo",
16           "note": "foo"
17         },
18         "archived": true,
19         "dateOfBirth": "1980-01-01",
20         "email": "john.doe@example.com",
21         "enrolled": true,
22         "externalIdentifier": "1234abcd",
23         "id": 1,
24         "phoneNumber": "+1234567890",
25         "sex": "unknown",
26         "site": {
27           "active": true,
28           "address": {
29             "city": "foo",
30             "country": "foo",
31             "lineOne": "foo",
32             "state": "foo",
33             "zipCode": "foo",
34             "lineThree": "foo",
35             "lineTwo": "foo",
36             "note": "foo"
37           },
38           "id": 1,
39           "name": "foo",
40           "phoneNumber": "foo"
41         }
42       },
43       "currentStatus": "foo",
44       "deviceEvents": [
45         {
46           "eventTimestamp": "foo",
47           "type": "foo"
48         }
49       ],
50       "deviceIdentifiers": [
51         {
52           "type": "foo",
53           "value": "foo"
54         }
55       ],
56       "disabledReadings": false,
57       "externalIdentifier": "1d23-4567-89ab-cdef",
58       "id": 1,
59       "item": {
60         "id": 1,
61         "manufacturer": {
62           "id": 1,
63           "name": "foo"
64         },
65         "model": "foo",
66         "name": "foo",
67         "orderable": true,
68         "sku": "foo"
69       },
70       "lastHealthCheck": "2023-10-01T12:00:00Z",
71       "site": {
72         "active": true,
73         "address": {
74           "city": "foo",
75           "country": "foo",
76           "lineOne": "foo",
77           "state": "foo",
78           "zipCode": "foo",
79           "lineThree": "foo",
80           "lineTwo": "foo",
81           "note": "foo"
82         },
83         "id": 1,
84         "name": "foo",
85         "phoneNumber": "foo"
86       },
87       "used": true
88     }
89   ],
90   "externalOrderIds": [
91     "foo"
92   ],
93   "id": 42,
94   "orderEvents": [
95     {
96       "eventTimestamp": "foo",
97       "name": "foo"
98     }
99   ],
100   "orderItems": [
101     {
102       "count": 42,
103       "item": {
104         "id": 1,
105         "manufacturer": {
106           "id": 1,
107           "name": "foo"
108         },
109         "model": "foo",
110         "name": "foo",
111         "orderable": true,
112         "sku": "foo"
113       }
114     }
115   ],
116   "orderKits": [
117     {
118       "count": 42,
119       "kit": {
120         "archived": true,
121         "id": 42,
122         "kitItems": [
123           {
124             "count": 42,
125             "item": {
126               "id": 1,
127               "manufacturer": {
128                 "id": 1,
129                 "name": "foo"
130               },
131               "model": "foo",
132               "name": "foo",
133               "orderable": true,
134               "sku": "foo"
135             }
136           }
137         ],
138         "name": "foo"
139       }
140     }
141   ],
142   "orderNotes": [
143     {
144       "createdAt": "foo",
145       "createdBy": {
146         "email": "foo",
147         "firstName": "foo",
148         "id": 42,
149         "lastName": "foo"
150       },
151       "note": "foo"
152     }
153   ],
154   "packedKits": [
155     {
156       "devices": [
157         {
158           "currentPatient": {
159             "firstName": "John",
160             "lastName": "Doe",
161             "address": {
162               "city": "foo",
163               "country": "foo",
164               "lineOne": "foo",
165               "state": "foo",
166               "zipCode": "foo",
167               "lineThree": "foo",
168               "lineTwo": "foo",
169               "note": "foo"
170             },
171             "archived": true,
172             "dateOfBirth": "1980-01-01",
173             "email": "john.doe@example.com",
174             "enrolled": true,
175             "externalIdentifier": "1234abcd",
176             "id": 1,
177             "phoneNumber": "+1234567890",
178             "sex": "unknown",
179             "site": {
180               "active": true,
181               "address": {
182                 "city": "foo",
183                 "country": "foo",
184                 "lineOne": "foo",
185                 "state": "foo",
186                 "zipCode": "foo",
187                 "lineThree": "foo",
188                 "lineTwo": "foo",
189                 "note": "foo"
190               },
191               "id": 1,
192               "name": "foo",
193               "phoneNumber": "foo"
194             }
195           },
196           "currentStatus": "foo",
197           "deviceEvents": [
198             {
199               "eventTimestamp": "foo",
200               "type": "foo"
201             }
202           ],
203           "deviceIdentifiers": [
204             {
205               "type": "foo",
206               "value": "foo"
207             }
208           ],
209           "disabledReadings": false,
210           "externalIdentifier": "1d23-4567-89ab-cdef",
211           "id": 1,
212           "item": {
213             "id": 1,
214             "manufacturer": {
215               "id": 1,
216               "name": "foo"
217             },
218             "model": "foo",
219             "name": "foo",
220             "orderable": true,
221             "sku": "foo"
222           },
223           "lastHealthCheck": "2023-10-01T12:00:00Z",
224           "site": {
225             "active": true,
226             "address": {
227               "city": "foo",
228               "country": "foo",
229               "lineOne": "foo",
230               "state": "foo",
231               "zipCode": "foo",
232               "lineThree": "foo",
233               "lineTwo": "foo",
234               "note": "foo"
235             },
236             "id": 1,
237             "name": "foo",
238             "phoneNumber": "foo"
239           },
240           "used": true
241         }
242       ],
243       "kit": {
244         "archived": true,
245         "id": 42,
246         "kitItems": [
247           {
248             "count": 42,
249             "item": {
250               "id": 1,
251               "manufacturer": {
252                 "id": 1,
253                 "name": "foo"
254               },
255               "model": "foo",
256               "name": "foo",
257               "orderable": true,
258               "sku": "foo"
259             }
260           }
261         ],
262         "name": "foo"
263       }
264     }
265   ],
266   "patient": {
267     "firstName": "John",
268     "lastName": "Doe",
269     "address": {
270       "city": "foo",
271       "country": "foo",
272       "lineOne": "foo",
273       "state": "foo",
274       "zipCode": "foo",
275       "lineThree": "foo",
276       "lineTwo": "foo",
277       "note": "foo"
278     },
279     "archived": true,
280     "dateOfBirth": "1980-01-01",
281     "email": "john.doe@example.com",
282     "enrolled": true,
283     "externalIdentifier": "1234abcd",
284     "id": 1,
285     "phoneNumber": "+1234567890",
286     "sex": "unknown",
287     "site": {
288       "active": true,
289       "address": {
290         "city": "foo",
291         "country": "foo",
292         "lineOne": "foo",
293         "state": "foo",
294         "zipCode": "foo",
295         "lineThree": "foo",
296         "lineTwo": "foo",
297         "note": "foo"
298       },
299       "id": 1,
300       "name": "foo",
301       "phoneNumber": "foo"
302     }
303   },
304   "shippingOption": "standard",
305   "site": {
306     "active": true,
307     "address": {
308       "city": "foo",
309       "country": "foo",
310       "lineOne": "foo",
311       "state": "foo",
312       "zipCode": "foo",
313       "lineThree": "foo",
314       "lineTwo": "foo",
315       "note": "foo"
316     },
317     "id": 1,
318     "name": "foo",
319     "phoneNumber": "foo"
320   },
321   "trackingNumbers": [
322     {
323       "carrier": "usps",
324       "value": "foo"
325     }
326   ]
327 }

Path parameters

orderIdlongRequired

Response

currentStatusenumOptional

The current status of the order

deviceslist of objectsOptional

The order item devices

externalOrderIdslist of stringsOptional

An array of order ids specified by the client

idlongOptional

Unique identifier for the order

orderEventslist of objectsOptional

Array of order events. These are the status updates for the order.

orderItemslist of objectsOptional

Array of items on the order. At least one of orderItems or orderKits must be not null.

orderKitslist of objectsOptional

Array of order kits on the order. At least one of orderItems or orderKits must be not null.

orderNoteslist of objectsOptional

Array of order notes. These are additional pieces of information attached to an order.

packedKitslist of objectsOptional

The kits packed in the order

patientobjectOptional

The patient receiving the order. Exactly one of patient or site must be not null.

shippingOptionenumOptional

Allowed values:

siteobjectOptional

The site receiving the order. Exactly one of patient or site must be not null.

trackingNumberslist of objectsOptional

Array of tracking numbers for the order.

Path parameters

Headers

Response