2.2.2.5 Order Pre-cancellation
About 291 wordsLess than 1 minute
2025-11-04
Warning
- Klook calls this interface to query the penalty information and refundable status required for the specified order if a cancellation operation were performed at the current time.
URL
Integrator to define and provide the URL to Klook
Input Parameters
| Field | Type | Mandatory | Description |
|---|---|---|---|
klookOrderCode | String | true | Klook Order Number. In case of timeout, this field is used for forced cancellation. |
supplierOrderCode | String | false | Supplier Order Number. |
Base Input Parameter Extension Fields
| Field | Type | Mandatory | Description |
|---|---|---|---|
supplierAccount | String | false | openApi supplier account data Integrator defines the account data1: The account is used for different product types for specific use cases. For example, a Member account returns rates for Members only, non-Members will not see the rate. It supports multiple accounts2: If the integrator does not have multiple accounts, the value passed is null3: Length does not exceed 128 characters |
Input Parameter Example
Example
{
"base": {
"requestId": "xxxx",
"requestTime": "xxx",
"requestAgent": "xxx",
"openApiSign": "xx",
"supplierAccount": "account1",
"version": "xxx"
},
"requestData": {
"supplierOrderCode": "SUPPLIERORDER987",
"klookOrderCode": "KLOOKORDER12345"
}
}Output Parameters
| Field | Type | Mandatory | Description |
|---|---|---|---|
refundable | boolean | true | Whether it is refundable at the current time. |
currency | String | true | Standard three-letter currency code. |
refundFee | String | true | Penalty fee. How much penalty is charged if cancellation occurs at the current time. |
configData | String | false | Integrator custom data returned from pre cancelRequired by Klook to be included in the integrator's cancel interface request. Optional, length must not exceed 64 |
Output Parameter Example
Example
{
"success": true,
"error": {
"code": "",
"message": ""
},
"result": {
"refundable": true,
"currency": "HKD",
"refundFee": "100",
"configData" : "{\"cancelUrl\", \"www.abc.com/cancel\"}"
}
}