Version 4.1 by Giorgi Mdivnishvili on 2024/04/11 09:35

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2
3
4 {{toc/}}
5 {{/box}}
6
7 = Method Description =
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.
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.
12
13
14 == Endpoint URL - [POST] ==
15
16 {{info}}
17 [[https:~~/~~/integration.kazunion.com/api/TourPackages/SearchTourPackages>>https://integration.kazunion.com/api/TourPackages/SearchTourPackages]]
18 {{/info}}
19
20 == Request Parameters ==
21
22 (% class="box infomessage" %)
23 (((
24 None 
25 )))
26
27
28 == Request example ==
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}}
48
49
50 == Response Body ==
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}}
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 |=Field|=Type|=Description
718 |departureCountryCode|string|The ISO 3166-1 alpha-2 country code for the departure country. For example, "KZ" for Kazakhstan.
719 |departureCityUID|string|The unique identifier for the departure city.
720 |arrivalCountryCode|string|The ISO 3166-1 alpha-2 country code for the arrival country. For example, "AE" for United Arab Emirates.
721 |arrivalLocations|array|An array of objects, each representing an arrival location. Each object contains: type (string) - The type of the location. This can be "city". label (string) - The name of the location. value (string) - The unique identifier for the location. tag (string) - A tag for the location.
722 |checkInDate|string|The check-in date in ISO 8601 format.
723 |checkInDateTo|string|The latest possible check-in date in ISO 8601 format.
724 |stayDays|integer|The minimum number of days to stay.
725 |stayDaysTo|integer|The maximum number of days to stay.
726 |airlineCode|string|The code of the airline. This field can be empty.
727 |ticketType|string|The type of the ticket. This field can be empty.
728 |directFlightsOnly|boolean|Indicates whether to search for direct flights only.
729 |longConnectTime|boolean|Indicates whether to include flights with long connection times.
730 |adults|integer|The number of adults.
731 |children|integer|The number of children.
732 |childrenAges|array|An array of integers, each representing the age of a child.
733 |extendedSearch|boolean|Indicates whether to perform an extended search.
734 |totalPriceFrom|float|The minimum total price.
735 |totalPriceTo|float|The maximum total price.
736 |recommended|boolean|Indicates whether to include recommended packages.
737 |popular|boolean|Indicates whether to include popular packages.
738 |freeSale|boolean|Indicates whether to include free sale packages.
739 |groupByHotel|boolean|Indicates whether to group the results by hotel.
740 |hotelCodes|array|An array of strings, each representing a hotel code. This field can be empty.
741 |mealPlans|array|An array of meal plans. This field can be empty.
742 |hotelClasses|array|An array of hotel classes. This field can be empty.
743 |hotelTypes|array|An array of hotel types. This field can be empty.
744 |hotelServices|array|An array of hotel services. This field can be empty.
745 |pagingId|string|The paging ID for paginated results. This field can be empty.
746 |pageNumber|integer|The page number for paginated results.
747 |pageRowCount|integer|The number of rows per page for paginated results.
748
749 (% class="wikigeneratedid" %)
750 **Response Parameters**
751
752 (% class="table-bordered" %)
753 |=Field|=Type|=Description
754 |packages|array|An array of packages available. Each package contains:
755 |cacheKey|string|A unique identifier for the cache.
756 |id|string|A unique identifier for the package.
757 |priceCurrency|string|The currency in which the price is displayed.
758 |totalPrice|float|The total price of the package.
759 |agentCommissionPercent|float|The commission percentage for the agent.
760 |agentCommissionAmount|float|The commission amount for the agent.
761 |includedExtrasAmount|integer|The amount of extras included in the package.
762 |priceDifference|integer|The difference in price from the original price.
763 |hotel|object|An object containing details about the hotel.
764 |hotelPriceId|string|A unique identifier for the hotel price.
765 |providerId|integer|A unique identifier for the provider.
766 |hotelName|string|The name of the hotel.
767 |hotelCode|string|A unique code for the hotel.
768 |nigths|integer|The number of nights for the stay.
769 |mealPlan|string|The meal plan for the stay.
770 |hotelClass|string|The class or rating of the hotel.
771 |availabilityType|string|The availability type of the hotel.
772 |availableRoomsCount|integer|The number of available rooms in the hotel.
773 |fewRooms|boolean|Indicates whether there are few rooms left.
774 |roomCategoryCode|string|A unique code for the room category.
775 |roomCategoryName|string|The name of the room category.
776 |placementTypeName|string|The name of the placement type.
777 |checkInDate|string|The check-in date in ISO 8601 format.
778 |checkOutDate|string|The check-out date in ISO 8601 format.
779 |adults|integer|The number of adults for the stay.
780 |children|integer|The number of children for the stay.
781 |districtUID|string|A unique identifier for the district.
782 |districtName|string|The name of the district.
783 |cityUID|string|A unique identifier for the city.
784 |cityName|string|The name of the city.
785 |countryCode|string|The ISO 3166-1 alpha-2 country code.
786 |countryName|string|The name of the country.
787 |hasAlcohol|boolean|Indicates whether the hotel serves alcohol.
788 |hasFreeWifi|boolean|Indicates whether the hotel offers free Wi-Fi.
789 |hasMetro|boolean|Indicates whether the hotel is near a metro station.
790 |hasPool|boolean|Indicates whether the hotel has a pool.
791 |hasMall|boolean|Indicates whether the hotel is near a shopping mall.
792 |cancellationPolicyDescription|string|The description of the cancellation policy.
793 |cancellationPolicy|object|An object containing details about the cancellation policy.
794 |flight|object|An object containing details about the flight.
795 |id|string|A unique identifier for the flight.
796 |departureDate|string|The departure date in ISO 8601 format.
797 |returnDate|string|The return date in ISO 8601 format.
798 |departureTicketsLeft|integer|The number of departure tickets left.
799 |returnTicketsLeft|integer|The number of return tickets left.
800 |departureAvailabilityType|string|The availability type of the departure flight.
801 |returnAvailabilityType|string|The availability type of the return flight.
802 |isTwoWay|boolean|Indicates whether the flight is two-way.
803 |sameBaggageForAll|boolean|Indicates whether the same baggage is applicable for all passengers.
804 |totalBaggage|boolean|Indicates whether total baggage is included.
805 |departureSegments|array|An array of objects, each representing a departure segment.
806 |returnSegments|array|An array of objects, each representing a return segment.
807 |passengers|array|An array of objects, each representing a passenger.
808 |extraServices|array|An array of extra services included in the package.
809 |insurancePrice|object|An object containing details about the insurance price.
810 |pagingId|string|The paging ID for paginated results.
811 |pageNumber|integer|The page number for paginated results.
812 |pageCount|integer|The total number of pages.
813 |totalCount|integer|The total count of packages.
814 |error|boolean|Indicates whether there was an error.
815
816 === Paging and Caching ===
817
818 During the first request, Paging id must be  empty like this  ( "pagingId": "",)  pagenumber is the number of the page, pagerowcount means number of the given result in one page. So in the first request we can search like this:
819
820
821 ==== first request ====
822
823 {{code language="Json"}}
824 {
825 "pagingId": "",
826 "pageNumber": 1,
827 "pageRowCount":10
828 }
829 {{/code}}
830
831
832 ==== Request with caching ====
833
834 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
835
836 {{code language="Json"}}
837 {
838 "pagingId": "80",
839 "pageNumber": 1,
840 "pageRowCount":10
841 }
842 {{/code}}
843
844
845 === search parameter options ===
846
847 in the request body it's available to filter search results with parameters. parameter examples:
848
849 {{code language="Json"}}
850 { "totalPriceFrom": 500,
851 "totalPriceTo": 10000,
852 "hotelTypes": [
853 "CityHotel",
854 "BeachHotel",
855 "SecondLineBeach"
856 ],
857 "hotelClasses": [
858 "1",
859 "2",
860 "3",
861 "4",
862 "5",
863 "6"
864 ],
865 "hotelServices": [
866 "HasAlcohol",
867 "HasFreeWifi",
868 "HasMetro",
869 "HasPool",
870 "HasMall"
871 ],
872 "mealPlans": [
873 "RO",
874 "BB",
875 "HB",
876 "FB",
877 "AL"
878 ]
879 }
880 {{/code}}
881
882
883
884 == Important ==
885
886 {{error}}
887 It's Important to in every other request header, put Auth token
888
889 **Key **- Authorization
890
891 **Value **- Bearer Token what is given in this response.
892
893
894 **also note in headers that:**
895
896 Content-Type - application/json
897
898 **Key - **X-nugios-timezone
899
900 **Value **- 240
901 {{/error}}