Last modified by Giorgi Mdivnishvili on 2024/07/11 12:45

From version 7.1
edited by Giorgi Mdivnishvili
on 2024/04/11 11:05
Change comment: There is no comment for this version
To version 1.1
edited by Giorgi Mdivnishvili
on 2024/04/11 09:30
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,895 +1,32 @@
1 1  {{box cssClass="floatinginfobox" title="**Contents**"}}
2 -
3 -
4 4  {{toc/}}
5 5  {{/box}}
6 6  
7 -= Method Description =
5 += Paragraph 1 =
8 8  
9 -Tour package mean, tour with hotel and flight together. Using this method gives data about full package availability with flight and hotel options.
7 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
10 10  
11 -It's possible to receive data as current dates, also in date ranges using parameter  "stayDays": 0,   "stayDaysTo": 0. the maximum difference between the days can be 7. Below you can see examples.
9 +== Sub-paragraph ==
12 12  
11 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
13 13  
14 -== Endpoint URL - [POST] ==
13 +== Sub-paragraph ==
15 15  
16 -{{info}}
17 -[[https:~~/~~/integration.kazunion.com/api/TourPackages/SearchTourPackages>>https://integration.kazunion.com/api/TourPackages/SearchTourPackages]]
18 -{{/info}}
15 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
19 19  
20 -== Request Parameters ==
17 +=== Sub-sub paragraph ===
21 21  
22 -(% class="box infomessage" %)
23 -(((
24 -None 
25 -)))
19 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
26 26  
27 27  
28 -== Request example ==
22 += Paragraph 2 =
29 29  
30 -{{code language="Json"}}
31 -{
32 - "departureCountryCode": "KZ",
33 - "departureCityUID": "f0ba6324-f337-405c-8cc7-23d62cf664e8",
34 - "arrivalCountryCode": "AE",
35 - "adults": 2,
36 - "children": 0,
37 - "departureDate": "2024-05-25T00:00:00",
38 - "returnDate": "2024-06-01T00:00:00",
39 - "departureAndReturnDaysCount": 7,
40 - "checkInDate": "2024-05-25T00:00:00",
41 - "checkOutDate": "2024-06-01T00:00:00",
42 - "checkInAndCheckOutDaysCount": 7,
43 - "directFlightsOnly": true,
44 - "pageRowCount": 25,
45 - "searchCurrency": "USD"
46 -}
47 -{{/code}}
24 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
48 48  
26 +== Sub-paragraph ==
49 49  
50 -== Response Body ==
28 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
51 51  
52 -{{code language="json"}}
53 -{
54 - "error": true,
55 - "errorCode": "string",
56 - "errorDescription": "string",
57 - "userErrorDescription": "string",
58 - "packages": [
59 - {
60 - "cacheKey": "string",
61 - "id": "string",
62 - "priceCurrency": "string",
63 - "totalPrice": 0,
64 - "agentCommissionPercent": 0,
65 - "agentCommissionAmount": 0,
66 - "includedExtrasAmount": 0,
67 - "priceDifference": 0,
68 - "hotel": {
69 - "hotelPriceId": "string",
70 - "providerId": 0,
71 - "hotelName": "string",
72 - "hotelCode": "string",
73 - "nigths": 0,
74 - "mealPlan": "string",
75 - "hotelClass": "string",
76 - "availabilityType": "OnRequest",
77 - "availableRoomsCount": 0,
78 - "fewRooms": true,
79 - "roomCategoryCode": "string",
80 - "roomCategoryName": "string",
81 - "placementTypeName": "string",
82 - "placementDescription": "string",
83 - "checkInDate": "2023-12-14T13:47:13.396Z",
84 - "checkOutDate": "2023-12-14T13:47:13.396Z",
85 - "adults": 0,
86 - "children": 0,
87 - "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
88 - "districtName": "string",
89 - "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
90 - "cityName": "string",
91 - "countryCode": "string",
92 - "countryName": "string",
93 - "hasAlcohol": true,
94 - "hasFreeWifi": true,
95 - "hasMetro": true,
96 - "hasPool": true,
97 - "hasMall": true,
98 - "cancellationPolicyDescription": "string",
99 - "cancellationPolicy": {
100 - "cancellationPolicyCode": "string",
101 - "noShowChargeValue": 0,
102 - "noShowChargeValueType": "string",
103 - "earlyDepartureChargeValue": 0,
104 - "earlyDepartureChargeValueType": "string",
105 - "conditions": [
106 - {
107 - "timeunits": 0,
108 - "timeunitType": "string",
109 - "timeOffsetTypeName": "string",
110 - "chargeValue": 0,
111 - "chargeValueType": "string"
112 - }
113 - ]
114 - }
115 - },
116 - "flight": {
117 - "id": "string",
118 - "departureDate": "2023-12-14T13:47:13.396Z",
119 - "returnDate": "2023-12-14T13:47:13.396Z",
120 - "departureTicketsLeft": 0,
121 - "returnTicketsLeft": 0,
122 - "departureAvailabilityType": "OnRequest",
123 - "returnAvailabilityType": "OnRequest",
124 - "isTwoWay": true,
125 - "departureSegments": [
126 - {
127 - "airlineCode": "string",
128 - "airlineName": "string",
129 - "flightCode": "string",
130 - "class": "string",
131 - "lugageWeight": 0,
132 - "handLugageWeight": 0,
133 - "departureFlightDate": "2023-12-14T13:47:13.396Z",
134 - "departureCountryName": "string",
135 - "departureCityName": "string",
136 - "departureAirportCode": "string",
137 - "departureAirportName": "string",
138 - "departureTerminalCode": "string",
139 - "arrivalFlightDate": "2023-12-14T13:47:13.396Z",
140 - "arrivalCountryName": "string",
141 - "arrivalCityName": "string",
142 - "arrivalAirportCode": "string",
143 - "arrivalAirportName": "string",
144 - "arrivalTerminalCode": "string",
145 - "flightDuration": "string",
146 - "baggages": [
147 - {
148 - "baggageCode": "string",
149 - "description": "string",
150 - "price": 0,
151 - "currency": "string",
152 - "included": true
153 - }
154 - ]
155 - }
156 - ],
157 - "returnSegments": [
158 - {
159 - "airlineCode": "string",
160 - "airlineName": "string",
161 - "flightCode": "string",
162 - "class": "string",
163 - "lugageWeight": 0,
164 - "handLugageWeight": 0,
165 - "departureFlightDate": "2023-12-14T13:47:13.396Z",
166 - "departureCountryName": "string",
167 - "departureCityName": "string",
168 - "departureAirportCode": "string",
169 - "departureAirportName": "string",
170 - "departureTerminalCode": "string",
171 - "arrivalFlightDate": "2023-12-14T13:47:13.396Z",
172 - "arrivalCountryName": "string",
173 - "arrivalCityName": "string",
174 - "arrivalAirportCode": "string",
175 - "arrivalAirportName": "string",
176 - "arrivalTerminalCode": "string",
177 - "flightDuration": "string",
178 - "baggages": [
179 - {
180 - "baggageCode": "string",
181 - "description": "string",
182 - "price": 0,
183 - "currency": "string",
184 - "included": true
185 - }
186 - ]
187 - }
188 - ]
189 - },
190 - "extraServices": [
191 - {
192 - "extraServiceCode": "string",
193 - "extraServiceTypeCode": "string",
194 - "isMandatory": 0,
195 - "extraServiceName": "string",
196 - "minimalServiceAmount": 0,
197 - "includedPriceCode": "string",
198 - "prices": [
199 - {
200 - "extraServicePriceCode": "string",
201 - "displayName": "string",
202 - "restrictionInfo": "string",
203 - "additionalInfo": "string",
204 - "price": 0,
205 - "extraPrice": 0,
206 - "currency": "string"
207 - }
208 - ]
209 - }
210 - ],
211 - "insurancePrice": {
212 - "name": "string",
213 - "price": 0,
214 - "priceSurcarge": 0,
215 - "actualStartDate": "2023-12-14T13:47:13.396Z",
216 - "actualEndDate": "2023-12-14T13:47:13.396Z",
217 - "optional": true,
218 - "includedInPackagePrice": true
219 - }
220 - }
221 - ],
222 - "pagingId": "string",
223 - "pageNumber": 0,
224 - "pageCount": 0
225 -}
226 -{{/code}}
30 +== Sub-paragraph ==
227 227  
228 -
229 -== Response example ==
230 -
231 -{{code language="Json"}}
232 -{
233 - "packages": [
234 - {
235 - "id": "tour:556ce3c2-4062-4181-9970-f41e1aeb3b8b:ce81c22f-7d91-4237-9a2a-43c4c4bcb62f:1d8793e6-346e-4b5c-933f-3d8637684d7e",
236 - "priceCurrency": "USD",
237 - "totalPrice": 909.78,
238 - "agentCommissionPercent": 0.0,
239 - "agentCommissionAmount": 0.0,
240 - "includedExtrasAmount": 0,
241 - "priceDifference": 0,
242 - "hotel": {
243 - "hotelPriceId": "ce81c22f-7d91-4237-9a2a-43c4c4bcb62f",
244 - "hotelName": "CityMax Sharjah",
245 - "hotelCode": "CMAXBSHJNUG",
246 - "nigths": 7,
247 - "mealPlan": "BB",
248 - "hotelClass": "3",
249 - "hotelColor": "#228B22",
250 - "availabilityType": "FreeSale",
251 - "availableRoomsCount": 0,
252 - "fewRooms": true,
253 - "roomCategoryCode": "DBL",
254 - "roomCategoryName": "Standard Room",
255 - "placementTypeName": "2 Adults",
256 - "placementDescription": "MARPROMDMC02/RUS",
257 - "checkInDate": "2024-05-25T00:00:00.000",
258 - "checkOutDate": "2024-06-01T00:00:00.000",
259 - "adults": 2,
260 - "children": 0,
261 - "districtUID": "7ac1bbc8-59ea-4977-b272-ed8553f94f9b",
262 - "districtName": "Sharjah",
263 - "cityUID": "f78ac3bc-f040-46d0-8319-2c52083080a6",
264 - "cityName": "Sharjah",
265 - "countryCode": "AE",
266 - "countryName": "United Arab Emirates",
267 - "hasAlcohol": false,
268 - "hasFreeWifi": true,
269 - "hasMetro": false,
270 - "hasPool": false,
271 - "hasMall": true,
272 - "infantMaxAge": 4.99,
273 - "childMinAge": 5.0,
274 - "childMaxAge": 11.99,
275 - "teenMinAge": 0.0,
276 - "teenMaxAge": 0.0,
277 - "adultMinAge": 12.0,
278 - "cancellationPolicyDescription": "Cancellation Policy: 2 Day Before Arrival: 1.00 Night, Early Departure: 1.00 Night, NoShow: 1.00 Night",
279 - "cancellationPolicy": {
280 - "noShowChargeValue": 1.0,
281 - "noShowChargeValueType": "Night",
282 - "earlyDepartureChargeValue": 1.0,
283 - "earlyDepartureChargeValueType": "Night",
284 - "conditions": [
285 - {
286 - "timeunits": 2,
287 - "timeunitType": "Day",
288 - "timeOffsetTypeName": "Before Arrival",
289 - "chargeValue": 1.0,
290 - "chargeValueType": "Night"
291 - }
292 - ]
293 - }
294 - },
295 - "flight": {
296 - "id": "1d8793e6-346e-4b5c-933f-3d8637684d7e",
297 - "departureDate": "2024-05-25T00:00:00.000",
298 - "returnDate": "2024-06-01T00:00:00.000",
299 - "departureTicketsLeft": 48,
300 - "returnTicketsLeft": 33,
301 - "departureAvailabilityType": "FreeSale",
302 - "returnAvailabilityType": "FreeSale",
303 - "isTwoWay": true,
304 - "sameBaggageForAll": false,
305 - "totalBaggage": false,
306 - "isBlock": true,
307 - "class": "Economy",
308 - "departureSegments": [
309 - {
310 - "airlineCode": "FZ",
311 - "airlineName": "Fly Dubai",
312 - "flightCode": "FZ1722",
313 - "class": "Economy",
314 - "lugageWeight": 20,
315 - "handLugageWeight": 6,
316 - "departureFlightDate": "2024-05-25T03:35:00.000",
317 - "departureCountryName": "Kazakhstan",
318 - "departureCityName": "Almaty",
319 - "departureAirportCode": "ALA",
320 - "departureAirportName": "Almaty Intl Airport",
321 - "departureTerminalCode": "ALA",
322 - "arrivalFlightDate": "2024-05-25T07:10:00.000",
323 - "arrivalCountryName": "United Arab Emirates",
324 - "arrivalCityName": "Dubai",
325 - "arrivalAirportCode": "DXB",
326 - "arrivalAirportName": "Dubai Intl Airport",
327 - "arrivalTerminalCode": "DXB3",
328 - "flightDuration": "5h 35m"
329 - }
330 - ],
331 - "returnSegments": [
332 - {
333 - "airlineCode": "FZ",
334 - "airlineName": "Fly Dubai",
335 - "flightCode": "FZ1721",
336 - "class": "Economy",
337 - "lugageWeight": 20,
338 - "handLugageWeight": 6,
339 - "departureFlightDate": "2024-06-01T21:25:00.000",
340 - "departureCountryName": "United Arab Emirates",
341 - "departureCityName": "Dubai",
342 - "departureAirportCode": "DXB",
343 - "departureAirportName": "Dubai Intl Airport",
344 - "departureTerminalCode": "DXB3",
345 - "arrivalFlightDate": "2024-06-02T02:35:00.000",
346 - "arrivalCountryName": "Kazakhstan",
347 - "arrivalCityName": "Almaty",
348 - "arrivalAirportCode": "ALA",
349 - "arrivalAirportName": "Almaty Intl Airport",
350 - "arrivalTerminalCode": "ALA",
351 - "flightDuration": "3h 10m"
352 - }
353 - ],
354 - "passengers": [
355 - {
356 - "id": "1d8793e6-346e-4b5c-933f-3d8637684d7e-A1",
357 - "isAdult": true,
358 - "selectedForwardBaggageCode": "INCLUDED",
359 - "selectedBackwardBaggageCode": "INCLUDED",
360 - "forwardBaggages": [
361 - {
362 - "baggageCode": "INCLUDED",
363 - "description": "20 Kg Included",
364 - "price": 0.0,
365 - "currency": "USD",
366 - "included": true
367 - }
368 - ],
369 - "backwardBaggages": [
370 - {
371 - "baggageCode": "INCLUDED",
372 - "description": "20 Kg Included",
373 - "price": 0.0,
374 - "currency": "USD",
375 - "included": true
376 - }
377 - ]
378 - },
379 - {
380 - "id": "1d8793e6-346e-4b5c-933f-3d8637684d7e-A2",
381 - "isAdult": true,
382 - "selectedForwardBaggageCode": "INCLUDED",
383 - "selectedBackwardBaggageCode": "INCLUDED",
384 - "forwardBaggages": [
385 - {
386 - "baggageCode": "INCLUDED",
387 - "description": "20 Kg Included",
388 - "price": 0.0,
389 - "currency": "USD",
390 - "included": true
391 - }
392 - ],
393 - "backwardBaggages": [
394 - {
395 - "baggageCode": "INCLUDED",
396 - "description": "20 Kg Included",
397 - "price": 0.0,
398 - "currency": "USD",
399 - "included": true
400 - }
401 - ]
402 - }
403 - ]
404 - },
405 - "extraServices": [],
406 - "insurancePrice": {
407 - "name": "Medical INS (N10000)",
408 - "price": 35.84,
409 - "actualStartDate": "2024-05-25T00:00:00.000",
410 - "actualEndDate": "2024-06-01T00:00:00.000",
411 - "optional": false,
412 - "includedInPackagePrice": true
413 - },
414 - "cacheKey": "bd7e9a28fb744528a2deb043f05e0502602ea56f943a4dc9805321db85d51137:{9}:i:1",
415 - "sortCheckInOut": "25.05.2024-01.06.2024",
416 - "sortAirline": "fly dubai",
417 - "sortHotelName": "citymax sharjah",
418 - "sortDetails": "bb",
419 - "sortPlacement": "standard room 2 adults"
420 - }
421 - ],
422 - "pagingId": "9",
423 - "pageNumber": 1,
424 - "pageCount": 883,
425 - "totalCount": 883,
426 - "error": false
427 -}
428 -{{/code}}
429 -
430 -
431 -=== Schema ===
432 -
433 -{{success}}
434 -SearchTourPackagesResponse{
435 -
436 -|error|boolean
437 -|errorCode|string
438 -nullable: true
439 -|errorDescription|string
440 -nullable: true
441 -|userErrorDescription|string
442 -nullable: true
443 -|packages|[
444 -nullable: trueTourPackage{(((
445 -|cacheKey|string
446 -nullable: true
447 -|id|string
448 -nullable: true
449 -|priceCurrency|string
450 -nullable: true
451 -|totalPrice|number($double)
452 -|agentCommissionPercent|number($double)
453 -|agentCommissionAmount|number($double)
454 -|includedExtrasAmount|number($double)
455 -|priceDifference|number($double)
456 -|hotel|PackageHotel{(((
457 -|hotelPriceId|string
458 -nullable: true
459 -|providerId|integer($int32)
460 -|hotelName|string
461 -nullable: true
462 -|hotelCode|string
463 -nullable: true
464 -|nigths|integer($int32)
465 -|mealPlan|string
466 -nullable: true
467 -|hotelClass|string
468 -nullable: true
469 -|availabilityType|RoomAvailabilityTypeEnumstringEnum:
470 -[ OnRequest, FreeSale, StopSale ]
471 -|availableRoomsCount|integer($int32)
472 -|fewRooms|boolean
473 -|roomCategoryCode|string
474 -nullable: true
475 -|roomCategoryName|string
476 -nullable: true
477 -|placementTypeName|string
478 -nullable: true
479 -|placementDescription|string
480 -nullable: true
481 -|checkInDate|string($date-time)
482 -|checkOutDate|string($date-time)
483 -|adults|integer($int32)
484 -|children|integer($int32)
485 -|districtUID|string($uuid)
486 -nullable: true
487 -|districtName|string
488 -nullable: true
489 -|cityUID|string($uuid)
490 -nullable: true
491 -|cityName|string
492 -nullable: true
493 -|countryCode|string
494 -nullable: true
495 -|countryName|string
496 -nullable: true
497 -|hasAlcohol|boolean
498 -|hasFreeWifi|boolean
499 -|hasMetro|boolean
500 -|hasPool|boolean
501 -|hasMall|boolean
502 -|cancellationPolicyDescription|string
503 -nullable: true
504 -|cancellationPolicy|CancellationPolicyExchange{(((
505 -|cancellationPolicyCode|string
506 -nullable: true
507 -|noShowChargeValue|number($double)
508 -nullable: true
509 -|noShowChargeValueType|string
510 -nullable: true
511 -|earlyDepartureChargeValue|number($double)
512 -nullable: true
513 -|earlyDepartureChargeValueType|string
514 -nullable: true
515 -|conditions|[
516 -nullable: trueCancellationPolicyConditionExchange{(((
517 -|timeunits|integer($int32)
518 -|timeunitType|string
519 -nullable: true
520 -|timeOffsetTypeName|string
521 -nullable: true
522 -|chargeValue|number($double)
523 -nullable: true
524 -|chargeValueType|string
525 -nullable: true
526 -
527 -}]
528 -)))
529 -
530 -}
531 -)))
532 -
533 -}
534 -)))
535 -|flight|PackageFlight{(((
536 -|id|string
537 -nullable: true
538 -|departureDate|string($date-time)
539 -|returnDate|string($date-time)
540 -nullable: true
541 -|departureTicketsLeft|integer($int32)
542 -|returnTicketsLeft|integer($int32)
543 -|departureAvailabilityType|FlightAvailabilityTypestringEnum:
544 -[ OnRequest, FreeSale, FewPlaces, StopSale ]
545 -|returnAvailabilityType|FlightAvailabilityTypestringEnum:
546 -[ OnRequest, FreeSale, FewPlaces, StopSale ]
547 -|isTwoWay|boolean
548 -|departureSegments|[
549 -nullable: trueFlightSegment{(((
550 -|airlineCode|string
551 -nullable: true
552 -|airlineName|string
553 -nullable: true
554 -|flightCode|string
555 -nullable: true
556 -|class|string
557 -nullable: true
558 -|lugageWeight|number($double)
559 -|handLugageWeight|number($double)
560 -|departureFlightDate|string($date-time)
561 -|departureCountryName|string
562 -nullable: true
563 -|departureCityName|string
564 -nullable: true
565 -|departureAirportCode|string
566 -nullable: true
567 -|departureAirportName|string
568 -nullable: true
569 -|departureTerminalCode|string
570 -nullable: true
571 -|arrivalFlightDate|string($date-time)
572 -|arrivalCountryName|string
573 -nullable: true
574 -|arrivalCityName|string
575 -nullable: true
576 -|arrivalAirportCode|string
577 -nullable: true
578 -|arrivalAirportName|string
579 -nullable: true
580 -|arrivalTerminalCode|string
581 -nullable: true
582 -|flightDuration|string
583 -nullable: true
584 -|baggages|[
585 -nullable: trueBaggage{(((
586 -|baggageCode|string
587 -nullable: true
588 -|description|string
589 -nullable: true
590 -|price|number($double)
591 -|currency|string
592 -nullable: true
593 -|included|boolean
594 -
595 -}]
596 -)))
597 -
598 -}]
599 -)))
600 -|returnSegments|[
601 -nullable: trueFlightSegment{(((
602 -|airlineCode|string
603 -nullable: true
604 -|airlineName|string
605 -nullable: true
606 -|flightCode|string
607 -nullable: true
608 -|class|string
609 -nullable: true
610 -|lugageWeight|number($double)
611 -|handLugageWeight|number($double)
612 -|departureFlightDate|string($date-time)
613 -|departureCountryName|string
614 -nullable: true
615 -|departureCityName|string
616 -nullable: true
617 -|departureAirportCode|string
618 -nullable: true
619 -|departureAirportName|string
620 -nullable: true
621 -|departureTerminalCode|string
622 -nullable: true
623 -|arrivalFlightDate|string($date-time)
624 -|arrivalCountryName|string
625 -nullable: true
626 -|arrivalCityName|string
627 -nullable: true
628 -|arrivalAirportCode|string
629 -nullable: true
630 -|arrivalAirportName|string
631 -nullable: true
632 -|arrivalTerminalCode|string
633 -nullable: true
634 -|flightDuration|string
635 -nullable: true
636 -|baggages|[
637 -nullable: trueBaggage{(((
638 -|baggageCode|string
639 -nullable: true
640 -|description|string
641 -nullable: true
642 -|price|number($double)
643 -|currency|string
644 -nullable: true
645 -|included|boolean
646 -
647 -}]
648 -)))
649 -
650 -}]
651 -)))
652 -
653 -}
654 -)))
655 -|extraServices|[
656 -nullable: trueHotelExtraServiceBase{(((
657 -|extraServiceCode|string
658 -nullable: true
659 -|extraServiceTypeCode|string
660 -nullable: true
661 -|isMandatory|integer($int32)
662 -|extraServiceName|string
663 -nullable: true
664 -|minimalServiceAmount|number($double)
665 -|includedPriceCode|string
666 -nullable: true
667 -|prices|[
668 -nullable: trueHotelExtraServicePriceBase{(((
669 -|extraServicePriceCode|string
670 -nullable: true
671 -|displayName|string
672 -nullable: true
673 -|restrictionInfo|string
674 -nullable: true
675 -|additionalInfo|string
676 -nullable: true
677 -|price|number($double)
678 -|extraPrice|number($double)
679 -|currency|string
680 -nullable: true
681 -
682 -}]
683 -)))
684 -
685 -}]
686 -)))
687 -|insurancePrice|InsurancePrice{(((
688 -|name|string
689 -nullable: true
690 -|price|number($double)
691 -|priceSurcarge|number($double)
692 -|actualStartDate|string($date-time)
693 -|actualEndDate|string($date-time)
694 -|optional|boolean
695 -|includedInPackagePrice|boolean
696 -
697 -}
698 -)))
699 -
700 -}]
701 -)))
702 -|pagingId|string
703 -nullable: true
704 -|pageNumber|integer($int64)
705 -|pageCount|integer($int64)
706 -
707 -}
708 -{{/success}}
709 -
710 -
711 -== Definitions ==
712 -
713 -
714 -=== **Request Parameters ** ===
715 -
716 -(% class="table-bordered" %)
717 -|=Key|=Type|=Nullable|=Description
718 -|departureCountryCode|String|No|The ISO 3166-1 alpha-2 code of the departure country. For example, "KZ" for Kazakhstan.
719 -|departureCityUID|String (UUID)|No|The unique identifier of the departure city. This is a UUID, such as "f0ba6324-f337-405c-8cc7-23d62cf664e8".
720 -|arrivalCountryCode|String|No|The ISO 3166-1 alpha-2 code of the arrival country. For example, "AE" for United Arab Emirates.
721 -|adults|Integer|No|The number of adults for the trip. For example, 2 for two adults.
722 -|children|Integer|No|The number of children for the trip. For example, 0 for no children.
723 -|departureDate|String (date-time)|No|The departure date in ISO 8601 format. For example, "2024-05-25T00:00:00" for May 25, 2024.
724 -|returnDate|String (date-time)|No|The return date in ISO 8601 format. For example, "2024-06-01T00:00:00" for June 1, 2024.
725 -|departureAndReturnDaysCount|Integer|No|The total number of days for the departure and return trip. For example, 7 for a week-long trip.
726 -|checkInDate|String (date-time)|No|The check-in date at the hotel in ISO 8601 format. For example, "2024-05-25T00:00:00" for May 25, 2024.
727 -|checkOutDate|String (date-time)|No|The check-out date from the hotel in ISO 8601 format. For example, "2024-06-01T00:00:00" for June 1, 2024.
728 -|checkInAndCheckOutDaysCount|Integer|No|The total number of days for the hotel stay. For example, 7 for a week-long stay.
729 -|directFlightsOnly|Boolean|No|Whether to search for direct flights only. For example, true to only search for direct flights.
730 -|pageRowCount|Integer|No|The number of results to return per page. For example, 1 to return 1 result per page.
731 -|searchCurrency|String|No|The currency in which the search results should be displayed. For example, "USD" for United States Dollar.
732 -
733 -=== ===
734 -
735 -=== **Response Parameters** ===
736 -
737 -(% class="table-bordered" %)
738 -|=Key|=Type|=Description
739 -|packages|Array|An array of travel packages. Each package includes various details about the package.
740 -|packages[].id|String|A unique identifier for the package. This is used to uniquely identify each package.
741 -|packages[].priceCurrency|String|The currency in which the price is denoted. This could be USD, EUR, etc.
742 -|packages[].totalPrice|Number|The total price of the package. This includes all costs associated with the package.
743 -|packages[].agentCommissionPercent|Number|The commission percentage for the agent. This is the percentage of the total price that the agent receives as commission.
744 -|packages[].agentCommissionAmount|Number|The commission amount for the agent. This is the actual amount the agent receives as commission.
745 -|packages[].includedExtrasAmount|Number|The amount for the included extras. This is the cost of any extra services included in the package.
746 -|packages[].priceDifference|Number|The price difference. This could be a discount or a price increase.
747 -|packages[].hotel|Object|An object containing details about the hotel included in the package. This includes information like the hotel name, class, availability, etc.
748 -|packages[].hotel.hotelPriceId|String|The price ID of the hotel. This is used to uniquely identify the price for the hotel.
749 -|packages[].hotel.hotelName|String|The name of the hotel. This is the actual name of the hotel.
750 -|packages[].hotel.hotelCode|String|The code of the hotel. This is a unique code used to identify the hotel.
751 -|packages[].hotel.nights|Number|The number of nights for the stay. This is the duration of the stay at the hotel.
752 -|packages[].hotel.mealPlan|String|The meal plan for the stay. This could be breakfast included, all inclusive, etc.
753 -|packages[].hotel.hotelClass|String|The class of the hotel. This could be 3-star, 4-star, 5-star, etc.
754 -|packages[].hotel.hotelColor|String|The color associated with the hotel. This could be used for categorization or visualization purposes.
755 -|packages[].hotel.availabilityType|String|The availability type of the hotel. This could be available, sold out, etc.
756 -|packages[].hotel.availableRoomsCount|Number|The count of available rooms. This is the number of rooms that are currently available at the hotel.
757 -|packages[].hotel.fewRooms|Boolean|A boolean indicating if there are few rooms left. If true, it means that there are only a few rooms left.
758 -|packages[].hotel.roomCategoryCode|String|The code of the room category. This is a unique code used to identify the room category.
759 -|packages[].hotel.roomCategoryName|String|The name of the room category. This is the actual name of the room category.
760 -|packages[].hotel.placementTypeName|String|The name of the placement type. This could be sea view, garden view, etc.
761 -|packages[].hotel.placementDescription|String|The description of the placement. This provides more details about the placement type.
762 -|packages[].hotel.checkInDate|String|The check-in date. This is the date when the stay at the hotel begins.
763 -|packages[].hotel.checkOutDate|String|The check-out date. This is the date when the stay at the hotel ends.
764 -|packages[].hotel.adults|Number|The number of adults. This is the number of adults that will be staying at the hotel.
765 -|packages[].hotel.children|Number|The number of children. This is the number of children that will be staying at the hotel.
766 -|packages[].hotel.districtUID|String|The UID of the district. This is a unique identifier for the district where the hotel is located.
767 -|packages[].hotel.districtName|String|The name of the district. This is the actual name of the district where the hotel is located.
768 -|packages[].hotel.cityUID|String|The UID of the city. This is a unique identifier for the city where the hotel is located.
769 -|packages[].hotel.cityName|String|The name of the city. This is the actual name of the city where the hotel is located.
770 -|packages[].hotel.countryCode|String|The code of the country. This is a unique code used to identify the country where the hotel is located.
771 -|packages[].hotel.countryName|String|The name of the country. This is the actual name of the country where the hotel is located.
772 -|packages[].hotel.hasAlcohol|Boolean|A boolean indicating if alcohol is available. If true, it means that alcohol is available at the hotel.
773 -|packages[].hotel.hasFreeWifi|Boolean|A boolean indicating if free Wi-Fi is available. If true, it means that free Wi-Fi is available at the hotel.
774 -|packages[].hotel.hasMetro|Boolean|A boolean indicating if metro is available. If true, it means that there is a metro station near the hotel.
775 -|packages[].hotel.hasPool|Boolean|A boolean indicating if a pool is available. If true, it means that the hotel has a pool.
776 -|packages[].hotel.hasMall|Boolean|A boolean indicating if a mall is available. If true, it means that there is a mall near the hotel.
777 -|packages[].hotel.infantMaxAge|Number|The maximum age for an infant. This is the maximum age at which a person is considered an infant.
778 -|packages[].hotel.childMinAge|Number|The minimum age for a child. This is the minimum age at which a person is considered a child.
779 -|packages[].hotel.childMaxAge|Number|The maximum age for a child. This is the maximum age at which a person is considered a child.
780 -|packages[].hotel.teenMinAge|Number|The minimum age for a teen. This is the minimum age at which a person is considered a teen.
781 -|packages[].hotel.teenMaxAge|Number|The maximum age for a teen. This is the maximum age at which a person is considered a teen.
782 -|packages[].hotel.adultMinAge|Number|The minimum age for an adult. This is the minimum age at which a person is considered an adult.
783 -|packages[].hotel.cancellationPolicyDescription|String|The description of the cancellation policy. This provides more details about the cancellation policy of the hotel.
784 -|packages[].hotel.cancellationPolicy|Object|An object containing details about the cancellation policy. This includes information like the cancellation deadline, cancellation fee, etc.
785 -|packages[].flight|Object|An object containing details about the flight included in the package. This includes information like the flight ID, departure date, return date, etc.
786 -|packages[].flight.id|String|The ID of the flight. This is used to uniquely identify the flight.
787 -|packages[].flight.departureDate|String|The departure date of the flight. This is the date when the flight departs.
788 -|packages[].flight.returnDate|String|The return date of the flight. This is the date when the flight returns.
789 -|packages[].flight.departureTicketsLeft|Number|The number of departure tickets left. This is the number of tickets that are still available for the departure flight.
790 -|packages[].flight.returnTicketsLeft|Number|The number of return tickets left. This is the number of tickets that are still available for the return flight.
791 -|packages[].flight.departureAvailabilityType|String|The availability type of the departure flight. This could be available, sold out, etc.
792 -|packages[].flight.returnAvailabilityType|String|The availability type of the return flight. This could be available, sold out, etc.
793 -|packages[].flight.isTwoWay|Boolean|A boolean indicating if the flight is two-way. If true, it means that the flight includes both departure and return.
794 -|packages[].flight.sameBaggageForAll|Boolean|A boolean indicating if the same baggage is for all. If true, it means that the same baggage allowance applies to all passengers.
795 -|packages[].flight.totalBaggage|Boolean|A boolean indicating if total baggage is included. If true, it means that the total baggage allowance is included in the price.
796 -|packages[].flight.isBlock|Boolean|A boolean indicating if the flight is blocked. If true, it means that the flight is currently blocked and cannot be booked.
797 -|packages[].flight.class|String|The class of the flight. This could be economy, business, first class, etc.
798 -|packages[].flight.departureSegments|Array|An array containing details about the departure segments. Each segment includes information like the departure airport, arrival airport, departure time, arrival time, etc.
799 -|packages[].flight.returnSegments|Array|An array containing details about the return segments. Each segment includes information like the departure airport, arrival airport, departure time, arrival time, etc.
800 -|packages[].flight.passengers|Array|An array containing details about the passengers. Each passenger includes information like the passenger type, baggage allowance, etc.
801 -|packages[].extraServices|Array|An array of any extra services included in the package. Each service includes information like the service name, service price, etc.
802 -|packages[].insurancePrice|Object|An object containing details about the insurance price included in the package. This includes information like the insurance type, insurance price, etc.
803 -|packages[].cacheKey|String|The cache key. This is used to cache the package details for faster retrieval.
804 -|packages[].sortCheckInOut|String|The check-in and check-out dates for sorting. This is used to sort the packages based on the check-in and check-out dates.
805 -|packages[].sortAirline|String|The airline for sorting. This is used to sort the packages based on the airline.
806 -|packages[].sortHotelName|String|The hotel name for sorting. This is used to sort the packages based on the hotel name.
807 -|packages[].sortDetails|String|The details for sorting. This is used to sort the packages based on various details.
808 -|packages[].sortPlacement|String|The placement for sorting. This is used to sort the packages based on the placement.
809 -|pagingId|String|An identifier for the page. This is used to uniquely identify each page of results.
810 -|pageNumber|Number|The current page number. This is the number of the current page of results.
811 -|pageCount|Number|The total number of pages. This is the total number of pages of results.
812 -|totalCount|Number|The total count of packages. This is the total number of packages in all pages of results.
813 -|error|Boolean|A boolean indicating whether there was an error. If true, it means that there was an error in retrieving the packages.
814 -
815 -==== first request ====
816 -
817 -{{code language="Json"}}
818 - {
819 - "pagingId": "",
820 - "pageNumber": 1,
821 - "pageRowCount":10
822 - }
823 -{{/code}}
824 -
825 -
826 -==== Request with caching ====
827 -
828 -as we receive response, in the end we can see pagingId- number, chich we can use for caching, and then just switch pagenumbers. for cleaning cache, it's important to make new request without pagingID
829 -
830 -{{code language="Json"}}
831 - {
832 - "pagingId": "80",
833 - "pageNumber": 1,
834 - "pageRowCount":10
835 - }
836 -{{/code}}
837 -
838 -
839 -=== search parameter options ===
840 -
841 -in the request body it's available to filter search results with parameters. parameter examples:
842 -
843 -{{code language="Json"}}
844 - { "totalPriceFrom": 500,
845 - "totalPriceTo": 10000,
846 - "hotelTypes": [
847 - "CityHotel",
848 - "BeachHotel",
849 - "SecondLineBeach"
850 - ],
851 - "hotelClasses": [
852 - "1",
853 - "2",
854 - "3",
855 - "4",
856 - "5",
857 - "6"
858 - ],
859 - "hotelServices": [
860 - "HasAlcohol",
861 - "HasFreeWifi",
862 - "HasMetro",
863 - "HasPool",
864 - "HasMall"
865 - ],
866 - "mealPlans": [
867 - "RO",
868 - "BB",
869 - "HB",
870 - "FB",
871 - "AL"
872 - ]
873 -}
874 -{{/code}}
875 -
876 -
877 -
878 -== Important ==
879 -
880 -{{error}}
881 -It's Important to in every other request header, put Auth token
882 -
883 -**Key **- Authorization
884 -
885 -**Value **- Bearer Token what is given in this response.
886 -
887 -
888 -**also note in headers that:**
889 -
890 -Content-Type - application/json
891 -
892 -**Key - **X-nugios-timezone
893 -
894 -**Value **- 240
895 -{{/error}}
32 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.