The Cancellation Policy Metadata Audit API ensures that the cancellation policy metadata pushed from Hotel Trader to the client system matches what is stored on the client’s side. It validates all cancellation policy details for a specific property to ensure alignment with the data sent during the Cancellation Policy Metadata Push.
The audit can be for a single cancellation policy or all cancellation policies of the property.
Appropriate alert messages will be sent to Partner systems after the audit.
Initiator - Hotel Trader
Endpoint
[POST] https://<client-base-url>/cancellation-policy-auditRequest
HTTP Headers
All HTTP headers are mandatory and apply consistently across both endpoints of the API.
Clients must provide their username and password to Hotel Trader. For more information on username and password encoding, please refer to the Authentication page in our Knowledge Base.
| Header Name | Type |
|---|---|
| Content-Type | application/json |
| Accept-Encoding | gzip |
| Authorization | Basic <token> |
Request Description
All the fields in the request are described below.
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| messageId | String | Yes | A string that uniquely identifies this particular message. This should be returned in the response. |
| propertyCode | String | Yes | The unique property code of the hotel for which rateplan metadata is requested. |
| cancellationPolicyCodes | Array | No | If present, return only the cancellation policies with these codes. |
Example
{
"messageId": "funnssq-6c1d-4e12-b374-c76735b49fc9",
"propertyCode": "NYCMIL",
"cancellationPolicyCodes": null,
}
Response
Success
Object Description
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| messageId | String | Yes | The same messageId string that is sent in the request. |
| status | Object | Yes | The standard status object that describes the success/error status and the error message, if any. |
| propertyCode | String | Yes | The property code is sent in the request. |
| cancellationPolicyCodes | Array | No | An array of cancellation policy objects that contain the rateplan metadata. |
Example
{
"messageId": "funnssq-6c1d-4e12-b374-c76735b49fc9",
"status": {
"success": true
},
"propertyCode": "NYCMIL",
"cancellationPolicies": [
{
"code": "CP001",
"name": "Standard Cancellation Policy",
"description": "Free cancellation up to 24 hours before check-in.",
"penaltyWindows": [
{
"relativeDeadline": {
"relativeTo": "CHECKIN_TIME",
"type": "Before",
"offsetUnit": "HOUR",
"offsetValue": 24
},
"penalty": {
"percent": null,
"nights": 1,
"taxInclusive": true
}
}
]
}
]
}
Error
This API follows the Standard Response model of the Content API for error response.