Get order by ID

Authorizations

Authorization

string

headerrequired

Token-based authentication with required prefix "Token"

Path Parameters

public_id

string

required

The ID of the order to retrieve.

Response

200 - application/json

order_id

string

The unique identifier of the order.

status

enum<string>

Available options:

pending,

in_progress,

completed,

canceled

recipient

object

kit_types

string[]

A list of the kit types that are included in this order.

kits

object[]

kits.kit_id

string

The unique identifier of the kit.

kits.type

string

The kit's type

kits.status

enum<string>

The new status of the kit.

Available options:

preparing,

in_transit,

delivered,

delivery_exception,

registered,

canceled

kits.events

object[]

A list of all the events that have occurred for this kit.

kits.shipment_to_customer

object

kits.registered_to

object

kits.sample

object

kits.sample.sample_id

string

kits.sample.status

enum<string>

The new status of the sample.

Available options:

awaiting_collection,

collection_exception,

delivery_exception,

delivered,

in_transit,

received,

resulted,

partially_resulted,

extra_quality_checks,

canceled

kits.sample.events

object[]

kits.sample.type

enum<string>

Available options:

adx100,

adx100_2,

adx100_4,

whatman903_10,

dry_transport_swab,

hemaspot_hf,

saliva_3

kits.sample.shipments

object[]

kits.sample.panels

string[]

The panel codes of the test being performed on the sample. We'll create these with you during onboarding.

kits.sample.reports

array

created

string

The date and time the order was created.

updated

string

The date and time the order was last updated.

metadata

object | null

An optional dictionary of key-value pairs stored with the order.

Welcome

Basic Guides

Advanced Guides

Integrations

API Reference - Orders

API Reference - Kits

API Reference - Requisitions

API Reference - Registration

Get order by ID

Authorizations

Path Parameters

Response