List Orders

GET

/api/v3/order

GET

/api/v3/order

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

Try it

200listOrdersExample

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

Query parameters

pageintegerOptionalDefaults to 1

sizeintegerOptionalDefaults to 15

patientIdlongOptional

externalOrderIdlist of stringsOptional

Lists only orders with the order external identifiers provided.

externalPatientIdlist of stringsOptional

Lists only orders with the patient external identifiers provided.

Response

contentlist of objects or null

The content of the page, consisting of a list of objects.

firstboolean or null

True if this is the first page, false otherwise.

lastboolean or null

True if this is the last page, false otherwise.

pageinteger or null

The current page number. The first page has value 1.

sizeinteger or null

The current page size. Default 15, maximum 250.

totalinteger or null

The number of objects matching the request.

Headers

Query parameters

Response