Fetch Transfer Request

1 curl https://app.impiloplatform.com/api/v3/transfer/transfer-request/42 \ 2 -H "Impilo-API-Key: <Impilo-API-Key>"

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

Fetches a Transfer Request by ID from the Impilo platform.

Path parameters

idlongRequired

The ID of the Transfer Request to fetch.

Response

createdAtstring

The timestamp when the Transfer Request was first created.

idlong

Unique identifier for the TransferRequest.

currentStatusenumOptional

The current status of the Transfer Request.

Allowed values:

fromCustomerobjectOptional

Customer from which the Inventory will be transferred away from. Typically auto-set to the caller of the TransferRequest endpoints.

toCustomerobjectOptional

The target Customer to send the requested Inventory to.

transferItemslist of objectsOptional

The Inventory that’s being requested to transfer.

transferRequestEventslist of objectsOptional

The sequence of events that this Transfer Request has undergone. Sorted most recent event first.

transferRequestNoteslist of objectsOptional

Notes attached to this Transfer Request.

Path parameters

Headers

Response