Create Item Transfer Request

POST

1 curl -X POST https://app.impiloplatform.com/api/v3/transfer/transfer-request \
2      -H "Impilo-API-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "toCustomerId": 1,
6   "transfers": [
7     {
8       "item": {
9         "id": 10,
10         "manufacturer": {
11           "id": 2,
12           "name": "Custom Manufacturer"
13         },
14         "name": "Blood Pressure Monitor",
15         "model": "iBloodPressureMonitor123",
16         "sku": "0000001"
17       },
18       "count": 20
19     },
20     {
21       "item": {
22         "id": 10,
23         "manufacturer": {
24           "id": 2,
25           "name": "Custom Manufacturer"
26         },
27         "name": "Blood Pressure Monitor",
28         "model": "iBloodPressureMonitor123",
29         "sku": "0000001"
30       },
31       "count": 20
32     }
33   ]
34 }'

Play

200createItemTransferRequestExample

1 1000000

Creates a Transfer Request, which consists of Items and Quantities to transfer from a Customer account to one of it’s sub-Customer accounts.

To submit a transfer request, the Target Customer must be a sub-Customer account of the requestor and the body must consist of at least one TransferItem object with a quantity greater than 0.

The only requirement for the TransferItem’s item parameter is a JSON object that includes an ID of the Item requested.

For more information see the ItemTransferRequest Model.

Request

This endpoint expects an object.

toCustomerIdlongRequired

The ID of the Customer to transfer the Devices to.

transferslist of objectsRequired

A list of ItemTransfer objects containing the Item IDs and quantities to transfer.

Response

This endpoint returns a long.

Headers

Request

Response