Update order metadata

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Path Parameters

public_id

string

required

The ID of the order to retrieve.

Body

application/json

metadata

object

The metadata to replace the existing metadata with.

Response

200 - application/json

created

string

The date and time the order was created.

kit_types

string[]

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

kits

object[]

kits.events

object[]

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

kits.kit_id

string

The unique identifier of the kit.

kits.registered_to

object

kits.sample

object

kits.sample.events

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

kits.sample.sample_id

string

kits.sample.shipments

object[]

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

enum<string>

Available options:

adx100,

adx100_2,

adx100_4,

whatman903_10,

dry_transport_swab,

hemaspot_hf,

saliva_3

kits.shipment_to_customer

object

kits.status

enum<string>

The new status of the kit.

Available options:

preparing,

in_transit,

delivered,

delivery_exception,

registered,

canceled

kits.type

string

The kit's type

metadata

object | null

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

order_id

string

The unique identifier of the order.

recipient

object

status

enum<string>

Available options:

pending,

in_progress,

completed,

canceled

updated

string

The date and time the order was last updated.

Welcome

Basic Guides

Advanced Guides

Integrations

API Reference - Orders

API Reference - Kits

API Reference - Requisitions

API Reference - Registration

Update order metadata

Authorizations

Path Parameters

Body

Response