Create Order

POST

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\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.

For more information see the Order Model.

Request

This endpoint expects an object.
idintegerOptional
Unique identifier for the order
externalOrderIdslist of stringsOptional
An array of order ids specified by the client
patientobjectOptional
The patient receiving the order. Exactly one of patient or site must be not null.
siteobjectOptional
The site receiving the order. Exactly one of patient or site must be not null.
currentStatusenumOptional
The current status of the order
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.
orderEventslist of objectsOptional
Array of order events. These are the status updates for the order.
trackingNumberslist of objectsOptional
Array of tracking numbers for the order.
deviceslist of objectsOptional
The order item devices
packedKitslist of objectsOptional
The kits packed in the order
shippingOption"standard" or "overnight"Optional
Allowed values: standardovernight

Response

This endpoint returns an object.
idintegerOptional
Unique identifier for the order
externalOrderIdslist of stringsOptional
An array of order ids specified by the client
patientobjectOptional
The patient receiving the order. Exactly one of patient or site must be not null.
siteobjectOptional
The site receiving the order. Exactly one of patient or site must be not null.
currentStatusenumOptional
The current status of the order
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.
orderEventslist of objectsOptional
Array of order events. These are the status updates for the order.
trackingNumberslist of objectsOptional
Array of tracking numbers for the order.
deviceslist of objectsOptional
The order item devices
packedKitslist of objectsOptional
The kits packed in the order
shippingOption"standard" or "overnight"Optional
Allowed values: standardovernight
Built with