Kits

List kits

GET /api/v1/kits

note

If you need to filter by multiple kit or order IDs, join them with a comma and pass them as kitID or orderID param. Note that the limit for such a search is 50 IDs per request.

Response example

[
    {
        "kitID": "SPOTZ52U66",
        "orderID": "OXY4T12I55",
        "recipientEmail": "test@email.com",
        "registeredToEmail": "test@email.com",
        "lastUpdatedDate": "2022-11-15T1600.000Z",
        "createdDate": "2022-09-29T2222.118Z",
        "kitStatus": "registered",
        "sampleStatus": "resulted",
        "status": "published",
	"externalID": "234423422",
	"progress": [
            {
                "type": "orderPlaced",
                "date": "2023-03-14"
            },
            {
                "type": "kitPreparing",
                "date": "2023-03-14"
            },
            {
                "type": "shippedToUser",
                "date": "2023-03-15"
            },
            {
                "type": "arrivedToUser",
                "date": "2023-03-29"
            },
            {
                "type": "registered",
                "date": "2023-03-31"
            },
            {
                "type": "shippedToLab"
            },
            {
                "type": "arrivedAtLab"
            },
            {
                "type": "reportReady"
            }
        ],
        "shipment": {
            "toUser": {
                "trackingNumber": "92055901755477300010651024",
                "carrier": "usps",
                "date": "2022-08-02T2315.114Z"
            },
            "toLab": {
                "trackingNumber": "4209215090059301910914700000075828",
                "carrier": "usps",
                "date": "2022-08-02T1407.178Z"
            }
        },
        "customerID": 12345
    },
    {
        "kitID": "SPOTL7M044",
        "orderID": "OXH8USJT33",
        "recipientEmail": "test@email.com",
        "registeredToEmail": "test@email.com",
        "lastUpdatedDate": "2022-08-11T1700.000Z",
        "createdDate": "2022-08-05T0041.885Z",
        "kitStatus": "registered",
        "sampleStatus": "resulted",
        "status": "notStarted",
	"externalID": "234423422"
    },
    {
        "kitID": "SPOT6WT111",
        "orderID": "OUOHRDR822",
        "recipientEmail": "test@email.com",
        "registeredToEmail": "test@email.com",
        "lastUpdatedDate": "2022-08-15T1600.000Z",
        "createdDate": "2022-08-02T2315.119Z",
        "kitStatus": "registered",
        "sampleStatus": "resulted",
        "status": "published",
	"externalID": "234423422"
    }
]

note

customerID will be present after kit is registered to the user

note

progress array contains kit lifetime statuses which can be:

format of progress is { type: status, date?: date in format YYYY-MM-DD }

If date is not present - this event did not happen yet

Open the live API playground

Full request and response schemas for every endpoint, testable with your sandbox token.

List kits​

List kits