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