Update order metadata

Parameters

public_idRequired

string

The ID of the order to retrieve.

Body

metadata

object

The metadata to replace the existing metadata with.

Response

order_id

string

The unique identifier of the order.

status

string

Available options: pending, in_progress, completed, canceled

recipient

object

addressRequired

object

zipRequired

string

Recipient's zip code.

countryRequired

string

Recipient's country of residence.

Available options: US, CA

stateRequired

string

Recipient's state of residence.

cityRequired

string

Recipient's city of residence.

street1Required

string

Recipient's address.

street2

string

Second line of recipient's address.

phoneRequired

string

Recipient's phone number, as a string.

emailRequired

string

Recipient's email.

last_nameRequired

string

Recipient's last name.

first_nameRequired

string

Recipient's first name.

kit_types

string[]

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

kits

array

kit_id

string

The unique identifier of the kit.

type

string

The kit's type

status

string

The new status of the kit.

Available options: preparing, in_transit, delivered, delivery_exception, registered, canceled

events

array

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

status

string

The new status of the kit.

Available options: preparing, in_transit, delivered, delivery_exception, registered, canceled

created

string

The date and time the event occurred.

shipment_to_customer

object

tracking_number

string

carrier

string

Available options: fedex, ups, usps

created

string

registered_to

object

patient_id

string

first_name

string

last_name

string

date_of_birth

string

sex

string

Available options: M, F

string

phone

string

sample

object

sample_id

string

status

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

events

array

status

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

created

string

type

string

Available options: adx100, adx100_2, adx100_4, whatman903_10, dry_transport_swab, hemaspot_hf, saliva_3

shipments

array

tracking_number

string

carrier

string

Available options: fedex, ups, usps

created

string

panels

string[]

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

reports

array

report_id

string

results

array

pdf

string

A URL to the PDF report.

txt

string

A URL to the TXT report.

date_collected

string

date_received

string

is_amendment

boolean

Whether this report is an amendment to a previous report.

created

string

The date and time the order was created.

updated

string

The date and time the order was last updated.

metadata

object

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

​Parameters

​Body

​Response

Parameters

Body

Response