Guides

Order Management Guide

This guide is designed to help you understand how orders can be created and linked with either an existing patient or an existing site, and the required as well as optional attributes for order creation.

Understanding Patients and Sites

Before we dive into the order creation process, it’s important to understand the entities associated with an order:

  • Patient: A patient profile is stored within Impilo and is managed by the customer. These profiles are essential for personalizing and managing patient-related orders.

  • Site: A site represents a customer-managed location that engages with Impilo’s services. Patients can be associated with a site for the purpose of orders and inventory management. The customer is responsible for managing the set of sites within their account, which can interact with Impilo’s services.

Create Order Endpoint

To create an order, you’ll interact with a specific endpoint designed for this purpose. This endpoint allows you to initiate and configure orders based on your requirements.

Required Attributes

For a successful order creation, you must ensure the following required attributes are correctly provided:

  • Association: Your order must be associated with either an existing patient or an site. It is crucial that exactly one of these is specified for an order, and only the id property of the patient or site is required.

  • Order Content: Your order must include at least one of the following:

  • orderItems: A list of items to be ordered. You must provide at least one item with only the id property required.

  • orderKits: A list of kits to be ordered. Similar to order items, at least one kit must be specified with only the id property required.

Create Patient Order Example

The following request contains the bare minimum for creating an order for an existing patient.

POST
/api/v3/order
1curl -X POST https://app.impiloplatform.com/api/v3/order \
2     -H "Impilo-API-Key: <Impilo-API-Key>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "emailLabel": false,
6  "externalOrderIds": [
7    "xyz_123_0",
8    "xyz_123_1",
9    "xyz_123_2",
10    "xyz_123_3"
11  ],
12  "orderItems": [
13    {
14      "count": 10,
15      "item": {}
16    },
17    {
18      "count": 10,
19      "item": {}
20    },
21    {
22      "count": 10,
23      "item": {}
24    },
25    {
26      "count": 10,
27      "item": {}
28    }
29  ],
30  "orderKits": [
31    {
32      "count": 10,
33      "kit": {
34        "id": 1000,
35        "kitItems": []
36      }
37    },
38    {
39      "count": 10,
40      "kit": {
41        "id": 1001,
42        "kitItems": []
43      }
44    },
45    {
46      "count": 10,
47      "kit": {
48        "id": 1002,
49        "kitItems": []
50      }
51    },
52    {
53      "count": 10,
54      "kit": {
55        "id": 1003,
56        "kitItems": []
57      }
58    }
59  ],
60  "orderNotes": [],
61  "patient": {
62    "firstName": "John",
63    "lastName": "Doe",
64    "id": 1234,
65    "sex": "unknown"
66  },
67  "returnDevices": [],
68  "returnItems": [],
69  "returnPackedKits": [],
70  "shippingOption": "standard"
71}'

Below is an example response containing sample data.

