Documents
Report Search Guide
Latest Update Time: 2026-07-02 00:00:00
Use this API to search inspection reports for your client account.
See the Report Introduction for base URL, authentication, and required headers.
Endpoint
GET https://ppapi.qima.com/user/{userId}/reports
Prerequisites
In addition to the required headers and authentication setup:
- Permission to view inspection reports for the target client
Path Parameters
| Parameter | Required | Description |
|---|---|---|
userId | Yes | QIMA client user login ID. |
Query Parameters
| Parameter | Required | Description |
|---|---|---|
start / end | No | Filter start/end date for the inspection date range, YYYY-MM-DD. |
keyword | No | Keyword to search against the order number or PO number. |
page / page-size | No | Pagination controls. |
all | No | Set to true to include reports from all sub-accounts under the super-master account. |
sortField / sortType | No | Sort field (must be one of the returned column names) and direction (DESC/ASC). |
companyRole | No | Set to broker to retrieve reports visible to the broker role. |
prodDivision | No | Filter by the product's division name in your company. |
advSearchUseProdName / advSearchUseProdRef | No | Set to true to include the product name / product reference number in the keyword search. |
startSendDate / endSendDate | No | Filter start/end date for the report send/resend date range, YYYY-MM-DD. |
status | No | Filter by report status code(s) — single value or comma-separated list. See status codes below. |
Request Example
curl --location --request GET 'https://ppapi.qima.com/user/<qima-user-id>/reports?page=1&page-size=50&sortType=desc&sortField=inspectionDate' \
--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/'
Successful Response
{
"message": null,
"content": {
"pageNo": 1,
"totalPageNum": 1,
"totalSize": 1,
"pageItems": [
{
"orderId": "EC73BC336B034CF886E7C0B8EAE3160A",
"productId": "1CD16979CD0A4947BE42610D02EAE5D2",
"orderNumber": "R-Cloud-PP-25004672",
"orderNumberProductSeq": "R-Cloud-PP-25004672",
"clientRefNb": null,
"poNumber": "SP2-PO",
"inspectionDate": 1751212800000,
"status": 30,
"companyId": "23EC09AB0F3C46BBA4F79718DCED16D0",
"companyName": "PP-Testing-77729",
"productName": "SP2",
"supplierName": "SupplierTest166595",
"supplierProvince": "Sichuan",
"supplierCity": "12687254",
"serviceType": "1",
"serviceTypeText": "PSI",
"prodReference": "SP2-SKU",
"bookingType": "General",
"prodDivision": "DIVI-A",
"prodQuantity": 300,
"prodQuantityUnit": "Pcs",
"specResult": "OK",
"testResult": "Passed",
"workmanshipResult": "WITHIN AQL",
"measurementResult": "N/A",
"overrallResult": "PASSED",
"criticalChecked": 50,
"majorChecked": 50,
"minorChecked": 50,
"criticalFound": 0,
"majorFound": 0,
"minorFound": 0,
"criticalMax": 0,
"majorMax": 3,
"minorMax": 5,
"isReInspection": "No",
"reportRemark": "-",
"read": true,
"inspectionDateMMMFormat": "30-Jun-2025",
"expectedShipDate": 1751212800000,
"bookingDate": 1750780800000,
"sampleSize": 50,
"prodFamily": "Accessories",
"prodCategory": "Bodycare, Fashion & accessories",
"supplierAddress": "Address test",
"supplierCountry": "China",
"supplierIdCode": "pp-supplier-9527",
"realMD": 2,
"totalCharge": "655.08",
"sendReportTime": 1756114884747,
"sendReportTimeFormat": "25-Aug-2025 17:41:24",
"refResults": [
{
"refId": "FD4DA4BF7FF848159A0CD075932B64B6",
"productId": "1CD16979CD0A4947BE42610D02EAE5D2",
"prodRefSeq": "1",
"prodRefPoNb": "SP2-PO",
"prodRefSkuNb": "SP2-SKU",
"prodRefQuantity": 300,
"aqlResult": "WITHIN AQL",
"status": 30,
"createTime": 1756114837617
}
]
}
],
"countByFields": null
}
}
Several fields are
nullin this particular capture (inspectionLocation,factoryName,factoryCountry,factoryProvince,factoryAddress,inspectorName, etc.) — these are legitimate fields that simply weren't populated for this order; they're omitted above for brevity but documented in the interactive API reference.
Response Field Notes
| Field | Notes |
|---|---|
pageItems[].orderId / productId | Order and product IDs. Pass productId to Get PDF Report File Info or Get Interactive Report Details (with orderId as a query param for the latter). |
pageItems[].status | Numeric report status code. 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[].inspectionDate / expectedShipDate / bookingDate | Unix timestamp in milliseconds. |
pageItems[].inspectionDateMMMFormat | Same date as inspectionDate, pre-formatted as dd-MMM-yyyy. |
pageItems[].overrallResult | Overall inspection result, for example "PASSED" or "FAILED" (note the spelling: "overrall", not "overall"). |
pageItems[].criticalChecked / majorChecked / minorChecked and ...Found / ...Max | AQL defect-checking counts: how many units were checked, how many defects were found, and the client's allowed maximum, per severity level. |
pageItems[].refResults[] | Per-reference (SKU/PO) inspection results within this product. |
Common Errors
See common authentication errors for 401 and 403 responses.
| Status | Meaning | Recommended Action |
|---|---|---|
500 Internal Server Error | Report search failed on the server. | Contact QIMA support with the request time and query parameters. |
Next Steps
- Use a result's
productIdto get the PDF report file or the full interactive report.
