Orders

Fetch Order

GET

Path parameters

orderIdintegerRequired

Response

This endpoint returns an object
id
integerOptional
Unique identifier for the order
externalOrderIds
list of stringsOptional
An array of order ids specified by the client
patient
objectOptional
The patient receiving the order. Exactly one of patient or site must be not null.
site
objectOptional
The site receiving the order. Exactly one of patient or site must be not null.
currentStatus
enumOptional
The current status of the order
orderItems
list of objectsOptional
Array of items on the order. At least one of orderItems or orderKits must be not null.
orderKits
list of objectsOptional
Array of order kits on the order. At least one of orderItems or orderKits must be not null.
orderEvents
list of objectsOptional
Array of order events. These are the status updates for the order.
trackingNumbers
list of objectsOptional
Array of tracking numbers for the order.
devices
list of objectsOptional
The order item devices
packedKits
list of objectsOptional
The kits packed in the order
GET
1curl https://app.impiloplatform.com/api/v3/order/1 \
2 -H "Impilo-API-Key: <apiKey>"
200Retrieved
1{
2 "id": 1,
3 "externalOrderIds": [
4 "externalOrderIds"
5 ],
6 "patient": {
7 "id": 1,
8 "externalIdentifier": "1234abcd",
9 "firstName": "John",
10 "lastName": "Doe",
11 "dateOfBirth": "1980-01-01",
12 "email": "john.doe@example.com",
13 "phoneNumber": "+1234567890",
14 "archived": true,
15 "address": {
16 "lineOne": "lineOne",
17 "lineTwo": "lineTwo",
18 "lineThree": "lineThree",
19 "city": "city",
20 "state": "state",
21 "zipCode": "zipCode",
22 "country": "country",
23 "note": "note"
24 },
25 "site": {
26 "id": 1,
27 "name": "name",
28 "active": true
29 },
30 "enrolled": true,
31 "sex": "female"
32 },
33 "site": {
34 "id": 1,
35 "name": "name",
36 "active": true,
37 "address": {
38 "lineOne": "lineOne",
39 "lineTwo": "lineTwo",
40 "lineThree": "lineThree",
41 "city": "city",
42 "state": "state",
43 "zipCode": "zipCode",
44 "country": "country",
45 "note": "note"
46 }
47 },
48 "currentStatus": "reconfirmAddress",
49 "orderItems": [
50 {
51 "item": {
52 "id": 1
53 },
54 "count": 1
55 }
56 ],
57 "orderKits": [
58 {
59 "count": 1
60 }
61 ],
62 "orderEvents": [
63 {
64 "name": "name",
65 "eventTimestamp": "eventTimestamp"
66 }
67 ],
68 "trackingNumbers": [
69 {
70 "carrier": "carrier",
71 "value": "value"
72 }
73 ],
74 "devices": [
75 {
76 "id": 1,
77 "item": {
78 "id": 1
79 },
80 "currentStatus": "currentStatus",
81 "used": true,
82 "currentPatient": {
83 "id": 1,
84 "externalIdentifier": "1234abcd",
85 "firstName": "John",
86 "lastName": "Doe",
87 "dateOfBirth": "1980-01-01",
88 "email": "john.doe@example.com",
89 "phoneNumber": "+1234567890",
90 "archived": true,
91 "sex": "female"
92 },
93 "site": {
94 "id": 1
95 },
96 "lastHealthCheck": "lastHealthCheck",
97 "deviceIdentifiers": [
98 {}
99 ],
100 "deviceEvents": [
101 {}
102 ],
103 "externalIdentifier": "externalIdentifier",
104 "disabledReadings": true
105 }
106 ],
107 "packedKits": [
108 {
109 "devices": [
110 {
111 "id": 1
112 }
113 ]
114 }
115 ]
116}