GET Order Status
Request the status of the order on the LetsGetChecked server for a specific client.
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 Header | Description |
|---|---|
| Authorization | The HTTP Authorization request header contains the credentials to authenticate a user agent with a server. |
| Accept | The HTTP Accept request header contains information about the content types, expressed as MIME types, that the client can understand. The MIME type for the GET Order API request is application/json. |
Path parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| clientId | The clientId is a unique code that is provided by LetsGetChecked. The clientId is used to identify a client, when a client calls the Orders and Results APIs. The code is formed by 1 to 4 alphanumeric characters. The clientId displays in the HL7 results as PV1.3.1. | string | Required |
| clientOrderId | The Client Order ID is a unique code associated with the order ID in the client's system. When you use the Order API, the clientOrderId will be your reference for the order in the LetsGetChecked system. The maximum length is 100 characters. | string | Required |
Body
<Empty>
Response
The sample response is a single JSON object that contains the following fields:
| Property | Description | Type |
|---|---|---|
| clientOrderId | The Client Order ID is a unique code associated with a client. | string |
| lgcOrderRef | The LetsGetChecked order reference, formatted as GUID. | string |
| participantId | The 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 |
| status | The following values are possible:
| string |
| lgcKitIdentifier | The LetsGetChecked kit identifier. The value is null before the KitRegistered status. | object(lgcKitIdentifier) |
| {lgcKitIdentifier}/numericalCode | Formatted as LGC-0000-0000-0000, where 0 indicates any digit. | string |
| {lgcKitIdentifier}/alphaCode | Formatted as AAAAAA, where A indicates any uppercase letter from A to Z. | string |
| shipment | The timestamp is in ISO 8601 format. | object(Shipment) |
| {Shipment}/OutboundTrackingNumber | The mail carrier tracking number for a test kit that is sent from LetsGetChecked to a participant. | string |
| {Shipment}/InboundTrackingNumber | The tracking number for the test sample that is returned by the participant to the LetsGetChecked laboratory. | string |
| createdAt | The date and time, in UTC time, that the order was created at. | string |
| updatedAt | The timestamp, in UTC time, is in ISO 8601 format. | string |
| replacementOrders | When 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}/clientOrderId | Unique LGC order reference. Formatted GUID. | string |
| {replacementOrders}/status | The following values are possible:
| string |
| {ReplacementOrders}/lgcKitIdentifier | The 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}/shipment | The 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"
}
]
}
