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

From version 6.1
edited by Giorgi Mdivnishvili
on 2024/04/11 10:33
Change comment: There is no comment for this version
To version 2.1
edited by Giorgi Mdivnishvili
on 2024/04/11 09:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -25,24 +25,123 @@
25 25  )))
26 26  
27 27  
28 +== Request Body ==
29 +
30 +{{code language="Json"}}
31 +{
32 + "departureCountryCode": "string",
33 + "departureCityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
34 + "arrivalCountryCode": "string",
35 + "arrivalLocations": [
36 + {
37 + "type": "string",
38 + "parent": "string",
39 + "label": "string",
40 + "subLabel": "string",
41 + "value": "string",
42 + "tag": "string"
43 + }
44 + ],
45 + "checkInDate": "2023-12-14",
46 + "checkInDateTo": "2023-12-14",
47 + "checkOutDate": "2023-12-14",
48 + "stayDays": 0,
49 + "stayDaysTo": 0,
50 + "departureDate": "2023-12-14",
51 + "returnDate": "2023-12-14",
52 + "airlineCode": "string",
53 + "ticketType": "string",
54 + "directFlightsOnly": true,
55 + "longConnectTime": true,
56 + "adults": 0,
57 + "children": 0,
58 + "childrenAges": [
59 + 0
60 + ],
61 + "extendedSearch": true,
62 + "totalPriceFrom": 0,
63 + "totalPriceTo": 0,
64 + "recommended": true,
65 + "popular": true,
66 + "freeSale": true,
67 + "groupByHotel": true,
68 + "hotelCodes": [
69 + "string"
70 + ],
71 + "mealPlans": [
72 + "string"
73 + ],
74 + "hotelClasses": [
75 + "string"
76 + ],
77 + "hotelTypes": [
78 + "CityHotel"
79 + ],
80 + "hotelServices": [
81 + "HasAlcohol"
82 + ],
83 + "pagingId": "string",
84 + "pageNumber": 0,
85 + "pageRowCount": 0
86 +}
87 +{{/code}}
88 +
89 +
28 28  == Request example ==
29 29  
30 30  {{code language="Json"}}
31 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"
94 + "departureCountryCode": "KZ",
95 + "departureCityUID": "f0ba6324-f337-405c-8cc7-23d62cf664e8",
96 + "arrivalCountryCode": "AE",
97 + "arrivalLocations": [
98 + {
99 + "type": "city",
100 + "label": "Dubai",
101 + "value": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
102 + "tag": "Dubai"
103 + }
104 + ],
105 + "checkInDate": "2024-02-05T20:00:00.000Z",
106 + "checkInDateTo": "2024-02-10T20:00:00.000Z",
107 +
108 + "stayDays": 3,
109 + "stayDaysTo": 6,
110 +
111 + "airlineCode": "",
112 + "ticketType": "",
113 + "directFlightsOnly": true,
114 + "longConnectTime": true,
115 + "adults": 1,
116 + "children": 1,
117 + "childrenAges": [
118 + 2
119 + ],
120 + "extendedSearch": false,
121 + "totalPriceFrom": 100,
122 + "totalPriceTo": 15000,
123 + "recommended": true,
124 + "popular": true,
125 + "freeSale": true,
126 + "groupByHotel": true,
127 + "hotelCodes": [
128 +
129 + ],
130 + "mealPlans": [
131 +
132 + ],
133 + "hotelClasses": [
134 +
135 + ],
136 + "hotelTypes": [
137 +
138 + ],
139 + "hotelServices": [
140 +
141 + ],
142 + "pagingId": "",
143 + "pageNumber": 10,
144 + "pageRowCount": 10
46 46  }
47 47  {{/code}}
48 48  
... ... @@ -232,173 +232,129 @@
232 232  {
233 233   "packages": [
234 234   {
235 - "id": "tour:556ce3c2-4062-4181-9970-f41e1aeb3b8b:ce81c22f-7d91-4237-9a2a-43c4c4bcb62f:1d8793e6-346e-4b5c-933f-3d8637684d7e",
334 + "cacheKey": "c705ab31e00e4f9a81c2fd46b2cdbb47f6fd9a6e16984236beb979b31aefafa4:{79}:i:10",
335 + "id": "tour:b01c168e-2ea7-4ea6-b6e0-55abb8cab0a0:da894a1e-88c0-4877-b216-0eeeabe186f3:4298d06f-4344-4a39-ad98-071b7760cf30",
236 236   "priceCurrency": "USD",
237 - "totalPrice": 909.78,
337 + "totalPrice": 1033.53,
238 238   "agentCommissionPercent": 0.0,
239 239   "agentCommissionAmount": 0.0,
240 240   "includedExtrasAmount": 0,
241 241   "priceDifference": 0,
242 242   "hotel": {
243 - "hotelPriceId": "ce81c22f-7d91-4237-9a2a-43c4c4bcb62f",
244 - "hotelName": "CityMax Sharjah",
245 - "hotelCode": "CMAXBSHJNUG",
246 - "nigths": 7,
343 + "hotelPriceId": "da894a1e-88c0-4877-b216-0eeeabe186f3",
344 + "providerId": 13,
345 + "hotelName": "Mercure Dubai Barsha Heights Suites Apartments",
346 + "hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14",
347 + "nigths": 3,
247 247   "mealPlan": "BB",
248 - "hotelClass": "3",
249 - "hotelColor": "#228B22",
349 + "hotelClass": "4",
250 250   "availabilityType": "FreeSale",
251 251   "availableRoomsCount": 0,
252 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",
353 + "roomCategoryCode": "bc5f2224-bd4c-49b2-ab57-01eb7fa80d41",
354 + "roomCategoryName": "1 B/R Suite City View",
355 + "placementTypeName": "DBL",
356 + "checkInDate": "2024-02-09T20:00:00.000Z",
357 + "checkOutDate": "2024-02-12T20:00:00.000Z",
358 + "adults": 1,
359 + "children": 1,
360 + "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
361 + "districtName": "Al Barsha",
362 + "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
363 + "cityName": "Dubai",
265 265   "countryCode": "AE",
266 266   "countryName": "United Arab Emirates",
267 267   "hasAlcohol": false,
268 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",
368 + "hasMetro": true,
369 + "hasPool": true,
370 + "hasMall": false,
371 + "cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
279 279   "cancellationPolicy": {
280 - "noShowChargeValue": 1.0,
281 - "noShowChargeValueType": "Night",
282 - "earlyDepartureChargeValue": 1.0,
283 - "earlyDepartureChargeValueType": "Night",
373 + "noShowChargeValue": 100.0,
374 + "noShowChargeValueType": "%",
375 + "earlyDepartureChargeValue": 100.0,
376 + "earlyDepartureChargeValueType": "%",
284 284   "conditions": [
285 285   {
286 - "timeunits": 2,
379 + "timeunits": 5,
287 287   "timeunitType": "Day",
288 288   "timeOffsetTypeName": "Before Arrival",
289 - "chargeValue": 1.0,
290 - "chargeValueType": "Night"
382 + "chargeValue": 100.0,
383 + "chargeValueType": "%"
291 291   }
292 292   ]
293 293   }
294 294   },
295 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",
389 + "id": "4298d06f-4344-4a39-ad98-071b7760cf30",
390 + "departureDate": "2024-02-09T20:00:00.000Z",
391 + "returnDate": "2024-02-12T20:00:00.000Z",
392 + "departureTicketsLeft": 7,
393 + "returnTicketsLeft": 7,
394 + "departureAvailabilityType": "FewPlaces",
395 + "returnAvailabilityType": "FewPlaces",
303 303   "isTwoWay": true,
304 304   "sameBaggageForAll": false,
305 305   "totalBaggage": false,
306 - "isBlock": true,
307 - "class": "Economy",
308 308   "departureSegments": [
309 309   {
310 - "airlineCode": "FZ",
311 - "airlineName": "Fly Dubai",
312 - "flightCode": "FZ1722",
313 - "class": "Economy",
401 + "airlineCode": "KC",
402 + "airlineName": "Air Astana-",
403 + "flightCode": "KC897",
404 + "class": "econom",
314 314   "lugageWeight": 20,
315 315   "handLugageWeight": 6,
316 - "departureFlightDate": "2024-05-25T03:35:00.000",
407 + "departureFlightDate": "2024-02-09T20:00:00.000Z",
317 317   "departureCountryName": "Kazakhstan",
318 318   "departureCityName": "Almaty",
319 319   "departureAirportCode": "ALA",
320 320   "departureAirportName": "Almaty Intl Airport",
321 321   "departureTerminalCode": "ALA",
322 - "arrivalFlightDate": "2024-05-25T07:10:00.000",
413 + "arrivalFlightDate": "2024-02-09T20:00:00.000Z",
323 323   "arrivalCountryName": "United Arab Emirates",
324 324   "arrivalCityName": "Dubai",
325 325   "arrivalAirportCode": "DXB",
326 326   "arrivalAirportName": "Dubai Intl Airport",
327 - "arrivalTerminalCode": "DXB3",
328 - "flightDuration": "5h 35m"
418 + "arrivalTerminalCode": "DXB1",
419 + "flightDuration": "0h 50m"
329 329   }
330 330   ],
331 331   "returnSegments": [
332 332   {
333 - "airlineCode": "FZ",
334 - "airlineName": "Fly Dubai",
335 - "flightCode": "FZ1721",
336 - "class": "Economy",
424 + "airlineCode": "KC",
425 + "airlineName": "Air Astana-",
426 + "flightCode": "KC900",
427 + "class": "econom",
337 337   "lugageWeight": 20,
338 338   "handLugageWeight": 6,
339 - "departureFlightDate": "2024-06-01T21:25:00.000",
430 + "departureFlightDate": "2024-02-12T20:00:00.000Z",
340 340   "departureCountryName": "United Arab Emirates",
341 341   "departureCityName": "Dubai",
342 342   "departureAirportCode": "DXB",
343 343   "departureAirportName": "Dubai Intl Airport",
344 - "departureTerminalCode": "DXB3",
345 - "arrivalFlightDate": "2024-06-02T02:35:00.000",
435 + "departureTerminalCode": "DXB1",
436 + "arrivalFlightDate": "2024-02-12T20:00:00.000Z",
346 346   "arrivalCountryName": "Kazakhstan",
347 347   "arrivalCityName": "Almaty",
348 348   "arrivalAirportCode": "ALA",
349 349   "arrivalAirportName": "Almaty Intl Airport",
350 350   "arrivalTerminalCode": "ALA",
351 - "flightDuration": "3h 10m"
442 + "flightDuration": "8h 15m"
352 352   }
353 353   ],
354 354   "passengers": [
355 355   {
356 - "id": "1d8793e6-346e-4b5c-933f-3d8637684d7e-A1",
447 + "id": "42768722011000004-A1",
357 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 - ]
449 + "forwardBaggages": [],
450 + "backwardBaggages": []
378 378   },
379 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 - ]
453 + "id": "42768722011000004-C1",
454 + "isAdult": false,
455 + "forwardBaggages": [],
456 + "backwardBaggages": []
402 402   }
403 403   ]
404 404   },
... ... @@ -405,24 +405,19 @@
405 405   "extraServices": [],
406 406   "insurancePrice": {
407 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",
463 + "price": 17.92,
464 + "priceSurcarge": 0.0,
465 + "actualStartDate": "2024-02-09T20:00:00.000Z",
466 + "actualEndDate": "2024-02-12T20:00:00.000Z",
411 411   "optional": false,
412 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"
469 + }
420 420   }
421 421   ],
422 - "pagingId": "9",
423 - "pageNumber": 1,
424 - "pageCount": 883,
425 - "totalCount": 883,
472 + "pagingId": "79",
473 + "pageNumber": 10,
474 + "pageCount": 2452,
475 + "totalCount": 2452,
426 426   "error": false
427 427  }
428 428  {{/code}}
... ... @@ -711,106 +711,113 @@
711 711  == Definitions ==
712 712  
713 713  
714 -=== **Request Parameters ** ===
764 +**Request Parameters **
715 715  
716 -|=Key|=Type|=Nullable|=Description
717 -|departureCountryCode|String|No|The ISO 3166-1 alpha-2 code of the departure country. For example, "KZ" for Kazakhstan.
718 -|departureCityUID|String (UUID)|No|The unique identifier of the departure city. This is a UUID, such as "f0ba6324-f337-405c-8cc7-23d62cf664e8".
719 -|arrivalCountryCode|String|No|The ISO 3166-1 alpha-2 code of the arrival country. For example, "AE" for United Arab Emirates.
720 -|adults|Integer|No|The number of adults for the trip. For example, 2 for two adults.
721 -|children|Integer|No|The number of children for the trip. For example, 0 for no children.
722 -|departureDate|String (date-time)|No|The departure date in ISO 8601 format. For example, "2024-05-25T00:00:00" for May 25, 2024.
723 -|returnDate|String (date-time)|No|The return date in ISO 8601 format. For example, "2024-06-01T00:00:00" for June 1, 2024.
724 -|departureAndReturnDaysCount|Integer|No|The total number of days for the departure and return trip. For example, 7 for a week-long trip.
725 -|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.
726 -|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.
727 -|checkInAndCheckOutDaysCount|Integer|No|The total number of days for the hotel stay. For example, 7 for a week-long stay.
728 -|directFlightsOnly|Boolean|No|Whether to search for direct flights only. For example, true to only search for direct flights.
729 -|pageRowCount|Integer|No|The number of results to return per page. For example, 1 to return 1 result per page.
730 -|searchCurrency|String|No|The currency in which the search results should be displayed. For example, "USD" for United States Dollar.
766 +(% class="table-bordered" %)
767 +|=Field|=Type|=Description
768 +|departureCountryCode|string|The ISO 3166-1 alpha-2 country code for the departure country. For example, "KZ" for Kazakhstan.
769 +|departureCityUID|string|The unique identifier for the departure city.
770 +|arrivalCountryCode|string|The ISO 3166-1 alpha-2 country code for the arrival country. For example, "AE" for United Arab Emirates.
771 +|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.
772 +|checkInDate|string|The check-in date in ISO 8601 format.
773 +|checkInDateTo|string|The latest possible check-in date in ISO 8601 format.
774 +|stayDays|integer|The minimum number of days to stay.
775 +|stayDaysTo|integer|The maximum number of days to stay.
776 +|airlineCode|string|The code of the airline. This field can be empty.
777 +|ticketType|string|The type of the ticket. This field can be empty.
778 +|directFlightsOnly|boolean|Indicates whether to search for direct flights only.
779 +|longConnectTime|boolean|Indicates whether to include flights with long connection times.
780 +|adults|integer|The number of adults.
781 +|children|integer|The number of children.
782 +|childrenAges|array|An array of integers, each representing the age of a child.
783 +|extendedSearch|boolean|Indicates whether to perform an extended search.
784 +|totalPriceFrom|float|The minimum total price.
785 +|totalPriceTo|float|The maximum total price.
786 +|recommended|boolean|Indicates whether to include recommended packages.
787 +|popular|boolean|Indicates whether to include popular packages.
788 +|freeSale|boolean|Indicates whether to include free sale packages.
789 +|groupByHotel|boolean|Indicates whether to group the results by hotel.
790 +|hotelCodes|array|An array of strings, each representing a hotel code. This field can be empty.
791 +|mealPlans|array|An array of meal plans. This field can be empty.
792 +|hotelClasses|array|An array of hotel classes. This field can be empty.
793 +|hotelTypes|array|An array of hotel types. This field can be empty.
794 +|hotelServices|array|An array of hotel services. This field can be empty.
795 +|pagingId|string|The paging ID for paginated results. This field can be empty.
796 +|pageNumber|integer|The page number for paginated results.
797 +|pageRowCount|integer|The number of rows per page for paginated results.
731 731  
732 -=== ===
799 +(% class="wikigeneratedid" %)
800 +**Response Parameters**
733 733  
734 -=== **Response Parameters** ===
802 +(% class="table-bordered" %)
803 +|=Field|=Type|=Description
804 +|packages|array|An array of packages available. Each package contains:
805 +|cacheKey|string|A unique identifier for the cache.
806 +|id|string|A unique identifier for the package.
807 +|priceCurrency|string|The currency in which the price is displayed.
808 +|totalPrice|float|The total price of the package.
809 +|agentCommissionPercent|float|The commission percentage for the agent.
810 +|agentCommissionAmount|float|The commission amount for the agent.
811 +|includedExtrasAmount|integer|The amount of extras included in the package.
812 +|priceDifference|integer|The difference in price from the original price.
813 +|hotel|object|An object containing details about the hotel.
814 +|hotelPriceId|string|A unique identifier for the hotel price.
815 +|providerId|integer|A unique identifier for the provider.
816 +|hotelName|string|The name of the hotel.
817 +|hotelCode|string|A unique code for the hotel.
818 +|nigths|integer|The number of nights for the stay.
819 +|mealPlan|string|The meal plan for the stay.
820 +|hotelClass|string|The class or rating of the hotel.
821 +|availabilityType|string|The availability type of the hotel.
822 +|availableRoomsCount|integer|The number of available rooms in the hotel.
823 +|fewRooms|boolean|Indicates whether there are few rooms left.
824 +|roomCategoryCode|string|A unique code for the room category.
825 +|roomCategoryName|string|The name of the room category.
826 +|placementTypeName|string|The name of the placement type.
827 +|checkInDate|string|The check-in date in ISO 8601 format.
828 +|checkOutDate|string|The check-out date in ISO 8601 format.
829 +|adults|integer|The number of adults for the stay.
830 +|children|integer|The number of children for the stay.
831 +|districtUID|string|A unique identifier for the district.
832 +|districtName|string|The name of the district.
833 +|cityUID|string|A unique identifier for the city.
834 +|cityName|string|The name of the city.
835 +|countryCode|string|The ISO 3166-1 alpha-2 country code.
836 +|countryName|string|The name of the country.
837 +|hasAlcohol|boolean|Indicates whether the hotel serves alcohol.
838 +|hasFreeWifi|boolean|Indicates whether the hotel offers free Wi-Fi.
839 +|hasMetro|boolean|Indicates whether the hotel is near a metro station.
840 +|hasPool|boolean|Indicates whether the hotel has a pool.
841 +|hasMall|boolean|Indicates whether the hotel is near a shopping mall.
842 +|cancellationPolicyDescription|string|The description of the cancellation policy.
843 +|cancellationPolicy|object|An object containing details about the cancellation policy.
844 +|flight|object|An object containing details about the flight.
845 +|id|string|A unique identifier for the flight.
846 +|departureDate|string|The departure date in ISO 8601 format.
847 +|returnDate|string|The return date in ISO 8601 format.
848 +|departureTicketsLeft|integer|The number of departure tickets left.
849 +|returnTicketsLeft|integer|The number of return tickets left.
850 +|departureAvailabilityType|string|The availability type of the departure flight.
851 +|returnAvailabilityType|string|The availability type of the return flight.
852 +|isTwoWay|boolean|Indicates whether the flight is two-way.
853 +|sameBaggageForAll|boolean|Indicates whether the same baggage is applicable for all passengers.
854 +|totalBaggage|boolean|Indicates whether total baggage is included.
855 +|departureSegments|array|An array of objects, each representing a departure segment.
856 +|returnSegments|array|An array of objects, each representing a return segment.
857 +|passengers|array|An array of objects, each representing a passenger.
858 +|extraServices|array|An array of extra services included in the package.
859 +|insurancePrice|object|An object containing details about the insurance price.
860 +|pagingId|string|The paging ID for paginated results.
861 +|pageNumber|integer|The page number for paginated results.
862 +|pageCount|integer|The total number of pages.
863 +|totalCount|integer|The total count of packages.
864 +|error|boolean|Indicates whether there was an error.
735 735  
736 -|=Key|=Type|=Description
737 -|packages|Array|An array of travel packages. Each package includes various details about the package.
738 -|packages[].id|String|A unique identifier for the package. This is used to uniquely identify each package.
739 -|packages[].priceCurrency|String|The currency in which the price is denoted. This could be USD, EUR, etc.
740 -|packages[].totalPrice|Number|The total price of the package. This includes all costs associated with the package.
741 -|packages[].agentCommissionPercent|Number|The commission percentage for the agent. This is the percentage of the total price that the agent receives as commission.
742 -|packages[].agentCommissionAmount|Number|The commission amount for the agent. This is the actual amount the agent receives as commission.
743 -|packages[].includedExtrasAmount|Number|The amount for the included extras. This is the cost of any extra services included in the package.
744 -|packages[].priceDifference|Number|The price difference. This could be a discount or a price increase.
745 -|packages[].hotel|Object|An object containing details about the hotel included in the package. This includes information like the hotel name, class, availability, etc.
746 -|packages[].hotel.hotelPriceId|String|The price ID of the hotel. This is used to uniquely identify the price for the hotel.
747 -|packages[].hotel.hotelName|String|The name of the hotel. This is the actual name of the hotel.
748 -|packages[].hotel.hotelCode|String|The code of the hotel. This is a unique code used to identify the hotel.
749 -|packages[].hotel.nights|Number|The number of nights for the stay. This is the duration of the stay at the hotel.
750 -|packages[].hotel.mealPlan|String|The meal plan for the stay. This could be breakfast included, all inclusive, etc.
751 -|packages[].hotel.hotelClass|String|The class of the hotel. This could be 3-star, 4-star, 5-star, etc.
752 -|packages[].hotel.hotelColor|String|The color associated with the hotel. This could be used for categorization or visualization purposes.
753 -|packages[].hotel.availabilityType|String|The availability type of the hotel. This could be available, sold out, etc.
754 -|packages[].hotel.availableRoomsCount|Number|The count of available rooms. This is the number of rooms that are currently available at the hotel.
755 -|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.
756 -|packages[].hotel.roomCategoryCode|String|The code of the room category. This is a unique code used to identify the room category.
757 -|packages[].hotel.roomCategoryName|String|The name of the room category. This is the actual name of the room category.
758 -|packages[].hotel.placementTypeName|String|The name of the placement type. This could be sea view, garden view, etc.
759 -|packages[].hotel.placementDescription|String|The description of the placement. This provides more details about the placement type.
760 -|packages[].hotel.checkInDate|String|The check-in date. This is the date when the stay at the hotel begins.
761 -|packages[].hotel.checkOutDate|String|The check-out date. This is the date when the stay at the hotel ends.
762 -|packages[].hotel.adults|Number|The number of adults. This is the number of adults that will be staying at the hotel.
763 -|packages[].hotel.children|Number|The number of children. This is the number of children that will be staying at the hotel.
764 -|packages[].hotel.districtUID|String|The UID of the district. This is a unique identifier for the district where the hotel is located.
765 -|packages[].hotel.districtName|String|The name of the district. This is the actual name of the district where the hotel is located.
766 -|packages[].hotel.cityUID|String|The UID of the city. This is a unique identifier for the city where the hotel is located.
767 -|packages[].hotel.cityName|String|The name of the city. This is the actual name of the city where the hotel is located.
768 -|packages[].hotel.countryCode|String|The code of the country. This is a unique code used to identify the country where the hotel is located.
769 -|packages[].hotel.countryName|String|The name of the country. This is the actual name of the country where the hotel is located.
770 -|packages[].hotel.hasAlcohol|Boolean|A boolean indicating if alcohol is available. If true, it means that alcohol is available at the hotel.
771 -|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.
772 -|packages[].hotel.hasMetro|Boolean|A boolean indicating if metro is available. If true, it means that there is a metro station near the hotel.
773 -|packages[].hotel.hasPool|Boolean|A boolean indicating if a pool is available. If true, it means that the hotel has a pool.
774 -|packages[].hotel.hasMall|Boolean|A boolean indicating if a mall is available. If true, it means that there is a mall near the hotel.
775 -|packages[].hotel.infantMaxAge|Number|The maximum age for an infant. This is the maximum age at which a person is considered an infant.
776 -|packages[].hotel.childMinAge|Number|The minimum age for a child. This is the minimum age at which a person is considered a child.
777 -|packages[].hotel.childMaxAge|Number|The maximum age for a child. This is the maximum age at which a person is considered a child.
778 -|packages[].hotel.teenMinAge|Number|The minimum age for a teen. This is the minimum age at which a person is considered a teen.
779 -|packages[].hotel.teenMaxAge|Number|The maximum age for a teen. This is the maximum age at which a person is considered a teen.
780 -|packages[].hotel.adultMinAge|Number|The minimum age for an adult. This is the minimum age at which a person is considered an adult.
781 -|packages[].hotel.cancellationPolicyDescription|String|The description of the cancellation policy. This provides more details about the cancellation policy of the hotel.
782 -|packages[].hotel.cancellationPolicy|Object|An object containing details about the cancellation policy. This includes information like the cancellation deadline, cancellation fee, etc.
783 -|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.
784 -|packages[].flight.id|String|The ID of the flight. This is used to uniquely identify the flight.
785 -|packages[].flight.departureDate|String|The departure date of the flight. This is the date when the flight departs.
786 -|packages[].flight.returnDate|String|The return date of the flight. This is the date when the flight returns.
787 -|packages[].flight.departureTicketsLeft|Number|The number of departure tickets left. This is the number of tickets that are still available for the departure flight.
788 -|packages[].flight.returnTicketsLeft|Number|The number of return tickets left. This is the number of tickets that are still available for the return flight.
789 -|packages[].flight.departureAvailabilityType|String|The availability type of the departure flight. This could be available, sold out, etc.
790 -|packages[].flight.returnAvailabilityType|String|The availability type of the return flight. This could be available, sold out, etc.
791 -|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.
792 -|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.
793 -|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.
794 -|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.
795 -|packages[].flight.class|String|The class of the flight. This could be economy, business, first class, etc.
796 -|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.
797 -|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.
798 -|packages[].flight.passengers|Array|An array containing details about the passengers. Each passenger includes information like the passenger type, baggage allowance, etc.
799 -|packages[].extraServices|Array|An array of any extra services included in the package. Each service includes information like the service name, service price, etc.
800 -|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.
801 -|packages[].cacheKey|String|The cache key. This is used to cache the package details for faster retrieval.
802 -|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.
803 -|packages[].sortAirline|String|The airline for sorting. This is used to sort the packages based on the airline.
804 -|packages[].sortHotelName|String|The hotel name for sorting. This is used to sort the packages based on the hotel name.
805 -|packages[].sortDetails|String|The details for sorting. This is used to sort the packages based on various details.
806 -|packages[].sortPlacement|String|The placement for sorting. This is used to sort the packages based on the placement.
807 -|pagingId|String|An identifier for the page. This is used to uniquely identify each page of results.
808 -|pageNumber|Number|The current page number. This is the number of the current page of results.
809 -|pageCount|Number|The total number of pages. This is the total number of pages of results.
810 -|totalCount|Number|The total count of packages. This is the total number of packages in all pages of results.
811 -|error|Boolean|A boolean indicating whether there was an error. If true, it means that there was an error in retrieving the packages.
866 +=== Paging and Caching ===
812 812  
868 +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:
813 813  
870 +
814 814  ==== first request ====
815 815  
816 816  {{code language="Json"}}