Inspection Order Search Guide

Latest Update Time: 2026-07-02 00:00:00

Use the inspection order search API to retrieve a paginated list of inspection bookings for a client account.

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

Endpoint

GET https://ppapi.qima.com/user/{userId}/inspection-orders

Prerequisites

In addition to the required headers and authentication setup:

Permission to view inspection orders for the target client

Path Parameters

Parameter	Required	Description
`userId`	Yes	QIMA client user login ID.

Query Parameters

Parameter	Required	Description
`service-type`	Yes	Inspection service type to filter by. Must be one of `psi`, `clc`, `pm`, `dupro`, `ipc`, `sp`, or a comma-separated combination.
`start`	No	Filter start date for the inspection date range, `YYYY-MM-DD`.
`end`	No	Filter end date for the inspection date range, `YYYY-MM-DD`.
`keyword`	No	Keyword to search against the order number, PO number, or supplier name.
`status`	No	Filter by order status code(s). Accepts a single value or a comma-separated list.
`pageSize`	No	Number of results to return per page.
`pageNumber`	No	Page number to retrieve (1-based index).
`all`	No	Set to `true` to include orders from all sub-accounts under the super-master account.
`sortField`	No	Field to sort results by, e.g. `bookingDate`.
`sortType`	No	`DESC` or `ASC`.

Request Example

curl --location --request GET 'https://ppapi.qima.com/user/<qima-user-id>/inspection-orders?service-type=psi&start=2026-06-01&end=2026-12-02&keyword=Q2600368591-PP&pageSize=20&pageNumber=1&all=false&sortField=bookingDate&sortType=DESC' \
  --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

HTTP 200 OK means the search completed successfully.

{
    "message": null,
    "content": {
        "pageNo": 1,
        "totalPageNum": 1,
        "totalSize": 1,
        "pageItems": [
            {
                "orderId": "8D21A68F78124F828E2232051E2712FD",
                "serviceType": "1",
                "serviceTypeText": "PSI",
                "status": "20",
                "statusText": "Waiting for Validation",
                "supplierName": "JiXieChang-Supplier",
                "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
    }
}

Response Field Notes

Field	Notes
`pageItems[].orderId`	Internal inspection order ID. Pass this to Get Order Details or Cancel Booking.
`pageItems[].refNumber`	Client-facing QIMA order number, for example `Q2600368591-PP`.
`pageItems[].status` / `statusText`	Numeric status code and its text label, for example `20` / `Waiting for Validation`.
`pageItems[].confirmBySupplier` / `isSupplierConfirmed`	Whether the supplier has confirmed the booking — `confirmBySupplier` as `YES`/`NO` text, `isSupplierConfirmed` as a boolean.
`pageItems[].supplierIdCode`	The supplier's client-side code (matches `supplierCode` used at booking time).

Common Errors

See common authentication errors for 401 and 403 responses.

Status	Meaning	Recommended Action
`500 Internal Server Error`	Order search failed on the server.	Contact QIMA support with the request time and query parameters.

Next Steps

Use the returned orderId to retrieve full inspection order details or cancel the booking.

Documents