Changes for page 1. SearchTourPackages

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

From 11.1 to 12.1 From 20.1 to 21.1

From version 12.1

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

Change comment: There is no comment for this version

To version 20.1

edited by Giorgi Mdivnishvili
on 2024/01/09 12:59

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 @@
--SearchTourPackages
++1. SearchTourPackages

Content

@@ -6,13 +6,15 @@
  = Method Description =
--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.
++Tour package mean, tour with hotel and flight together. Using this method gives data about full package availability with flight and hotel options.
++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:~~/~~/online-api.kazunion.com/api/TourPackages/SearchTourPackages>>https://online-api.kazunion.com/api/TourPackages/SearchTourPackages]]
++[[https:~~/~~/integration.kazunion.com/api/TourPackages/SearchTourPackages>>https://integration.kazunion.com/api/TourPackages/SearchTourPackages]]
  {{/info}}
  == Request Parameters ==
@@ -85,6 +85,65 @@
  {{/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"}}
@@ -264,10 +264,156 @@
  {{/code}}
--=== example ===
++== Response example ==
  {{code language="Json"}}
--X
++{
++    "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
++}
  {{/code}}
@@ -550,4 +550,93 @@
  }
  {{/success}}
--
++
++== Definitions ==
++
++
++=== 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