Documents
Inspection Introduction
Latest Update Time: 2026-07-02 00:00:00
Inspection is one of QIMA's major business services. The Public API supports several inspection types — Pre-Shipment Inspection (PSI), During Production Inspection (DUPRO), Pre-Customs Clearance Inspection (PEO), and more — and provides APIs for creating bookings (synchronously or asynchronously), searching orders, retrieving order details, and cancelling bookings.
This page documents the shared setup used by every Inspection guide. Each API-specific guide links back here for authentication, headers, and environment details.
Base URL
All Inspection APIs are served from the QIMA Public API host for your environment:
https://ppapi.qima.com
For production integrations, replace the host with the QIMA API host provided for your environment.
Required Headers
Call the Auth API first (POST /auth/v2/token) before any Inspection request. See the Getting Started Guide or Get Token API for authentication setup.
You also need a QIMA customer account with permission for the target Inspection operation, and an Ai-Api-Access-Token for the target environment provided by QIMA. Each API guide lists additional operation-specific requirements.
| Header / Parameter | Location | Source | Description |
|---|---|---|---|
Ai-Api-Access-Token | Request header (all Inspection APIs) | Provided by QIMA | Request source identifier. Each client may have a different value per environment. |
Ai-User-Id | Request header (all Inspection APIs) | Auth API response userId | QIMA client user login ID of the authenticated user. |
Authorization | Request header (all Inspection APIs) | Auth API access token | Format: Bearer <access-token>. Use the token from the same Auth API session as the other headers. |
Referer | Request header (all Inspection APIs) | Fixed value | https://preprodmy.qima.com/ |
Common Authentication Errors
| Status | Meaning | Recommended Action |
|---|---|---|
401 Unauthorized | Token or user authentication failed. | Confirm the Authorization, Ai-User-Id, and Ai-Api-Access-Token headers are from the same Auth API session and environment. |
403 Forbidden | The user does not have access to the requested resource. | Verify account permissions for the target Inspection operation. |
Each API guide includes additional operation-specific error codes.
Available APIs
| API | Method | Endpoint | Guide | API Reference |
|---|---|---|---|---|
| Create an inspection booking | POST | /v1.0/inspection | Inspection Booking Guide | API Reference |
| Create inspection booking asynchronously | POST | /v1.0/async-inspection | Async Booking Guide | API Reference |
| Get async booking result | GET | /booking-result/{requestId} | Async Booking Result Guide | API Reference |
| Search inspection booking orders | GET | /user/{userId}/inspection-orders | Order Search Guide | API Reference |
| Get inspection order details | GET | /user/{userId}/inspection-order/{orderId} | Order Detail Guide | API Reference |
| Cancel an inspection booking | DELETE | /user/{userId}/inspection/{orderId} | Cancel Booking Guide | API Reference |
Integration Workflows
1. Authenticate (Required for All Flows)
- Guide: Getting Started Guide
- API Reference: Get Token
2. Create a Booking (Synchronous)
Use this flow for a simple, blocking booking call where you want the confirmation (or error) immediately.
| Step | Guide |
|---|---|
| Create booking | Inspection Booking Guide |
3. Create a Booking (Asynchronous)
Use this flow when you'd rather not block on the booking call — submit the request, get a requestId immediately, and poll for the result.
| Step | Guide |
|---|---|
| Submit async booking | Async Booking Guide |
| Poll for result | Async Booking Result Guide |
4. Find, Review, and Manage an Order
| Step | Guide |
|---|---|
| Search orders | Order Search Guide |
| Get order details | Order Detail Guide |
| Cancel an order | Cancel Booking Guide |
Choosing the Right API
| Your goal | Recommended APIs |
|---|---|
| Submit a new booking and get an immediate result | Create Booking (Synchronous) |
| Submit a new booking without blocking on the result | Create Booking Asynchronously + Get Async Result |
| List or filter existing bookings | Search Orders |
| View full order information | Get Order Details |
| Cancel a booking | Cancel Booking |
Related Documentation
- Getting Started Guide — Authentication and first API call
- Module Overview — Overview of all QIMA Public API modules
- API Reference — Interactive endpoint explorer for all Public APIs