QIMA Logo
API Reference

8 categories • 44 endpoints

  • All APIs

    44

    • Quick Actions
    Getting StartedDocumentation
    Inspection
    v1.0.0

    Search inspection booking orders

    Request
    Query Parameters
    NameTypeLocationRequiredDescription
    userIdstringpathYesQIMA client user login ID.
    service-typestringqueryYesInspection service type to filter by. Must be one of `psi`, `clc`, `pm`, `dupro`, `ipc`, `sp`, or a comma-separated combination.
    startstringqueryNoFilter start date for the inspection date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
    endstringqueryNoFilter end date for the inspection date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
    keywordstringqueryNoKeyword to search against the order number, PO number, or supplier name.
    statusstringqueryNoFilter by order status code(s). Accepts a single value or a comma-separated list. Open order codes: `10,15,17,20,21,22,23,25,30,40,50,56`. Completed order code: `60`.
    pageSizestringqueryNoNumber of results to return per page.
    pageNumberstringqueryNoPage number to retrieve (1-based index).
    allstringqueryNoSet to `true` to include orders from all sub-accounts under the super-master account.
    sortFieldstringqueryNoField to sort results by. Accepted values: `orderId`, `status`, `serviceType`, `refNumber`, `clientReference`, `supplierName`, `bookingDate`, `serviceDate`, `confirmBySupplier`.
    sortTypestringqueryNoDESC or ASC
    Responses
    200
    Inspection bookings search results will be returned

    Content-Type: application/json

    pageNo
    integer
    FieldTypeDescription
    pageNointegerCurrent page number in search results
    FieldTypeDescription
    totalPageNumintegerCount of pages in search results
    FieldTypeDescription
    totalSizeintegerTotal results count in search results
    FieldTypeDescription
    orderIdstringInternal inspection order ID. Pass this to Get Order Details or Cancel Booking.
    serviceTypestringNumeric inspection service type code.
    serviceTypeTextstringText label for the service type, for example "PSI".
    statusstringNumeric order status code.
    statusTextstringText label for the order status.
    supplierNamestring
    supplierIdCodestringThe supplier's client-side code (matches `supplierCode` used at booking time).
    refNumberstringClient-facing QIMA order number, for example "Q2600368591-PP".
    clientReferencestringClient's own reference number for this order.
    productNamesstring
    poNumbersstring
    serviceDatestring
    bookingDatestring
    confirmBySupplierstringWhether the supplier has confirmed the booking, as "YES"/"NO" text.
    isSupplierConfirmedbooleanWhether the supplier has confirmed the booking, as a boolean.
    isQuickBookedboolean
    businessTypestring
    {
  "message": null,
  "content": {
    "pageNo": 1,
    "totalPageNum": 1,
    "totalSize": 1,
    "pageItems": [
      {
        "orderId": "8D21A68F78124F828E2232051E2712FD",
        "serviceType": "1",
        "serviceTypeText": "PSI",
        "status": "20",
        "statusText": "Waiting for Validation",
        "supplierName": "Sample Supplier Co.",
        "supplierIdCode": "SF-TL90",
        "refNumber": "Q2600368591-PP",
        "clientReference": "2107-0-041",
        "productNames": "Dumbbell Kaytan 2kg",
        "poNumbers": "6111",
        "serviceDate": "21-Dec-2026",
        "bookingDate": "02-Jul-2026",
        "confirmBySupplier": "YES",
        "isSupplierConfirmed": true,
        "isQuickBooked": false,
        "businessType": null
      }
    ],
    "countByFields": null
  }
}

    Content-Type: application/json

    GET
    /user/{userId}/inspection-orders
    Request samples

    application/json

    {}
    Response samples

    application/json

    { "message": null, "content": { "pageNo": 1, "totalPageNum": 1, "totalSize": 1, "pageItems": [ { "orderId": "8D21A68F78124F828E2232051E2712FD", "serviceType": "1", "serviceTypeText": "PSI", "status": "20", "statusText": "Waiting for Validation", "supplierName": "Sample Supplier Co.", "supplierIdCode": "SF-TL90", "refNumber": "Q2600368591-PP", "clientReference": "2107-0-041", "productNames": "Dumbbell Kaytan 2kg", "poNumbers": "6111", "serviceDate": "21-Dec-2026", "bookingDate": "02-Jul-2026", "confirmBySupplier": "YES", "isSupplierConfirmed": true, "isQuickBooked": false, "businessType": null } ], "countByFields": null } }