Create Return

1 curl -X POST https://app.impiloplatform.com/api/v3/return \ 2 -H "Impilo-API-Key: <Impilo-API-Key>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

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

Creates a Return Merchandise Authorization (RMA).

Request

This endpoint expects an object.

emailLabelbooleanOptionalDefaults to false

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

patientIdlongOptional

The patient that is making the return.

returnDeviceslist of objectsOptional

An array of devices expected on this return.

returnItemslist of objectsOptional

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

shippingOptionenumOptional

The shipping service level.

Allowed values:

siteIdlongOptional

The site that is making the return.

Response

Created

currentStatusenum

The current status of this return.

idlongOptional

Unique identifier for the return, managed by Impilo.

patientobjectOptional

The patient that is making the return.

relatedOrderIdlongOptional

The identifier of a related order, if exists.

returnDeviceslist of objectsOptional

An array of devices expected on this return.

returnEventslist of objectsOptional

An array of the return events for this return.

returnItemslist of objectsOptional

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

returnKitslist of objectsOptional

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

siteobjectOptional

The site that is making the return.

trackingNumberslist of objectsOptional

An array of tracking numbers associated with this return.

Headers

Request

Response