QIMA Logo

Lab Testing Order Search Guide

Latest Update Time: 2026-06-23 00:00:00

Use the lab testing order search API to retrieve a paginated list of LT orders for a client.

See the Lab Testing Introduction for base URL, authentication, and required headers.

Endpoint

GET https://ppapi.qima.com/v1.2/lt/orders

This API additionally requires the clientId query parameter, mapped from the Auth API response field companyId.

Prerequisites

In addition to the required headers and authentication setup:

  • Permission to view lab testing orders for the target client

Query Parameters

ParameterRequiredDescription
clientIdYesCompany ID from the Auth API response field companyId. Used to scope the order search.
pageYesPage number. Starts at 1.
sizeYesNumber of orders returned per page. Default in the API spec is 100.
orderIdNoFilter by the QIMA internal LT order ID.
qimaRefNoNoFilter by the QIMA lab order reference number, for example T-26012264.
bookingRefNoNoFilter by the client's booking reference number.
testDateNoFilter by the scheduled test date.
reportDateNoFilter by the report due or issuance date.
statusNoFilter by the current order status, for example Testing or Validation.
accountNoFilter by partial or full company (client account) name.
supplierNoFilter by partial or full supplier name.
productNameNoFilter by product name.
purchaseOrderNoNoFilter by the client's purchase order number.
submitterNoFilter by the name or identifier of the person who submitted the order.

Request Example

curl --location 'https://ppapi.qima.com/v1.2/lt/orders?clientId=<company-id>&page=1&size=10' \
  --header 'Ai-Api-Access-Token: {your api access token}' \
  --header 'Ai-User-Id: {your user ID}' \
  --header 'Authorization: Bearer {your token}' \
  --header 'Referer: https://preprodmy.qima.com/'

Filtered Request Example

Use optional query parameters to narrow the result set:

curl --location 'https://ppapi.qima.com/v1.2/lt/orders?clientId=<company-id>&page=1&size=10&status=Testing&qimaRefNo=T-26012264' \
  --header 'Ai-Api-Access-Token: {your api access token}' \
  --header 'Ai-User-Id: {your user ID}' \
  --header 'Authorization: Bearer {your token}' \
  --header 'Referer: https://preprodmy.qima.com/'

Query Parameter Notes

ParameterNotes
clientIdMust match the Auth API response field companyId for the authenticated user.
pageUse with totalPage in the response to iterate through all results.
sizeUse a smaller page size during development and increase it only when needed.
statusCommon values include Testing and Validation.
qimaRefNoQIMA lab order number in the format T-XXXXXXXX.

Successful Response

HTTP 200 OK means the search completed successfully. The response wraps the paginated order list in content.

{
  "message": "Success",
  "content": {
    "pageSize": 10,
    "currentPage": 1,
    "totalPage": 984,
    "data": [
      {
        "generalInformation": {
          "orderId": "3df3a61f-139e-4e03-a51d-401a2dffd955",
          "qimaRefNo": "T-26012264",
          "bookingRefNo": "",
          "testDate": "2026-06-22",
          "reportDate": "2027-07-09",
          "status": "Testing",
          "client": "QIMA_DAISY_LIU_MASTER",
          "clientId": "7F78B7B555EB47A1AE0DD4DCCAD526F2",
          "supplier": "",
          "supplierId": "",
          "submitter": "QIMA_DAISY_LIU_CLIENT",
          "submitterId": "5C9B1F313EE14F95B79372F950F88165",
          "program": "dod",
          "programId": "dc05901e-3254-4ffe-92e9-835800065e35"
        },
        "product": {
          "productName": "Test Platform created",
          "purchaseOrderNo": "C1234"
        }
      },
      {
        "generalInformation": {
          "orderId": "e923d611-2802-42ee-a318-69007587f51d",
          "qimaRefNo": "T-26012188",
          "bookingRefNo": "",
          "testDate": "",
          "reportDate": "",
          "status": "Validation",
          "client": "QIMA_DAISY_LIU_MASTER",
          "clientId": "7F78B7B555EB47A1AE0DD4DCCAD526F2",
          "supplier": "",
          "supplierId": "",
          "submitter": "QIMA_DAISY_LIU_CLIENT",
          "submitterId": "5C9B1F313EE14F95B79372F950F88165",
          "program": "PG_004_rename_12",
          "programId": "1d21b747-f740-41e6-a352-8ea81e2bf71f"
        },
        "product": {
          "productName": "",
          "purchaseOrderNo": null
        }
      }
    ]
  }
}

Response Field Notes

FieldNotes
content.pageSizeNumber of orders returned in the current page.
content.currentPageCurrent page number.
content.totalPageTotal number of pages available for the current query.
content.data[].generalInformation.orderIdQIMA internal LT order ID. Use this value to retrieve order details or upload attachments.
content.data[].generalInformation.qimaRefNoQIMA lab order reference number.
content.data[].generalInformation.statusCurrent order status, such as Testing or Validation.
content.data[].product.productNameProduct name associated with the order.
content.data[].product.purchaseOrderNoClient purchase order number, if provided.

Store the returned orderId if you need to retrieve full order details, test results, or upload attachments later.

Common Errors

See common authentication errors for 401 and 403 responses.

StatusMeaningRecommended Action
400 Bad RequestRequired query parameters are missing or invalid.Confirm clientId, page, and size are present and valid.
500 Internal Server ErrorOrder search failed on the server.Contact QIMA support with the request time and query parameters.

Next Steps

  • Use the returned orderId to retrieve full lab testing order details.
  • Retrieve lab testing order test results when the report is available.
  • Upload attachments to an existing lab testing order when additional documents are required — see the Order Attachments Guide.