Wiki source code of SearchTourPackages
Version 8.1 by Giorgi Mdivnishvili on 2023/12/15 12:20
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
| |
2.1 | 2 | |
| 3 | |||
| |
1.1 | 4 | {{toc/}} |
| 5 | {{/box}} | ||
| 6 | |||
| |
2.1 | 7 | = Method Description = |
| |
1.1 | 8 | |
| |
2.1 | 9 | 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. |
| |
1.1 | 10 | |
| 11 | |||
| |
3.1 | 12 | == Endpoint URL - [POST] == |
| |
1.1 | 13 | |
| |
2.1 | 14 | {{info}} |
| |
8.1 | 15 | {{{https://online-api.kazunion.com/api/TourPackages/SearchTourPackages}}} |
| |
2.1 | 16 | {{/info}} |
| |
1.1 | 17 | |
| 18 | |||
| |
2.1 | 19 | == Request Parameters == |
| |
1.1 | 20 | |
| |
2.1 | 21 | (% class="box infomessage" %) |
| 22 | ((( | ||
| |
3.1 | 23 | None |
| |
2.1 | 24 | ))) |
| |
1.1 | 25 | |
| 26 | |||
| |
2.1 | 27 | == Request Body == |
| |
1.1 | 28 | |
| |
2.1 | 29 | {{code language="Json"}} |
| |
3.1 | 30 | { |
| 31 | "departureCountryCode": "string", | ||
| 32 | "departureCityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 33 | "arrivalCountryCode": "string", | ||
| 34 | "arrivalLocations": [ | ||
| 35 | { | ||
| 36 | "type": "string", | ||
| 37 | "parent": "string", | ||
| 38 | "label": "string", | ||
| 39 | "subLabel": "string", | ||
| 40 | "value": "string", | ||
| 41 | "tag": "string" | ||
| 42 | } | ||
| 43 | ], | ||
| 44 | "checkInDate": "2023-12-14T13:43:54.766Z", | ||
| 45 | "checkInDateTo": "2023-12-14T13:43:54.766Z", | ||
| 46 | "checkOutDate": "2023-12-14T13:43:54.766Z", | ||
| 47 | "stayDays": 0, | ||
| 48 | "stayDaysTo": 0, | ||
| 49 | "departureDate": "2023-12-14T13:43:54.766Z", | ||
| 50 | "returnDate": "2023-12-14T13:43:54.766Z", | ||
| 51 | "airlineCode": "string", | ||
| 52 | "ticketType": "string", | ||
| 53 | "directFlightsOnly": true, | ||
| 54 | "longConnectTime": true, | ||
| 55 | "adults": 0, | ||
| 56 | "children": 0, | ||
| 57 | "childrenAges": [ | ||
| 58 | 0 | ||
| 59 | ], | ||
| 60 | "extendedSearch": true, | ||
| 61 | "totalPriceFrom": 0, | ||
| 62 | "totalPriceTo": 0, | ||
| 63 | "recommended": true, | ||
| 64 | "popular": true, | ||
| 65 | "freeSale": true, | ||
| 66 | "groupByHotel": true, | ||
| 67 | "hotelCodes": [ | ||
| 68 | "string" | ||
| 69 | ], | ||
| 70 | "mealPlans": [ | ||
| 71 | "string" | ||
| 72 | ], | ||
| 73 | "hotelClasses": [ | ||
| 74 | "string" | ||
| 75 | ], | ||
| 76 | "hotelTypes": [ | ||
| 77 | "CityHotel" | ||
| 78 | ], | ||
| 79 | "hotelServices": [ | ||
| 80 | "HasAlcohol" | ||
| 81 | ], | ||
| 82 | "pagingId": "string", | ||
| 83 | "pageNumber": 0, | ||
| 84 | "pageRowCount": 0 | ||
| 85 | } | ||
| |
2.1 | 86 | {{/code}} |
| |
1.1 | 87 | |
| 88 | |||
| |
2.1 | 89 | == Response Body == |
| 90 | |||
| 91 | {{code language="json"}} | ||
| |
3.1 | 92 | { |
| 93 | "error": true, | ||
| 94 | "errorCode": "string", | ||
| 95 | "errorDescription": "string", | ||
| 96 | "userErrorDescription": "string", | ||
| 97 | "packages": [ | ||
| 98 | { | ||
| 99 | "cacheKey": "string", | ||
| 100 | "id": "string", | ||
| 101 | "priceCurrency": "string", | ||
| 102 | "totalPrice": 0, | ||
| 103 | "agentCommissionPercent": 0, | ||
| 104 | "agentCommissionAmount": 0, | ||
| 105 | "includedExtrasAmount": 0, | ||
| 106 | "priceDifference": 0, | ||
| 107 | "hotel": { | ||
| 108 | "hotelPriceId": "string", | ||
| 109 | "providerId": 0, | ||
| 110 | "hotelName": "string", | ||
| 111 | "hotelCode": "string", | ||
| 112 | "nigths": 0, | ||
| 113 | "mealPlan": "string", | ||
| 114 | "hotelClass": "string", | ||
| 115 | "availabilityType": "OnRequest", | ||
| 116 | "availableRoomsCount": 0, | ||
| 117 | "fewRooms": true, | ||
| 118 | "roomCategoryCode": "string", | ||
| 119 | "roomCategoryName": "string", | ||
| 120 | "placementTypeName": "string", | ||
| 121 | "placementDescription": "string", | ||
| 122 | "checkInDate": "2023-12-14T13:47:13.396Z", | ||
| 123 | "checkOutDate": "2023-12-14T13:47:13.396Z", | ||
| 124 | "adults": 0, | ||
| 125 | "children": 0, | ||
| 126 | "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 127 | "districtName": "string", | ||
| 128 | "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 129 | "cityName": "string", | ||
| 130 | "countryCode": "string", | ||
| 131 | "countryName": "string", | ||
| 132 | "hasAlcohol": true, | ||
| 133 | "hasFreeWifi": true, | ||
| 134 | "hasMetro": true, | ||
| 135 | "hasPool": true, | ||
| 136 | "hasMall": true, | ||
| 137 | "cancellationPolicyDescription": "string", | ||
| 138 | "cancellationPolicy": { | ||
| 139 | "cancellationPolicyCode": "string", | ||
| 140 | "noShowChargeValue": 0, | ||
| 141 | "noShowChargeValueType": "string", | ||
| 142 | "earlyDepartureChargeValue": 0, | ||
| 143 | "earlyDepartureChargeValueType": "string", | ||
| 144 | "conditions": [ | ||
| 145 | { | ||
| 146 | "timeunits": 0, | ||
| 147 | "timeunitType": "string", | ||
| 148 | "timeOffsetTypeName": "string", | ||
| 149 | "chargeValue": 0, | ||
| 150 | "chargeValueType": "string" | ||
| 151 | } | ||
| 152 | ] | ||
| 153 | } | ||
| 154 | }, | ||
| 155 | "flight": { | ||
| 156 | "id": "string", | ||
| 157 | "departureDate": "2023-12-14T13:47:13.396Z", | ||
| 158 | "returnDate": "2023-12-14T13:47:13.396Z", | ||
| 159 | "departureTicketsLeft": 0, | ||
| 160 | "returnTicketsLeft": 0, | ||
| 161 | "departureAvailabilityType": "OnRequest", | ||
| 162 | "returnAvailabilityType": "OnRequest", | ||
| 163 | "isTwoWay": true, | ||
| 164 | "departureSegments": [ | ||
| 165 | { | ||
| 166 | "airlineCode": "string", | ||
| 167 | "airlineName": "string", | ||
| 168 | "flightCode": "string", | ||
| 169 | "class": "string", | ||
| 170 | "lugageWeight": 0, | ||
| 171 | "handLugageWeight": 0, | ||
| 172 | "departureFlightDate": "2023-12-14T13:47:13.396Z", | ||
| 173 | "departureCountryName": "string", | ||
| 174 | "departureCityName": "string", | ||
| 175 | "departureAirportCode": "string", | ||
| 176 | "departureAirportName": "string", | ||
| 177 | "departureTerminalCode": "string", | ||
| 178 | "arrivalFlightDate": "2023-12-14T13:47:13.396Z", | ||
| 179 | "arrivalCountryName": "string", | ||
| 180 | "arrivalCityName": "string", | ||
| 181 | "arrivalAirportCode": "string", | ||
| 182 | "arrivalAirportName": "string", | ||
| 183 | "arrivalTerminalCode": "string", | ||
| 184 | "flightDuration": "string", | ||
| 185 | "baggages": [ | ||
| 186 | { | ||
| 187 | "baggageCode": "string", | ||
| 188 | "description": "string", | ||
| 189 | "price": 0, | ||
| 190 | "currency": "string", | ||
| 191 | "included": true | ||
| 192 | } | ||
| 193 | ] | ||
| 194 | } | ||
| 195 | ], | ||
| 196 | "returnSegments": [ | ||
| 197 | { | ||
| 198 | "airlineCode": "string", | ||
| 199 | "airlineName": "string", | ||
| 200 | "flightCode": "string", | ||
| 201 | "class": "string", | ||
| 202 | "lugageWeight": 0, | ||
| 203 | "handLugageWeight": 0, | ||
| 204 | "departureFlightDate": "2023-12-14T13:47:13.396Z", | ||
| 205 | "departureCountryName": "string", | ||
| 206 | "departureCityName": "string", | ||
| 207 | "departureAirportCode": "string", | ||
| 208 | "departureAirportName": "string", | ||
| 209 | "departureTerminalCode": "string", | ||
| 210 | "arrivalFlightDate": "2023-12-14T13:47:13.396Z", | ||
| 211 | "arrivalCountryName": "string", | ||
| 212 | "arrivalCityName": "string", | ||
| 213 | "arrivalAirportCode": "string", | ||
| 214 | "arrivalAirportName": "string", | ||
| 215 | "arrivalTerminalCode": "string", | ||
| 216 | "flightDuration": "string", | ||
| 217 | "baggages": [ | ||
| 218 | { | ||
| 219 | "baggageCode": "string", | ||
| 220 | "description": "string", | ||
| 221 | "price": 0, | ||
| 222 | "currency": "string", | ||
| 223 | "included": true | ||
| 224 | } | ||
| 225 | ] | ||
| 226 | } | ||
| 227 | ] | ||
| 228 | }, | ||
| 229 | "extraServices": [ | ||
| 230 | { | ||
| 231 | "extraServiceCode": "string", | ||
| 232 | "extraServiceTypeCode": "string", | ||
| 233 | "isMandatory": 0, | ||
| 234 | "extraServiceName": "string", | ||
| 235 | "minimalServiceAmount": 0, | ||
| 236 | "includedPriceCode": "string", | ||
| 237 | "prices": [ | ||
| 238 | { | ||
| 239 | "extraServicePriceCode": "string", | ||
| 240 | "displayName": "string", | ||
| 241 | "restrictionInfo": "string", | ||
| 242 | "additionalInfo": "string", | ||
| 243 | "price": 0, | ||
| 244 | "extraPrice": 0, | ||
| 245 | "currency": "string" | ||
| 246 | } | ||
| 247 | ] | ||
| 248 | } | ||
| 249 | ], | ||
| 250 | "insurancePrice": { | ||
| 251 | "name": "string", | ||
| 252 | "price": 0, | ||
| 253 | "priceSurcarge": 0, | ||
| 254 | "actualStartDate": "2023-12-14T13:47:13.396Z", | ||
| 255 | "actualEndDate": "2023-12-14T13:47:13.396Z", | ||
| 256 | "optional": true, | ||
| 257 | "includedInPackagePrice": true | ||
| 258 | } | ||
| 259 | } | ||
| 260 | ], | ||
| 261 | "pagingId": "string", | ||
| 262 | "pageNumber": 0, | ||
| 263 | "pageCount": 0 | ||
| 264 | } | ||
| |
2.1 | 265 | {{/code}} |
| 266 | |||
| 267 | |||
| 268 | === example === | ||
| 269 | |||
| 270 | {{code language="Json"}} | ||
| |
3.1 | 271 | X |
| |
2.1 | 272 | {{/code}} |
| 273 | |||
| 274 | |||
| 275 | === Schema === | ||
| 276 | |||
| 277 | {{code language="none"}} | ||
| |
4.1 | 278 | SearchTourPackagesResponse{ |
| 279 | error boolean | ||
| 280 | errorCode string | ||
| |
2.1 | 281 | nullable: true |
| |
4.1 | 282 | errorDescription string |
| 283 | nullable: true | ||
| 284 | userErrorDescription string | ||
| 285 | nullable: true | ||
| 286 | packages [ | ||
| 287 | nullable: true | ||
| 288 | TourPackage{ | ||
| 289 | cacheKey string | ||
| 290 | nullable: true | ||
| 291 | id string | ||
| 292 | nullable: true | ||
| 293 | priceCurrency string | ||
| 294 | nullable: true | ||
| 295 | totalPrice number($double) | ||
| 296 | agentCommissionPercent number($double) | ||
| 297 | agentCommissionAmount number($double) | ||
| 298 | includedExtrasAmount number($double) | ||
| 299 | priceDifference number($double) | ||
| 300 | hotel PackageHotel{ | ||
| 301 | hotelPriceId string | ||
| 302 | nullable: true | ||
| 303 | providerId integer($int32) | ||
| |
2.1 | 304 | hotelName string |
| 305 | nullable: true | ||
| |
4.1 | 306 | hotelCode string |
| 307 | nullable: true | ||
| 308 | nigths integer($int32) | ||
| 309 | mealPlan string | ||
| 310 | nullable: true | ||
| |
2.1 | 311 | hotelClass string |
| 312 | nullable: true | ||
| |
4.1 | 313 | availabilityType RoomAvailabilityTypeEnum[...] |
| 314 | availableRoomsCount integer($int32) | ||
| 315 | fewRooms boolean | ||
| 316 | roomCategoryCode string | ||
| |
2.1 | 317 | nullable: true |
| |
4.1 | 318 | roomCategoryName string |
| |
2.1 | 319 | nullable: true |
| |
4.1 | 320 | placementTypeName string |
| |
2.1 | 321 | nullable: true |
| |
4.1 | 322 | placementDescription string |
| 323 | nullable: true | ||
| 324 | checkInDate string($date-time) | ||
| 325 | checkOutDate string($date-time) | ||
| 326 | adults integer($int32) | ||
| 327 | children integer($int32) | ||
| |
2.1 | 328 | districtUID string($uuid) |
| 329 | nullable: true | ||
| |
4.1 | 330 | districtName string |
| 331 | nullable: true | ||
| 332 | cityUID string($uuid) | ||
| 333 | nullable: true | ||
| |
2.1 | 334 | cityName string |
| 335 | nullable: true | ||
| |
4.1 | 336 | countryCode string |
| |
2.1 | 337 | nullable: true |
| |
4.1 | 338 | countryName string |
| |
2.1 | 339 | nullable: true |
| 340 | hasAlcohol boolean | ||
| 341 | hasFreeWifi boolean | ||
| 342 | hasMetro boolean | ||
| 343 | hasPool boolean | ||
| 344 | hasMall boolean | ||
| |
4.1 | 345 | cancellationPolicyDescription string |
| 346 | nullable: true | ||
| 347 | cancellationPolicy CancellationPolicyExchange{ | ||
| 348 | cancellationPolicyCode string | ||
| 349 | nullable: true | ||
| 350 | noShowChargeValue number($double) | ||
| 351 | nullable: true | ||
| 352 | noShowChargeValueType string | ||
| 353 | nullable: true | ||
| 354 | earlyDepartureChargeValue number($double) | ||
| 355 | nullable: true | ||
| 356 | earlyDepartureChargeValueType string | ||
| 357 | nullable: true | ||
| 358 | conditions [ | ||
| 359 | nullable: true | ||
| 360 | CancellationPolicyConditionExchange{ | ||
| 361 | timeunits integer($int32) | ||
| 362 | timeunitType string | ||
| 363 | nullable: true | ||
| 364 | timeOffsetTypeName string | ||
| 365 | nullable: true | ||
| 366 | chargeValue number($double) | ||
| 367 | nullable: true | ||
| 368 | chargeValueType string | ||
| 369 | nullable: true | ||
| |
2.1 | 370 | }] |
| |
4.1 | 371 | } |
| 372 | } | ||
| 373 | flight PackageFlight{ | ||
| 374 | id string | ||
| 375 | nullable: true | ||
| 376 | departureDate string($date-time) | ||
| 377 | returnDate string($date-time) | ||
| 378 | nullable: true | ||
| 379 | departureTicketsLeft integer($int32) | ||
| 380 | returnTicketsLeft integer($int32) | ||
| 381 | departureAvailabilityType FlightAvailabilityTypestring | ||
| 382 | Enum: | ||
| 383 | [ OnRequest, FreeSale, FewPlaces, StopSale ] | ||
| 384 | returnAvailabilityType FlightAvailabilityTypestring | ||
| 385 | Enum: | ||
| 386 | [ OnRequest, FreeSale, FewPlaces, StopSale ] | ||
| 387 | isTwoWay boolean | ||
| 388 | departureSegments [ | ||
| 389 | nullable: true | ||
| 390 | FlightSegment{ | ||
| 391 | airlineCode string | ||
| 392 | nullable: true | ||
| 393 | airlineName string | ||
| 394 | nullable: true | ||
| 395 | flightCode string | ||
| 396 | nullable: true | ||
| 397 | class string | ||
| 398 | nullable: true | ||
| 399 | lugageWeight number($double) | ||
| 400 | handLugageWeight number($double) | ||
| 401 | departureFlightDate string($date-time) | ||
| 402 | departureCountryName string | ||
| 403 | nullable: true | ||
| 404 | departureCityName string | ||
| 405 | nullable: true | ||
| 406 | departureAirportCode string | ||
| 407 | nullable: true | ||
| 408 | departureAirportName string | ||
| 409 | nullable: true | ||
| 410 | departureTerminalCode string | ||
| 411 | nullable: true | ||
| 412 | arrivalFlightDate string($date-time) | ||
| 413 | arrivalCountryName string | ||
| 414 | nullable: true | ||
| 415 | arrivalCityName string | ||
| 416 | nullable: true | ||
| 417 | arrivalAirportCode string | ||
| 418 | nullable: true | ||
| 419 | arrivalAirportName string | ||
| 420 | nullable: true | ||
| 421 | arrivalTerminalCode string | ||
| 422 | nullable: true | ||
| 423 | flightDuration string | ||
| 424 | nullable: true | ||
| 425 | baggages [ | ||
| 426 | nullable: true | ||
| 427 | Baggage{ | ||
| 428 | baggageCode string | ||
| 429 | nullable: true | ||
| 430 | description string | ||
| 431 | nullable: true | ||
| 432 | price number($double) | ||
| 433 | currency string | ||
| 434 | nullable: true | ||
| 435 | included boolean | ||
| 436 | }] | ||
| 437 | }] | ||
| 438 | returnSegments [ | ||
| 439 | nullable: true | ||
| 440 | FlightSegment{ | ||
| 441 | airlineCode string | ||
| 442 | nullable: true | ||
| 443 | airlineName string | ||
| 444 | nullable: true | ||
| 445 | flightCode string | ||
| 446 | nullable: true | ||
| 447 | class string | ||
| 448 | nullable: true | ||
| 449 | lugageWeight number($double) | ||
| 450 | handLugageWeight number($double) | ||
| 451 | departureFlightDate string($date-time) | ||
| 452 | departureCountryName string | ||
| 453 | nullable: true | ||
| 454 | departureCityName string | ||
| 455 | nullable: true | ||
| 456 | departureAirportCode string | ||
| 457 | nullable: true | ||
| 458 | departureAirportName string | ||
| 459 | nullable: true | ||
| 460 | departureTerminalCode string | ||
| 461 | nullable: true | ||
| 462 | arrivalFlightDate string($date-time) | ||
| 463 | arrivalCountryName string | ||
| 464 | nullable: true | ||
| 465 | arrivalCityName string | ||
| 466 | nullable: true | ||
| 467 | arrivalAirportCode string | ||
| 468 | nullable: true | ||
| 469 | arrivalAirportName string | ||
| 470 | nullable: true | ||
| 471 | arrivalTerminalCode string | ||
| 472 | nullable: true | ||
| 473 | flightDuration string | ||
| 474 | nullable: true | ||
| 475 | baggages [ | ||
| 476 | nullable: true | ||
| 477 | Baggage{ | ||
| 478 | baggageCode string | ||
| 479 | nullable: true | ||
| 480 | description string | ||
| 481 | nullable: true | ||
| 482 | price number($double) | ||
| 483 | currency string | ||
| 484 | nullable: true | ||
| 485 | included boolean | ||
| 486 | }] | ||
| 487 | }] | ||
| 488 | } | ||
| 489 | extraServices [ | ||
| 490 | nullable: true | ||
| 491 | HotelExtraServiceBase{ | ||
| 492 | extraServiceCode string | ||
| 493 | nullable: true | ||
| 494 | extraServiceTypeCode string | ||
| 495 | nullable: true | ||
| 496 | isMandatory integer($int32) | ||
| 497 | extraServiceName string | ||
| 498 | nullable: true | ||
| 499 | minimalServiceAmount number($double) | ||
| 500 | includedPriceCode string | ||
| 501 | nullable: true | ||
| 502 | prices [ | ||
| 503 | nullable: true | ||
| 504 | HotelExtraServicePriceBase{ | ||
| 505 | extraServicePriceCode string | ||
| 506 | nullable: true | ||
| 507 | displayName string | ||
| 508 | nullable: true | ||
| 509 | restrictionInfo string | ||
| 510 | nullable: true | ||
| 511 | additionalInfo string | ||
| 512 | nullable: true | ||
| 513 | price number($double) | ||
| 514 | extraPrice number($double) | ||
| 515 | currency string | ||
| 516 | nullable: true | ||
| 517 | }] | ||
| 518 | }] | ||
| 519 | insurancePrice InsurancePrice{ | ||
| 520 | name string | ||
| 521 | nullable: true | ||
| 522 | price number($double) | ||
| 523 | priceSurcarge number($double) | ||
| 524 | actualStartDate string($date-time) | ||
| 525 | actualEndDate string($date-time) | ||
| 526 | optional boolean | ||
| 527 | includedInPackagePrice boolean | ||
| 528 | } | ||
| 529 | }] | ||
| 530 | pagingId string | ||
| 531 | nullable: true | ||
| 532 | pageNumber integer($int64) | ||
| 533 | pageCount integer($int64) | ||
| 534 | } | ||
| |
2.1 | 535 | {{/code}} |