Response
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  "emailLabel": true,
91  "externalOrderIds": [
92    "foo"
93  ],
94  "id": 42,
95  "orderEvents": [
96    {
97      "eventTimestamp": "foo",
98      "name": "foo"
99    }
100  ],
101  "orderItems": [
102    {
103      "count": 42,
104      "item": {
105        "id": 1,
106        "manufacturer": {
107          "id": 1,
108          "name": "foo"
109        },
110        "model": "foo",
111        "name": "foo",
112        "orderable": true,
113        "sku": "foo"
114      }
115    }
116  ],
117  "orderKits": [
118    {
119      "count": 42,
120      "kit": {
121        "archived": true,
122        "id": 42,
123        "kitItems": [
124          {
125            "count": 42,
126            "drivesExternalIdentifier": true,
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      "externalIdentifier": "foo",
246      "id": 42,
247      "kit": {
248        "archived": true,
249        "id": 42,
250        "kitItems": [
251          {
252            "count": 42,
253            "drivesExternalIdentifier": true,
254            "item": {
255              "id": 1,
256              "manufacturer": {
257                "id": 1,
258                "name": "foo"
259              },
260              "model": "foo",
261              "name": "foo",
262              "orderable": true,
263              "sku": "foo"
264            }
265          }
266        ],
267        "name": "foo"
268      }
269    }
270  ],
271  "patient": {
272    "firstName": "John",
273    "lastName": "Doe",
274    "address": {
275      "city": "foo",
276      "country": "foo",
277      "lineOne": "foo",
278      "state": "foo",
279      "zipCode": "foo",
280      "lineThree": "foo",
281      "lineTwo": "foo",
282      "note": "foo"
283    },
284    "archived": true,
285    "dateOfBirth": "1980-01-01",
286    "email": "john.doe@example.com",
287    "enrolled": true,
288    "externalIdentifier": "1234abcd",
289    "id": 1,
290    "phoneNumber": "+1234567890",
291    "sex": "unknown",
292    "site": {
293      "active": true,
294      "address": {
295        "city": "foo",
296        "country": "foo",
297        "lineOne": "foo",
298        "state": "foo",
299        "zipCode": "foo",
300        "lineThree": "foo",
301        "lineTwo": "foo",
302        "note": "foo"
303      },
304      "id": 1,
305      "name": "foo",
306      "phoneNumber": "foo"
307    }
308  },
309  "returnDevices": [
310    {
311      "id": 42
312    }
313  ],
314  "returnItems": [
315    {
316      "count": 42,
317      "id": 42
318    }
319  ],
320  "returnPackedKits": [
321    {
322      "id": 42,
323      "quantity": 42
324    }
325  ],
326  "shippingOption": "standard",
327  "site": {
328    "active": true,
329    "address": {
330      "city": "foo",
331      "country": "foo",
332      "lineOne": "foo",
333      "state": "foo",
334      "zipCode": "foo",
335      "lineThree": "foo",
336      "lineTwo": "foo",
337      "note": "foo"
338    },
339    "id": 1,
340    "name": "foo",
341    "phoneNumber": "foo"
342  },
343  "trackingNumbers": [
344    {
345      "carrier": "usps",
346      "value": "foo"
347    }
348  ]
349}

Create Site Order Example

The following request contains the bare minimum for creating an order for an existing site.

POST
/api/v3/order
1curl -X POST https://app.impiloplatform.com/api/v3/order \
2     -H "Impilo-API-Key: <Impilo-API-Key>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "emailLabel": false,
6  "externalOrderIds": [
7    "xyz_123_0",
8    "xyz_123_1",
9    "xyz_123_2",
10    "xyz_123_3"
11  ],
12  "orderItems": [
13    {
14      "count": 10,
15      "item": {}
16    },
17    {
18      "count": 10,
19      "item": {}
20    },
21    {
22      "count": 10,
23      "item": {}
24    },
25    {
26      "count": 10,
27      "item": {}
28    }
29  ],
30  "orderKits": [
31    {
32      "count": 10,
33      "kit": {
34        "id": 1000,
35        "kitItems": []
36      }
37    },
38    {
39      "count": 10,
40      "kit": {
41        "id": 1001,
42        "kitItems": []
43      }
44    },
45    {
46      "count": 10,
47      "kit": {
48        "id": 1002,
49        "kitItems": []
50      }
51    },
52    {
53      "count": 10,
54      "kit": {
55        "id": 1003,
56        "kitItems": []
57      }
58    }
59  ],
60  "orderNotes": [],
61  "returnDevices": [],
62  "returnItems": [],
63  "returnPackedKits": [],
64  "shippingOption": "standard",
65  "site": {}
66}'

Below is an example response containing sample data.

Response
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  "emailLabel": true,
91  "externalOrderIds": [
92    "foo"
93  ],
94  "id": 42,
95  "orderEvents": [
96    {
97      "eventTimestamp": "foo",
98      "name": "foo"
99    }
100  ],
101  "orderItems": [
102    {
103      "count": 42,
104      "item": {
105        "id": 1,
106        "manufacturer": {
107          "id": 1,
108          "name": "foo"
109        },
110        "model": "foo",
111        "name": "foo",
112        "orderable": true,
113        "sku": "foo"
114      }
115    }
116  ],
117  "orderKits": [
118    {
119      "count": 42,
120      "kit": {
121        "archived": true,
122        "id": 42,
123        "kitItems": [
124          {
125            "count": 42,
126            "drivesExternalIdentifier": true,
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      "externalIdentifier": "foo",
246      "id": 42,
247      "kit": {
248        "archived": true,
249        "id": 42,
250        "kitItems": [
251          {
252            "count": 42,
253            "drivesExternalIdentifier": true,
254            "item": {
255              "id": 1,
256              "manufacturer": {
257                "id": 1,
258                "name": "foo"
259              },
260              "model": "foo",
261              "name": "foo",
262              "orderable": true,
263              "sku": "foo"
264            }
265          }
266        ],
267        "name": "foo"
268      }
269    }
270  ],
271  "patient": {
272    "firstName": "John",
273    "lastName": "Doe",
274    "address": {
275      "city": "foo",
276      "country": "foo",
277      "lineOne": "foo",
278      "state": "foo",
279      "zipCode": "foo",
280      "lineThree": "foo",
281      "lineTwo": "foo",
282      "note": "foo"
283    },
284    "archived": true,
285    "dateOfBirth": "1980-01-01",
286    "email": "john.doe@example.com",
287    "enrolled": true,
288    "externalIdentifier": "1234abcd",
289    "id": 1,
290    "phoneNumber": "+1234567890",
291    "sex": "unknown",
292    "site": {
293      "active": true,
294      "address": {
295        "city": "foo",
296        "country": "foo",
297        "lineOne": "foo",
298        "state": "foo",
299        "zipCode": "foo",
300        "lineThree": "foo",
301        "lineTwo": "foo",
302        "note": "foo"
303      },
304      "id": 1,
305      "name": "foo",
306      "phoneNumber": "foo"
307    }
308  },
309  "returnDevices": [
310    {
311      "id": 42
312    }
313  ],
314  "returnItems": [
315    {
316      "count": 42,
317      "id": 42
318    }
319  ],
320  "returnPackedKits": [
321    {
322      "id": 42,
323      "quantity": 42
324    }
325  ],
326  "shippingOption": "standard",
327  "site": {
328    "active": true,
329    "address": {
330      "city": "foo",
331      "country": "foo",
332      "lineOne": "foo",
333      "state": "foo",
334      "zipCode": "foo",
335      "lineThree": "foo",
336      "lineTwo": "foo",
337      "note": "foo"
338    },
339    "id": 1,
340    "name": "foo",
341    "phoneNumber": "foo"
342  },
343  "trackingNumbers": [
344    {
345      "carrier": "usps",
346      "value": "foo"
347    }
348  ]
349}

Optional Attributes

In addition to the required attributes, the following optional attributes can be specified to further customize your order:

  • External Order IDs (externalOrderIds): An array of strings allowing the client to associate one or more of their own order IDs with the Impilo order record. This is particularly useful for tracking and management purposes on the client’s end.

Listing Orders

This functionality allows you to retrieve a list of orders made within the system. It supports pagination to help manage and navigate through large sets of orders effectively. This endpoint is particularly useful for overviewing all orders and analyzing order trends or statuses within a specific timeframe or criteria.

GET
/api/v3/order
1curl https://app.impiloplatform.com/api/v3/order \
2     -H "Impilo-API-Key: <Impilo-API-Key>"
Response
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      "emailLabel": true,
93      "externalOrderIds": [
94        "foo"
95      ],
96      "id": 42,
97      "orderEvents": [
98        {
99          "eventTimestamp": "foo",
100          "name": "foo"
101        }
102      ],
103      "orderItems": [
104        {
105          "count": 42,
106          "item": {
107            "id": 1,
108            "manufacturer": {
109              "id": 1,
110              "name": "foo"
111            },
112            "model": "foo",
113            "name": "foo",
114            "orderable": true,
115            "sku": "foo"
116          }
117        }
118      ],
119      "orderKits": [
120        {
121          "count": 42,
122          "kit": {
123            "archived": true,
124            "id": 42,
125            "kitItems": [
126              {
127                "count": 42,
128                "drivesExternalIdentifier": true,
129                "item": {
130                  "id": 1,
131                  "manufacturer": {
132                    "id": 1,
133                    "name": "foo"
134                  },
135                  "model": "foo",
136                  "name": "foo",
137                  "orderable": true,
138                  "sku": "foo"
139                }
140              }
141            ],
142            "name": "foo"
143          }
144        }
145      ],
146      "orderNotes": [
147        {
148          "createdAt": "foo",
149          "createdBy": {
150            "email": "foo",
151            "firstName": "foo",
152            "id": 42,
153            "lastName": "foo"
154          },
155          "note": "foo"
156        }
157      ],
158      "packedKits": [
159        {
160          "devices": [
161            {
162              "currentPatient": {
163                "firstName": "John",
164                "lastName": "Doe",
165                "address": {
166                  "city": "foo",
167                  "country": "foo",
168                  "lineOne": "foo",
169                  "state": "foo",
170                  "zipCode": "foo",
171                  "lineThree": "foo",
172                  "lineTwo": "foo",
173                  "note": "foo"
174                },
175                "archived": true,
176                "dateOfBirth": "1980-01-01",
177                "email": "john.doe@example.com",
178                "enrolled": true,
179                "externalIdentifier": "1234abcd",
180                "id": 1,
181                "phoneNumber": "+1234567890",
182                "sex": "unknown",
183                "site": {
184                  "active": true,
185                  "address": {
186                    "city": "foo",
187                    "country": "foo",
188                    "lineOne": "foo",
189                    "state": "foo",
190                    "zipCode": "foo",
191                    "lineThree": "foo",
192                    "lineTwo": "foo",
193                    "note": "foo"
194                  },
195                  "id": 1,
196                  "name": "foo",
197                  "phoneNumber": "foo"
198                }
199              },
200              "currentStatus": "foo",
201              "deviceEvents": [
202                {
203                  "eventTimestamp": "foo",
204                  "type": "foo"
205                }
206              ],
207              "deviceIdentifiers": [
208                {
209                  "type": "foo",
210                  "value": "foo"
211                }
212              ],
213              "disabledReadings": false,
214              "externalIdentifier": "1d23-4567-89ab-cdef",
215              "id": 1,
216              "item": {
217                "id": 1,
218                "manufacturer": {
219                  "id": 1,
220                  "name": "foo"
221                },
222                "model": "foo",
223                "name": "foo",
224                "orderable": true,
225                "sku": "foo"
226              },
227              "lastHealthCheck": "2023-10-01T12:00:00Z",
228              "site": {
229                "active": true,
230                "address": {
231                  "city": "foo",
232                  "country": "foo",
233                  "lineOne": "foo",
234                  "state": "foo",
235                  "zipCode": "foo",
236                  "lineThree": "foo",
237                  "lineTwo": "foo",
238                  "note": "foo"
239                },
240                "id": 1,
241                "name": "foo",
242                "phoneNumber": "foo"
243              },
244              "used": true
245            }
246          ],
247          "externalIdentifier": "foo",
248          "id": 42,
249          "kit": {
250            "archived": true,
251            "id": 42,
252            "kitItems": [
253              {
254                "count": 42,
255                "drivesExternalIdentifier": true,
256                "item": {
257                  "id": 1,
258                  "manufacturer": {
259                    "id": 1,
260                    "name": "foo"
261                  },
262                  "model": "foo",
263                  "name": "foo",
264                  "orderable": true,
265                  "sku": "foo"
266                }
267              }
268            ],
269            "name": "foo"
270          }
271        }
272      ],
273      "patient": {
274        "firstName": "John",
275        "lastName": "Doe",
276        "address": {
277          "city": "foo",
278          "country": "foo",
279          "lineOne": "foo",
280          "state": "foo",
281          "zipCode": "foo",
282          "lineThree": "foo",
283          "lineTwo": "foo",
284          "note": "foo"
285        },
286        "archived": true,
287        "dateOfBirth": "1980-01-01",
288        "email": "john.doe@example.com",
289        "enrolled": true,
290        "externalIdentifier": "1234abcd",
291        "id": 1,
292        "phoneNumber": "+1234567890",
293        "sex": "unknown",
294        "site": {
295          "active": true,
296          "address": {
297            "city": "foo",
298            "country": "foo",
299            "lineOne": "foo",
300            "state": "foo",
301            "zipCode": "foo",
302            "lineThree": "foo",
303            "lineTwo": "foo",
304            "note": "foo"
305          },
306          "id": 1,
307          "name": "foo",
308          "phoneNumber": "foo"
309        }
310      },
311      "returnDevices": [
312        {
313          "id": 42
314        }
315      ],
316      "returnItems": [
317        {
318          "count": 42,
319          "id": 42
320        }
321      ],
322      "returnPackedKits": [
323        {
324          "id": 42,
325          "quantity": 42
326        }
327      ],
328      "shippingOption": "standard",
329      "site": {
330        "active": true,
331        "address": {
332          "city": "foo",
333          "country": "foo",
334          "lineOne": "foo",
335          "state": "foo",
336          "zipCode": "foo",
337          "lineThree": "foo",
338          "lineTwo": "foo",
339          "note": "foo"
340        },
341        "id": 1,
342        "name": "foo",
343        "phoneNumber": "foo"
344      },
345      "trackingNumbers": [
346        {
347          "carrier": "usps",
348          "value": "foo"
349        }
350      ]
351    }
352  ],
353  "first": true,
354  "last": true,
355  "page": 42,
356  "size": 42,
357  "total": 42
358}

