GET Order
Request the status of the order on the LetsGetChecked server for a specific client.
Request
Endpoint
GET {clientId}/api/v2/orders/{clientOrderId}
Headers
The GET Order 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 |
| 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 |
| orderItems | The list of order items associated to the order. | object(OrderItemModel) |
orderItems /code | The test kit code. | string |
orderItems /id | The order item identifier. | string |
orderItems /replacementOrderItemId | The replacement order item identifier. | string |
orderItems /createdAt | The date and time, in UTC time, that the order was created at. | string |
orderItems /updatedAt | The timestamp, in UTC time, is in ISO 8601 format. | string |
orderItems /status | The following values are possible:
| string |
orderItems /lgcKitIdentifier | The LetsGetChecked kit identifier. The value is null before the KitRegistered status. | object(lgcKitIdentifier) |
orderItems/lgcKitIdentifier /numericalCode | Formatted as LGC-0000-0000-0000, where 0 indicates any digit. | string |
orderItems/lgcKitIdentifier /alphaCode | Formatted as AAAAAA, where A indicates any uppercase letter from A to Z. | string |
orderItems /shipment | The timestamp is in ISO 8601 format. | object(Shipment) |
orderItems/shipment /OutboundTrackingNumber | The mail carrier tracking number for a test kit that is sent from LetsGetChecked to a participant. | string |
orderItems/shipment /InboundTrackingNumber | The tracking number for the test sample that is returned by the participant to the LetsGetChecked laboratory. | string |
Status Codes
| Status Code | Description |
|---|---|
| 200 | Ok. Order was found. |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | NotFound |
| 415 | Unsupported media type. Payload in a unsupported format |
| 500 | Server Error |
| 503 | Server Error |
Sample responses
200 (with only one order item)
This is a sample response for a client workflow ordering only one test kit in an order.
{
"clientOrderId":"275096",
"participantId":"824110",
"orderItems": [
{
"code": "FCIT",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"replacementOrderItemId": "",
"createdAt": "2023-03-18T14:07:31.4836772+00:00",
"updatedAt": "2023-04-10T21:50:03.9095135+01:00",
"status": {
"code": "KitRegistered"
},
"lgcKitIdentifier": {
"barcode": "LGC-2790-6273-7366",
"alphaCode": "MGSTSM"
},
"shipment": {
"outboundTrackingNumber": "96740002733921443423848388",
"inboundTrackingNumber": "96740002733921443423848398"
}
}
]
}
200 (with multiple order items)
This is a sample response for a client workflow ordering three different test kits in an order.
{
"clientOrderId":"275096",
"participantId":"824110",
"orderItems": [
{
"code": "FCIT",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"replacementOrderItemId": "",
"createdAt": "2023-03-18T14:07:31.4836772+00:00",
"updatedAt": "2023-04-10T21:50:03.9095135+01:00",
"status": {
"code": "KitRegistered"
},
"lgcKitIdentifier": {
"barcode": "LGC-2790-6273-7366",
"alphaCode": "MGSTSM"
},
"shipment": {
"outboundTrackingNumber": "96740002733921443423848387",
"inboundTrackingNumber": "96740002733921443423848355"
}
},
{
"code": "GLCS",
"id": "4da85f64-5717-4562-b3fc-2c963f66afa5",
"replacementOrderItemId": "",
"createdAt": "2023-04-27T10:21:04.9435347+01:00",
"updatedAt": "2023-04-19T07:58:16.062391+01:00",
"status": {
"code": "Created"
},
"lgcKitIdentifier": {
"barcode": "LGC-3616-7700-3824",
"alphaCode": "TCTNFK"
},
"shipment": {
"outboundTrackingNumber": "",
"inboundTrackingNumber": ""
}
},
{
"code": "UACR",
"id": "2aa85f64-5717-4562-b3fc-2c963f66afa3",
"replacementOrderItemId": "",
"createdAt": "2023-01-02T07:51:31.7936286+00:00",
"updatedAt": "2022-11-23T12:26:09.3319907+00:00",
"status": {
"code": "KitRegistered"
},
"lgcKitIdentifier": {
"barcode": "LGC-3571-9812-0358",
"alphaCode": "ZORGAC"
},
"shipment": {
"outboundTrackingNumber": "96740002733921443423848383",
"inboundTrackingNumber": "96740002733921443423848398"
}
}
]
}
200 (with replacement information)
{
"clientOrderId":"275097",
"participantId":"824110",
"orderItems": [
{
"code": "FCIT",
"id": "4da85f64-5717-4562-b3fc-2c963f66afa5",
"replacementOrderItemId": "3fa85f64-5717-4562-b3fc-2c963f66afb6",
"createdAt": "2023-03-18T14:07:31.4836772+00:00",
"updatedAt": "2023-04-10T21:50:03.9095135+01:00",
"status": {
"code": "Cancelled"
},
"lgcKitIdentifier": {
"barcode": "LGC-2790-6273-7366",
"alphaCode": "MGSTSM"
},
"shipment": {
"outboundTrackingNumber": "96740002733921443423848382",
"inboundTrackingNumber": "96740002733921443423848383"
}
},
{
"code": "FCIT",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afb6",
"replacementOrderItemId": "",
"createdAt": "2023-04-27T10:21:04.9435347+01:00",
"updatedAt": "2023-04-19T07:58:16.062391+01:00",
"status": {
"code": "Created"
},
"lgcKitIdentifier": {
"barcode": "LGC-3616-7700-3824",
"alphaCode": "TCTNFK"
},
"shipment": {
"outboundTrackingNumber": "",
"inboundTrackingNumber": ""
}
},
{
"code": "UACR",
"id": "2ba85f64-5717-4562-b3fc-2c963f66afb5",
"replacementOrderItemId": "",
"createdAt": "2023-01-02T07:51:31.7936286+00:00",
"updatedAt": "2022-11-23T12:26:09.3319907+00:00",
"status": {
"code": "KitRegistered"
},
"lgcKitIdentifier": {
"barcode": "LGC-3571-9812-0358",
"alphaCode": "ZORGAC"
},
"shipment": {
"outboundTrackingNumber": "96740002733921443423848381",
"inboundTrackingNumber": "96740002733921443423848345"
}
}
]
}
