API ReferenceReturns

Create Return

Creates a Return Merchandise Authorization (RMA).

Headers

Impilo-API-KeystringRequired

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.
idlong or null
Unique identifier for the return, managed by Impilo.
patientobject or null
The patient that is making the return.
relatedOrderIdlong or null
The identifier of a related order, if exists.
returnDeviceslist of objects or null
An array of devices expected on this return.
returnEventslist of objects or null
An array of the return events for this return.
returnItemslist of objects or null

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

returnKitslist of objects or null
An array of kits related to items expected on this return.
siteobject or null
The site that is making the return.
trackingNumberslist of objects or null
An array of tracking numbers associated with this return.