Fetching a Single Order

For detailed analysis or management of a specific order, the system provides an endpoint to fetch the details of a single order using its unique identifier.

GET
/api/v3/order/:orderId
1curl https://app.impiloplatform.com/api/v3/order/42 \
2     -H "Impilo-API-Key: <Impilo-API-Key>"
Response
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  "emailLabel": true,
91  "externalOrderIds": [
92    "foo"
93  ],
94  "id": 42,
95  "orderEvents": [
96    {
97      "eventTimestamp": "foo",
98      "name": "foo"
99    }
100  ],
101  "orderItems": [
102    {
103      "count": 42,
104      "item": {
105        "id": 1,
106        "manufacturer": {
107          "id": 1,
108          "name": "foo"
109        },
110        "model": "foo",
111        "name": "foo",
112        "orderable": true,
113        "sku": "foo"
114      }
115    }
116  ],
117  "orderKits": [
118    {
119      "count": 42,
120      "kit": {
121        "archived": true,
122        "id": 42,
123        "kitItems": [
124          {
125            "count": 42,
126            "drivesExternalIdentifier": true,
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      "externalIdentifier": "foo",
246      "id": 42,
247      "kit": {
248        "archived": true,
249        "id": 42,
250        "kitItems": [
251          {
252            "count": 42,
253            "drivesExternalIdentifier": true,
254            "item": {
255              "id": 1,
256              "manufacturer": {
257                "id": 1,
258                "name": "foo"
259              },
260              "model": "foo",
261              "name": "foo",
262              "orderable": true,
263              "sku": "foo"
264            }
265          }
266        ],
267        "name": "foo"
268      }
269    }
270  ],
271  "patient": {
272    "firstName": "John",
273    "lastName": "Doe",
274    "address": {
275      "city": "foo",
276      "country": "foo",
277      "lineOne": "foo",
278      "state": "foo",
279      "zipCode": "foo",
280      "lineThree": "foo",
281      "lineTwo": "foo",
282      "note": "foo"
283    },
284    "archived": true,
285    "dateOfBirth": "1980-01-01",
286    "email": "john.doe@example.com",
287    "enrolled": true,
288    "externalIdentifier": "1234abcd",
289    "id": 1,
290    "phoneNumber": "+1234567890",
291    "sex": "unknown",
292    "site": {
293      "active": true,
294      "address": {
295        "city": "foo",
296        "country": "foo",
297        "lineOne": "foo",
298        "state": "foo",
299        "zipCode": "foo",
300        "lineThree": "foo",
301        "lineTwo": "foo",
302        "note": "foo"
303      },
304      "id": 1,
305      "name": "foo",
306      "phoneNumber": "foo"
307    }
308  },
309  "returnDevices": [
310    {
311      "id": 42
312    }
313  ],
314  "returnItems": [
315    {
316      "count": 42,
317      "id": 42
318    }
319  ],
320  "returnPackedKits": [
321    {
322      "id": 42,
323      "quantity": 42
324    }
325  ],
326  "shippingOption": "standard",
327  "site": {
328    "active": true,
329    "address": {
330      "city": "foo",
331      "country": "foo",
332      "lineOne": "foo",
333      "state": "foo",
334      "zipCode": "foo",
335      "lineThree": "foo",
336      "lineTwo": "foo",
337      "note": "foo"
338    },
339    "id": 1,
340    "name": "foo",
341    "phoneNumber": "foo"
342  },
343  "trackingNumbers": [
344    {
345      "carrier": "usps",
346      "value": "foo"
347    }
348  ]
349}

More

Create Order API Reference
Print