Skip to content

Get Hotel Cancellation Policy

Note:
Few attributes in below sample response are supplier specific, hence there can be possibility these attributes will not appear in the response. We recommend you to parse these fields as mentioned in the sample responses.

/api/v1/hotel/cancellation-policy

This service method is used to fetch Cancellation policies of the selected room(s) for a hotel. It will consist of room-wise cancellation policy or combined cancellation policy.

Room-wise policy

If combinePolicy attribute value is “false” then separate cancellation policy can be returned for each room.

Combined cancellation policy

If combinePolicy attribute value is “true” then single cancellation policy can be returned which will be applied to the complete booking.

In case of no show, charges will be as per the No Show policy. If No Show policy is not available then charges would be 100% charge.

Hotel Cancellation Policy Request

Tags Attribute Description
HotelCancellationPolicyCriteria (JsonObject)
hotelKey*
(String)		 Unique Key for Hotels
searchKey*
(String)		 Unique Key for the search
culture*(String) en
rooms (JsonArray) List of rooms
room (JsonObject)
roomIndex*
(String)		 Room Index
roomKey*
(String)		 Room Key which is unique for a room


hotel cancellation policies request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "hotelKey": "aff2cea4-60c3-405e-b7fe-b69d991a132ftravelboutiqueonlinehtr00000000",
  "searchKey": "aff2cea4-60c3-405e-b7fe-b69d991a132f",
  "rooms": [
    {
      "roomIndex": 1,
      "roomKey": "784527aff2cea4-60c3-405e-b7fe-b69d991a132ftravelboutiqueonlinehtr00000000rcmb00000000"
    },
    {
      "roomIndex": 2,
      "roomKey": "784527aff2cea4-60c3-405e-b7fe-b69d991a132ftravelboutiqueonlinehtr00000000rcmb00000000"
    }
  ],
  "culture": "en"
}

Hotel Cancellation Policy Response

Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData searchKey*
(String)		 This attribute contains a unique search key.
productCode*
(String)
 Product code for hotels - H
culture*
(String)
 en
data (JsonObject)
cancellationPolicies (JsonArray)
cancellationPolicy (JsonObject)
hotelKey*
(String)
 This attribute contains a unique hotel id.
roomIndex*
(Integer List)		 Room Index
roomKey*
(String)		 Unique Key for Room
description
(String)		 Room description
policyRemarks
(String)		 Room Policy remarks
noChargePolicyDetail
(String)		 No-charge Policy details
noChargePolicyType
(String)		 No-charge Policy type
noChargeHourDays
(String)		 No-charge Policy Hours and Days
isCombinedPolicy
(Boolean)		 show if a given policy is for all rooms or it is for specific room index
cancellationDeadline
(DateTime)		 DeadLine for cancellation policy
noShowPolicyDetail (JsonObject) No Show policy details
noShowPolicyType
(String)		 No Show policy type
noShowPolicyCharge
(String)		 No Show policy charge
policyDetailS (JsonArray) Unique Key for Hotels
policyDetail (JsonObject) Unique Key for Hotels
fromDate
(DateTime)		 Date from which policy will be applicable.
toDate
(DateTime)		 Ending date which policy will be applicable.
chargeType
(String)		 Cancellation policy type
charge
(Double)		 Cancellation surcharge amount

hotel cancellation policies response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
  "meta": {
    "success": true,
    "statusCode": "",
    "statusMessage": "",
    "additionalProperties": [
      {
        "key": "timeStamp",
        "value": "YYYY-MM-DD HH:MM:SST",
        "description": "description"
      },
      {
        "key": "serverKey",
        "value": "Server01",
        "description": "description"
      }
    ],
    "actionType": "",
    "conversationId": "fe22cb8d-67e9-4c29-92af-e44dffdcb9a9"
  },
  "warnings": [
    {
      "code": "validation_required",
      "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
      "message": "Check In Time' can't be blank",
      "value": "Check In Time might be changed"
    }
  ],
  "errors": [
    {
      "code": "validation_required",
      "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
      "message": "Field ‘roomKey’ can't be blank",
      "value": "Field ‘roomKey’ can't be blank",
      "source": {
        "field": "roomKey",
        "pointer": "/HotelCancellationPolicyCriteria/roomKey"
      },
      "title": "Required field",
      "type": "validation_error"
    }
  ],
  "commonData": {
    "searchKey": "260d6c37-ab74-4331-9fdc-a9d42a5b55a6",
    "culture": "en"
  },
  "data": [
    {
      "hotelKey": "aff2cea4-60c3-405e-b7fe-b69d991a132ftravelboutiqueonlinehtr00000000",
      "description": "ifCancelledOn/before28/05/2020:NoCharge.\nifCancelledBetween29/",
      "policyRemarks": "",
      "noChargePolicyDetail": "",
      "noChargePolicyType": "",
      "noChargeHourDays": "",
      "noShowPolicyDetail": {
        "noShowPolicyType": "p",
        "noShowPolicyCharge": 100
      },
      "policyDetails": [
        {
          "fromDate": "YYYY-MM-DD",
          "toDate": "YYYY-MM-DD",
          "chargeType": "p",
          "charge": 100
        }
      ],
      "roomIndex": [
        1
      ],
      "roomCombId": "784527aff2cea4-60c3-405e-b7fe-b69d991a132ftravelboutiqueonlinehtr00000000rcmb00000000",
      "isCcombinePolicy": false,
      "cancellationDeadlineDate": "YYYY-MM-DD",
      "additionalProperties": [
        {
          "key": "key1",
          "value": "value1",
          "description": "description"
        },
        {
          "key": "key1",
          "value": "value1",
          "description": "description"
        }
      ]
    }
  ]
}