Skip to Content

Wiki source code of 4. CalcCheckout

Version 9.1 by Giorgi Mdivnishvili on 2024/04/11 13:22
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2
3
4 {{toc/}}
5 {{/box}}
6
7 = Method Description =
8
9
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.
11
12
13 == Endpoint URL - [POST] ==
14
15 {{info}}
16 [[https:~~/~~/integration.kazunion.com/api/Checkout/CalcCheckout>>https://integration.kazunion.com/api/Checkout/CalcCheckout]]
17 {{/info}}
18
19
20 == Request Parameters ==
21
22 (% class="box infomessage" %)
23 (((
24 None
25 )))
26
27
28 == Request Body ==
29
30 {{code language="Json"}}
31 {
32 "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
33 "calcTourPackageRequests": [
34 {
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
48 }
49 ],
50 "calcOnlyHotelPackageRequests": [
51 {
52 "packageId": "string",
53 "extraServicePriceCodes": [
54 "string"
55 ],
56 "includeInsurance": true,
57 "refreshPrices": true
58 }
59 ],
60 "calcOnlyAviaPackageRequests": [
61 {
62 "packageId": "string",
63 "refreshPrices": true,
64 "flightPassengers": [
65 {
66 "id": "string",
67 "selectedForwardBaggageCode": "string",
68 "selectedBackwardBaggageCode": "string"
69 }
70 ]
71 }
72 ],
73 "hotels": [
74 {
75 "hotelPriceId": "string",
76 "agentConfirmationNumber": "string",
77 "note": "string",
78 "touristIds": [
79 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
80 ]
81 }
82 ],
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 }
118 ],
119 "note": "string",
120 "contactPhone": "string"
121 }
122
123 {{/code}}
124
125 (% class="wikigeneratedid" id="HRequestBodyexample" %)
126 (% id="cke_bm_10575S" style="display:none" %)
127
128
129
130 == Request Body example ==
131
132 {{code language="Json"}}
133 {
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 }
177 ],
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 }
188 ],
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 }
265 ],
266 "visas": [
267 {
268 "prid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
269 "prName": "string",
270 "prValue": 0,
271 "sortingOrder": 0
272 }
273 ],
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 }
283 ],
284 "containsError": true,
285 "refreshPriceResult": "Success",
286 "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
287 "reservationDetailsUnavailable": true
288 }
289 {{/code}}
290
291
292 === Response example ===
293
294 {{code language="Json"}}
295 {
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": [
462 {
463 "id": "tour:1d0fa533-4261-4254-93bb-83599d581ffc:193990fa-41a5-46e6-9805-50f82c3c377f:63d79c94-1e19-443f-8a17-50e59e633ea8",
464 "priceCurrency": "USD",
465 "totalPrice": 968.40,
466 "agentCommissionPercent": 0.00,
467 "agentCommissionAmount": 0.00,
468 "includedExtrasAmount": 0,
469 "priceDifference": 31.24,
470 "hotel": {
471 "hotelPriceId": "193990fa-41a5-46e6-9805-50f82c3c377f",
472 "providerId": 13,
473 "hotelName": "Mercure Dubai Barsha Heights Suites Apartments",
474 "hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14",
475 "nigths": 2,
476 "mealPlan": "BB",
477 "hotelClass": "4",
478 "availabilityType": "StopSale",
479 "availableRoomsCount": 0,
480 "fewRooms": true,
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",
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",
494 "hasAlcohol": false,
495 "hasFreeWifi": true,
496 "hasMetro": true,
497 "hasPool": true,
498 "hasMall": false,
499 "cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
500 "cancellationPolicy": {
501 "noShowChargeValue": 100.00,
502 "noShowChargeValueType": "%",
503 "earlyDepartureChargeValue": 100.00,
504 "earlyDepartureChargeValueType": "%",
505 "conditions": [
506 {
507 "timeunits": 5,
508 "timeunitType": "Day",
509 "timeOffsetTypeName": "Before Arrival",
510 "chargeValue": 100.00,
511 "chargeValueType": "%"
512 }
513 ]
514 }
515 },
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 }
634 },
635 {
636 {{/code}}
637
638
639 === Schema ===
640
641 {{success}}
642 |error|boolean
643 |errorCode|string
644 nullable: true
645 |errorDescription|string
646 nullable: true
647 |userErrorDescription|string
648 nullable: true
649 |priceCurrency|string
650 nullable: true
651 |totalPrice|number($double)
652 |agentCommissionPercent|number($double)
653 |agentCommissionAmount|number($double)
654 |requiredCitizenIdentifiers|[
655 nullable: trueCitizenIdentifier{(((
656 |countryCode|[...]
657 |identifierType|IdentifierTypeEnumstringEnum:
658 [ TIN, FIN ]
659
660 }]
661 )))
662 |hotels|[
663 nullable: trueCheckoutHotelOut{(((
664 |hotelPriceId|string
665 nullable: true
666 |touristIds|[
667 nullable: truestring($uuid)]
668 |errorCode|string
669 nullable: true
670 |errorMessage|string
671 nullable: true
672 |description|string
673 nullable: true
674
675 }]
676 )))
677 |tourists|[
678 nullable: trueCheckoutTouristOut{(((
679 |id|[...]
680 |age|[...]
681 |isAdult|[...]
682 |flightIds|[...]
683 |flights|[...]
684 |arrivalFlightInfo|ManualFlightInfo{(((
685 |flightNumber|string
686 nullable: true
687 |terminalCode|string
688 nullable: true
689 |date|string($date-time)
690 nullable: true
691 |time|string
692 nullable: true
693
694 }
695 )))
696 |departureFlightInfo|ManualFlightInfo{(((
697 |flightNumber|string
698 nullable: true
699 |terminalCode|string
700 nullable: true
701 |date|string($date-time)
702 nullable: true
703 |time|string
704 nullable: true
705
706 }
707 )))
708 |insurancePrice|InsurancePriceForTourist{(((
709 |insuranceId|string($uuid)
710 |insuranceServiceId|string($uuid)
711 |insurancePriceId|string($uuid)
712 |touristId|string($uuid)
713 |insuranceName|string
714 nullable: true
715 |insuranceDescription|string
716 nullable: true
717 |contragentName|string
718 nullable: true
719 |contragentFullName|string
720 nullable: true
721 |actualStartDate|string($date-time)
722 |actualEndDate|string($date-time)
723 |costCurrencyCode|string
724 nullable: true
725 |costAmount|number($double)
726 |priceCurrencyCode|string
727 nullable: true
728 |priceAmount|number($double)
729 |coverageCurrencyCode|string
730 nullable: true
731 |coverageAmount|number($double)
732
733 }
734 )))
735 |selectedVisaId|string
736 nullable: true
737 |transfers|[
738 nullable: trueCheckoutTransferOut{(((
739 |id|string
740 nullable: true
741 |type|CheckoutTransferTypeEnumstringEnum:
742 [ Arrival, Departure, HotelToHotel ]
743 |flightId|string
744 nullable: true
745 |flightInfo|ManualFlightInfo{(((
746 |flightNumber|string
747 nullable: true
748 |terminalCode|string
749 nullable: true
750 |date|string($date-time)
751 nullable: true
752 |time|string
753 nullable: true
754
755 }
756 )))
757 |checkInHotelId|string
758 nullable: true
759 |checkOutHotelId|string
760 nullable: true
761 |selectedTransferPriceId|string
762 nullable: true
763 |transferPrices|[
764 nullable: trueCheckoutTransferPrice{(((
765 |id|string
766 nullable: true
767 |name|string
768 nullable: true
769 |adultPlaces|integer($int32)
770 |childPlaces|integer($int32)
771 |perPersonPrice|boolean
772 |adultPrice|number($double)
773 |childPrice|number($double)
774
775 }]
776 )))
777
778 }]
779 )))
780 |errorCode|string
781 nullable: true
782 |errorMessage|string
783 nullable: true
784 |description|string
785 nullable: true
786
787 }]
788 )))
789 |visas|[
790 nullable: trueServicePrice{(((
791 |prid|string($uuid)
792 |prName|string
793 nullable: true
794 |prValue|number($double)
795 |sortingOrder|integer($int32)
796
797 }]
798 )))
799 |terminals|[
800 nullable: trueTerminal{(((
801 |terminalCode|string
802 nullable: true
803 |cityUID|string($uuid)
804 nullable: true
805 |districtUID|string($uuid)
806 nullable: true
807 |terminalName|string
808 nullable: true
809 |countryCode|string
810 nullable: true
811 |note|string
812 nullable: true
813
814 }]
815 )))
816 |containsError|boolean
817 |refreshPriceResult|RefreshPriceResultEnumstringEnum:
818 [ Success, HotelPriceNoMoreAvailable, FlightPriceNoMoreAvailable ]
819 |reservationId|string($uuid)
820 |reservationDetailsUnavailable|boolean
821
822 }
823 {{/success}}
824
825
826 == Descriptions ==
827
828
829 === Request ===
830
831 Here's a table describing each parameter of the JSON request:
832
833 (% class="table-bordered" %)
834 |=Parameter|=Data Type|=Description
835 |calcTourPackageRequests|Array|An array of objects, each representing a tour package request.
836 |refreshPrices|Boolean|If true, the prices for the tour package will be refreshed.
837 |packageId|String|A unique identifier for the tour package.
838 |flightPassengers|Array|An array of objects, each representing a flight passenger.
839 |id|String|A unique identifier for each flight passenger.
840 |selectedForwardBaggageCode|String|The selected baggage option for the forward journey.
841 |selectedBackwardBaggageCode|String|The selected baggage option for the backward journey.
842 |extraServicePriceCodes|Array|An array of extra service price codes. If empty, no extra services are selected.
843 |includeInsurance|Boolean|If true, insurance will be included in the tour package.
844 |calcOnlyHotelPackageRequests|Array|An array of objects, each representing a hotel-only package request. If empty, no hotel-only packages are requested.
845 |calcOnlyAviaPackageRequests|Array|An array of objects, each representing an avia-only package request. If empty, no avia-only packages are requested.
846
847 === Response ===
848
849 (% class="table-bordered" %)
850 |=Parameter|=Data Type|=Description
851 |priceCurrency|String|The currency code (ISO 4217) for all prices mentioned in the response.
852 |totalPrice|Number|The total price of the booking.
853 |agentCommissionPercent|Number|The commission percentage for the agent.
854 |agentCommissionAmount|Number|The total commission amount for the agent in priceCurrency.
855 |requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code.
856 |requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN").
857 |hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
858 |hotels[*].touristIds[*]|String|List of tourist IDs that are booked in this hotel.
859 |hotels[*].description|String|A brief description of the hotel.
860 |tourists[*].id|String|Unique identifier for the tourist.
861 |tourists[*].isAdult|Boolean|Indicates if the tourist is an adult.
862 |tourists[*].flightIds[*]|String|Identifiers for flights associated with the tourist.
863 |tourists[*].flights[*].flightId|String|Unique identifier for the flight.
864 |tourists[*].flights[*].note|String|Additional information about the flight, such as baggage allowance.
865 |tourists[*].insurancePrice.insuranceId|String|Unique identifier for the insurance product.
866 |tourists[*].insurancePrice.insuranceServiceId|String|Identifier for the insurance service provider.
867 |...|...|Additional fields for insurancePrice as detailed previously.
868 |tourists[*].transfers[*].id|String|Unique identifier for the transfer service.
869 |tourists[*].transfers[*].type|String|The type of transfer (e.g., "Arrival", "Departure").
870 |tourists[*].transfers[*].flightId|String|Identifier of the flight associated with this transfer.
871 |tourists[*].transfers[*].checkInHotelId|String|Hotel ID for check-in associated with this transfer (for arrival type).
872 |tourists[*].transfers[*].checkOutHotelId|String|Hotel ID for check-out associated with this transfer (for departure type).
873 |tourists[*].transfers[*].selectedTransferPriceId|String|The ID of the selected pricing option for the transfer.
874 |tourists[*].transfers[*].transferPrices[*].id|String|Unique identifier for the transfer price option.
875 |tourists[*].transfers[*].transferPrices[*].name|String|The name of the transfer service (e.g., "GROUP", "MINIVAN").
876 |...|...|Additional fields for transferPrices as detailed previously.
877 |visas[*].prid|String|Unique identifier for the visa option.
878 |visas[*].prName|String|The name of the visa option.
879 |visas[*].prValue|Number|The cost associated with this visa option.
880 |visas[*].sortingOrder|Number|Used to sort visa options in the response or UI.
881 |terminals[*].terminalCode|String|The code representing the terminal.
882 |terminals[*].cityUID|String|Unique identifier for the city where the terminal is located.
883 |...|...|Additional fields for terminals as detailed previously.
884 |containsError|Boolean|Indicates if the response contains any errors.
885 |refreshPriceResult|String|The result of attempting to refresh the price (e.g., "Success").
886 |reservationId|String|Unique identifier for the reservation.
887 |reservationDetailsUnavailable|Boolean|Indicates if the reservation details are currently unavailable.
888 |error|Boolean|A generic error indicator, presumably redundant with containsError.
889
890