Changes for page 1. SearchTourPackages

Last modified by Giorgi Mdivnishvili on 2025/02/12 15:25

From 12.1 to 11.1 From 25.1 to 24.1

From version 24.1

edited by Giorgi Mdivnishvili
on 2024/04/10 10:56

Change comment: There is no comment for this version

To version 12.1

edited by Giorgi Mdivnishvili
on 2023/12/15 16:13

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--1. SearchTourPackages
++SearchTourPackages

Content

@@ -6,15 +6,13 @@
  = Method Description =
--Tour package mean, tour with hotel and flight together. Using this method gives data about full package availability with flight and hotel options.
++The initial method of the integration process is authorization. You will be provided with a test user username and password to generate the access token that you will need to pass in all the following methods.
--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.
--
  == Endpoint URL - [POST] ==
  {{info}}
--[[https:~~/~~/integration.kazunion.com/api/TourPackages/SearchTourPackages>>https://integration.kazunion.com/api/TourPackages/SearchTourPackages]]
++[[https:~~/~~/online-api.kazunion.com/api/TourPackages/SearchTourPackages>>https://online-api.kazunion.com/api/TourPackages/SearchTourPackages]]
  {{/info}}
  == Request Parameters ==
@@ -42,13 +42,13 @@
        "tag": "string"
      }
    ],
--  "checkInDate": "2023-12-14",
--  "checkInDateTo": "2023-12-14",
--  "checkOutDate": "2023-12-14",
++  "checkInDate": "2023-12-14T13:43:54.766Z",
++  "checkInDateTo": "2023-12-14T13:43:54.766Z",
++  "checkOutDate": "2023-12-14T13:43:54.766Z",
    "stayDays": 0,
    "stayDaysTo": 0,
--  "departureDate": "2023-12-14",
--  "returnDate": "2023-12-14",
++  "departureDate": "2023-12-14T13:43:54.766Z",
++  "returnDate": "2023-12-14T13:43:54.766Z",
    "airlineCode": "string",
    "ticketType": "string",
    "directFlightsOnly": true,
@@ -87,65 +87,6 @@
  {{/code}}
--== Request example ==
--
--{{code language="Json"}}
--{
--  "departureCountryCode": "KZ",
--  "departureCityUID": "f0ba6324-f337-405c-8cc7-23d62cf664e8",
--  "arrivalCountryCode": "AE",
--    "arrivalLocations": [
--        {
--            "type": "city",
--            "label": "Dubai",
--            "value": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
--            "tag": "Dubai"
--        }
--    ],
--  "checkInDate": "2024-02-05T20:00:00.000Z",
--  "checkInDateTo": "2024-02-10T20:00:00.000Z",
--
--  "stayDays": 3,
--  "stayDaysTo": 6,
--
--  "airlineCode": "",
--  "ticketType": "",
--  "directFlightsOnly": true,
--  "longConnectTime": true,
--  "adults": 1,
--  "children": 1,
--  "childrenAges": [
--    2
--  ],
--  "extendedSearch": false,
--  "totalPriceFrom": 100,
--  "totalPriceTo": 15000,
--  "recommended": true,
--  "popular": true,
--  "freeSale": true,
--  "groupByHotel": true,
--  "hotelCodes": [
--
--  ],
--  "mealPlans": [
--
--  ],
--  "hotelClasses": [
--
--  ],
--  "hotelTypes": [
--
--  ],
--  "hotelServices": [
--
--  ],
--  "pagingId": "",
--  "pageNumber": 10,
--  "pageRowCount": 10
--}
--{{/code}}
--
--
  == Response Body ==
  {{code language="json"}}
@@ -325,156 +325,10 @@
  {{/code}}
--== Response example ==
++=== example ===
  {{code language="Json"}}
--{
--    "packages": [
--        {
--            "cacheKey": "c705ab31e00e4f9a81c2fd46b2cdbb47f6fd9a6e16984236beb979b31aefafa4:{79}:i:10",
--            "id": "tour:b01c168e-2ea7-4ea6-b6e0-55abb8cab0a0:da894a1e-88c0-4877-b216-0eeeabe186f3:4298d06f-4344-4a39-ad98-071b7760cf30",
--            "priceCurrency": "USD",
--            "totalPrice": 1033.53,
--            "agentCommissionPercent": 0.0,
--            "agentCommissionAmount": 0.0,
--            "includedExtrasAmount": 0,
--            "priceDifference": 0,
--            "hotel": {
--                "hotelPriceId": "da894a1e-88c0-4877-b216-0eeeabe186f3",
--                "providerId": 13,
--                "hotelName": "Mercure Dubai Barsha Heights Suites  Apartments",
--                "hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14",
--                "nigths": 3,
--                "mealPlan": "BB",
--                "hotelClass": "4",
--                "availabilityType": "FreeSale",
--                "availableRoomsCount": 0,
--                "fewRooms": true,
--                "roomCategoryCode": "bc5f2224-bd4c-49b2-ab57-01eb7fa80d41",
--                "roomCategoryName": "1 B/R Suite City View",
--                "placementTypeName": "DBL",
--                "checkInDate": "2024-02-09T20:00:00.000Z",
--                "checkOutDate": "2024-02-12T20:00:00.000Z",
--                "adults": 1,
--                "children": 1,
--                "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
--                "districtName": "Al Barsha",
--                "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
--                "cityName": "Dubai",
--                "countryCode": "AE",
--                "countryName": "United Arab Emirates",
--                "hasAlcohol": false,
--                "hasFreeWifi": true,
--                "hasMetro": true,
--                "hasPool": true,
--                "hasMall": false,
--                "cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
--                "cancellationPolicy": {
--                    "noShowChargeValue": 100.0,
--                    "noShowChargeValueType": "%",
--                    "earlyDepartureChargeValue": 100.0,
--                    "earlyDepartureChargeValueType": "%",
--                    "conditions": [
--                        {
--                            "timeunits": 5,
--                            "timeunitType": "Day",
--                            "timeOffsetTypeName": "Before Arrival",
--                            "chargeValue": 100.0,
--                            "chargeValueType": "%"
--                        }
--                    ]
--                }
--            },
--            "flight": {
--                "id": "4298d06f-4344-4a39-ad98-071b7760cf30",
--                "departureDate": "2024-02-09T20:00:00.000Z",
--                "returnDate": "2024-02-12T20:00:00.000Z",
--                "departureTicketsLeft": 7,
--                "returnTicketsLeft": 7,
--                "departureAvailabilityType": "FewPlaces",
--                "returnAvailabilityType": "FewPlaces",
--                "isTwoWay": true,
--                "sameBaggageForAll": false,
--                "totalBaggage": false,
--                "departureSegments": [
--                    {
--                        "airlineCode": "KC",
--                        "airlineName": "Air Astana-",
--                        "flightCode": "KC897",
--                        "class": "econom",
--                        "lugageWeight": 20,
--                        "handLugageWeight": 6,
--                        "departureFlightDate": "2024-02-09T20:00:00.000Z",
--                        "departureCountryName": "Kazakhstan",
--                        "departureCityName": "Almaty",
--                        "departureAirportCode": "ALA",
--                        "departureAirportName": "Almaty Intl Airport",
--                        "departureTerminalCode": "ALA",
--                        "arrivalFlightDate": "2024-02-09T20:00:00.000Z",
--                        "arrivalCountryName": "United Arab Emirates",
--                        "arrivalCityName": "Dubai",
--                        "arrivalAirportCode": "DXB",
--                        "arrivalAirportName": "Dubai Intl Airport",
--                        "arrivalTerminalCode": "DXB1",
--                        "flightDuration": "0h 50m"
--                    }
--                ],
--                "returnSegments": [
--                    {
--                        "airlineCode": "KC",
--                        "airlineName": "Air Astana-",
--                        "flightCode": "KC900",
--                        "class": "econom",
--                        "lugageWeight": 20,
--                        "handLugageWeight": 6,
--                        "departureFlightDate": "2024-02-12T20:00:00.000Z",
--                        "departureCountryName": "United Arab Emirates",
--                        "departureCityName": "Dubai",
--                        "departureAirportCode": "DXB",
--                        "departureAirportName": "Dubai Intl Airport",
--                        "departureTerminalCode": "DXB1",
--                        "arrivalFlightDate": "2024-02-12T20:00:00.000Z",
--                        "arrivalCountryName": "Kazakhstan",
--                        "arrivalCityName": "Almaty",
--                        "arrivalAirportCode": "ALA",
--                        "arrivalAirportName": "Almaty Intl Airport",
--                        "arrivalTerminalCode": "ALA",
--                        "flightDuration": "8h 15m"
--                    }
--                ],
--                "passengers": [
--                    {
--                        "id": "42768722011000004-A1",
--                        "isAdult": true,
--                        "forwardBaggages": [],
--                        "backwardBaggages": []
--                    },
--                    {
--                        "id": "42768722011000004-C1",
--                        "isAdult": false,
--                        "forwardBaggages": [],
--                        "backwardBaggages": []
--                    }
--                ]
--            },
--            "extraServices": [],
--            "insurancePrice": {
--                "name": "Medical INS (N10000)",
--                "price": 17.92,
--                "priceSurcarge": 0.0,
--                "actualStartDate": "2024-02-09T20:00:00.000Z",
--                "actualEndDate": "2024-02-12T20:00:00.000Z",
--                "optional": false,
--                "includedInPackagePrice": true
--            }
--        }
--    ],
--    "pagingId": "79",
--    "pageNumber": 10,
--    "pageCount": 2452,
--    "totalCount": 2452,
--    "error": false
--}
++X
  {{/code}}
@@ -757,198 +757,4 @@
  }
  {{/success}}
--
--== Definitions ==
--
--Request Parameters
--
--(% class="table-bordered" %)
--|=Field|=Type|=Description
--|departureCountryCode|string|The ISO 3166-1 alpha-2 country code for the departure country. For example, "KZ" for Kazakhstan.
--|departureCityUID|string|The unique identifier for the departure city.
--|arrivalCountryCode|string|The ISO 3166-1 alpha-2 country code for the arrival country. For example, "AE" for United Arab Emirates.
--|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.
--|checkInDate|string|The check-in date in ISO 8601 format.
--|checkInDateTo|string|The latest possible check-in date in ISO 8601 format.
--|stayDays|integer|The minimum number of days to stay.
--|stayDaysTo|integer|The maximum number of days to stay.
--|airlineCode|string|The code of the airline. This field can be empty.
--|ticketType|string|The type of the ticket. This field can be empty.
--|directFlightsOnly|boolean|Indicates whether to search for direct flights only.
--|longConnectTime|boolean|Indicates whether to include flights with long connection times.
--|adults|integer|The number of adults.
--|children|integer|The number of children.
--|childrenAges|array|An array of integers, each representing the age of a child.
--|extendedSearch|boolean|Indicates whether to perform an extended search.
--|totalPriceFrom|float|The minimum total price.
--|totalPriceTo|float|The maximum total price.
--|recommended|boolean|Indicates whether to include recommended packages.
--|popular|boolean|Indicates whether to include popular packages.
--|freeSale|boolean|Indicates whether to include free sale packages.
--|groupByHotel|boolean|Indicates whether to group the results by hotel.
--|hotelCodes|array|An array of strings, each representing a hotel code. This field can be empty.
--|mealPlans|array|An array of meal plans. This field can be empty.
--|hotelClasses|array|An array of hotel classes. This field can be empty.
--|hotelTypes|array|An array of hotel types. This field can be empty.
--|hotelServices|array|An array of hotel services. This field can be empty.
--|pagingId|string|The paging ID for paginated results. This field can be empty.
--|pageNumber|integer|The page number for paginated results.
--|pageRowCount|integer|The number of rows per page for paginated results.
--
--
--(% class="wikigeneratedid" %)
--Response Parameters
--
--
--
--
--(% class="table-bordered" %)
--|=Field|=Type|=Description
--|packages|array|An array of packages available. Each package contains:
--|cacheKey|string|A unique identifier for the cache.
--|id|string|A unique identifier for the package.
--|priceCurrency|string|The currency in which the price is displayed.
--|totalPrice|float|The total price of the package.
--|agentCommissionPercent|float|The commission percentage for the agent.
--|agentCommissionAmount|float|The commission amount for the agent.
--|includedExtrasAmount|integer|The amount of extras included in the package.
--|priceDifference|integer|The difference in price from the original price.
--|hotel|object|An object containing details about the hotel.
--|hotelPriceId|string|A unique identifier for the hotel price.
--|providerId|integer|A unique identifier for the provider.
--|hotelName|string|The name of the hotel.
--|hotelCode|string|A unique code for the hotel.
--|nigths|integer|The number of nights for the stay.
--|mealPlan|string|The meal plan for the stay.
--|hotelClass|string|The class or rating of the hotel.
--|availabilityType|string|The availability type of the hotel.
--|availableRoomsCount|integer|The number of available rooms in the hotel.
--|fewRooms|boolean|Indicates whether there are few rooms left.
--|roomCategoryCode|string|A unique code for the room category.
--|roomCategoryName|string|The name of the room category.
--|placementTypeName|string|The name of the placement type.
--|checkInDate|string|The check-in date in ISO 8601 format.
--|checkOutDate|string|The check-out date in ISO 8601 format.
--|adults|integer|The number of adults for the stay.
--|children|integer|The number of children for the stay.
--|districtUID|string|A unique identifier for the district.
--|districtName|string|The name of the district.
--|cityUID|string|A unique identifier for the city.
--|cityName|string|The name of the city.
--|countryCode|string|The ISO 3166-1 alpha-2 country code.
--|countryName|string|The name of the country.
--|hasAlcohol|boolean|Indicates whether the hotel serves alcohol.
--|hasFreeWifi|boolean|Indicates whether the hotel offers free Wi-Fi.
--|hasMetro|boolean|Indicates whether the hotel is near a metro station.
--|hasPool|boolean|Indicates whether the hotel has a pool.
--|hasMall|boolean|Indicates whether the hotel is near a shopping mall.
--|cancellationPolicyDescription|string|The description of the cancellation policy.
--|cancellationPolicy|object|An object containing details about the cancellation policy.
--|flight|object|An object containing details about the flight.
--|id|string|A unique identifier for the flight.
--|departureDate|string|The departure date in ISO 8601 format.
--|returnDate|string|The return date in ISO 8601 format.
--|departureTicketsLeft|integer|The number of departure tickets left.
--|returnTicketsLeft|integer|The number of return tickets left.
--|departureAvailabilityType|string|The availability type of the departure flight.
--|returnAvailabilityType|string|The availability type of the return flight.
--|isTwoWay|boolean|Indicates whether the flight is two-way.
--|sameBaggageForAll|boolean|Indicates whether the same baggage is applicable for all passengers.
--|totalBaggage|boolean|Indicates whether total baggage is included.
--|departureSegments|array|An array of objects, each representing a departure segment.
--|returnSegments|array|An array of objects, each representing a return segment.
--|passengers|array|An array of objects, each representing a passenger.
--|extraServices|array|An array of extra services included in the package.
--|insurancePrice|object|An object containing details about the insurance price.
--|pagingId|string|The paging ID for paginated results.
--|pageNumber|integer|The page number for paginated results.
--|pageCount|integer|The total number of pages.
--|totalCount|integer|The total count of packages.
--|error|boolean|Indicates whether there was an error.
--
--=== Paging and Caching ===
--
--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:
--
--
--==== first request ====
--
--{{code language="Json"}}
-- {
--  "pagingId": "",
--  "pageNumber": 1,
--  "pageRowCount":10
-- }
--{{/code}}
--
--
--==== Request with caching ====
--
--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
--
--{{code language="Json"}}
-- {
--  "pagingId": "80",
--  "pageNumber": 1,
--  "pageRowCount":10
-- }
--{{/code}}
--
--
--=== search parameter options ===
--
--in the request body it's available to filter search results with parameters. parameter examples:
--
--{{code language="Json"}}
-- { "totalPriceFrom": 500,
--    "totalPriceTo": 10000,
--    "hotelTypes": [
--        "CityHotel",
--        "BeachHotel",
--        "SecondLineBeach"
--    ],
--    "hotelClasses": [
--        "1",
--        "2",
--        "3",
--        "4",
--        "5",
--        "6"
--    ],
--    "hotelServices": [
--        "HasAlcohol",
--        "HasFreeWifi",
--        "HasMetro",
--        "HasPool",
--        "HasMall"
--    ],
--    "mealPlans": [
--        "RO",
--        "BB",
--        "HB",
--        "FB",
--        "AL"
--    ]
--}
--{{/code}}
--
--
--
--== Important ==
--
--{{error}}
--It's Important to in every other request header, put Auth token
--
--**Key **- Authorization
--
--**Value **- Bearer Token what is given in this response.
--
--
--**also note in headers that:**
--
--Content-Type - application/json
--
--**Key - **X-nugios-timezone
--
--**Value **- 240
--{{/error}}
++

Changes for page 1. SearchTourPackages

Summary

Details

Applications

Navigation