Fetch Transfer Request

GET

Fetches a Transfer Request by ID from the Impilo platform.

Path parameters

idlongRequired

The ID of the Transfer Request to fetch.

Response

This endpoint returns an object.

idlongOptional

Unique identifier for the TransferRequest.

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.

currentStatusenumOptional

Allowed values: requestedapprovedpendingInventoryvoidedcompleted

createdAtdatetimeOptional

The timestamp when the Transfer Request was first created.

transferRequestNoteslist of objectsOptional

Notes attached to this Transfer Request.

transferRequestEventslist of objectsOptional

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

transferItemslist of objectsOptional

The Inventory that’s being requested to transfer.

GET

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

200item-transfer-request

1 {
2   "id": 123,
3   "fromCustomer": {
4     "id": 2,
5     "name": "Customer 2"
6   },
7   "toCustomer": {
8     "id": 3,
9     "name": "Customer 3"
10   },
11   "currentStatus": "requested",
12   "createdAt": "2024-12-16T19:16:40Z",
13   "transferRequestNotes": [
14     {
15       "note": "Note Text Here",
16       "createdAt": "2024-12-16T19:16:40.535392Z"
17     }
18   ],
19   "transferRequestEvents": [
20     {
21       "name": "requested",
22       "eventTimestamp": "2024-12-16T19:16:40Z"
23     }
24   ],
25   "transferItems": [
26     {
27       "item": {
28         "id": 791,
29         "manufacturer": {
30           "id": 2,
31           "name": "Custom Manufacturer"
32         },
33         "name": "Blood Pressure Monitor",
34         "model": "iBloodPressureMonitor123",
35         "sku": "0000001"
36       },
37       "count": 5,
38       "devices": [
39         {
40           "id": 1,
41           "currentPatient": {
42             "firstName": "John",
43             "lastName": "Doe",
44             "id": 1,
45             "externalIdentifier": "1234abcd",
46             "dateOfBirth": "1980-01-01",
47             "email": "john.doe@example.com",
48             "phoneNumber": "+1234567890",
49             "archived": true
50           }
51         }
52       ]
53     }
54   ]
55 }

Built with

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

1	{
2	"id": 123,
3	"fromCustomer": {
4	"id": 2,
5	"name": "Customer 2"
6	},
7	"toCustomer": {
8	"id": 3,
9	"name": "Customer 3"
10	},
11	"currentStatus": "requested",
12	"createdAt": "2024-12-16T19:16:40Z",
13	"transferRequestNotes": [
14	{
15	"note": "Note Text Here",
16	"createdAt": "2024-12-16T19:16:40.535392Z"
17	}
18	],
19	"transferRequestEvents": [
20	{
21	"name": "requested",
22	"eventTimestamp": "2024-12-16T19:16:40Z"
23	}
24	],
25	"transferItems": [
26	{
27	"item": {
28	"id": 791,
29	"manufacturer": {
30	"id": 2,
31	"name": "Custom Manufacturer"
32	},
33	"name": "Blood Pressure Monitor",
34	"model": "iBloodPressureMonitor123",
35	"sku": "0000001"
36	},
37	"count": 5,
38	"devices": [
39	{
40	"id": 1,
41	"currentPatient": {
42	"firstName": "John",
43	"lastName": "Doe",
44	"id": 1,
45	"externalIdentifier": "1234abcd",
46	"dateOfBirth": "1980-01-01",
47	"email": "john.doe@example.com",
48	"phoneNumber": "+1234567890",
49	"archived": true
50	}
51	}
52	]
53	}
54	]
55	}