Inspection Cancel Booking Guide

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

Use the cancel booking API to cancel an existing inspection order. A cancellation reason is required.

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

Endpoint

DELETE https://ppapi.qima.com/user/{userId}/inspection/{orderId}

Prerequisites

In addition to the required headers and authentication setup:

Permission to cancel inspection orders for the target client
An orderId obtained from Search Orders or Get Order Details
Confirm orderExtra.cancelable is true on the order (from Get Order Details) before attempting to cancel

Path Parameters

Parameter	Required	Description
`userId`	Yes	QIMA client user login ID.
`orderId`	Yes	Inspection order ID to cancel.

Query Parameters

Parameter	Required	Description
`reason`	Yes	Cancellation reason.
`reason_options`	No	Additional cancellation reason detail.

Request Example

curl --location --request DELETE 'https://ppapi.qima.com/user/<qima-user-id>/inspection/<order-id>?reason=request%20by%20client' \
  --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 with content: true means the booking was cancelled successfully.

{
    "message": null,
    "content": true
}

Common Errors

See common authentication errors for 401 and 403 responses.

Status	Meaning	Recommended Action
`500 Internal Server Error`	Cancellation failed on the server (e.g. the order can no longer be cancelled).	Check `orderExtra.cancelable` via Get Order Details before retrying; contact QIMA support if the order should be cancelable.

Next Steps

Search orders or get order details again to confirm the cancellation was applied.

Documents