Fetch Order

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

1 { 2 "id": 1000000, 3 "externalOrderIds": [ 4 "externalOrderIds" 5 ], 6 "patient": { 7 "firstName": "John", 8 "lastName": "Doe", 9 "id": 1, 10 "externalIdentifier": "1234abcd", 11 "dateOfBirth": "1980-01-01", 12 "email": "john.doe@example.com", 13 "phoneNumber": "+1234567890", 14 "archived": true, 15 "address": { 16 "lineOne": "lineOne", 17 "city": "city", 18 "state": "state", 19 "zipCode": "zipCode", 20 "country": "country", 21 "lineTwo": "lineTwo", 22 "lineThree": "lineThree", 23 "note": "note" 24 }, 25 "site": { 26 "id": 1, 27 "name": "name", 28 "active": true, 29 "phoneNumber": "phoneNumber", 30 "address": { 31 "lineOne": "lineOne", 32 "city": "city", 33 "state": "state", 34 "zipCode": "zipCode", 35 "country": "country" 36 } 37 }, 38 "enrolled": true, 39 "sex": "other" 40 }, 41 "site": { 42 "id": 1, 43 "name": "name", 44 "active": true, 45 "phoneNumber": "phoneNumber", 46 "address": { 47 "lineOne": "lineOne", 48 "city": "city", 49 "state": "state", 50 "zipCode": "zipCode", 51 "country": "country", 52 "lineTwo": "lineTwo", 53 "lineThree": "lineThree", 54 "note": "note" 55 } 56 }, 57 "currentStatus": "availableForPickup", 58 "orderItems": [ 59 { 60 "item": { 61 "id": 1 62 }, 63 "count": 1 64 } 65 ], 66 "orderKits": [ 67 { 68 "count": 1 69 } 70 ], 71 "orderEvents": [ 72 { 73 "name": "name", 74 "eventTimestamp": "eventTimestamp" 75 } 76 ], 77 "trackingNumbers": [ 78 { 79 "carrier": "carrier", 80 "value": "value" 81 } 82 ], 83 "devices": [ 84 { 85 "id": 1, 86 "item": { 87 "id": 1 88 }, 89 "currentStatus": "currentStatus", 90 "used": true, 91 "currentPatient": { 92 "firstName": "John", 93 "lastName": "Doe", 94 "id": 1, 95 "externalIdentifier": "1234abcd", 96 "dateOfBirth": "1980-01-01", 97 "email": "john.doe@example.com", 98 "phoneNumber": "+1234567890", 99 "archived": true 100 }, 101 "site": { 102 "id": 1 103 }, 104 "lastHealthCheck": "lastHealthCheck", 105 "deviceIdentifiers": [ 106 {} 107 ], 108 "deviceEvents": [ 109 {} 110 ], 111 "externalIdentifier": "externalIdentifier", 112 "disabledReadings": true 113 } 114 ], 115 "packedKits": [ 116 { 117 "devices": [ 118 { 119 "id": 1, 120 "currentPatient": { 121 "firstName": "John", 122 "lastName": "Doe", 123 "id": 1, 124 "externalIdentifier": "1234abcd", 125 "dateOfBirth": "1980-01-01", 126 "email": "john.doe@example.com", 127 "phoneNumber": "+1234567890", 128 "archived": true 129 } 130 } 131 ] 132 } 133 ], 134 "shippingOption": "standard" 135 }

Path parameters

orderIdlongRequired

Response

This endpoint returns an object.

idlongOptional

Unique identifier for the order

externalOrderIdslist of stringsOptional

An array of order ids specified by the client

patientobjectOptional

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

siteobjectOptional

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

currentStatusenumOptional

The current status of the order

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.

orderEventslist of objectsOptional

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

trackingNumberslist of objectsOptional

Array of tracking numbers for the order.

deviceslist of objectsOptional

The order item devices

packedKitslist of objectsOptional

The kits packed in the order

shippingOptionenumOptional

Allowed values:

Path parameters

Headers

Response