Advanced Guides
Integrations
API Reference - Orders
API Reference - Kits
API Reference - Requisitions
API Reference - Registration
Create order
Create an order for delivering kits to a client, which will be created with a status of ‘pending’.The order will be created with the user making the request as the ‘placed_by’ user.
Token-based authentication with required prefix "Token"
A list of all the kit types to place in the order.
Recipient's first name.
Recipient's last name.
Recipient's email.
Recipient's phone number, as a string.
Recipient's address.
Second line of recipient's address.
Recipient's city of residence.
Recipient's state of residence.
Recipient's country of residence.
Recipient's zip code.
An optional dictionary of key-value pairs stored with the order.
Authorizations
Token-based authentication with required prefix "Token"
Body
A list of all the kit types to place in the order.
Recipient's first name.
Recipient's last name.
Recipient's email.
Recipient's phone number, as a string.
Recipient's address.
Recipient's city of residence.
Recipient's state of residence.
Recipient's country of residence.
US, CA Recipient's zip code.
Second line of recipient's address.
An optional dictionary of key-value pairs stored with the order.
Response
The unique identifier of the order.
pending, in_progress, completed, canceled Recipient's first name.
Recipient's last name.
Recipient's email.
Recipient's phone number, as a string.
Recipient's address.
Recipient's city of residence.
Recipient's state of residence.
Recipient's country of residence.
US, CA Recipient's zip code.
Second line of recipient's address.
A list of the kit types that are included in this order.
The unique identifier of the kit.
The kit's type
The new status of the kit.
preparing, in_transit, delivered, delivery_exception, registered, canceled The new status of the sample.
awaiting_collection, collection_exception, delivery_exception, delivered, in_transit, received, resulted, partially_resulted, extra_quality_checks, canceled adx100, adx100_2, adx100_4, whatman903_10, dry_transport_swab, hemaspot_hf, saliva_3 The panel codes of the test being performed on the sample. We'll create these with you during onboarding.
quantity The biomarker that was analyzed.
x > 0A URL to the PDF report.
A URL to the TXT report.
Whether this report is an amendment to a previous report.
An optional dictionary of key-value pairs stored with the order.