Changes for page 2. CalcPackage

Last modified by Giorgi Mdivnishvili on 2024/04/12 18:58

From version 5.1
edited by Giorgi Mdivnishvili
on 2023/12/14 12:51
Change comment: There is no comment for this version
To version 12.2
edited by Giorgi Mdivnishvili
on 2024/04/12 18:58
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,10 +39,8 @@
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  
... ... @@ -140,41 +140,47 @@
140 140  {{code language="Json"}}
141 141  {
142 142   "package": {
143 - "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",
144 144   "priceCurrency": "USD",
145 - "totalPrice": 381.70,
143 + "totalPrice": 46.94,
146 146   "agentCommissionPercent": 0.00,
147 147   "agentCommissionAmount": 0.00,
148 148   "hotel": {
149 - "hotelPriceId": "504f63ca-6dd5-4d84-8245-cf7e77ccff73",
150 - "providerId": 13,
151 - "hotelName": "Golden Tulip Al Barsha Hotel",
152 - "hotelCode": "ed0820c5-29b0-4e1b-8bcf-9f3c181e7961",
153 - "nigths": 4,
147 + "hotelPriceId": "9963330c-2346-4330-b9cf-7abbb0f64636",
148 + "hotelName": "Royal Continental Hotel",
149 + "hotelCode": "03cf038c-df96-4926-af5f-0f285e600405",
150 + "nigths": 1,
154 154   "mealPlan": "RO",
155 155   "hotelClass": "4",
153 + "hotelColor": "#000000",
156 156   "availabilityType": "FreeSale",
157 157   "availableRoomsCount": 0,
158 158   "fewRooms": true,
159 - "roomCategoryCode": "e63ea5ac-4883-4059-bb0a-795a534bbbfb",
160 - "roomCategoryName": "Superior Twin",
161 - "placementTypeName": "SNGL + CHILD(6-11.99)sharing",
162 - "checkInDate": "2024-02-17T08:00:00.000Z",
163 - "checkOutDate": "2024-02-21T08:00:00.000Z",
164 - "adults": 1,
165 - "children": 1,
166 - "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
167 - "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",
168 168   "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
169 169   "cityName": "Dubai",
170 170   "countryCode": "AE",
171 171   "countryName": "United Arab Emirates",
172 - "hasAlcohol": true,
170 + "hasAlcohol": false,
173 173   "hasFreeWifi": true,
174 174   "hasMetro": false,
175 175   "hasPool": true,
176 176   "hasMall": false,
177 - "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 %",
178 178   "cancellationPolicy": {
179 179   "noShowChargeValue": 100.00,
180 180   "noShowChargeValueType": "%",
... ... @@ -182,17 +182,30 @@
182 182   "earlyDepartureChargeValueType": "%",
183 183   "conditions": [
184 184   {
185 - "timeunits": 15,
189 + "timeunits": 1,
186 186   "timeunitType": "Day",
187 187   "timeOffsetTypeName": "Before Arrival",
188 - "chargeValue": 100.00,
189 - "chargeValueType": "%"
192 + "chargeValue": 1.00,
193 + "chargeValueType": "Night"
190 190   }
191 191   ]
192 192   }
193 193   },
194 - "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"
195 195   },
212 + "refreshPriceResult": "Success",
196 196   "error": false
197 197  }
198 198  {{/code}}
... ... @@ -200,54 +200,161 @@
200 200  
201 201  === Schema ===
202 202  
203 -{{code language="none"}}
220 +{{success}}
204 204  CalcOnlyHotelPackageResponse{
205 -error boolean
206 -errorCode string
207 -nullable: true
208 -errorDescription string
209 -nullable: true
210 -userErrorDescription string
211 -nullable: true
212 -package OnlyHotelPackage{
213 -id string
214 -nullable: true
215 -priceCurrency string
216 -nullable: true
217 -totalPrice number($double)
218 -agentCommissionPercent number($double)
219 -agentCommissionAmount number($double)
220 -hotel PackageHotel{...}
221 -extraServices [
222 -nullable: true
223 -HotelExtraServiceBase{
224 -extraServiceCode string
225 -nullable: true
226 -extraServiceTypeCode string
227 -nullable: true
228 -isMandatory integer($int32)
229 -extraServiceName string
230 -nullable: true
231 -minimalServiceAmount number($double)
232 -includedPriceCode string
233 -nullable: true
234 -prices [
235 -nullable: true
236 -HotelExtraServicePriceBase{
237 -extraServicePriceCode string
238 -nullable: true
239 -displayName string
240 -nullable: true
241 -restrictionInfo string
242 -nullable: true
243 -additionalInfo string
244 -nullable: true
245 -price number($double)
246 -extraPrice number($double)
247 -currency string
248 -nullable: true
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 +
249 249  }]
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 +
250 250  }]
345 +)))
346 +
347 +}]
348 +)))
349 +
251 251  }
351 +)))
352 +
252 252  }
253 -{{/code}}
354 +{{/success}}
355 +
356 +
357 +
358 +== Important ==
359 +
360 +{{error}}
361 +=== Implementing Authorization in Subsequent Requests ===
362 +
363 +For every API request after the initial authentication, it's crucial to include the authorization token in the request header. This ensures your requests are authorized and can access the necessary resources. Here's how to properly include your token:
364 +
365 +* **Header Key:** Authorization
366 +* **Header Value:** Bearer [Your Token Here] - Use the bearer token provided in the initial authentication response. The authorization type should be specified as Bearer Token.
367 +
368 +Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
369 +
370 +* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
371 +* **Header Key:** X-nugios-timezone
372 +* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
373 +
374 +Incorporating these headers with their respective values is essential for the successful processing of your API requests.
375 +{{/error}}
376 +
377 +