Create Order

POST

/api/v3/order

POST

/api/v3/order

1 curl -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   "externalOrderIds": [
6     "xyz_123_0",
7     "xyz_123_1",
8     "xyz_123_2",
9     "xyz_123_3"
10   ],
11   "orderItems": [
12     {
13       "count": 10,
14       "item": {}
15     },
16     {
17       "count": 10,
18       "item": {}
19     },
20     {
21       "count": 10,
22       "item": {}
23     },
24     {
25       "count": 10,
26       "item": {}
27     }
28   ],
29   "orderKits": [
30     {
31       "count": 10,
32       "kit": {
33         "id": 1000,
34         "kitItems": []
35       }
36     },
37     {
38       "count": 10,
39       "kit": {
40         "id": 1001,
41         "kitItems": []
42       }
43     },
44     {
45       "count": 10,
46       "kit": {
47         "id": 1002,
48         "kitItems": []
49       }
50     },
51     {
52       "count": 10,
53       "kit": {
54         "id": 1003,
55         "kitItems": []
56       }
57     }
58   ],
59   "orderNotes": [],
60   "patient": {
61     "firstName": "John",
62     "lastName": "Doe",
63     "id": 1234,
64     "sex": "unknown"
65   },
66   "shippingOption": "standard"
67 }'

Try it

201existing-patient-order

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             "drivesExternalIdentifier": true,
126             "item": {
127               "id": 1,
128               "manufacturer": {
129                 "id": 1,
130                 "name": "foo"
131               },
132               "model": "foo",
133               "name": "foo",
134               "orderable": true,
135               "sku": "foo"
136             }
137           }
138         ],
139         "name": "foo"
140       }
141     }
142   ],
143   "orderNotes": [
144     {
145       "createdAt": "foo",
146       "createdBy": {
147         "email": "foo",
148         "firstName": "foo",
149         "id": 42,
150         "lastName": "foo"
151       },
152       "note": "foo"
153     }
154   ],
155   "packedKits": [
156     {
157       "devices": [
158         {
159           "currentPatient": {
160             "firstName": "John",
161             "lastName": "Doe",
162             "address": {
163               "city": "foo",
164               "country": "foo",
165               "lineOne": "foo",
166               "state": "foo",
167               "zipCode": "foo",
168               "lineThree": "foo",
169               "lineTwo": "foo",
170               "note": "foo"
171             },
172             "archived": true,
173             "dateOfBirth": "1980-01-01",
174             "email": "john.doe@example.com",
175             "enrolled": true,
176             "externalIdentifier": "1234abcd",
177             "id": 1,
178             "phoneNumber": "+1234567890",
179             "sex": "unknown",
180             "site": {
181               "active": true,
182               "address": {
183                 "city": "foo",
184                 "country": "foo",
185                 "lineOne": "foo",
186                 "state": "foo",
187                 "zipCode": "foo",
188                 "lineThree": "foo",
189                 "lineTwo": "foo",
190                 "note": "foo"
191               },
192               "id": 1,
193               "name": "foo",
194               "phoneNumber": "foo"
195             }
196           },
197           "currentStatus": "foo",
198           "deviceEvents": [
199             {
200               "eventTimestamp": "foo",
201               "type": "foo"
202             }
203           ],
204           "deviceIdentifiers": [
205             {
206               "type": "foo",
207               "value": "foo"
208             }
209           ],
210           "disabledReadings": false,
211           "externalIdentifier": "1d23-4567-89ab-cdef",
212           "id": 1,
213           "item": {
214             "id": 1,
215             "manufacturer": {
216               "id": 1,
217               "name": "foo"
218             },
219             "model": "foo",
220             "name": "foo",
221             "orderable": true,
222             "sku": "foo"
223           },
224           "lastHealthCheck": "2023-10-01T12:00:00Z",
225           "site": {
226             "active": true,
227             "address": {
228               "city": "foo",
229               "country": "foo",
230               "lineOne": "foo",
231               "state": "foo",
232               "zipCode": "foo",
233               "lineThree": "foo",
234               "lineTwo": "foo",
235               "note": "foo"
236             },
237             "id": 1,
238             "name": "foo",
239             "phoneNumber": "foo"
240           },
241           "used": true
242         }
243       ],
244       "externalIdentifier": "foo",
245       "id": 42,
246       "kit": {
247         "archived": true,
248         "id": 42,
249         "kitItems": [
250           {
251             "count": 42,
252             "drivesExternalIdentifier": true,
253             "item": {
254               "id": 1,
255               "manufacturer": {
256                 "id": 1,
257                 "name": "foo"
258               },
259               "model": "foo",
260               "name": "foo",
261               "orderable": true,
262               "sku": "foo"
263             }
264           }
265         ],
266         "name": "foo"
267       }
268     }
269   ],
270   "patient": {
271     "firstName": "John",
272     "lastName": "Doe",
273     "address": {
274       "city": "foo",
275       "country": "foo",
276       "lineOne": "foo",
277       "state": "foo",
278       "zipCode": "foo",
279       "lineThree": "foo",
280       "lineTwo": "foo",
281       "note": "foo"
282     },
283     "archived": true,
284     "dateOfBirth": "1980-01-01",
285     "email": "john.doe@example.com",
286     "enrolled": true,
287     "externalIdentifier": "1234abcd",
288     "id": 1,
289     "phoneNumber": "+1234567890",
290     "sex": "unknown",
291     "site": {
292       "active": true,
293       "address": {
294         "city": "foo",
295         "country": "foo",
296         "lineOne": "foo",
297         "state": "foo",
298         "zipCode": "foo",
299         "lineThree": "foo",
300         "lineTwo": "foo",
301         "note": "foo"
302       },
303       "id": 1,
304       "name": "foo",
305       "phoneNumber": "foo"
306     }
307   },
308   "shippingOption": "standard",
309   "site": {
310     "active": true,
311     "address": {
312       "city": "foo",
313       "country": "foo",
314       "lineOne": "foo",
315       "state": "foo",
316       "zipCode": "foo",
317       "lineThree": "foo",
318       "lineTwo": "foo",
319       "note": "foo"
320     },
321     "id": 1,
322     "name": "foo",
323     "phoneNumber": "foo"
324   },
325   "trackingNumbers": [
326     {
327       "carrier": "usps",
328       "value": "foo"
329     }
330   ]
331 }

This endpoint is for creating orders linked to either a patient or a site, with order content specified by item or kit IDs and an association with a patient or site ID. Optional attributes offer further customization, such as tracking through external order IDs.\n\nFor a comprehensive guide on utilizing this endpoint, including examples, required and optional attributes, and additional functionalities like listing and fetching orders, visit the Order Management Guide.

Request

This endpoint expects an object.

externalOrderIdslist of stringsOptional

An array of order ids specified by the client

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.

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.

Response

Created

currentStatusenum or null

The current status of the order

deviceslist of objects or null

The order item devices

externalOrderIdslist of strings or null

An array of order ids specified by the client

idlong or null

Unique identifier for the order

orderEventslist of objects or null

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

orderItemslist of objects or null

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

orderKitslist of objects or null

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

orderNoteslist of objects or null

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

packedKitslist of objects or null

The kits packed in the order

patientobject or null

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

shippingOptionenum or null

Allowed values:

siteobject or null

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

trackingNumberslist of objects or null

Array of tracking numbers for the order.

Headers

Request

Response