Wiki source code of 3. CalcCheckout
Version 1.3 by Giorgi Mdivnishvili on 2024/04/12 18:49
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
1.1 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
| |
1.2 | 2 | |
| 3 | |||
| |
1.1 | 4 | {{toc/}} |
| 5 | {{/box}} | ||
| 6 | |||
| |
1.2 | 7 | = Method Description = |
| |
1.1 | 8 | |
| 9 | |||
| |
1.3 | 10 | Once the desired tour variation has been selected, the next step involves calculating the package price in greater detail, typically just before proceeding with the reservation. To accomplish this, the **CalcCheckout **method must be utilized. This stage marks the pre-booking phase of the process. |
| |
1.1 | 11 | |
| 12 | |||
| |
1.2 | 13 | == Endpoint URL - [POST] == |
| 14 | |||
| 15 | {{info}} | ||
| |
1.3 | 16 | [[https:~~/~~/integration.kazunion.com/api/Checkout/CalcCheckout>>https://integration.kazunion.com/api/Checkout/CalcCheckout]] |
| |
1.2 | 17 | {{/info}} |
| 18 | |||
| 19 | |||
| 20 | == Request Parameters == | ||
| 21 | |||
| 22 | (% class="box infomessage" %) | ||
| 23 | ((( | ||
| 24 | None | ||
| 25 | ))) | ||
| 26 | |||
| |
1.3 | 27 | |
| |
1.2 | 28 | == Request Body == |
| 29 | |||
| 30 | {{code language="Json"}} | ||
| 31 | { | ||
| |
1.3 | 32 | "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", |
| 33 | "calcTourPackageRequests": [ | ||
| |
1.2 | 34 | { |
| |
1.3 | 35 | "packageId": "string", |
| 36 | "extraServicePriceCodes": [ | ||
| 37 | "string" | ||
| 38 | ], | ||
| 39 | "flightPassengers": [ | ||
| 40 | { | ||
| 41 | "id": "string", | ||
| 42 | "selectedForwardBaggageCode": "string", | ||
| 43 | "selectedBackwardBaggageCode": "string" | ||
| 44 | } | ||
| 45 | ], | ||
| 46 | "includeInsurance": true, | ||
| 47 | "refreshPrices": true | ||
| |
1.2 | 48 | } |
| 49 | ], | ||
| |
1.3 | 50 | "calcOnlyHotelPackageRequests": [ |
| 51 | { | ||
| 52 | "packageId": "string", | ||
| 53 | "extraServicePriceCodes": [ | ||
| 54 | "string" | ||
| 55 | ], | ||
| 56 | "includeInsurance": true, | ||
| 57 | "refreshPrices": true | ||
| 58 | } | ||
| |
1.2 | 59 | ], |
| |
1.3 | 60 | "calcOnlyAviaPackageRequests": [ |
| 61 | { | ||
| 62 | "packageId": "string", | ||
| 63 | "refreshPrices": true, | ||
| 64 | "flightPassengers": [ | ||
| 65 | { | ||
| 66 | "id": "string", | ||
| 67 | "selectedForwardBaggageCode": "string", | ||
| 68 | "selectedBackwardBaggageCode": "string" | ||
| 69 | } | ||
| 70 | ] | ||
| 71 | } | ||
| |
1.2 | 72 | ], |
| |
1.3 | 73 | "hotels": [ |
| 74 | { | ||
| 75 | "hotelPriceId": "string", | ||
| 76 | "agentConfirmationNumber": "string", | ||
| 77 | "note": "string", | ||
| 78 | "touristIds": [ | ||
| 79 | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | ||
| 80 | ] | ||
| 81 | } | ||
| |
1.2 | 82 | ], |
| |
1.3 | 83 | "tourists": [ |
| 84 | { | ||
| 85 | "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 86 | "firstName": "string", | ||
| 87 | "lastName": "string", | ||
| 88 | "birthDate": "2024-04-11T03:34:15.828Z", | ||
| 89 | "passportNumber": "string", | ||
| 90 | "passportExpiry": "2024-04-11T03:34:15.828Z", | ||
| 91 | "passportIssue": "2024-04-11T03:34:15.828Z", | ||
| 92 | "citizenship": "string", | ||
| 93 | "tin": "string", | ||
| 94 | "isMale": true, | ||
| 95 | "flightIds": [ | ||
| 96 | "string" | ||
| 97 | ], | ||
| 98 | "arrivalFlightInfo": { | ||
| 99 | "flightNumber": "string", | ||
| 100 | "terminalCode": "string", | ||
| 101 | "date": "2024-04-11T03:34:15.828Z", | ||
| 102 | "time": "string" | ||
| 103 | }, | ||
| 104 | "departureFlightInfo": { | ||
| 105 | "flightNumber": "string", | ||
| 106 | "terminalCode": "string", | ||
| 107 | "date": "2024-04-11T03:34:15.828Z", | ||
| 108 | "time": "string" | ||
| 109 | }, | ||
| 110 | "selectedVisaId": "string", | ||
| 111 | "transfers": [ | ||
| 112 | { | ||
| 113 | "id": "string", | ||
| 114 | "selectedTransferPriceId": "string" | ||
| 115 | } | ||
| 116 | ] | ||
| 117 | } | ||
| |
1.2 | 118 | ], |
| |
1.3 | 119 | "note": "string", |
| 120 | "contactPhone": "string" | ||
| |
1.2 | 121 | } |
| |
1.3 | 122 | |
| |
1.2 | 123 | {{/code}} |
| 124 | |||
| |
1.3 | 125 | (% class="wikigeneratedid" id="HRequestBodyexample" %) |
| 126 | (% id="cke_bm_10575S" style="display:none" %) | ||
| 127 | |||
| 128 | |||
| 129 | |||
| |
1.2 | 130 | == Request Body example == |
| 131 | |||
| 132 | {{code language="Json"}} | ||
| 133 | { | ||
| |
1.3 | 134 | "calcTourPackageRequests": [ |
| 135 | { | ||
| 136 | "refreshPrices": true, | ||
| 137 | "packageId": "tour:7caef71d-25e3-4882-b0db-81e766af2b72:fa7a89d5-1c20-4004-b3d2-f8d08163827f:53552191-59ea-469d-ae9d-5b848da8839d", | ||
| 138 | "flightPassengers": [ | ||
| 139 | { | ||
| 140 | "id": "53552191-59ea-469d-ae9d-5b848da8839d-A1", | ||
| 141 | "selectedForwardBaggageCode": "INCLUDED", | ||
| 142 | "selectedBackwardBaggageCode": "INCLUDED" | ||
| 143 | }, | ||
| 144 | { | ||
| 145 | "id": "53552191-59ea-469d-ae9d-5b848da8839d-A2", | ||
| 146 | "selectedForwardBaggageCode": "INCLUDED", | ||
| 147 | "selectedBackwardBaggageCode": "INCLUDED" | ||
| 148 | } | ||
| 149 | ], | ||
| 150 | "extraServicePriceCodes": [], | ||
| 151 | "includeInsurance": true | ||
| 152 | } | ||
| 153 | ], | ||
| 154 | "calcOnlyHotelPackageRequests": [], | ||
| 155 | "calcOnlyAviaPackageRequests": [] | ||
| 156 | } | ||
| 157 | {{/code}} | ||
| 158 | |||
| 159 | |||
| 160 | == Response == | ||
| 161 | |||
| 162 | {{code language="json"}} | ||
| 163 | { | ||
| 164 | "error": true, | ||
| 165 | "errorCode": "string", | ||
| 166 | "errorDescription": "string", | ||
| 167 | "userErrorDescription": "string", | ||
| 168 | "priceCurrency": "string", | ||
| 169 | "totalPrice": 0, | ||
| 170 | "agentCommissionPercent": 0, | ||
| 171 | "agentCommissionAmount": 0, | ||
| 172 | "requiredCitizenIdentifiers": [ | ||
| 173 | { | ||
| 174 | "countryCode": "string", | ||
| 175 | "identifierType": "TIN" | ||
| 176 | } | ||
| |
1.2 | 177 | ], |
| |
1.3 | 178 | "hotels": [ |
| 179 | { | ||
| 180 | "hotelPriceId": "string", | ||
| 181 | "touristIds": [ | ||
| 182 | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | ||
| 183 | ], | ||
| 184 | "errorCode": "string", | ||
| 185 | "errorMessage": "string", | ||
| 186 | "description": "string" | ||
| 187 | } | ||
| |
1.2 | 188 | ], |
| |
1.3 | 189 | "tourists": [ |
| 190 | { | ||
| 191 | "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 192 | "age": 0, | ||
| 193 | "isAdult": true, | ||
| 194 | "flightIds": [ | ||
| 195 | "string" | ||
| 196 | ], | ||
| 197 | "flights": [ | ||
| 198 | { | ||
| 199 | "flightId": "string", | ||
| 200 | "note": "string" | ||
| 201 | } | ||
| 202 | ], | ||
| 203 | "arrivalFlightInfo": { | ||
| 204 | "flightNumber": "string", | ||
| 205 | "terminalCode": "string", | ||
| 206 | "date": "2024-04-11T05:03:16.796Z", | ||
| 207 | "time": "string" | ||
| 208 | }, | ||
| 209 | "departureFlightInfo": { | ||
| 210 | "flightNumber": "string", | ||
| 211 | "terminalCode": "string", | ||
| 212 | "date": "2024-04-11T05:03:16.796Z", | ||
| 213 | "time": "string" | ||
| 214 | }, | ||
| 215 | "insurancePrice": { | ||
| 216 | "insuranceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 217 | "insuranceServiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 218 | "insurancePriceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 219 | "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 220 | "insuranceName": "string", | ||
| 221 | "insuranceDescription": "string", | ||
| 222 | "contragentName": "string", | ||
| 223 | "contragentFullName": "string", | ||
| 224 | "actualStartDate": "2024-04-11T05:03:16.796Z", | ||
| 225 | "actualEndDate": "2024-04-11T05:03:16.796Z", | ||
| 226 | "costCurrencyCode": "string", | ||
| 227 | "costAmount": 0, | ||
| 228 | "priceCurrencyCode": "string", | ||
| 229 | "priceAmount": 0, | ||
| 230 | "coverageCurrencyCode": "string", | ||
| 231 | "coverageAmount": 0 | ||
| 232 | }, | ||
| 233 | "selectedVisaId": "string", | ||
| 234 | "transfers": [ | ||
| 235 | { | ||
| 236 | "id": "string", | ||
| 237 | "type": "Arrival", | ||
| 238 | "flightId": "string", | ||
| 239 | "flightInfo": { | ||
| 240 | "flightNumber": "string", | ||
| 241 | "terminalCode": "string", | ||
| 242 | "date": "2024-04-11T05:03:16.796Z", | ||
| 243 | "time": "string" | ||
| 244 | }, | ||
| 245 | "checkInHotelId": "string", | ||
| 246 | "checkOutHotelId": "string", | ||
| 247 | "selectedTransferPriceId": "string", | ||
| 248 | "transferPrices": [ | ||
| 249 | { | ||
| 250 | "id": "string", | ||
| 251 | "name": "string", | ||
| 252 | "adultPlaces": 0, | ||
| 253 | "childPlaces": 0, | ||
| 254 | "perPersonPrice": true, | ||
| 255 | "adultPrice": 0, | ||
| 256 | "childPrice": 0 | ||
| 257 | } | ||
| 258 | ] | ||
| 259 | } | ||
| 260 | ], | ||
| 261 | "errorCode": "string", | ||
| 262 | "errorMessage": "string", | ||
| 263 | "description": "string" | ||
| 264 | } | ||
| |
1.2 | 265 | ], |
| |
1.3 | 266 | "visas": [ |
| 267 | { | ||
| 268 | "prid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 269 | "prName": "string", | ||
| 270 | "prValue": 0, | ||
| 271 | "sortingOrder": 0 | ||
| 272 | } | ||
| |
1.2 | 273 | ], |
| |
1.3 | 274 | "terminals": [ |
| 275 | { | ||
| 276 | "terminalCode": "string", | ||
| 277 | "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 278 | "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 279 | "terminalName": "string", | ||
| 280 | "countryCode": "string", | ||
| 281 | "note": "string" | ||
| 282 | } | ||
| |
1.2 | 283 | ], |
| |
1.3 | 284 | "containsError": true, |
| 285 | "refreshPriceResult": "Success", | ||
| 286 | "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
| 287 | "reservationDetailsUnavailable": true | ||
| |
1.2 | 288 | } |
| 289 | {{/code}} | ||
| 290 | |||
| 291 | |||
| |
1.3 | 292 | === Response example === |
| |
1.2 | 293 | |
| 294 | {{code language="Json"}} | ||
| 295 | { | ||
| |
1.3 | 296 | "package": { |
| 297 | "id": "tour:1d0fa533-4261-4254-93bb-83599d581ffc:193990fa-41a5-46e6-9805-50f82c3c377f:0c299240-6fc6-4f79-ba99-3548f2de3f57", | ||
| 298 | "priceCurrency": "USD", | ||
| 299 | "totalPrice": 937.16, | ||
| 300 | "agentCommissionPercent": 0.00, | ||
| 301 | "agentCommissionAmount": 0.00, | ||
| 302 | "includedExtrasAmount": 0, | ||
| 303 | "priceDifference": 0, | ||
| 304 | "hotel": { | ||
| 305 | "hotelPriceId": "193990fa-41a5-46e6-9805-50f82c3c377f", | ||
| 306 | "providerId": 13, | ||
| 307 | "hotelName": "Mercure Dubai Barsha Heights Suites Apartments", | ||
| 308 | "hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14", | ||
| 309 | "nigths": 2, | ||
| 310 | "mealPlan": "BB", | ||
| 311 | "hotelClass": "4", | ||
| 312 | "availabilityType": "StopSale", | ||
| 313 | "availableRoomsCount": 0, | ||
| 314 | "fewRooms": true, | ||
| 315 | "roomCategoryCode": "f8e1ffe5-25cc-46a4-80e8-586d1c049de4", | ||
| 316 | "roomCategoryName": "1 B/R Apartment City View", | ||
| 317 | "placementTypeName": "SNGL + CHILD(2-5.99)sharing", | ||
| 318 | "checkInDate": "2024-02-15T20:00:00.000Z", | ||
| 319 | "checkOutDate": "2024-02-17T20:00:00.000Z", | ||
| 320 | "adults": 1, | ||
| 321 | "children": 1, | ||
| 322 | "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e", | ||
| 323 | "districtName": "Al Barsha", | ||
| 324 | "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2", | ||
| 325 | "cityName": "Dubai", | ||
| 326 | "countryCode": "AE", | ||
| 327 | "countryName": "United Arab Emirates", | ||
| 328 | "hasAlcohol": false, | ||
| 329 | "hasFreeWifi": true, | ||
| 330 | "hasMetro": true, | ||
| 331 | "hasPool": true, | ||
| 332 | "hasMall": false, | ||
| 333 | "cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %", | ||
| 334 | "cancellationPolicy": { | ||
| 335 | "noShowChargeValue": 100.00, | ||
| 336 | "noShowChargeValueType": "%", | ||
| 337 | "earlyDepartureChargeValue": 100.00, | ||
| 338 | "earlyDepartureChargeValueType": "%", | ||
| 339 | "conditions": [ | ||
| 340 | { | ||
| 341 | "timeunits": 5, | ||
| 342 | "timeunitType": "Day", | ||
| 343 | "timeOffsetTypeName": "Before Arrival", | ||
| 344 | "chargeValue": 100.00, | ||
| 345 | "chargeValueType": "%" | ||
| 346 | } | ||
| 347 | ] | ||
| 348 | } | ||
| 349 | }, | ||
| 350 | "flight": { | ||
| 351 | "id": "0c299240-6fc6-4f79-ba99-3548f2de3f57", | ||
| 352 | "departureDate": "2024-02-15T20:00:00.000Z", | ||
| 353 | "returnDate": "2024-02-17T20:00:00.000Z", | ||
| 354 | "departureTicketsLeft": 7, | ||
| 355 | "returnTicketsLeft": 7, | ||
| 356 | "departureAvailabilityType": "FewPlaces", | ||
| 357 | "returnAvailabilityType": "FewPlaces", | ||
| 358 | "isTwoWay": true, | ||
| 359 | "sameBaggageForAll": false, | ||
| 360 | "totalBaggage": true, | ||
| 361 | "departureSegments": [ | ||
| 362 | { | ||
| 363 | "airlineCode": "KC", | ||
| 364 | "airlineName": "Air Astana-", | ||
| 365 | "flightCode": "KC899", | ||
| 366 | "class": "econom", | ||
| 367 | "lugageWeight": 20, | ||
| 368 | "handLugageWeight": 6, | ||
| 369 | "departureFlightDate": "2024-02-15T20:00:00.000Z", | ||
| 370 | "departureCountryName": "Kazakhstan", | ||
| 371 | "departureCityName": "Almaty", | ||
| 372 | "departureAirportCode": "ALA", | ||
| 373 | "departureAirportName": "Almaty Intl Airport", | ||
| 374 | "departureTerminalCode": "ALA", | ||
| 375 | "arrivalFlightDate": "2024-02-15T20:00:00.000Z", | ||
| 376 | "arrivalCountryName": "United Arab Emirates", | ||
| 377 | "arrivalCityName": "Dubai", | ||
| 378 | "arrivalAirportCode": "DXB", | ||
| 379 | "arrivalAirportName": "Dubai Intl Airport", | ||
| 380 | "arrivalTerminalCode": "DXB1", | ||
| 381 | "flightDuration": "0h 50m" | ||
| 382 | } | ||
| 383 | ], | ||
| 384 | "returnSegments": [ | ||
| 385 | { | ||
| 386 | "airlineCode": "KC", | ||
| 387 | "airlineName": "Air Astana-", | ||
| 388 | "flightCode": "KC900", | ||
| 389 | "class": "econom", | ||
| 390 | "lugageWeight": 20, | ||
| 391 | "handLugageWeight": 6, | ||
| 392 | "departureFlightDate": "2024-02-17T20:00:00.000Z", | ||
| 393 | "departureCountryName": "United Arab Emirates", | ||
| 394 | "departureCityName": "Dubai", | ||
| 395 | "departureAirportCode": "DXB", | ||
| 396 | "departureAirportName": "Dubai Intl Airport", | ||
| 397 | "departureTerminalCode": "DXB1", | ||
| 398 | "arrivalFlightDate": "2024-02-17T20:00:00.000Z", | ||
| 399 | "arrivalCountryName": "Kazakhstan", | ||
| 400 | "arrivalCityName": "Almaty", | ||
| 401 | "arrivalAirportCode": "ALA", | ||
| 402 | "arrivalAirportName": "Almaty Intl Airport", | ||
| 403 | "arrivalTerminalCode": "ALA", | ||
| 404 | "flightDuration": "8h 15m" | ||
| 405 | } | ||
| 406 | ], | ||
| 407 | "passengers": [ | ||
| 408 | { | ||
| 409 | "id": "42779531011000004-A1", | ||
| 410 | "isAdult": true, | ||
| 411 | "forwardBaggages": [ | ||
| 412 | { | ||
| 413 | "baggageCode": "TOTAL_BAGGAGE", | ||
| 414 | "description": "1 piece included, UP TO 50 POUNDS/23 KILOGRAMS, OVER 62 LINEAR INCHES/158 LINEAR CENTIMETERS", | ||
| 415 | "price": 45.00, | ||
| 416 | "currency": "USD", | ||
| 417 | "included": false | ||
| 418 | } | ||
| 419 | ], | ||
| 420 | "backwardBaggages": [ | ||
| 421 | { | ||
| 422 | "baggageCode": "INCLUDED_IN_FORWARD", | ||
| 423 | "price": 0, | ||
| 424 | "included": false | ||
| 425 | } | ||
| 426 | ] | ||
| 427 | }, | ||
| 428 | { | ||
| 429 | "id": "42779531011000004-C1", | ||
| 430 | "isAdult": false, | ||
| 431 | "forwardBaggages": [ | ||
| 432 | { | ||
| 433 | "baggageCode": "TOTAL_BAGGAGE", | ||
| 434 | "description": "1 piece included, UP TO 50 POUNDS/23 KILOGRAMS, OVER 62 LINEAR INCHES/158 LINEAR CENTIMETERS", | ||
| 435 | "price": 45.00, | ||
| 436 | "currency": "USD", | ||
| 437 | "included": false | ||
| 438 | } | ||
| 439 | ], | ||
| 440 | "backwardBaggages": [ | ||
| 441 | { | ||
| 442 | "baggageCode": "INCLUDED_IN_FORWARD", | ||
| 443 | "price": 0, | ||
| 444 | "included": false | ||
| 445 | } | ||
| 446 | ] | ||
| 447 | } | ||
| 448 | ] | ||
| 449 | }, | ||
| 450 | "extraServices": [], | ||
| 451 | "insurancePrice": { | ||
| 452 | "name": "Medical INS (N10000)", | ||
| 453 | "price": 13.44, | ||
| 454 | "priceSurcarge": 0.00, | ||
| 455 | "actualStartDate": "2024-02-15T20:00:00.000Z", | ||
| 456 | "actualEndDate": "2024-02-17T20:00:00.000Z", | ||
| 457 | "optional": false, | ||
| 458 | "includedInPackagePrice": true | ||
| 459 | } | ||
| 460 | }, | ||
| 461 | "altPackages": [ | ||
| |
1.2 | 462 | { |
| |
1.3 | 463 | "id": "tour:1d0fa533-4261-4254-93bb-83599d581ffc:193990fa-41a5-46e6-9805-50f82c3c377f:63d79c94-1e19-443f-8a17-50e59e633ea8", |
| |
1.2 | 464 | "priceCurrency": "USD", |
| |
1.3 | 465 | "totalPrice": 968.40, |
| 466 | "agentCommissionPercent": 0.00, | ||
| 467 | "agentCommissionAmount": 0.00, | ||
| 468 | "includedExtrasAmount": 0, | ||
| 469 | "priceDifference": 31.24, | ||
| |
1.2 | 470 | "hotel": { |
| |
1.3 | 471 | "hotelPriceId": "193990fa-41a5-46e6-9805-50f82c3c377f", |
| |
1.2 | 472 | "providerId": 13, |
| |
1.3 | 473 | "hotelName": "Mercure Dubai Barsha Heights Suites Apartments", |
| 474 | "hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14", | ||
| 475 | "nigths": 2, | ||
| 476 | "mealPlan": "BB", | ||
| |
1.2 | 477 | "hotelClass": "4", |
| |
1.3 | 478 | "availabilityType": "StopSale", |
| |
1.2 | 479 | "availableRoomsCount": 0, |
| 480 | "fewRooms": true, | ||
| |
1.3 | 481 | "roomCategoryCode": "f8e1ffe5-25cc-46a4-80e8-586d1c049de4", |
| 482 | "roomCategoryName": "1 B/R Apartment City View", | ||
| 483 | "placementTypeName": "SNGL + CHILD(2-5.99)sharing", | ||
| 484 | "checkInDate": "2024-02-15T20:00:00.000Z", | ||
| 485 | "checkOutDate": "2024-02-17T20:00:00.000Z", | ||
| |
1.2 | 486 | "adults": 1, |
| 487 | "children": 1, | ||
| 488 | "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e", | ||
| 489 | "districtName": "Al Barsha", | ||
| 490 | "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2", | ||
| 491 | "cityName": "Dubai", | ||
| 492 | "countryCode": "AE", | ||
| 493 | "countryName": "United Arab Emirates", | ||
| |
1.3 | 494 | "hasAlcohol": false, |
| |
1.2 | 495 | "hasFreeWifi": true, |
| |
1.3 | 496 | "hasMetro": true, |
| |
1.2 | 497 | "hasPool": true, |
| 498 | "hasMall": false, | ||
| |
1.3 | 499 | "cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %", |
| |
1.2 | 500 | "cancellationPolicy": { |
| |
1.3 | 501 | "noShowChargeValue": 100.00, |
| |
1.2 | 502 | "noShowChargeValueType": "%", |
| |
1.3 | 503 | "earlyDepartureChargeValue": 100.00, |
| |
1.2 | 504 | "earlyDepartureChargeValueType": "%", |
| 505 | "conditions": [ | ||
| 506 | { | ||
| |
1.3 | 507 | "timeunits": 5, |
| |
1.2 | 508 | "timeunitType": "Day", |
| 509 | "timeOffsetTypeName": "Before Arrival", | ||
| |
1.3 | 510 | "chargeValue": 100.00, |
| |
1.2 | 511 | "chargeValueType": "%" |
| 512 | } | ||
| 513 | ] | ||
| 514 | } | ||
| 515 | }, | ||
| |
1.3 | 516 | "flight": { |
| 517 | "id": "63d79c94-1e19-443f-8a17-50e59e633ea8", | ||
| 518 | "departureDate": "2024-02-15T20:00:00.000Z", | ||
| 519 | "returnDate": "2024-02-17T20:00:00.000Z", | ||
| 520 | "departureTicketsLeft": 50, | ||
| 521 | "returnTicketsLeft": 50, | ||
| 522 | "departureAvailabilityType": "FewPlaces", | ||
| 523 | "returnAvailabilityType": "FewPlaces", | ||
| 524 | "isTwoWay": true, | ||
| 525 | "sameBaggageForAll": false, | ||
| 526 | "totalBaggage": false, | ||
| 527 | "departureSegments": [ | ||
| 528 | { | ||
| 529 | "airlineCode": "FZ", | ||
| 530 | "airlineName": "Fly Dubai.", | ||
| 531 | "flightCode": "FZ1722", | ||
| 532 | "class": "econom", | ||
| 533 | "lugageWeight": 20, | ||
| 534 | "handLugageWeight": 6, | ||
| 535 | "departureFlightDate": "2024-02-15T20:00:00.000Z", | ||
| 536 | "departureCountryName": "Kazakhstan", | ||
| 537 | "departureCityName": "Almaty", | ||
| 538 | "departureAirportCode": "ALA", | ||
| 539 | "departureAirportName": "Almaty Intl Airport", | ||
| 540 | "departureTerminalCode": "ALA", | ||
| 541 | "arrivalFlightDate": "2024-02-15T20:00:00.000Z", | ||
| 542 | "arrivalCountryName": "United Arab Emirates", | ||
| 543 | "arrivalCityName": "Dubai", | ||
| 544 | "arrivalAirportCode": "DXB", | ||
| 545 | "arrivalAirportName": "Dubai Intl Airport", | ||
| 546 | "arrivalTerminalCode": "DXB3", | ||
| 547 | "flightDuration": "0h 55m" | ||
| 548 | } | ||
| 549 | ], | ||
| 550 | "returnSegments": [ | ||
| 551 | { | ||
| 552 | "airlineCode": "FZ", | ||
| 553 | "airlineName": "Fly Dubai.", | ||
| 554 | "flightCode": "FZ1721", | ||
| 555 | "class": "econom", | ||
| 556 | "lugageWeight": 20, | ||
| 557 | "handLugageWeight": 6, | ||
| 558 | "departureFlightDate": "2024-02-17T20:00:00.000Z", | ||
| 559 | "departureCountryName": "United Arab Emirates", | ||
| 560 | "departureCityName": "Dubai", | ||
| 561 | "departureAirportCode": "DXB", | ||
| 562 | "departureAirportName": "Dubai Intl Airport", | ||
| 563 | "departureTerminalCode": "DXB3", | ||
| 564 | "arrivalFlightDate": "2024-02-18T20:00:00.000Z", | ||
| 565 | "arrivalCountryName": "Kazakhstan", | ||
| 566 | "arrivalCityName": "Almaty", | ||
| 567 | "arrivalAirportCode": "ALA", | ||
| 568 | "arrivalAirportName": "Almaty Intl Airport", | ||
| 569 | "arrivalTerminalCode": "DXB3", | ||
| 570 | "flightDuration": "8h 10m" | ||
| 571 | } | ||
| 572 | ], | ||
| 573 | "passengers": [ | ||
| 574 | { | ||
| 575 | "id": "42779547001000004-A1", | ||
| 576 | "isAdult": true, | ||
| 577 | "selectedForwardBaggageCode": "INCLUDED", | ||
| 578 | "selectedBackwardBaggageCode": "INCLUDED", | ||
| 579 | "forwardBaggages": [ | ||
| 580 | { | ||
| 581 | "baggageCode": "INCLUDED", | ||
| 582 | "description": "20 KG INCLUDED", | ||
| 583 | "price": 0.0, | ||
| 584 | "currency": "USD", | ||
| 585 | "included": true | ||
| 586 | } | ||
| 587 | ], | ||
| 588 | "backwardBaggages": [ | ||
| 589 | { | ||
| 590 | "baggageCode": "INCLUDED", | ||
| 591 | "description": "20 KG INCLUDED", | ||
| 592 | "price": 0.0, | ||
| 593 | "currency": "USD", | ||
| 594 | "included": true | ||
| 595 | } | ||
| 596 | ] | ||
| 597 | }, | ||
| 598 | { | ||
| 599 | "id": "42779547001000004-C1", | ||
| 600 | "isAdult": false, | ||
| 601 | "selectedForwardBaggageCode": "INCLUDED", | ||
| 602 | "selectedBackwardBaggageCode": "INCLUDED", | ||
| 603 | "forwardBaggages": [ | ||
| 604 | { | ||
| 605 | "baggageCode": "INCLUDED", | ||
| 606 | "description": "20 KG INCLUDED", | ||
| 607 | "price": 0.0, | ||
| 608 | "currency": "USD", | ||
| 609 | "included": true | ||
| 610 | } | ||
| 611 | ], | ||
| 612 | "backwardBaggages": [ | ||
| 613 | { | ||
| 614 | "baggageCode": "INCLUDED", | ||
| 615 | "description": "20 KG INCLUDED", | ||
| 616 | "price": 0.0, | ||
| 617 | "currency": "USD", | ||
| 618 | "included": true | ||
| 619 | } | ||
| 620 | ] | ||
| 621 | } | ||
| 622 | ] | ||
| 623 | }, | ||
| 624 | "extraServices": [], | ||
| 625 | "insurancePrice": { | ||
| 626 | "name": "Medical INS (N10000)", | ||
| 627 | "price": 13.44, | ||
| 628 | "priceSurcarge": 0.00, | ||
| 629 | "actualStartDate": "2024-02-15T20:00:00.000Z", | ||
| 630 | "actualEndDate": "2024-02-17T20:00:00.000Z", | ||
| 631 | "optional": false, | ||
| 632 | "includedInPackagePrice": true | ||
| 633 | } | ||
| |
1.2 | 634 | }, |
| |
1.3 | 635 | { |
| |
1.2 | 636 | {{/code}} |
| 637 | |||
| 638 | |||
| 639 | === Schema === | ||
| 640 | |||
| 641 | {{success}} | ||
| |
1.3 | 642 | CheckoutFormIn{ |
| |
1.2 | 643 | |
| |
1.3 | 644 | |reservationId|string($uuid) |
| 645 | nullable: true | ||
| 646 | |calcTourPackageRequests|[ | ||
| 647 | nullable: trueCalcTourPackageRequest{((( | ||
| 648 | |packageId|string | ||
| 649 | nullable: true | ||
| 650 | |extraServicePriceCodes|[ | ||
| 651 | nullable: truestring] | ||
| 652 | |flightPassengers|[ | ||
| 653 | nullable: trueFlightPassengerIn{((( | ||
| |
1.2 | 654 | |id|string |
| 655 | nullable: true | ||
| |
1.3 | 656 | |selectedForwardBaggageCode|string |
| |
1.2 | 657 | nullable: true |
| |
1.3 | 658 | |selectedBackwardBaggageCode|string |
| |
1.2 | 659 | nullable: true |
| |
1.3 | 660 | |
| 661 | }] | ||
| 662 | ))) | ||
| 663 | |includeInsurance|boolean | ||
| |
1.2 | 664 | nullable: true |
| |
1.3 | 665 | |refreshPrices|boolean |
| 666 | |||
| 667 | }] | ||
| 668 | ))) | ||
| 669 | |calcOnlyHotelPackageRequests|[ | ||
| 670 | nullable: trueCalcOnlyHotelPackageRequest{((( | ||
| 671 | |packageId|string | ||
| |
1.2 | 672 | nullable: true |
| |
1.3 | 673 | |extraServicePriceCodes|[ |
| 674 | nullable: truestring] | ||
| 675 | |includeInsurance|boolean | ||
| 676 | |refreshPrices|boolean | ||
| 677 | |||
| 678 | }] | ||
| 679 | ))) | ||
| 680 | |calcOnlyAviaPackageRequests|[ | ||
| 681 | nullable: trueCalcOnlyAviaPackageRequest{((( | ||
| 682 | |packageId|string | ||
| |
1.2 | 683 | nullable: true |
| |
1.3 | 684 | |refreshPrices|boolean |
| 685 | |flightPassengers|[ | ||
| 686 | nullable: trueFlightPassengerIn{((( | ||
| 687 | |id|string | ||
| |
1.2 | 688 | nullable: true |
| |
1.3 | 689 | |selectedForwardBaggageCode|string |
| |
1.2 | 690 | nullable: true |
| |
1.3 | 691 | |selectedBackwardBaggageCode|string |
| |
1.2 | 692 | nullable: true |
| |
1.3 | 693 | |
| 694 | }] | ||
| 695 | ))) | ||
| 696 | |||
| 697 | }] | ||
| 698 | ))) | ||
| 699 | |hotels|[ | ||
| 700 | nullable: trueCheckoutHotelIn{((( | ||
| 701 | |hotelPriceId|string | ||
| |
1.2 | 702 | nullable: true |
| |
1.3 | 703 | |agentConfirmationNumber|string |
| |
1.2 | 704 | nullable: true |
| |
1.3 | 705 | |note|string |
| |
1.2 | 706 | nullable: true |
| |
1.3 | 707 | |touristIds|[ |
| 708 | nullable: truestring($uuid)] | ||
| 709 | |||
| 710 | }] | ||
| 711 | ))) | ||
| 712 | |tourists|[ | ||
| 713 | nullable: trueCheckoutTouristIn{((( | ||
| 714 | |id|string($uuid) | ||
| 715 | |firstName|string | ||
| |
1.2 | 716 | nullable: true |
| |
1.3 | 717 | |lastName|string |
| |
1.2 | 718 | nullable: true |
| |
1.3 | 719 | |birthDate|string($date-time) |
| |
1.2 | 720 | nullable: true |
| |
1.3 | 721 | |passportNumber|string |
| |
1.2 | 722 | nullable: true |
| |
1.3 | 723 | |passportExpiry|string($date-time) |
| |
1.2 | 724 | nullable: true |
| |
1.3 | 725 | |passportIssue|string($date-time) |
| |
1.2 | 726 | nullable: true |
| |
1.3 | 727 | |citizenship|string |
| |
1.2 | 728 | nullable: true |
| |
1.3 | 729 | |tin|string |
| |
1.2 | 730 | nullable: true |
| |
1.3 | 731 | |isMale|boolean |
| |
1.2 | 732 | nullable: true |
| |
1.3 | 733 | |flightIds|[ |
| 734 | nullable: truestring] | ||
| 735 | |arrivalFlightInfo|ManualFlightInfo{((( | ||
| 736 | |flightNumber|string | ||
| |
1.2 | 737 | nullable: true |
| |
1.3 | 738 | |terminalCode|string |
| |
1.2 | 739 | nullable: true |
| |
1.3 | 740 | |date|string($date-time) |
| |
1.2 | 741 | nullable: true |
| |
1.3 | 742 | |time|string |
| |
1.2 | 743 | nullable: true |
| |
1.3 | 744 | |
| 745 | } | ||
| 746 | ))) | ||
| 747 | |departureFlightInfo|ManualFlightInfo{((( | ||
| 748 | |flightNumber|string | ||
| |
1.2 | 749 | nullable: true |
| |
1.3 | 750 | |terminalCode|string |
| |
1.2 | 751 | nullable: true |
| |
1.3 | 752 | |date|string($date-time) |
| 753 | nullable: true | ||
| 754 | |time|string | ||
| 755 | nullable: true | ||
| |
1.2 | 756 | |
| |
1.3 | 757 | } |
| 758 | ))) | ||
| 759 | |selectedVisaId|string | ||
| 760 | nullable: true | ||
| 761 | |transfers|[ | ||
| 762 | nullable: trueCheckoutTransferIn{((( | ||
| 763 | |id|string | ||
| 764 | nullable: true | ||
| 765 | |selectedTransferPriceId|string | ||
| 766 | nullable: true | ||
| 767 | |||
| |
1.2 | 768 | }] |
| 769 | ))) | ||
| 770 | |||
| |
1.3 | 771 | }] |
| |
1.2 | 772 | ))) |
| |
1.3 | 773 | |note|string |
| 774 | nullable: true | ||
| 775 | |contactPhone|string | ||
| 776 | nullable: true | ||
| |
1.2 | 777 | |
| 778 | } | ||
| |
1.3 | 779 | {{/success}} |
| 780 | |||
| 781 | {{success}} | ||
| 782 | CheckoutFormOut{ | ||
| 783 | |||
| 784 | |error|boolean | ||
| 785 | |errorCode|string | ||
| |
1.2 | 786 | nullable: true |
| |
1.3 | 787 | |errorDescription|string |
| |
1.2 | 788 | nullable: true |
| |
1.3 | 789 | |userErrorDescription|string |
| |
1.2 | 790 | nullable: true |
| |
1.3 | 791 | |priceCurrency|string |
| |
1.2 | 792 | nullable: true |
| |
1.3 | 793 | |totalPrice|number($double) |
| 794 | |agentCommissionPercent|number($double) | ||
| 795 | |agentCommissionAmount|number($double) | ||
| 796 | |requiredCitizenIdentifiers|[ | ||
| 797 | nullable: trueCitizenIdentifier{((( | ||
| 798 | |countryCode|string | ||
| |
1.2 | 799 | nullable: true |
| |
1.3 | 800 | |identifierType|IdentifierTypeEnumstringEnum: |
| 801 | [ TIN, FIN ] | ||
| 802 | |||
| 803 | }] | ||
| 804 | ))) | ||
| 805 | |hotels|[ | ||
| 806 | nullable: trueCheckoutHotelOut{((( | ||
| 807 | |hotelPriceId|string | ||
| |
1.2 | 808 | nullable: true |
| |
1.3 | 809 | |touristIds|[ |
| 810 | nullable: truestring($uuid)] | ||
| 811 | |errorCode|string | ||
| |
1.2 | 812 | nullable: true |
| |
1.3 | 813 | |errorMessage|string |
| |
1.2 | 814 | nullable: true |
| |
1.3 | 815 | |description|string |
| |
1.2 | 816 | nullable: true |
| 817 | |||
| 818 | }] | ||
| 819 | ))) | ||
| |
1.3 | 820 | |tourists|[ |
| 821 | nullable: trueCheckoutTouristOut{...}] | ||
| 822 | |visas|[ | ||
| 823 | nullable: trueServicePrice{((( | ||
| 824 | |prid|string($uuid) | ||
| 825 | |prName|string | ||
| 826 | nullable: true | ||
| 827 | |prValue|number($double) | ||
| 828 | |sortingOrder|integer($int32) | ||
| |
1.2 | 829 | |
| 830 | }] | ||
| 831 | ))) | ||
| |
1.3 | 832 | |terminals|[ |
| 833 | nullable: trueTerminal{((( | ||
| 834 | |terminalCode|string | ||
| 835 | nullable: true | ||
| 836 | |cityUID|string($uuid) | ||
| 837 | nullable: true | ||
| 838 | |districtUID|string($uuid) | ||
| 839 | nullable: true | ||
| 840 | |terminalName|string | ||
| 841 | nullable: true | ||
| 842 | |countryCode|string | ||
| 843 | nullable: true | ||
| 844 | |note|string | ||
| 845 | nullable: true | ||
| |
1.2 | 846 | |
| 847 | }] | ||
| 848 | ))) | ||
| |
1.3 | 849 | |containsError|boolean |
| 850 | |refreshPriceResult|RefreshPriceResultEnumstringEnum: | ||
| 851 | [ Success, HotelPriceNoMoreAvailable, FlightPriceNoMoreAvailable ] | ||
| 852 | |reservationId|string($uuid) | ||
| 853 | |reservationDetailsUnavailable|boolean | ||
| |
1.2 | 854 | |
| 855 | } | ||
| 856 | {{/success}} | ||
| 857 | |||
| 858 | |||
| |
1.3 | 859 | == Descriptions == |
| |
1.2 | 860 | |
| 861 | |||
| |
1.3 | 862 | === Request === |
| |
1.2 | 863 | |
| |
1.3 | 864 | Here's a table describing each parameter of the JSON request: |
| |
1.2 | 865 | |
| |
1.3 | 866 | (% class="table-bordered" %) |
| 867 | |=Parameter|=Data Type|=Description | ||
| 868 | |calcTourPackageRequests|Array|An array of objects, each representing a tour package request. | ||
| 869 | |refreshPrices|Boolean|If true, the prices for the tour package will be refreshed. | ||
| 870 | |packageId|String|A unique identifier for the tour package. | ||
| 871 | |flightPassengers|Array|An array of objects, each representing a flight passenger. | ||
| 872 | |id|String|A unique identifier for each flight passenger. | ||
| 873 | |selectedForwardBaggageCode|String|The selected baggage option for the forward journey. there is two optoions "" | ||
| 874 | |selectedBackwardBaggageCode|String|The selected baggage option for the backward journey. | ||
| 875 | |extraServicePriceCodes|Array|An array of extra service price codes. If empty, no extra services are selected. | ||
| 876 | |includeInsurance|Boolean|If true, insurance will be included in the tour package. | ||
| 877 | |calcOnlyHotelPackageRequests|Array|An array of objects, each representing a hotel-only package request. If empty, no hotel-only packages are requested. | ||
| 878 | |calcOnlyAviaPackageRequests|Array|An array of objects, each representing an avia-only package request. If empty, no avia-only packages are requested. | ||
| |
1.2 | 879 | |
| |
1.3 | 880 | === Response === |
| |
1.2 | 881 | |
| |
1.3 | 882 | (% class="table-bordered" %) |
| 883 | |=Parameter|=Data Type|=Description | ||
| 884 | |priceCurrency|String|The currency code (ISO 4217) for all prices mentioned in the response. | ||
| 885 | |totalPrice|Number|The total price of the booking. | ||
| 886 | |agentCommissionPercent|Number|The commission percentage for the agent. | ||
| 887 | |agentCommissionAmount|Number|The total commission amount for the agent in priceCurrency. | ||
| 888 | |requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code. | ||
| 889 | |requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN"). **TIN (Taxpayer Identification Number) & FIN (Financial Identification Number)** | ||
| 890 | |hotels[*].hotelPriceId|String|Unique identifier for the hotel price. | ||
| 891 | |hotels[*].touristIds[*]|String|List of tourist IDs that are booked in this hotel. | ||
| 892 | |hotels[*].description|String|A brief description of the hotel. | ||
| 893 | |tourists[*].id|String|Unique identifier for the tourist. | ||
| 894 | |tourists[*].isAdult|Boolean|Indicates if the tourist is an adult. | ||
| 895 | |tourists[*].flightIds[*]|String|Identifiers for flights associated with the tourist. | ||
| 896 | |tourists[*].flights[*].flightId|String|Unique identifier for the flight. | ||
| 897 | |tourists[*].flights[*].note|String|Additional information about the flight, such as baggage allowance. | ||
| 898 | |tourists[*].insurancePrice.insuranceId|String|Unique identifier for the insurance product. | ||
| 899 | |tourists[*].insurancePrice.insuranceServiceId|String|Identifier for the insurance service provider. | ||
| 900 | |...|...|Additional fields for insurancePrice as detailed previously. | ||
| 901 | |tourists[*].transfers[*].id|String|Unique identifier for the transfer service. | ||
| 902 | |tourists[*].transfers[*].type|String|The type of transfer (e.g., "Arrival", "Departure"). | ||
| 903 | |tourists[*].transfers[*].flightId|String|Identifier of the flight associated with this transfer. | ||
| 904 | |tourists[*].transfers[*].checkInHotelId|String|Hotel ID for check-in associated with this transfer (for arrival type). | ||
| 905 | |tourists[*].transfers[*].checkOutHotelId|String|Hotel ID for check-out associated with this transfer (for departure type). | ||
| 906 | |tourists[*].transfers[*].selectedTransferPriceId|String|The ID of the selected pricing option for the transfer. | ||
| 907 | |tourists[*].transfers[*].transferPrices[*].id|String|Unique identifier for the transfer price option. | ||
| 908 | |tourists[*].transfers[*].transferPrices[*].name|String|The name of the transfer service (e.g., "GROUP", "MINIVAN"). | ||
| 909 | |...|...|Additional fields for transferPrices as detailed previously. | ||
| 910 | |visas[*].prid|String|Unique identifier for the visa option. | ||
| 911 | |visas[*].prName|String|The name of the visa option. | ||
| 912 | |visas[*].prValue|Number|The cost associated with this visa option. | ||
| 913 | |visas[*].sortingOrder|Number|Used to sort visa options in the response or UI. | ||
| 914 | |terminals[*].terminalCode|String|The code representing the terminal. | ||
| 915 | |terminals[*].cityUID|String|Unique identifier for the city where the terminal is located. | ||
| 916 | |...|...|Additional fields for terminals as detailed previously. | ||
| 917 | |containsError|Boolean|Indicates if the response contains any errors. | ||
| 918 | |refreshPriceResult|String|The result of attempting to refresh the price (e.g., "Success"). | ||
| 919 | |reservationId|String|Unique identifier for the reservation. | ||
| 920 | |reservationDetailsUnavailable|Boolean|Indicates if the reservation details are currently unavailable. | ||
| 921 | |error|Boolean|A generic error indicator, presumably redundant with containsError. | ||
| |
1.2 | 922 | |
| |
1.3 | 923 |