API Reference

Authenticates a client using their credentials and returns a JWT access token, a refresh key, and a token expiry timestamp. Include the `ai-api-access-token` and `Referer` headers in the request. The `Referer` header value must remain unchanged across all subsequent requests.

Issues a new access token using the refresh key. Include the `ai-api-refresh-key`, `ai-api-access-token`, `Authorization`, and `Referer` headers in the request. The request body may be empty.

Invalidates and removes the current access token. Include the `ai-api-access-token`, `Authorization`, `ai-api-refresh-key`, and `Referer` headers in the request.

Uploads a file and attaches it to one or more QIMA resources such as an inspection order or product. The file is linked via the document type and source ID. Requires `Content-Type: multipart/form-data`.

Downloads a file by its ID and returns the file content as a binary stream. Use the file ID obtained from the PDF info endpoints for inspection or audit reports.

Allows a supplier to confirm the inspection date, container ready date, and factory details for a given inspection order. A password derived from the order's confirmation password must be provided.

Creates a new supplier under the specified client account. If a supplier with the same name or identification already exists for that client, the creation will be rejected.

Retrieves detailed information for a specific supplier by their supplier ID.

Updates the details of an existing supplier. Returns `true` if the update was successful.

Retrieves a list of suppliers associated with the specified client account. Optionally filter by supplier type.

Permanently deletes one or more suppliers identified by their IDs. Multiple supplier IDs can be provided as a comma-separated list.

Returns the list of countries belonging to the specified continent. Use `/parameter/v2/continents` to obtain valid continent IDs.

Returns the complete list of continents available in QIMA's reference data. Continent IDs from this endpoint can be used to look up countries per continent.

Returns the complete list of countries available in QIMA's reference data. Country IDs from this endpoint can be used to look up provinces and cities.

Returns all cities for the specified country. Use `/parameter/v2/countries` or `/parameter/v2/searchCountries` to obtain a valid country ID.

Returns all provinces or states for the specified country.

Searches for cities within the specified country using a partial or full city name. Useful for autocomplete scenarios.

Returns all product categories available in QIMA's reference data. Use these categories when booking inspections or lab tests.

Returns all product families available in QIMA's reference data. Product families group related product types within a category.

Returns the complete product taxonomy as a hierarchical tree, including categories, families, and types. Use this to navigate the full product classification structure.

Returns all product types available in QIMA's reference data. Product types represent the most granular classification level within the product taxonomy.

Searches for cities within the specified province using a partial or full city name. Useful for autocomplete scenarios.

Searches for countries by partial or full name. Useful for autocomplete lookups when building address forms.

Returns metadata (file ID, name, size) for the PDF report associated with the specified inspection product. Use the returned file ID with `/user/{userId}/file/{fileId}` to download the actual report.

Searches and returns a paginated list of inspection reports for the specified client account. Supports filtering by date range, keyword, status, and sorting.

Returns the full interactive report data for a specific inspection product, including all sections and findings. The order ID must be provided as a query parameter.

Returns a paginated list of audit reports for the specified client account. Supports filtering by date range, keyword, and sorting.

Creates a new audit order for the specified factory. Returns the booking confirmation when successful. Returns HTTP 202 if the factory has not yet been confirmed.

Returns the full details of a specific audit report for the given client account.

Returns the full booking details for a specific inspection order, including service type, product information, factory details, and schedule.

Returns a paginated list of inspection booking orders for the specified client account. Filter by service type, date range, status, and keyword. Supports sorting.

Cancels an existing inspection booking. A cancellation reason must be provided. Returns `true` if the cancellation was successful.

Creates a new inspection booking order. Returns the booking confirmation on success. Returns HTTP 202 if the factory has not yet confirmed, or HTTP 409 if a duplicate booking is detected.

Submits a new inspection booking request asynchronously. Returns a request ID immediately. Poll `/booking-result/{requestId}` to check the final booking result.

Retrieves the result of an asynchronous inspection booking request. Use the `requestId` returned by the `POST /v1.0/async-inspection` endpoint.

Confirms a lab testing booking order. Returns the confirmed order details.

Confirms a lab testing inquiry order, converting it into a booking. Returns the confirmed order details.

Returns a paginated list of lab testing orders for the specified client. Supports filtering by order ID, reference numbers, dates, status, supplier, product, and submitter.

Creates a new lab testing order with the provided booking details. Returns the created order on success.

Returns comprehensive details for a specific lab testing order, including product information, tests, sample collection, and attachments.

Updates the details of an existing lab testing order. Returns the updated order on success.

Uploads one or more file attachments to an existing lab testing order. Files must be sent as `multipart/form-data`. Include the `Idempotency-Key` request header to prevent duplicate uploads.

Returns detailed test results and the final report for a specific lab testing order, including overall result, individual test outcomes, and report file links.