QIMA Logo
API Reference

8 categories • 44 endpoints

  • All APIs

    44

    • Quick Actions
    Getting StartedDocumentation
    Report
    v1.0.0

    Search inspection reports

    Request
    Query Parameters
    NameTypeLocationRequiredDescription
    userIdstringpathYesQIMA client user login ID.
    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 or PO number.
    pageintegerqueryNoPage number to show
    page-sizeintegerqueryNoPage size in search results
    allstringqueryNoSet to `true` to include reports from all sub-accounts under the super-master account.
    sortFieldstringqueryNoField name to sort results by. Must be one of the returned column names.
    sortTypestringqueryNoSort direction. Use `DESC` for descending or `ASC` for ascending order.
    companyRolestringqueryNoSpecify the company role to filter reports. Set to `broker` to retrieve reports visible to the broker role.
    prodDivisionstringqueryNoDivision name that this product belongs to in client's company
    advSearchUseProdNamestringqueryNoSet to `true` to include the product name in the advanced keyword search.
    advSearchUseProdRefstringqueryNoSet to `true` to include the product reference number in the advanced keyword search.
    startSendDatestringqueryNoFilter start or end date for the report send/resend date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
    endSendDatestringqueryNoFilter start or end date for the report send/resend date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
    statusstringqueryNoFilter reports by status. Accepts a single status value or a comma-separated list of status values.
    Responses
    200
    Inspection reports search results will be returned

    Content-Type: application/json

    message
    string
    FieldTypeDescription
    messagestring
    FieldTypeDescription
    pageNointegerCurrent page number in search results
    totalPageNumintegerCount of pages in search results
    totalSizeintegerTotal results count in search results
    pageItemsarrayList of the search result
    pageItems[].orderIdstringOrder id, primary key of the inspection order
    pageItems[].productIdstringId of this product(report)
    pageItems[].orderNumberstringQIMA booking order number, like R-Cloud-xx
    pageItems[].orderNumberProductSeqstringQIMA booking order number plus product sequence
    pageItems[].clientRefNbstringReference number client can use for referencing with QIMA's inspection booking
    pageItems[].poNumberstringPO number
    pageItems[].inspectionDatestringInspection date in unix timestamp
    pageItems[].statusintegerReport status value, 30=>Approved by supervisor and diffused to client, 40=>Approved by client online, 50=>Rejected by client online, 60=>Archived by client online, 65=>Archived by client after approval, 70=>Archived by client after rejection
    pageItems[].companyIdstringCompany id in QIMA system
    pageItems[].companyNamestringCompany name
    pageItems[].productNamestringProduct name
    pageItems[].supplierNamestringSupplier name
    pageItems[].supplierProvincestringProvince name of the supplier
    pageItems[].supplierCitystringCity id of the supplier
    pageItems[].inspectionLocationstringLocation of the inspection
    pageItems[].factoryIdCodestringFactory's identification code in client's system
    pageItems[].factoryNamestringFactory name
    pageItems[].factoryCountrystringCountry name of the factory
    pageItems[].factoryProvincestringProvince name of the factory
    pageItems[].factoryAddressstringFactory address
    pageItems[].inspectorNamestringInspector's name
    pageItems[].serviceTypestringQIMA inspection service type value 1: PSI (Pre-Shipment Inspection), 2: IPC (Initial Production Check), 3: DUPRO (During Production Inspection) , 4: CLC (Container Loading Check), 6: PM (Production Monitoring), 8: SR (Sample Review), 21: SC (Sample Collection)
    pageItems[].serviceTypeTextstringQIMA inspection service type text
    pageItems[].prodReferencestringProduct level product reference
    pageItems[].bookingTypestringBooking type in product level
    pageItems[].prodDivisionstringDivision name that this product belongs to in client's company
    pageItems[].prodQuantityintegerProduct level product quantity
    pageItems[].prodQuantityUnitstringUnit name of the product quantity, like pcs, sets
    pageItems[].rejectionReasonstringProduct level reject reason
    pageItems[].approvalReasonstringProduct level approve reason
    pageItems[].reportApproveTimestringApproved time in unix timestamp
    pageItems[].approverstringQIMA Login of the approver
    pageItems[].commentsstringComment on the approval/rejection
    pageItems[].specResultstringInspection result based specification
    pageItems[].testResultstringTest result
    pageItems[].workmanshipResultstringWorkmanship result
    pageItems[].measurementResultstringMeasurement result
    pageItems[].overrallResultstringOverall result
    pageItems[].criticalCheckedintegerHow many product checked for critical level defect checking
    pageItems[].majorCheckedintegerHow many product checked for major level defect checking
    pageItems[].minorCheckedintegerHow many product checked for minor level defect checking
    pageItems[].criticalFoundintegerHow many critical level defect found
    pageItems[].majorFoundintegerHow many major level defect found
    pageItems[].minorFoundintegerHow many minor level defect found
    pageItems[].criticalMaxintegerClient allowed critical level defects count
    pageItems[].majorMaxintegerClient allowed major level defects count
    pageItems[].minorMaxintegerClient allowed minor level defects count
    pageItems[].missedInspectionbooleanIndicate if this inspection is a missed inspection
    pageItems[].isReInspectionstringIndicate if this inspection is an re-inspection
    pageItems[].reportRemarkstringInspector remarks on the report
    pageItems[].reportSummarystringSummary of the report
    pageItems[].clientRatingintegerClient's rating on this report
    pageItems[].clientFeedbackstringClient's feedback on this report
    pageItems[].readbooleanIndicate if client has read this report
    pageItems[].inspectionDateMMMFormatstringInspection date in dd-MMM-yyyy format
    pageItems[].clientDecisionstringClient's decision on this report
    pageItems[].expectedShipDatestringExpected shipment date in unix timestamp
    pageItems[].bookingDatestringBooking date in unix timestamp
    pageItems[].sampleSizenumberProduct sample sizer
    pageItems[].prodFamilystringProduct family name
    pageItems[].prodCategorystringProduct category name
    pageItems[].supplierAddressstringSupplier's address
    pageItems[].supplierCountrystringSupplier's country name
    pageItems[].supplierIdCodestringSupplier's identification code in client's system
    pageItems[].realMDintegerCharged man day
    pageItems[].totalChargestringTotal charge of this order
    pageItems[].sendReportTimestringsend report time.The newest time for sending/resending report
    pageItems[].sendReportTimeFormatstringInspection date in dd-MMM-yyyy format
    pageItems[].refResultsarray
    pageItems[].refResults[].refIdstring
    pageItems[].refResults[].productIdstring
    pageItems[].refResults[].prodRefSeqstring
    pageItems[].refResults[].prodRefPoNbstring
    pageItems[].refResults[].prodRefSkuNbstring
    pageItems[].refResults[].prodRefQuantityinteger
    pageItems[].refResults[].aqlResultstring
    pageItems[].refResults[].overrallResultstring
    pageItems[].refResults[].statusinteger
    pageItems[].refResults[].approverstring
    pageItems[].refResults[].approveTimestring
    pageItems[].refResults[].rejectionReasonstring
    pageItems[].refResults[].approvalReasonstring
    pageItems[].refResults[].icStatusstring
    pageItems[].refResults[].commentsstring
    pageItems[].refResults[].createTimestring
    pageItems[].refResults[].updateTimestring
    pageItems[].refResults[].createBystring
    pageItems[].refResults[].updateBystring
    pageItems[].refResults[].supplierIdstring
    pageItems[].refResults[].supplierNamestring
    countByFieldsarrayCount by fields
    {
  "message": null,
  "content": {
    "pageNo": 1,
    "totalPageNum": 1,
    "totalSize": 1,
    "pageItems": [
      {
        "orderId": "EC73BC336B034CF886E7C0B8EAE3160A",
        "productId": "1CD16979CD0A4947BE42610D02EAE5D2",
        "orderNumber": "R-Cloud-PP-25004672",
        "poNumber": "SP2-PO",
        "inspectionDate": "1751212800000",
        "status": 30,
        "productName": "SP2",
        "supplierName": "SupplierTest166595",
        "serviceType": "1",
        "serviceTypeText": "PSI",
        "overrallResult": "PASSED",
        "read": true,
        "inspectionDateMMMFormat": "30-Jun-2025",
        "sendReportTime": "1756114884747",
        "sendReportTimeFormat": "25-Aug-2025 17:41:24"
      }
    ],
    "countByFields": null
  }
}

    Content-Type: application/json

    GET
    /user/{userId}/reports
    Request samples

    application/json

    {}
    Response samples

    application/json

    { "message": null, "content": { "pageNo": 1, "totalPageNum": 1, "totalSize": 1, "pageItems": [ { "orderId": "EC73BC336B034CF886E7C0B8EAE3160A", "productId": "1CD16979CD0A4947BE42610D02EAE5D2", "orderNumber": "R-Cloud-PP-25004672", "poNumber": "SP2-PO", "inspectionDate": "1751212800000", "status": 30, "productName": "SP2", "supplierName": "SupplierTest166595", "serviceType": "1", "serviceTypeText": "PSI", "overrallResult": "PASSED", "read": true, "inspectionDateMMMFormat": "30-Jun-2025", "sendReportTime": "1756114884747", "sendReportTimeFormat": "25-Aug-2025 17:41:24" } ], "countByFields": null } }