Create Return

POST

1 curl -X POST https://app.impiloplatform.com/api/v3/return \
2      -H "Impilo-API-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "patientId": 36892,
6   "returnItems": [
7     {
8       "id": 83521,
9       "count": 3
10     }
11   ],
12   "shippingOption": "standard",
13   "emailLabel": false
14 }'

Play

200rmaCreateResponseExample

1 {
2   "id": 472,
3   "patient": {
4     "firstName": "John",
5     "lastName": "Doe",
6     "id": 456,
7     "externalIdentifier": "external-identifier-123",
8     "dateOfBirth": "1987-09-13",
9     "email": "email@example.com",
10     "phoneNumber": "111-222-3333",
11     "archived": true,
12     "address": {
13       "lineOne": "1234 Market Street",
14       "city": "Philadelphia",
15       "state": "PA",
16       "zipCode": "19137",
17       "country": "USA",
18       "lineTwo": "Suite 110",
19       "lineThree": "lineThree",
20       "note": "note"
21     },
22     "site": {
23       "id": 1,
24       "name": "name",
25       "active": true,
26       "phoneNumber": "phoneNumber",
27       "address": {
28         "lineOne": "lineOne",
29         "city": "city",
30         "state": "state",
31         "zipCode": "zipCode",
32         "country": "country"
33       }
34     },
35     "enrolled": true,
36     "sex": "unknown"
37   },
38   "site": {
39     "id": 1,
40     "name": "name",
41     "active": true,
42     "phoneNumber": "phoneNumber",
43     "address": {
44       "lineOne": "lineOne",
45       "city": "city",
46       "state": "state",
47       "zipCode": "zipCode",
48       "country": "country",
49       "lineTwo": "lineTwo",
50       "lineThree": "lineThree",
51       "note": "note"
52     }
53   },
54   "currentStatus": "rmaPlaced",
55   "returnKits": [
56     {
57       "id": 1000000,
58       "name": "name",
59       "archived": true,
60       "kitItems": [
61         {}
62       ]
63     }
64   ],
65   "returnItems": [
66     {
67       "item": {
68         "id": 791,
69         "manufacturer": {
70           "id": 2,
71           "name": "Custom Manufacturer"
72         },
73         "name": "Blood Pressure Monitor",
74         "model": "iBloodPressureMonitor123",
75         "sku": "0000001"
76       },
77       "count": 1
78     }
79   ],
80   "returnEvents": [
81     {
82       "type": "type",
83       "eventTimestamp": "eventTimestamp"
84     }
85   ],
86   "trackingNumbers": [
87     {
88       "carrier": "USPS",
89       "value": "9400110200883830000001"
90     }
91   ],
92   "returnDevices": [
93     {
94       "id": 599,
95       "item": {
96         "id": 791,
97         "manufacturer": {
98           "id": 2,
99           "name": "Custom Manufacturer"
100         },
101         "name": "Blood Pressure Monitor",
102         "model": "iBloodPressureMonitor123",
103         "sku": "0000001"
104       },
105       "currentStatus": "withPatient",
106       "used": true,
107       "currentPatient": {
108         "firstName": "John",
109         "lastName": "Doe",
110         "id": 456,
111         "externalIdentifier": "external-identifier-123",
112         "dateOfBirth": "1987-09-13",
113         "email": "email@example.com",
114         "phoneNumber": "111-222-3333",
115         "archived": true,
116         "address": {
117           "lineOne": "1234 Market Street",
118           "city": "Philadelphia",
119           "state": "PA",
120           "zipCode": "19137",
121           "country": "USA",
122           "lineTwo": "Suite 110"
123         },
124         "sex": "unknown"
125       },
126       "site": {
127         "id": 1
128       },
129       "lastHealthCheck": "lastHealthCheck",
130       "deviceIdentifiers": [
131         {
132           "type": "imei",
133           "value": "354833969951611"
134         },
135         {
136           "type": "serial",
137           "value": "A44-A0623930"
138         },
139         {
140           "type": "macAddress",
141           "value": "f51da43314fc"
142         }
143       ],
144       "deviceEvents": [
145         {}
146       ],
147       "externalIdentifier": "externalIdentifier",
148       "disabledReadings": false
149     }
150   ],
151   "relatedOrderId": 846
152 }

Creates a Return Merchandise Authorization (RMA).

For more information see the CreateReturn Model.

Request

This endpoint expects an object.

patientIdlongOptional

The patient that is making the return.

siteIdlongOptional

The site that is making the return.

returnItemslist of objectsOptional

An array of non-tracked items expected on this return.

returnDeviceslist of objectsOptional

An array of devices expected on this return.

shippingOptionenumOptionalDefaults to standard

The shipping service level.

Allowed values:

emailLabelbooleanOptional

Indicates if the return shipping label will be emailed or shipped.

Response

This endpoint returns an object.

idlongOptional

Unique identifier for the return, managed by Impilo.

patientobjectOptional

The patient that is making the return.

siteobjectOptional

The site that is making the return.

currentStatusstringOptional

The current status of this return.

returnKitslist of objectsOptional

An array of kits related to items expected on this return.

returnItemslist of objectsOptional

An array of non-tracked items expected on this return.

returnEventslist of objectsOptional

An array of the return events for this return.

trackingNumberslist of objectsOptional

An array of tracking numbers associated with this return.

returnDeviceslist of objectsOptional

An array of devices expected on this return.

relatedOrderIdlongOptional

The identifier of a related order, if exists.

Headers

Request

Response