API ReferenceOrders

Fetch Order

Authentication

Impilo-API-Keystring
API Key authentication via header

Path parameters

orderIdlongRequired

Response

OK
currentStatusenum or null
The current status of the order
deviceslist of objects or null
The order item devices
emailLabelboolean or nullDefaults to false
Indicates if the return shipping label will be emailed or shipped. Only applies when return items are included.
externalOrderIdslist of strings or null
An array of order ids specified by the client
idlong or null
Unique identifier for the order
orderEventslist of objects or null
Array of order events. These are the status updates for the order.
orderItemslist of objects or null
Array of items on the order. At least one of orderItems or orderKits must be not null.
orderKitslist of objects or null
Array of order kits on the order. At least one of orderItems or orderKits must be not null.
orderNoteslist of objects or null
Array of order notes. These are additional pieces of information attached to an order.
packedKitslist of objects or null
The kits packed in the order
patientobject or null
The patient receiving the order. Exactly one of patient or site must be not null.
returnDeviceslist of objects or null

An array of devices expected on this return. Optional field for two-way orders.

returnItemslist of objects or null

An array of items expected on this return. Optional field for two-way orders.

returnPackedKitslist of objects or null

An array of packed kits expected on this return. Optional field for two-way orders.

shippingOptionenum or null
Allowed values:
siteobject or null
The site receiving the order. Exactly one of patient or site must be not null.
trackingNumberslist of objects or null
Array of tracking numbers for the order.