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": "2024-07-04T00:00:00Z", 3 "id": 123, 4 "currentStatus": "requested", 5 "fromCustomer": { 6 "id": 2, 7 "name": "Customer 2" 8 }, 9 "toCustomer": { 10 "id": 3, 11 "name": "Customer 3" 12 }, 13 "transferItems": [ 14 { 15 "count": 5, 16 "item": { 17 "id": 791, 18 "manufacturer": { 19 "id": 2, 20 "name": "Custom Manufacturer" 21 }, 22 "model": "iBloodPressureMonitor123", 23 "name": "Blood Pressure Monitor", 24 "sku": "0000001" 25 }, 26 "devices": [] 27 } 28 ], 29 "transferRequestEvents": [ 30 { 31 "eventTimestamp": "2024-07-04T00:00:00Z", 32 "name": "requested" 33 } 34 ], 35 "transferRequestNotes": [ 36 { 37 "createdAt": "2024-07-04T00:00:00Z", 38 "note": "Note Text Here" 39 } 40 ] 41 }

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.

currentStatusenum or null

The current status of the Transfer Request.

Allowed values:

fromCustomerobject or null

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

toCustomerobject or null

The target Customer to send the requested Inventory to.

transferItemslist of objects or null

The Inventory that's being requested to transfer.

transferRequestEventslist of objects or null

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

transferRequestNoteslist of objects or null

Notes attached to this Transfer Request.

Path parameters

Headers

Response