Skip to main content

Overview

Create Orders​

post

/v2/testkit/orders/

Request fields and example

No parameters

Create order
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from vital import Client

client = Client(api_key, "sandbox")

data = client.Testkits.order(
    user_id=*,
    testkit_id="5b41f610-ebc5-4803-8f0c-a61c3bdc7faf",
    patient_details={
        "dob": "2020-01-01",
        "gender": "female"
    },
    patient_address={
            "receiver_name": "john Doe",
            "street": "606 Capp st.",
            "street_number": "Apt 14",
            "city": "San Francisco",
            "state": "CA",
            "zip": "94107",
            "country": "US",
            "phone_number": "+181808433"
            },
    }
)
Response fields and example

No parameters

Response
1

Cancel Order​

post

/v2/testkit/orders/{order_id}/cancel

Request fields and example

No parameters

Cancel order
1
2
3
4
5
from vital import Client

client = Client(api_key, "sandbox")

data = client.Testkits.cancel(user_id=*)
Response fields and example

No parameters

Response
1