List Returns

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

1 { 2 "content": [ 3 { 4 "currentStatus": "rmaPlaced", 5 "id": 1, 6 "patient": { 7 "firstName": "John", 8 "lastName": "Doe", 9 "address": { 10 "city": "foo", 11 "country": "foo", 12 "lineOne": "foo", 13 "state": "foo", 14 "zipCode": "foo", 15 "lineThree": "foo", 16 "lineTwo": "foo", 17 "note": "foo" 18 }, 19 "archived": true, 20 "dateOfBirth": "1980-01-01", 21 "email": "john.doe@example.com", 22 "enrolled": true, 23 "externalIdentifier": "1234abcd", 24 "id": 1, 25 "phoneNumber": "+1234567890", 26 "sex": "unknown", 27 "site": { 28 "active": true, 29 "address": { 30 "city": "foo", 31 "country": "foo", 32 "lineOne": "foo", 33 "state": "foo", 34 "zipCode": "foo", 35 "lineThree": "foo", 36 "lineTwo": "foo", 37 "note": "foo" 38 }, 39 "id": 1, 40 "name": "foo", 41 "phoneNumber": "foo" 42 } 43 }, 44 "relatedOrderId": 123456, 45 "returnDevices": [ 46 { 47 "currentPatient": { 48 "firstName": "John", 49 "lastName": "Doe", 50 "address": { 51 "city": "foo", 52 "country": "foo", 53 "lineOne": "foo", 54 "state": "foo", 55 "zipCode": "foo", 56 "lineThree": "foo", 57 "lineTwo": "foo", 58 "note": "foo" 59 }, 60 "archived": true, 61 "dateOfBirth": "1980-01-01", 62 "email": "john.doe@example.com", 63 "enrolled": true, 64 "externalIdentifier": "1234abcd", 65 "id": 1, 66 "phoneNumber": "+1234567890", 67 "sex": "unknown", 68 "site": { 69 "active": true, 70 "address": { 71 "city": "foo", 72 "country": "foo", 73 "lineOne": "foo", 74 "state": "foo", 75 "zipCode": "foo", 76 "lineThree": "foo", 77 "lineTwo": "foo", 78 "note": "foo" 79 }, 80 "id": 1, 81 "name": "foo", 82 "phoneNumber": "foo" 83 } 84 }, 85 "currentStatus": "foo", 86 "deviceEvents": [ 87 { 88 "eventTimestamp": "foo", 89 "type": "foo" 90 } 91 ], 92 "deviceIdentifiers": [ 93 { 94 "type": "foo", 95 "value": "foo" 96 } 97 ], 98 "disabledReadings": false, 99 "externalIdentifier": "1d23-4567-89ab-cdef", 100 "id": 1, 101 "item": { 102 "id": 1, 103 "manufacturer": { 104 "id": 1, 105 "name": "foo" 106 }, 107 "model": "foo", 108 "name": "foo", 109 "orderable": true, 110 "sku": "foo" 111 }, 112 "lastHealthCheck": "2023-10-01T12:00:00Z", 113 "site": { 114 "active": true, 115 "address": { 116 "city": "foo", 117 "country": "foo", 118 "lineOne": "foo", 119 "state": "foo", 120 "zipCode": "foo", 121 "lineThree": "foo", 122 "lineTwo": "foo", 123 "note": "foo" 124 }, 125 "id": 1, 126 "name": "foo", 127 "phoneNumber": "foo" 128 }, 129 "used": true 130 } 131 ], 132 "returnEvents": [ 133 { 134 "eventTimestamp": "2023-10-01T12:00:00Z", 135 "type": "rmaPlaced" 136 } 137 ], 138 "returnItems": [ 139 { 140 "count": 1, 141 "item": { 142 "id": 1, 143 "manufacturer": { 144 "id": 1, 145 "name": "foo" 146 }, 147 "model": "foo", 148 "name": "foo", 149 "orderable": true, 150 "sku": "foo" 151 } 152 } 153 ], 154 "returnKits": [ 155 { 156 "archived": true, 157 "id": 42, 158 "kitItems": [ 159 { 160 "count": 42, 161 "item": { 162 "id": 1, 163 "manufacturer": { 164 "id": 1, 165 "name": "foo" 166 }, 167 "model": "foo", 168 "name": "foo", 169 "orderable": true, 170 "sku": "foo" 171 } 172 } 173 ], 174 "name": "foo" 175 } 176 ], 177 "site": { 178 "active": true, 179 "address": { 180 "city": "foo", 181 "country": "foo", 182 "lineOne": "foo", 183 "state": "foo", 184 "zipCode": "foo", 185 "lineThree": "foo", 186 "lineTwo": "foo", 187 "note": "foo" 188 }, 189 "id": 1, 190 "name": "foo", 191 "phoneNumber": "foo" 192 }, 193 "trackingNumbers": [ 194 { 195 "carrier": "usps", 196 "value": "foo" 197 } 198 ] 199 } 200 ], 201 "first": true, 202 "last": true, 203 "page": 42, 204 "size": 42, 205 "total": 42 206 }

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

lastUpdatedBeforestringOptionalformat: "date"

standalonebooleanOptional

pageintegerOptionalDefaults to 1

sizeintegerOptionalDefaults to 15

Response

contentlist of objectsOptional

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

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

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.

Headers

Query parameters

Response