API ReferenceOrders

Create Order

This endpoint is for creating orders linked to either a patient or a site, with order content specified by item or kit IDs and an association with a patient or site ID. Optional attributes offer further customization, such as tracking through external order IDs.\n\nThis endpoint also supports two-way orders (outbound + return) by including returnDevices, returnItems, or returnPackedKits. When including returns without outbound items, at least one return field must be specified.\n\nFor a comprehensive guide on utilizing this endpoint, including examples, required and optional attributes, and additional functionalities like listing and fetching orders, visit the [Order Management Guide](/guides/order-management).

Authentication

Impilo-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
currentStatusenumOptional
The current status of the order
emailLabelbooleanOptionalDefaults to false
Indicates if the return shipping label will be emailed or shipped. Only applies when return items are included.
externalOrderIdslist of stringsOptional
An array of order ids specified by the client
orderItemslist of objectsOptional
Array of items on the order. At least one of orderItems or orderKits must be not null.
orderKitslist of objectsOptional
Array of order kits on the order. At least one of orderItems or orderKits must be not null.
orderNoteslist of objectsOptional
Array of order notes. These are additional pieces of information attached to an order.
patientobjectOptional
The patient receiving the order. Exactly one of patient or site must be not null.
returnDeviceslist of objectsOptional

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

returnItemslist of objectsOptional

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

returnPackedKitslist of objectsOptional

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

shippingOptionenumOptional
Allowed values:
siteobjectOptional
The site receiving the order. Exactly one of patient or site must be not null.

Response

Order created successfully
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.

Errors