List Returns

GET

1 curl -G https://app.impiloplatform.com/api/v3/return \
2      -H "Impilo-API-Key: <apiKey>" \
3      -d lastUpdatedBefore=2022-03-10

Play

200rmaListResponseExample

1 {
2   "content": [
3     {
4       "id": 472,
5       "patient": {
6         "firstName": "John",
7         "lastName": "Doe",
8         "id": 456,
9         "externalIdentifier": "external-identifier-123",
10         "dateOfBirth": "1987-09-13",
11         "email": "email@example.com",
12         "phoneNumber": "111-222-3333",
13         "archived": true,
14         "address": {
15           "lineOne": "1234 Market Street",
16           "city": "Philadelphia",
17           "state": "PA",
18           "zipCode": "19137",
19           "country": "USA",
20           "lineTwo": "Suite 110"
21         },
22         "sex": "unknown"
23       },
24       "site": {
25         "id": 1
26       },
27       "currentStatus": "rmaPlaced",
28       "returnKits": [
29         {}
30       ],
31       "returnItems": [
32         {
33           "item": {
34             "id": 791,
35             "manufacturer": {
36               "id": 2,
37               "name": "Custom Manufacturer"
38             },
39             "name": "Blood Pressure Monitor",
40             "model": "iBloodPressureMonitor123",
41             "sku": "0000001"
42           },
43           "count": 1
44         }
45       ],
46       "returnEvents": [
47         {}
48       ],
49       "trackingNumbers": [
50         {
51           "carrier": "USPS",
52           "value": "9400110200883830000001"
53         }
54       ],
55       "returnDevices": [
56         {
57           "id": 599,
58           "item": {
59             "id": 791,
60             "manufacturer": {
61               "id": 2,
62               "name": "Custom Manufacturer"
63             },
64             "name": "Blood Pressure Monitor",
65             "model": "iBloodPressureMonitor123",
66             "sku": "0000001"
67           },
68           "currentStatus": "withPatient",
69           "currentPatient": {
70             "firstName": "John",
71             "lastName": "Doe",
72             "id": 456,
73             "externalIdentifier": "external-identifier-123",
74             "dateOfBirth": "1987-09-13",
75             "email": "email@example.com",
76             "phoneNumber": "111-222-3333",
77             "archived": true,
78             "address": {
79               "lineOne": "1234 Market Street",
80               "city": "Philadelphia",
81               "state": "PA",
82               "zipCode": "19137",
83               "country": "USA",
84               "lineTwo": "Suite 110"
85             },
86             "sex": "unknown"
87           },
88           "deviceIdentifiers": [
89             {
90               "type": "imei",
91               "value": "354833969951611"
92             },
93             {
94               "type": "serial",
95               "value": "A44-A0623930"
96             },
97             {
98               "type": "macAddress",
99               "value": "f51da43314fc"
100             }
101           ],
102           "disabledReadings": false
103         }
104       ],
105       "relatedOrderId": 846
106     },
107     {
108       "id": 473,
109       "patient": {
110         "firstName": "John",
111         "lastName": "Doe",
112         "id": 456,
113         "externalIdentifier": "external-identifier-123",
114         "dateOfBirth": "1987-09-13",
115         "email": "email@example.com",
116         "phoneNumber": "111-222-3333",
117         "archived": true,
118         "address": {
119           "lineOne": "1234 Market Street",
120           "city": "Philadelphia",
121           "state": "PA",
122           "zipCode": "19137",
123           "country": "USA",
124           "lineTwo": "Suite 110"
125         },
126         "sex": "unknown"
127       },
128       "site": {
129         "id": 1
130       },
131       "currentStatus": "rmaPlaced",
132       "returnKits": [
133         {}
134       ],
135       "returnItems": [
136         {
137           "item": {
138             "id": 791,
139             "manufacturer": {
140               "id": 2,
141               "name": "Custom Manufacturer"
142             },
143             "name": "Blood Pressure Monitor",
144             "model": "iBloodPressureMonitor123",
145             "sku": "0000001"
146           },
147           "count": 1
148         }
149       ],
150       "returnEvents": [
151         {}
152       ],
153       "trackingNumbers": [
154         {
155           "carrier": "USPS",
156           "value": "9400110200883830000001"
157         }
158       ],
159       "returnDevices": [
160         {
161           "id": 599,
162           "item": {
163             "id": 791,
164             "manufacturer": {
165               "id": 2,
166               "name": "Custom Manufacturer"
167             },
168             "name": "Blood Pressure Monitor",
169             "model": "iBloodPressureMonitor123",
170             "sku": "0000001"
171           },
172           "currentStatus": "withPatient",
173           "currentPatient": {
174             "firstName": "John",
175             "lastName": "Doe",
176             "id": 456,
177             "externalIdentifier": "external-identifier-123",
178             "dateOfBirth": "1987-09-13",
179             "email": "email@example.com",
180             "phoneNumber": "111-222-3333",
181             "archived": true,
182             "address": {
183               "lineOne": "1234 Market Street",
184               "city": "Philadelphia",
185               "state": "PA",
186               "zipCode": "19137",
187               "country": "USA",
188               "lineTwo": "Suite 110"
189             },
190             "sex": "unknown"
191           },
192           "deviceIdentifiers": [
193             {
194               "type": "imei",
195               "value": "354833969951611"
196             },
197             {
198               "type": "serial",
199               "value": "A44-A0623930"
200             },
201             {
202               "type": "macAddress",
203               "value": "f51da43314fc"
204             }
205           ],
206           "disabledReadings": false
207         }
208       ],
209       "relatedOrderId": 846
210     }
211   ],
212   "page": 1,
213   "size": 2,
214   "total": 4,
215   "first": true,
216   "last": false
217 }

Retrieves a paginated list of Return Merchandise Authorizations (RMAs) with various filtering options including pagination, sorting, and specific attributes such as status, last updated before, and standalone.

Query parameters

statusenumOptional

Lists only returns with the provided status.

relatedOrderIdlongOptional

Lists only returns related to the provided order ID.

searchStringstringOptional

lastUpdatedBeforestringOptional

standalonebooleanOptional

pageintegerOptional

sizeintegerOptional

Response

This endpoint returns an object.

contentlist of objectsOptional

The content of the page, consisting of a list of objects.

pageintegerOptional

The current page number. The first page has value 1.

sizeintegerOptional

The current page size. Default 15, maximum 250.

totalintegerOptional

The number of objects matching the request.

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

Headers

Query parameters

Response