Skip to Content

Changes for page 2. CalcPackage

Last modified by Giorgi Mdivnishvili on 2024/04/12 18:58
From version 3.1
edited by Giorgi Mdivnishvili
on 2023/12/14 12:46
Change comment: There is no comment for this version
To version 12.1
edited by Giorgi Mdivnishvili
on 2024/04/12 18:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -CalcPackage
1 +2. CalcPackage
Content
... ... @@ -6,13 +6,13 @@
6 6  
7 7  = Method Description =
8 8  
9 -The initial method of the integration process is authorization. You will be provided with a test user username and password to generate the access token that you will need to pass in all the following methods.
9 +This method is used to calculate package only hotels, to recheck prices, availability, prices and cancelation policy before book.
10 10  
11 11  
12 -== Endpoint URL - [GET] ==
12 +== Endpoint URL - [POST] ==
13 13  
14 14  {{info}}
15 -[[https:~~/~~/online-api.kazunion.com/api/OnlyHotelPackages/CalcPackage>>https://online-api.kazunion.com/api/OnlyHotelPackages/CalcPackage]]
15 +[[https:~~/~~/integration.kazunion.com/api/OnlyHotelPackages/CalcPackage>>https://integration.kazunion.com/api/OnlyHotelPackages/CalcPackage]]
16 16  {{/info}}
17 17  
18 18  
... ... @@ -39,38 +39,97 @@
39 39  
40 40  {{code language="Json"}}
41 41  {
42 - "packageId": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
43 - "extraServicePriceCodes": [
44 -
45 - ]
42 + "packageId": "onlyhotel:25a0ce83-047e-485a-8fd7-f2b5a7a1fa37:9963330c-2346-4330-b9cf-7abbb0f64636",
43 + "includeInsurance": false
46 46  }
47 47  {{/code}}
48 48  
49 49  
50 -== Response ==
48 +== Response ==
51 51  
52 52  {{code language="json"}}
53 -[
54 - {
55 - "hotelCode": "string",
56 - "hotelName": "string",
57 - "hotelClass": "string",
58 - "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
59 - "countryCode": "string",
60 - "countryName": "string",
61 - "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
62 - "cityName": "string",
63 - "districtName": "string",
64 - "hotelType": "CityHotel",
65 - "latitude": "string",
66 - "longitude": "string",
67 - "hasAlcohol": true,
68 - "hasFreeWifi": true,
69 - "hasMetro": true,
70 - "hasPool": true,
71 - "hasMall": true
51 +{
52 + "error": true,
53 + "errorCode": "string",
54 + "errorDescription": "string",
55 + "userErrorDescription": "string",
56 + "package": {
57 + "id": "string",
58 + "priceCurrency": "string",
59 + "totalPrice": 0,
60 + "agentCommissionPercent": 0,
61 + "agentCommissionAmount": 0,
62 + "hotel": {
63 + "hotelPriceId": "string",
64 + "providerId": 0,
65 + "hotelName": "string",
66 + "hotelCode": "string",
67 + "nigths": 0,
68 + "mealPlan": "string",
69 + "hotelClass": "string",
70 + "availabilityType": "OnRequest",
71 + "availableRoomsCount": 0,
72 + "fewRooms": true,
73 + "roomCategoryCode": "string",
74 + "roomCategoryName": "string",
75 + "placementTypeName": "string",
76 + "placementDescription": "string",
77 + "checkInDate": "2023-12-14T08:49:36.703Z",
78 + "checkOutDate": "2023-12-14T08:49:36.703Z",
79 + "adults": 0,
80 + "children": 0,
81 + "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
82 + "districtName": "string",
83 + "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
84 + "cityName": "string",
85 + "countryCode": "string",
86 + "countryName": "string",
87 + "hasAlcohol": true,
88 + "hasFreeWifi": true,
89 + "hasMetro": true,
90 + "hasPool": true,
91 + "hasMall": true,
92 + "cancellationPolicyDescription": "string",
93 + "cancellationPolicy": {
94 + "cancellationPolicyCode": "string",
95 + "noShowChargeValue": 0,
96 + "noShowChargeValueType": "string",
97 + "earlyDepartureChargeValue": 0,
98 + "earlyDepartureChargeValueType": "string",
99 + "conditions": [
100 + {
101 + "timeunits": 0,
102 + "timeunitType": "string",
103 + "timeOffsetTypeName": "string",
104 + "chargeValue": 0,
105 + "chargeValueType": "string"
106 + }
107 + ]
108 + }
109 + },
110 + "extraServices": [
111 + {
112 + "extraServiceCode": "string",
113 + "extraServiceTypeCode": "string",
114 + "isMandatory": 0,
115 + "extraServiceName": "string",
116 + "minimalServiceAmount": 0,
117 + "includedPriceCode": "string",
118 + "prices": [
119 + {
120 + "extraServicePriceCode": "string",
121 + "displayName": "string",
122 + "restrictionInfo": "string",
123 + "additionalInfo": "string",
124 + "price": 0,
125 + "extraPrice": 0,
126 + "currency": "string"
127 + }
128 + ]
129 + }
130 + ]
72 72   }
73 -]
132 +}
74 74  {{/code}}
75 75  
76 76  
... ... @@ -79,41 +79,47 @@
79 79  {{code language="Json"}}
80 80  {
81 81   "package": {
82 - "id": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
141 + "id": "onlyhotel:25a0ce83-047e-485a-8fd7-f2b5a7a1fa37:9963330c-2346-4330-b9cf-7abbb0f64636",
83 83   "priceCurrency": "USD",
84 - "totalPrice": 381.70,
143 + "totalPrice": 46.94,
85 85   "agentCommissionPercent": 0.00,
86 86   "agentCommissionAmount": 0.00,
87 87   "hotel": {
88 - "hotelPriceId": "504f63ca-6dd5-4d84-8245-cf7e77ccff73",
89 - "providerId": 13,
90 - "hotelName": "Golden Tulip Al Barsha Hotel",
91 - "hotelCode": "ed0820c5-29b0-4e1b-8bcf-9f3c181e7961",
92 - "nigths": 4,
147 + "hotelPriceId": "9963330c-2346-4330-b9cf-7abbb0f64636",
148 + "hotelName": "Royal Continental Hotel",
149 + "hotelCode": "03cf038c-df96-4926-af5f-0f285e600405",
150 + "nigths": 1,
93 93   "mealPlan": "RO",
94 94   "hotelClass": "4",
153 + "hotelColor": "#000000",
95 95   "availabilityType": "FreeSale",
96 96   "availableRoomsCount": 0,
97 97   "fewRooms": true,
98 - "roomCategoryCode": "e63ea5ac-4883-4059-bb0a-795a534bbbfb",
99 - "roomCategoryName": "Superior Twin",
100 - "placementTypeName": "SNGL + CHILD(6-11.99)sharing",
101 - "checkInDate": "2024-02-17T08:00:00.000Z",
102 - "checkOutDate": "2024-02-21T08:00:00.000Z",
103 - "adults": 1,
104 - "children": 1,
105 - "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
106 - "districtName": "Al Barsha",
157 + "roomCategoryCode": "ff13e5ec-2116-46d1-9ff4-ae76be84ff91",
158 + "roomCategoryName": "Superior King Room",
159 + "placementTypeName": "DBL",
160 + "checkInDate": "2024-06-30T00:00:00.000",
161 + "checkOutDate": "2024-07-01T00:00:00.000",
162 + "adults": 2,
163 + "children": 0,
164 + "districtUID": "aaff2238-fa72-4900-83f8-a16990415547",
165 + "districtName": "Deira",
107 107   "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
108 108   "cityName": "Dubai",
109 109   "countryCode": "AE",
110 110   "countryName": "United Arab Emirates",
111 - "hasAlcohol": true,
170 + "hasAlcohol": false,
112 112   "hasFreeWifi": true,
113 113   "hasMetro": false,
114 114   "hasPool": true,
115 115   "hasMall": false,
116 - "cancellationPolicyDescription": "Cancellation Policy: 15 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
175 + "infantMaxAge": 5.99,
176 + "childMinAge": 6.00,
177 + "childMaxAge": 11.99,
178 + "teenMinAge": 0.0,
179 + "teenMaxAge": 0.0,
180 + "adultMinAge": 12.00,
181 + "cancellationPolicyDescription": "Cancellation Policy: 1 Day Before Arrival: 1.00 Night, Early Departure: 100.00 %, NoShow: 100.00 %",
117 117   "cancellationPolicy": {
118 118   "noShowChargeValue": 100.00,
119 119   "noShowChargeValueType": "%",
... ... @@ -121,17 +121,30 @@
121 121   "earlyDepartureChargeValueType": "%",
122 122   "conditions": [
123 123   {
124 - "timeunits": 15,
189 + "timeunits": 1,
125 125   "timeunitType": "Day",
126 126   "timeOffsetTypeName": "Before Arrival",
127 - "chargeValue": 100.00,
128 - "chargeValueType": "%"
192 + "chargeValue": 1.00,
193 + "chargeValueType": "Night"
129 129   }
130 130   ]
131 131   }
132 132   },
133 - "extraServices": []
198 + "extraServices": [],
199 + "insurancePrice": {
200 + "name": "Insurance (10000 USD) with COVID coverage",
201 + "price": 8.96,
202 + "actualStartDate": "2024-06-30T00:00:00.000",
203 + "actualEndDate": "2024-07-01T00:00:00.000",
204 + "optional": true,
205 + "includedInPackagePrice": false
206 + },
207 + "sortCheckInOut": "30.06.2024-01.07.2024",
208 + "sortHotelName": "royal continental hotel",
209 + "sortDetails": "ro",
210 + "sortPlacement": "superior king room dbl"
134 134   },
212 + "refreshPriceResult": "Success",
135 135   "error": false
136 136  }
137 137  {{/code}}
... ... @@ -139,37 +139,139 @@
139 139  
140 140  === Schema ===
141 141  
142 -{{code language="none"}}
143 -[Hotel{
144 -hotelCode string
145 -nullable: true
146 -hotelName string
147 -nullable: true
148 -hotelClass string
149 -nullable: true
150 -cityUID string($uuid)
151 -nullable: true
152 -countryCode string
153 -nullable: true
154 -countryName string
155 -nullable: true
156 -districtUID string($uuid)
157 -nullable: true
158 -cityName string
159 -nullable: true
160 -districtName string
161 -nullable: true
162 -hotelType HotelTypeEnumstring
163 -Enum:
164 -[ CityHotel, BeachHotel, SecondLineBeach ]
165 -latitude string
166 -nullable: true
167 -longitude string
168 -nullable: true
169 -hasAlcohol boolean
170 -hasFreeWifi boolean
171 -hasMetro boolean
172 -hasPool boolean
173 -hasMall boolean
220 +{{success}}
221 +CalcOnlyHotelPackageResponse{
222 +
223 +|error|boolean
224 +|errorCode|string
225 +nullable: true
226 +|errorDescription|string
227 +nullable: true
228 +|userErrorDescription|string
229 +nullable: true
230 +|package|OnlyHotelPackage{(((
231 +|id|string
232 +nullable: true
233 +|priceCurrency|string
234 +nullable: true
235 +|totalPrice|number($double)
236 +|agentCommissionPercent|number($double)
237 +|agentCommissionAmount|number($double)
238 +|hotel|PackageHotel{(((
239 +|hotelPriceId|string
240 +nullable: true
241 +|providerId|integer($int32)
242 +|hotelName|string
243 +nullable: true
244 +|hotelCode|string
245 +nullable: true
246 +|nigths|integer($int32)
247 +|mealPlan|string
248 +nullable: true
249 +|hotelClass|string
250 +nullable: true
251 +|availabilityType|RoomAvailabilityTypeEnumstringEnum:
252 +[ OnRequest, FreeSale, StopSale ]
253 +|availableRoomsCount|integer($int32)
254 +|fewRooms|boolean
255 +|roomCategoryCode|string
256 +nullable: true
257 +|roomCategoryName|string
258 +nullable: true
259 +|placementTypeName|string
260 +nullable: true
261 +|placementDescription|string
262 +nullable: true
263 +|checkInDate|string($date-time)
264 +|checkOutDate|string($date-time)
265 +|adults|integer($int32)
266 +|children|integer($int32)
267 +|districtUID|string($uuid)
268 +nullable: true
269 +|districtName|string
270 +nullable: true
271 +|cityUID|string($uuid)
272 +nullable: true
273 +|cityName|string
274 +nullable: true
275 +|countryCode|string
276 +nullable: true
277 +|countryName|string
278 +nullable: true
279 +|hasAlcohol|boolean
280 +|hasFreeWifi|boolean
281 +|hasMetro|boolean
282 +|hasPool|boolean
283 +|hasMall|boolean
284 +|cancellationPolicyDescription|string
285 +nullable: true
286 +|cancellationPolicy|CancellationPolicyExchange{(((
287 +|cancellationPolicyCode|string
288 +nullable: true
289 +|noShowChargeValue|number($double)
290 +nullable: true
291 +|noShowChargeValueType|string
292 +nullable: true
293 +|earlyDepartureChargeValue|number($double)
294 +nullable: true
295 +|earlyDepartureChargeValueType|string
296 +nullable: true
297 +|conditions|[
298 +nullable: trueCancellationPolicyConditionExchange{(((
299 +|timeunits|integer($int32)
300 +|timeunitType|string
301 +nullable: true
302 +|timeOffsetTypeName|string
303 +nullable: true
304 +|chargeValue|number($double)
305 +nullable: true
306 +|chargeValueType|string
307 +nullable: true
308 +
174 174  }]
175 -{{/code}}
310 +)))
311 +
312 +}
313 +)))
314 +
315 +}
316 +)))
317 +|extraServices|[
318 +nullable: trueHotelExtraServiceBase{(((
319 +|extraServiceCode|string
320 +nullable: true
321 +|extraServiceTypeCode|string
322 +nullable: true
323 +|isMandatory|integer($int32)
324 +|extraServiceName|string
325 +nullable: true
326 +|minimalServiceAmount|number($double)
327 +|includedPriceCode|string
328 +nullable: true
329 +|prices|[
330 +nullable: trueHotelExtraServicePriceBase{(((
331 +|extraServicePriceCode|string
332 +nullable: true
333 +|displayName|string
334 +nullable: true
335 +|restrictionInfo|string
336 +nullable: true
337 +|additionalInfo|string
338 +nullable: true
339 +|price|number($double)
340 +|extraPrice|number($double)
341 +|currency|string
342 +nullable: true
343 +
344 +}]
345 +)))
346 +
347 +}]
348 +)))
349 +
350 +}
351 +)))
352 +
353 +}
354 +{{/success}}
355 +