Skip to main content

GET Order Status

Request the status of the order on the LetsGetChecked server for a specific client.

Request

Response

Request

Endpoint

GET {clientId}/api/v1/orders/{clientOrderId}/status

Headers

The GET Order Status API requires the following information in the headers of an HTTP request:

HTTP HeaderDescription
AuthorizationThe HTTP Authorization request header contains the credentials to authenticate a user agent with a server.
AcceptThe HTTP Accept request header contains information about the content types, expressed as MIME types, that the client can understand. The MIME type for the Create Order API request is application/json.

Path parameters

ParameterDescriptionTypeRequired/Optional
clientIdThe Client ID is a unique code that is provided by LetsGetChecked.stringRequired
clientOrderIdThe Client Order ID is a unique code associated with the order ID in the client's system. When you use the Order API, a clientOrderId value is generated that is your reference for the order in the LetsGetChecked system.stringRequired

Body

<Empty>

Response

The sample response is a single JSON object that contains the following fields:

PropertyDescriptionType
clientOrderIdThe Client Order ID is a unique code associated with a client.string
lgcOrderRefThe LetsGetChecked order reference, formatted as GUID.string
participantIdThe Participant ID must be unique and associated with a person in your system of record. It can be an employee ID or Customer ID. Do not reuse or recycle Participant IDs.string
statusThe following values are possible:
  • Submitted
  • ValidationFailed
  • Created
  • KitDispatched
  • KitRegistered
  • KitArrivedAtLab
  • ResultsAvailable
For more information about order statuses, see Orders.
string
lgcKitIdentifierThe LetsGetChecked kit identifier. The value is null before the KitRegistered status.object(LgcKitIdentifier)
{LgcKitIdentifier}/numericalCodeFormatted as LGC-0000-0000-0000, where 0 indicates any digit.string
{LgcKitIdentifier}/alphaCodeFormatted as AAAAAA, where A indicates any uppercase letter from A to Z.string
shipmentThe timestamp is in ISO 8601 format.object(Shipment)
{Shipment}/OutboundTrackingNumberThe mail carrier tracking number for a test kit that is sent from LetsGetChecked to a participant.string
{Shipment}/InboundTrackingNumberThe tracking number for the test sample that is returned by the participant to the LetsGetChecked laboratory.string
createdAtThe date and time, in UTC time, that the order was created at.string
updatedAtThe timestamp, in UTC time, is in ISO 8601 format.string
replacementOrdersWhen an ordered kit must be replaced (for example, if it was not received in transit or there is an issue with the sample not giving a full result), the details of the order(s) that replaced the original order is outlined here. For more information, see Replacement orders.Array of object(ReplacementOrder)
{ReplacementOrders}/clientOrderIdUnique LGC order reference. Formatted GUID.string
{replacementOrders}/statusThe following values are possible:
  • Submitted
  • ValidationFailed
  • Created
  • KitDispatched
  • KitRegistered
  • KitArrivedAtLab
  • ResultsAvailable
For more information about result statuses, see GET Results Status.
string
{ReplacementOrders}/lgcKitIdentifierThe LetsGetChecked kit identifier. If the patient has not registered the kit yet, the value is null before the KitRegistered status.object(LgcKitIdentifier)
{ReplacementOrders}/{LgcKitIdentifier}

/numericalCode

Formatted as LGC-0000-0000-0000, where 0 indicates any digit.string
{ReplacementOrders}/{LgcKitIdentifier}

/alphaCode

Formatted as AAAAAA, where A indicates any uppercase letter from A to Z.string
{ReplacementOrders}/shipmentThe timestamp is in ISO 8601 format. The value is null before the KitRegistered status.object(Shipment)
{ReplacementOrders}/{LgcKitIdentifier}/{Shipment}

/OutboundTrackingNumber

The mail carrier tracking number for a test kit that is sent from LetsGetChecked to a participant.string
{ReplacementOrders}/{LgcKitIdentifier}/{Shipment}

/InboundTrackingNumber

The tracking number for the test sample that is returned by the participant to the LetsGetChecked laboratory.string
{ReplacementOrders}/{LgcKitIdentifier}

/createdAt

The date and time, in UTC time, that the order was created.string
{ReplacementOrders}/{LgcKitIdentifier}

/updatedAt

The timestamp, in UTC time, is in ISO 8601 format.string

Sample response

{
"clientOrderId":"275096",
"lgcOrderRef":"df9b0178-8cdf-4388-8a8b-97b0767210a2",
"participantId":"824110",
"status":"KitRegistered",
"lgcKitIdentifier":{
"numericalCode":"LGC-4564-6542-4945",
"alphaCode":"PCSXPZ"
},
"shipment":{
"outboundTrackingNumber":"1Z9999999999999999",
"inboundTrackingNumber":"1Z999999999999998"
},
"createdAt":"2022-01-05T12:29:28+00:00",
"updatedAt":"2022-01-05T12:29:52+00:00",
"replacementOrders":[
{
"clientOrderId":"157699b5-88b1-4de2-a620-bda1a1e508c4",
"status":"KitRegistered",
"lgcKitIdentifier":{
"numericalCode":"LGC-1723-7609-5792",
"alphaCode":"INMSLH"
},
"shipment":{
"outboundTrackingNumber":"1Z9999999999999999",
"inboundTrackingNumber":"1Z999999999999998"
},
"createdAt":"2022-01-05T12:29:52+00:00",
"updatedAt":"2022-01-05T13:28:08+00:00"
}
]
}