Skip to Content
Last modified by Giorgi Mdivnishvili on 2024/07/11 12:45
From version 4.1
edited by Giorgi Mdivnishvili
on 2024/04/11 09:35
Change comment: There is no comment for this version
To version 10.1
edited by Giorgi Mdivnishvili
on 2024/04/11 11:32
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -46,7 +46,35 @@
46 46  }
47 47  {{/code}}
48 48  
49 +== Request example for 2Adults 2Child ==
49 49  
51 +{{code language="Json"}}
52 +{
53 + "departureCountryCode": "KZ",
54 + "departureCityUID": "f0ba6324-f337-405c-8cc7-23d62cf664e8",
55 + "arrivalCountryCode": "AE",
56 + "adults": 2,
57 + "children": 2,
58 + "childrenAges": [
59 + 4,
60 + 8
61 + ],
62 + "departureDate": "2024-05-26T00:00:00",
63 + "returnDate": "2024-06-02T00:00:00",
64 + "departureAndReturnDaysCount": 7,
65 + "checkInDate": "2024-05-26T00:00:00",
66 + "checkOutDate": "2024-06-02T00:00:00",
67 + "checkInAndCheckOutDaysCount": 7,
68 + "directFlightsOnly": true,
69 + "searchCurrency": "USD",
70 +
71 + "pagingId": "",
72 + "pageNumber": 1,
73 + "pageRowCount":5
74 +}
75 +{{/code}}
76 +
77 +
50 50  == Response Body ==
51 51  
52 52  {{code language="json"}}
... ... @@ -711,113 +711,109 @@
711 711  == Definitions ==
712 712  
713 713  
714 -**Request Parameters **
742 +=== **Request Parameters ** ===
715 715  
716 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.
745 +|=Key|=Type|=Nullable|=Description
746 +|departureCountryCode|String|No|The ISO 3166-1 alpha-2 code of the departure country. For example, "KZ" for Kazakhstan.
747 +|departureCityUID|String (UUID)|No|The unique identifier of the departure city. This is a UUID, such as "f0ba6324-f337-405c-8cc7-23d62cf664e8".
748 +|arrivalCountryCode|String|No|The ISO 3166-1 alpha-2 code of the arrival country. For example, "AE" for United Arab Emirates.
749 +|adults|Integer|No|The number of adults for the trip. For example, 2 for two adults.
750 +|children|Integer|No|The number of children for the trip. For example, 0 for no children.
751 +|departureDate|String (date-time)|No|The departure date in ISO 8601 format. For example, "2024-05-25T00:00:00" for May 25, 2024.
752 +|returnDate|String (date-time)|No|The return date in ISO 8601 format. For example, "2024-06-01T00:00:00" for June 1, 2024.
753 +|departureAndReturnDaysCount|Integer|No|The total number of days for the departure and return trip. For example, 7 for a week-long trip.
754 +|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.
755 +|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.
756 +|checkInAndCheckOutDaysCount|Integer|No|The total number of days for the hotel stay. For example, 7 for a week-long stay.
757 +|directFlightsOnly|Boolean|No|Whether to search for direct flights only. For example, true to only search for direct flights.
758 +|pageRowCount|Integer|No|The number of results to return per page. For example, 1 to return 1 result per page.
759 +|searchCurrency|String|No|The currency in which the search results should be displayed. For example, "USD" for United States Dollar.
748 748  
749 -(% class="wikigeneratedid" %)
750 -**Response Parameters**
761 +=== ===
751 751  
763 +=== **Response Parameters** ===
764 +
752 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.
766 +|=Key|=Type|=Description
767 +|packages|Array|An array of travel packages. Each package includes various details about the package.
768 +|packages[].id|String|A unique identifier for the package. This is used to uniquely identify each package.
769 +|packages[].priceCurrency|String|The currency in which the price is denoted. This could be USD, EUR, etc.
770 +|packages[].totalPrice|Number|The total price of the package. This includes all costs associated with the package.
771 +|packages[].agentCommissionPercent|Number|The commission percentage for the agent. This is the percentage of the total price that the agent receives as commission.
772 +|packages[].agentCommissionAmount|Number|The commission amount for the agent. This is the actual amount the agent receives as commission.
773 +|packages[].includedExtrasAmount|Number|The amount for the included extras. This is the cost of any extra services included in the package.
774 +|packages[].priceDifference|Number|The price difference. This could be a discount or a price increase.
775 +|packages[].hotel|Object|An object containing details about the hotel included in the package. This includes information like the hotel name, class, availability, etc.
776 +|packages[].hotel.hotelPriceId|String|The price ID of the hotel. This is used to uniquely identify the price for the hotel.
777 +|packages[].hotel.hotelName|String|The name of the hotel. This is the actual name of the hotel.
778 +|packages[].hotel.hotelCode|String|The code of the hotel. This is a unique code used to identify the hotel.
779 +|packages[].hotel.nights|Number|The number of nights for the stay. This is the duration of the stay at the hotel.
780 +|packages[].hotel.mealPlan|String|The meal plan for the stay. This could be breakfast included, all inclusive, etc.
781 +|packages[].hotel.hotelClass|String|The class of the hotel. This could be 3-star, 4-star, 5-star, etc.
782 +|packages[].hotel.hotelColor|String|The color associated with the hotel. This could be used for categorization or visualization purposes.
783 +|packages[].hotel.availabilityType|String|The availability type of the hotel. This could be available, sold out, etc.
784 +|packages[].hotel.availableRoomsCount|Number|The count of available rooms. This is the number of rooms that are currently available at the hotel.
785 +|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.
786 +|packages[].hotel.roomCategoryCode|String|The code of the room category. This is a unique code used to identify the room category.
787 +|packages[].hotel.roomCategoryName|String|The name of the room category. This is the actual name of the room category.
788 +|packages[].hotel.placementTypeName|String|The name of the placement type. This could be sea view, garden view, etc.
789 +|packages[].hotel.placementDescription|String|The description of the placement. This provides more details about the placement type.
790 +|packages[].hotel.checkInDate|String|The check-in date. This is the date when the stay at the hotel begins.
791 +|packages[].hotel.checkOutDate|String|The check-out date. This is the date when the stay at the hotel ends.
792 +|packages[].hotel.adults|Number|The number of adults. This is the number of adults that will be staying at the hotel.
793 +|packages[].hotel.children|Number|The number of children. This is the number of children that will be staying at the hotel.
794 +|packages[].hotel.districtUID|String|The UID of the district. This is a unique identifier for the district where the hotel is located.
795 +|packages[].hotel.districtName|String|The name of the district. This is the actual name of the district where the hotel is located.
796 +|packages[].hotel.cityUID|String|The UID of the city. This is a unique identifier for the city where the hotel is located.
797 +|packages[].hotel.cityName|String|The name of the city. This is the actual name of the city where the hotel is located.
798 +|packages[].hotel.countryCode|String|The code of the country. This is a unique code used to identify the country where the hotel is located.
799 +|packages[].hotel.countryName|String|The name of the country. This is the actual name of the country where the hotel is located.
800 +|packages[].hotel.hasAlcohol|Boolean|A boolean indicating if alcohol is available. If true, it means that alcohol is available at the hotel.
801 +|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.
802 +|packages[].hotel.hasMetro|Boolean|A boolean indicating if metro is available. If true, it means that there is a metro station near the hotel.
803 +|packages[].hotel.hasPool|Boolean|A boolean indicating if a pool is available. If true, it means that the hotel has a pool.
804 +|packages[].hotel.hasMall|Boolean|A boolean indicating if a mall is available. If true, it means that there is a mall near the hotel.
805 +|packages[].hotel.infantMaxAge|Number|The maximum age for an infant. This is the maximum age at which a person is considered an infant.
806 +|packages[].hotel.childMinAge|Number|The minimum age for a child. This is the minimum age at which a person is considered a child.
807 +|packages[].hotel.childMaxAge|Number|The maximum age for a child. This is the maximum age at which a person is considered a child.
808 +|packages[].hotel.teenMinAge|Number|The minimum age for a teen. This is the minimum age at which a person is considered a teen.
809 +|packages[].hotel.teenMaxAge|Number|The maximum age for a teen. This is the maximum age at which a person is considered a teen.
810 +|packages[].hotel.adultMinAge|Number|The minimum age for an adult. This is the minimum age at which a person is considered an adult.
811 +|packages[].hotel.cancellationPolicyDescription|String|The description of the cancellation policy. This provides more details about the cancellation policy of the hotel.
812 +|packages[].hotel.cancellationPolicy|Object|An object containing details about the cancellation policy. This includes information like the cancellation deadline, cancellation fee, etc.
813 +|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.
814 +|packages[].flight.id|String|The ID of the flight. This is used to uniquely identify the flight.
815 +|packages[].flight.departureDate|String|The departure date of the flight. This is the date when the flight departs.
816 +|packages[].flight.returnDate|String|The return date of the flight. This is the date when the flight returns.
817 +|packages[].flight.departureTicketsLeft|Number|The number of departure tickets left. This is the number of tickets that are still available for the departure flight.
818 +|packages[].flight.returnTicketsLeft|Number|The number of return tickets left. This is the number of tickets that are still available for the return flight.
819 +|packages[].flight.departureAvailabilityType|String|The availability type of the departure flight. This could be available, sold out, etc.
820 +|packages[].flight.returnAvailabilityType|String|The availability type of the return flight. This could be available, sold out, etc.
821 +|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.
822 +|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.
823 +|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.
824 +|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.
825 +|packages[].flight.class|String|The class of the flight. This could be economy, business, first class, etc.
826 +|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.
827 +|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.
828 +|packages[].flight.passengers|Array|An array containing details about the passengers. Each passenger includes information like the passenger type, baggage allowance, etc.
829 +|packages[].extraServices|Array|An array of any extra services included in the package. Each service includes information like the service name, service price, etc.
830 +|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.
831 +|packages[].cacheKey|String|The cache key. This is used to cache the package details for faster retrieval.
832 +|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.
833 +|packages[].sortAirline|String|The airline for sorting. This is used to sort the packages based on the airline.
834 +|packages[].sortHotelName|String|The hotel name for sorting. This is used to sort the packages based on the hotel name.
835 +|packages[].sortDetails|String|The details for sorting. This is used to sort the packages based on various details.
836 +|packages[].sortPlacement|String|The placement for sorting. This is used to sort the packages based on the placement.
837 +|pagingId|String|An identifier for the page. This is used to uniquely identify each page of results.
838 +|pageNumber|Number|The current page number. This is the number of the current page of results.
839 +|pageCount|Number|The total number of pages. This is the total number of pages of results.
840 +|totalCount|Number|The total count of packages. This is the total number of packages in all pages of results.
841 +|error|Boolean|A boolean indicating whether there was an error. If true, it means that there was an error in retrieving the packages.
815 815  
816 -=== Paging and Caching ===
843 +==== ====
817 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 821  ==== first request ====
822 822  
823 823  {{code language="Json"}}
... ... @@ -828,10 +828,12 @@
828 828   }
829 829  {{/code}}
830 830  
855 +While making first search request, paging id should be empty,  "pageNumber":  and  "pageRowCount":10 means that, in response there will be returned maximum 10 packages per page.
831 831  
857 +
832 832  ==== Request with caching ====
833 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
860 +after receiving response from first search request, in the end we can see pagingId- number, wchich we can use for caching, and (pageinatoin) for switch pagenumbers, and displaying results as we whant. For cleaning cache, it's important to make new request without cllear pagingID, like this  "pagingId": "",
835 835  
836 836  {{code language="Json"}}
837 837   {