Wiki source code of 4. ConfirmCheckout

Version 2.1 by Giorgi Mdivnishvili on 2024/04/12 19:01

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2
3
4 {{toc/}}
5 {{/box}}
6
7 = Method Description =
8
9
10 This API endpoint serves the purpose of registering a new reservation.
11
12 Upon successfully processing the data retrieved from preceding methods, users can populate the designated parameters in their entirety and proceed to initiate a reservation request.
13
14
15 == Endpoint URL - [POST] ==
16
17 {{info}}
18 [[https:~~/~~/integration.kazunion.com/api/Checkout/ConfirmCheckout>>https://integration.kazunion.com/api/Checkout/ConfirmCheckout]]
19 {{/info}}
20
21
22 == Request Parameters ==
23
24 (% class="box infomessage" %)
25 (((
26 None
27 )))
28
29
30 == Request Body ==
31
32 {{code language="Json"}}
33 {
34 "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
35 "calcTourPackageRequests": [
36 {
37 "packageId": "string",
38 "extraServicePriceCodes": [
39 "string"
40 ],
41 "flightPassengers": [
42 {
43 "id": "string",
44 "selectedForwardBaggageCode": "string",
45 "selectedBackwardBaggageCode": "string"
46 }
47 ],
48 "includeInsurance": true,
49 "refreshPrices": true
50 }
51 ],
52 "calcOnlyHotelPackageRequests": [
53 {
54 "packageId": "string",
55 "extraServicePriceCodes": [
56 "string"
57 ],
58 "includeInsurance": true,
59 "refreshPrices": true
60 }
61 ],
62 "calcOnlyAviaPackageRequests": [
63 {
64 "packageId": "string",
65 "refreshPrices": true,
66 "flightPassengers": [
67 {
68 "id": "string",
69 "selectedForwardBaggageCode": "string",
70 "selectedBackwardBaggageCode": "string"
71 }
72 ]
73 }
74 ],
75 "hotels": [
76 {
77 "hotelPriceId": "string",
78 "agentConfirmationNumber": "string",
79 "note": "string",
80 "touristIds": [
81 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
82 ]
83 }
84 ],
85 "tourists": [
86 {
87 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
88 "firstName": "string",
89 "lastName": "string",
90 "birthDate": "2024-04-11T05:16:08.319Z",
91 "passportNumber": "string",
92 "passportExpiry": "2024-04-11T05:16:08.319Z",
93 "passportIssue": "2024-04-11T05:16:08.319Z",
94 "citizenship": "string",
95 "tin": "string",
96 "isMale": true,
97 "flightIds": [
98 "string"
99 ],
100 "arrivalFlightInfo": {
101 "flightNumber": "string",
102 "terminalCode": "string",
103 "date": "2024-04-11T05:16:08.319Z",
104 "time": "string"
105 },
106 "departureFlightInfo": {
107 "flightNumber": "string",
108 "terminalCode": "string",
109 "date": "2024-04-11T05:16:08.319Z",
110 "time": "string"
111 },
112 "selectedVisaId": "string",
113 "transfers": [
114 {
115 "id": "string",
116 "selectedTransferPriceId": "string"
117 }
118 ]
119 }
120 ],
121 "note": "string",
122 "contactPhone": "string"
123 }
124 {{/code}}
125
126 (% class="wikigeneratedid" id="HRequestBodyexample" %)
127 (% id="cke_bm_10575S" style="display:none" %)
128
129
130
131 == Request Body example ==
132
133 {{code language="Json"}}
134 {
135 "calcTourPackageRequests": [
136 {
137 "refreshPrices": false,
138 "packageId": "tour:7caef71d-25e3-4882-b0db-81e766af2b72:fa7a89d5-1c20-4004-b3d2-f8d08163827f:53552191-59ea-469d-ae9d-5b848da8839d",
139 "flightPassengers": [
140 {
141 "id": "53552191-59ea-469d-ae9d-5b848da8839d-A1",
142 "selectedForwardBaggageCode": "INCLUDED",
143 "selectedBackwardBaggageCode": "INCLUDED"
144 },
145 {
146 "id": "53552191-59ea-469d-ae9d-5b848da8839d-A2",
147 "selectedForwardBaggageCode": "INCLUDED",
148 "selectedBackwardBaggageCode": "INCLUDED"
149 }
150 ],
151 "extraServicePriceCodes": [],
152 "includeInsurance": true
153 }
154 ],
155 "calcOnlyHotelPackageRequests": [],
156 "calcOnlyAviaPackageRequests": [],
157 "hotels": [
158 {
159 "note": null,
160 "agentConfirmationNumber": null,
161 "hotelPriceId": "fa7a89d5-1c20-4004-b3d2-f8d08163827f",
162 "touristIds": [
163 "27977a19-045e-4990-95a8-fbd7d49083de",
164 "0b3cb288-00c5-4c68-946e-87fc5f5d5b82"
165 ]
166 }
167 ],
168 "tourists": [
169 {
170 "id": "27977a19-045e-4990-95a8-fbd7d49083de",
171 "isMale": true,
172 "firstName": "Test",
173 "lastName": "Teeeest",
174 "birthDate": "1990-09-23T00:00:00",
175 "citizenship": "GE",
176 "passportNumber": "123123",
177 "passportIssue": "2020-09-23T00:00:00",
178 "passportExpiry": "2029-12-23T00:00:00",
179 "tin": null,
180 "selectedVisaId": "00000000-0000-0000-0000-000000000000",
181 "flights": [
182 {
183 "flightId": "53552191-59ea-469d-ae9d-5b848da8839d",
184 "note": "Kazunion Block, Baggage Info: 20 Kg Included"
185 }
186 ],
187 "flightIds": [
188 "53552191-59ea-469d-ae9d-5b848da8839d"
189 ],
190 "insurancePrice": {
191 "insuranceId": "5bd59c71-e465-45da-a9ff-fe6a90678aef",
192 "insuranceServiceId": "6ecadb9f-7327-4354-9ddc-45d39470c5ac",
193 "insurancePriceId": "c4fe2c52-bd39-45a5-ab50-46ef00292f3c",
194 "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
195 "insuranceName": "Medical INS (N10000)",
196 "contragentName": "Nomad Insurance",
197 "contragentFullName": "Nomad Insurance",
198 "actualStartDate": "2024-05-17T00:00:00.000",
199 "actualEndDate": "2024-05-21T00:00:00.000",
200 "costCurrencyCode": "USD",
201 "costAmount": 6.7,
202 "priceCurrencyCode": "USD",
203 "priceAmount": 11.2,
204 "coverageCurrencyCode": "USD",
205 "coverageAmount": 10000
206 },
207 "departureFlightInfo": {
208 "date": null,
209 "time": null,
210 "flightNumber": null,
211 "terminalCode": null
212 },
213 "arrivalFlightInfo": {
214 "date": null,
215 "time": null,
216 "flightNumber": null,
217 "terminalCode": null
218 },
219 "transfers": [
220 {
221 "id": "DXB-3df91d4d-a89d-4b73-8076-baa8f8b230cf",
222 "selectedTransferPriceId": "a9252005-0a92-4ed1-9603-0f2f14295c29"
223 },
224 {
225 "id": "3df91d4d-a89d-4b73-8076-baa8f8b230cf-DXB",
226 "selectedTransferPriceId": "a9252005-0a92-4ed1-9603-0f2f14295c29"
227 }
228 ]
229 },
230 {
231 "id": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
232 "isMale": true,
233 "firstName": "Teeeeest",
234 "lastName": "Teest",
235 "birthDate": "1990-09-23T00:00:00",
236 "citizenship": "GE",
237 "passportNumber": "1231233",
238 "passportIssue": "2020-09-23T00:00:00",
239 "passportExpiry": "2029-12-23T00:00:00",
240 "tin": null,
241 "selectedVisaId": "00000000-0000-0000-0000-000000000000",
242 "flights": [
243 {
244 "flightId": "53552191-59ea-469d-ae9d-5b848da8839d",
245 "note": "Kazunion Block, Baggage Info: 20 Kg Included"
246 }
247 ],
248 "flightIds": [
249 "53552191-59ea-469d-ae9d-5b848da8839d"
250 ],
251 "insurancePrice": {
252 "insuranceId": "5bd59c71-e465-45da-a9ff-fe6a90678aef",
253 "insuranceServiceId": "6ecadb9f-7327-4354-9ddc-45d39470c5ac",
254 "insurancePriceId": "c4fe2c52-bd39-45a5-ab50-46ef00292f3c",
255 "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
256 "insuranceName": "Medical INS (N10000)",
257 "contragentName": "Nomad Insurance",
258 "contragentFullName": "Nomad Insurance",
259 "actualStartDate": "2024-05-17T00:00:00.000",
260 "actualEndDate": "2024-05-21T00:00:00.000",
261 "costCurrencyCode": "USD",
262 "costAmount": 6.7,
263 "priceCurrencyCode": "USD",
264 "priceAmount": 11.2,
265 "coverageCurrencyCode": "USD",
266 "coverageAmount": 10000
267 },
268 "departureFlightInfo": {
269 "date": null,
270 "time": null,
271 "flightNumber": null,
272 "terminalCode": null
273 },
274 "arrivalFlightInfo": {
275 "date": null,
276 "time": null,
277 "flightNumber": null,
278 "terminalCode": null
279 },
280 "transfers": [
281 {
282 "id": "DXB-3df91d4d-a89d-4b73-8076-baa8f8b230cf",
283 "selectedTransferPriceId": "a9252005-0a92-4ed1-9603-0f2f14295c29"
284 },
285 {
286 "id": "3df91d4d-a89d-4b73-8076-baa8f8b230cf-DXB",
287 "selectedTransferPriceId": "a9252005-0a92-4ed1-9603-0f2f14295c29"
288 }
289 ]
290 }
291 ],
292 "note": "teeeest, for testing purpose !",
293 "contactPhone": "597101803",
294 "reservationId": "3882a7ee-fec1-4bd3-9e73-ccc4613be36d"
295 }
296 {{/code}}
297
298
299 == Response ==
300
301 {{code language="json"}}
302 {
303 "error": true,
304 "errorCode": "string",
305 "errorDescription": "string",
306 "userErrorDescription": "string",
307 "priceCurrency": "string",
308 "totalPrice": 0,
309 "agentCommissionPercent": 0,
310 "agentCommissionAmount": 0,
311 "requiredCitizenIdentifiers": [
312 {
313 "countryCode": "string",
314 "identifierType": "TIN"
315 }
316 ],
317 "hotels": [
318 {
319 "hotelPriceId": "string",
320 "touristIds": [
321 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
322 ],
323 "errorCode": "string",
324 "errorMessage": "string",
325 "description": "string"
326 }
327 ],
328 "tourists": [
329 {
330 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
331 "age": 0,
332 "isAdult": true,
333 "flightIds": [
334 "string"
335 ],
336 "flights": [
337 {
338 "flightId": "string",
339 "note": "string"
340 }
341 ],
342 "arrivalFlightInfo": {
343 "flightNumber": "string",
344 "terminalCode": "string",
345 "date": "2024-04-11T05:16:08.335Z",
346 "time": "string"
347 },
348 "departureFlightInfo": {
349 "flightNumber": "string",
350 "terminalCode": "string",
351 "date": "2024-04-11T05:16:08.335Z",
352 "time": "string"
353 },
354 "insurancePrice": {
355 "insuranceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
356 "insuranceServiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 "insurancePriceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
358 "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
359 "insuranceName": "string",
360 "insuranceDescription": "string",
361 "contragentName": "string",
362 "contragentFullName": "string",
363 "actualStartDate": "2024-04-11T05:16:08.335Z",
364 "actualEndDate": "2024-04-11T05:16:08.335Z",
365 "costCurrencyCode": "string",
366 "costAmount": 0,
367 "priceCurrencyCode": "string",
368 "priceAmount": 0,
369 "coverageCurrencyCode": "string",
370 "coverageAmount": 0
371 },
372 "selectedVisaId": "string",
373 "transfers": [
374 {
375 "id": "string",
376 "type": "Arrival",
377 "flightId": "string",
378 "flightInfo": {
379 "flightNumber": "string",
380 "terminalCode": "string",
381 "date": "2024-04-11T05:16:08.335Z",
382 "time": "string"
383 },
384 "checkInHotelId": "string",
385 "checkOutHotelId": "string",
386 "selectedTransferPriceId": "string",
387 "transferPrices": [
388 {
389 "id": "string",
390 "name": "string",
391 "adultPlaces": 0,
392 "childPlaces": 0,
393 "perPersonPrice": true,
394 "adultPrice": 0,
395 "childPrice": 0
396 }
397 ]
398 }
399 ],
400 "errorCode": "string",
401 "errorMessage": "string",
402 "description": "string"
403 }
404 ],
405 "visas": [
406 {
407 "prid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
408 "prName": "string",
409 "prValue": 0,
410 "sortingOrder": 0
411 }
412 ],
413 "terminals": [
414 {
415 "terminalCode": "string",
416 "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
417 "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
418 "terminalName": "string",
419 "countryCode": "string",
420 "note": "string"
421 }
422 ],
423 "containsError": true,
424 "refreshPriceResult": "Success",
425 "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
426 "reservationDetailsUnavailable": true
427 }
428 {{/code}}
429
430
431 === Response example ===
432
433 {{code language="Json"}}
434 {
435 "priceCurrency": "USD",
436 "totalPrice": 782,
437 "agentCommissionPercent": 0.00,
438 "agentCommissionAmount": 0,
439 "requiredCitizenIdentifiers": [
440 {
441 "countryCode": "KZ",
442 "identifierType": "TIN"
443 },
444 {
445 "countryCode": "AZ",
446 "identifierType": "FIN"
447 }
448 ],
449 "hotels": [
450 {
451 "hotelPriceId": "fa7a89d5-1c20-4004-b3d2-f8d08163827f",
452 "touristIds": [
453 "27977a19-045e-4990-95a8-fbd7d49083de",
454 "0b3cb288-00c5-4c68-946e-87fc5f5d5b82"
455 ],
456 "description": "Ibis Al Rigga"
457 }
458 ],
459 "tourists": [
460 {
461 "id": "27977a19-045e-4990-95a8-fbd7d49083de",
462 "age": 33,
463 "isAdult": true,
464 "flightIds": [
465 "53552191-59ea-469d-ae9d-5b848da8839d"
466 ],
467 "flights": [
468 {
469 "flightId": "53552191-59ea-469d-ae9d-5b848da8839d",
470 "note": "Kazunion Block, Baggage Info: 20 Kg Included"
471 }
472 ],
473 "insurancePrice": {
474 "insuranceId": "5bd59c71-e465-45da-a9ff-fe6a90678aef",
475 "insuranceServiceId": "6ecadb9f-7327-4354-9ddc-45d39470c5ac",
476 "insurancePriceId": "c4fe2c52-bd39-45a5-ab50-46ef00292f3c",
477 "touristId": "27977a19-045e-4990-95a8-fbd7d49083de",
478 "insuranceName": "Medical INS (N10000)",
479 "contragentName": "Nomad Insurance",
480 "contragentFullName": "Nomad Insurance",
481 "actualStartDate": "2024-05-17T00:00:00.000",
482 "actualEndDate": "2024-05-21T00:00:00.000",
483 "costCurrencyCode": "USD",
484 "costAmount": 6.70,
485 "priceCurrencyCode": "USD",
486 "priceAmount": 11.20,
487 "coverageCurrencyCode": "USD",
488 "coverageAmount": 10000.0000
489 },
490 "selectedVisaId": "00000000-0000-0000-0000-000000000000",
491 "transfers": [
492 {
493 "id": "DXB-3df91d4d-a89d-4b73-8076-baa8f8b230cf",
494 "type": "Arrival",
495 "flightId": "53552191-59ea-469d-ae9d-5b848da8839d",
496 "checkInHotelId": "fa7a89d5-1c20-4004-b3d2-f8d08163827f",
497 "selectedTransferPriceId": "a9252005-0a92-4ed1-9603-0f2f14295c29",
498 "transferPrices": [
499 {
500 "id": "a9252005-0a92-4ed1-9603-0f2f14295c29",
501 "name": "GROUP",
502 "adultPlaces": 1,
503 "childPlaces": 1,
504 "perPersonPrice": true,
505 "adultPrice": 0,
506 "childPrice": 0
507 },
508 {
509 "id": "9bc3625d-017e-4e72-a4bc-b1e57dc2a146",
510 "name": "MINIVAN",
511 "adultPlaces": 5,
512 "childPlaces": 0,
513 "perPersonPrice": false,
514 "adultPrice": 45.00000000,
515 "childPrice": 0
516 },
517 {
518 "id": "fc3815bb-af00-4733-9134-4b6334ce3854",
519 "name": "TOYOTA HIACE",
520 "adultPlaces": 9,
521 "childPlaces": 0,
522 "perPersonPrice": false,
523 "adultPrice": 50.00000000,
524 "childPrice": 0
525 },
526 {
527 "id": "1df09212-11e3-44b1-b615-fbb6338efaf2",
528 "name": "HIGER BUS (27 SEATERS)",
529 "adultPlaces": 27,
530 "childPlaces": 0,
531 "perPersonPrice": false,
532 "adultPrice": 85.00000000,
533 "childPrice": 0
534 },
535 {
536 "id": "bd26e2cf-15ed-41c0-8e6f-743834b12dfb",
537 "name": "HIGER 53",
538 "adultPlaces": 51,
539 "childPlaces": 0,
540 "perPersonPrice": false,
541 "adultPrice": 120.00000000,
542 "childPrice": 0
543 },
544 {
545 "id": "5d67ad4f-5e8a-4dd2-abc0-74e5389e8c04",
546 "name": "MERCEDES S CLASS 400",
547 "adultPlaces": 3,
548 "childPlaces": 0,
549 "perPersonPrice": false,
550 "adultPrice": 140.00000000,
551 "childPrice": 0
552 },
553 {
554 "id": "f6fe44b2-574d-47b5-a15c-b0560cfc71a6",
555 "name": "MERCEDES V CLASS",
556 "adultPlaces": 7,
557 "childPlaces": 0,
558 "perPersonPrice": false,
559 "adultPrice": 140.00000000,
560 "childPrice": 0
561 },
562 {
563 "id": "50cf907a-2145-4b46-bb67-0dde2e7b7326",
564 "name": "MERCEDES S CLASS 500",
565 "adultPlaces": 3,
566 "childPlaces": 0,
567 "perPersonPrice": false,
568 "adultPrice": 165.00000000,
569 "childPrice": 0
570 }
571 ]
572 },
573 {
574 "id": "3df91d4d-a89d-4b73-8076-baa8f8b230cf-DXB",
575 "type": "Departure",
576 "flightId": "53552191-59ea-469d-ae9d-5b848da8839d",
577 "checkOutHotelId": "fa7a89d5-1c20-4004-b3d2-f8d08163827f",
578 "selectedTransferPriceId": "a9252005-0a92-4ed1-9603-0f2f14295c29",
579 "transferPrices": [
580 {
581 "id": "a9252005-0a92-4ed1-9603-0f2f14295c29",
582 "name": "GROUP",
583 "adultPlaces": 1,
584 "childPlaces": 1,
585 "perPersonPrice": true,
586 "adultPrice": 0,
587 "childPrice": 0
588 },
589 {
590 "id": "9bc3625d-017e-4e72-a4bc-b1e57dc2a146",
591 "name": "MINIVAN",
592 "adultPlaces": 5,
593 "childPlaces": 0,
594 "perPersonPrice": false,
595 "adultPrice": 45.00000000,
596 "childPrice": 0
597 },
598 {
599 "id": "fc3815bb-af00-4733-9134-4b6334ce3854",
600 "name": "TOYOTA HIACE",
601 "adultPlaces": 9,
602 "childPlaces": 0,
603 "perPersonPrice": false,
604 "adultPrice": 50.00000000,
605 "childPrice": 0
606 },
607 {
608 "id": "1df09212-11e3-44b1-b615-fbb6338efaf2",
609 "name": "HIGER BUS (27 SEATERS)",
610 "adultPlaces": 27,
611 "childPlaces": 0,
612 "perPersonPrice": false,
613 "adultPrice": 85.00000000,
614 "childPrice": 0
615 },
616 {
617 "id": "bd26e2cf-15ed-41c0-8e6f-743834b12dfb",
618 "name": "HIGER 53",
619 "adultPlaces": 51,
620 "childPlaces": 0,
621 "perPersonPrice": false,
622 "adultPrice": 120.00000000,
623 "childPrice": 0
624 },
625 {
626 "id": "5d67ad4f-5e8a-4dd2-abc0-74e5389e8c04",
627 "name": "MERCEDES S CLASS 400",
628 "adultPlaces": 3,
629 "childPlaces": 0,
630 "perPersonPrice": false,
631 "adultPrice": 140.00000000,
632 "childPrice": 0
633 },
634 {
635 "id": "f6fe44b2-574d-47b5-a15c-b0560cfc71a6",
636 "name": "MERCEDES V CLASS",
637 "adultPlaces": 7,
638 "childPlaces": 0,
639 "perPersonPrice": false,
640 "adultPrice": 140.00000000,
641 "childPrice": 0
642 },
643 {
644 "id": "50cf907a-2145-4b46-bb67-0dde2e7b7326",
645 "name": "MERCEDES S CLASS 500",
646 "adultPlaces": 3,
647 "childPlaces": 0,
648 "perPersonPrice": false,
649 "adultPrice": 165.00000000,
650 "childPrice": 0
651 }
652 ]
653 }
654 ],
655 "description": "Test Teeeest"
656 },
657 {
658 "id": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
659 "age": 33,
660 "isAdult": true,
661 "flightIds": [
662 "53552191-59ea-469d-ae9d-5b848da8839d"
663 ],
664 "flights": [
665 {
666 "flightId": "53552191-59ea-469d-ae9d-5b848da8839d",
667 "note": "Kazunion Block, Baggage Info: 20 Kg Included"
668 }
669 ],
670 "insurancePrice": {
671 "insuranceId": "5bd59c71-e465-45da-a9ff-fe6a90678aef",
672 "insuranceServiceId": "6ecadb9f-7327-4354-9ddc-45d39470c5ac",
673 "insurancePriceId": "c4fe2c52-bd39-45a5-ab50-46ef00292f3c",
674 "touristId": "0b3cb288-00c5-4c68-946e-87fc5f5d5b82",
675 "insuranceName": "Medical INS (N10000)",
676 "contragentName": "Nomad Insurance",
677 "contragentFullName": "Nomad Insurance",
678 "actualStartDate": "2024-05-17T00:00:00.000",
679 "actualEndDate": "2024-05-21T00:00:00.000",
680 "costCurrencyCode": "USD",
681 "costAmount": 6.70,
682 "priceCurrencyCode": "USD",
683 "priceAmount": 11.20,
684 "coverageCurrencyCode": "USD",
685 "coverageAmount": 10000.0000
686 },
687 "selectedVisaId": "00000000-0000-0000-0000-000000000000",
688 "transfers": [
689 {
690 "id": "DXB-3df91d4d-a89d-4b73-8076-baa8f8b230cf",
691 "type": "Arrival",
692 "flightId": "53552191-59ea-469d-ae9d-5b848da8839d",
693 "checkInHotelId": "fa7a89d5-1c20-4004-b3d2-f8d08163827f",
694 "selectedTransferPriceId": "a9252005-0a92-4ed1-9603-0f2f14295c29",
695 "transferPrices": [
696 {
697 "id": "a9252005-0a92-4ed1-9603-0f2f14295c29",
698 "name": "GROUP",
699 "adultPlaces": 1,
700 "childPlaces": 1,
701 "perPersonPrice": true,
702 "adultPrice": 0,
703 "childPrice": 0
704 },
705 {
706 "id": "9bc3625d-017e-4e72-a4bc-b1e57dc2a146",
707 "name": "MINIVAN",
708 "adultPlaces": 5,
709 "childPlaces": 0,
710 "perPersonPrice": false,
711 "adultPrice": 45.00000000,
712 "childPrice": 0
713 },
714 {
715 "id": "fc3815bb-af00-4733-9134-4b6334ce3854",
716 "name": "TOYOTA HIACE",
717 "adultPlaces": 9,
718 "childPlaces": 0,
719 "perPersonPrice": false,
720 "adultPrice": 50.00000000,
721 "childPrice": 0
722 },
723 {
724 "id": "1df09212-11e3-44b1-b615-fbb6338efaf2",
725 "name": "HIGER BUS (27 SEATERS)",
726 "adultPlaces": 27,
727 "childPlaces": 0,
728 "perPersonPrice": false,
729 "adultPrice": 85.00000000,
730 "childPrice": 0
731 },
732 {
733 "id": "bd26e2cf-15ed-41c0-8e6f-743834b12dfb",
734 "name": "HIGER 53",
735 "adultPlaces": 51,
736 "childPlaces": 0,
737 "perPersonPrice": false,
738 "adultPrice": 120.00000000,
739 "childPrice": 0
740 },
741 {
742 "id": "5d67ad4f-5e8a-4dd2-abc0-74e5389e8c04",
743 "name": "MERCEDES S CLASS 400",
744 "adultPlaces": 3,
745 "childPlaces": 0,
746 "perPersonPrice": false,
747 "adultPrice": 140.00000000,
748 "childPrice": 0
749 },
750 {
751 "id": "f6fe44b2-574d-47b5-a15c-b0560cfc71a6",
752 "name": "MERCEDES V CLASS",
753 "adultPlaces": 7,
754 "childPlaces": 0,
755 "perPersonPrice": false,
756 "adultPrice": 140.00000000,
757 "childPrice": 0
758 },
759 {
760 "id": "50cf907a-2145-4b46-bb67-0dde2e7b7326",
761 "name": "MERCEDES S CLASS 500",
762 "adultPlaces": 3,
763 "childPlaces": 0,
764 "perPersonPrice": false,
765 "adultPrice": 165.00000000,
766 "childPrice": 0
767 }
768 ]
769 },
770 {
771 "id": "3df91d4d-a89d-4b73-8076-baa8f8b230cf-DXB",
772 "type": "Departure",
773 "flightId": "53552191-59ea-469d-ae9d-5b848da8839d",
774 "checkOutHotelId": "fa7a89d5-1c20-4004-b3d2-f8d08163827f",
775 "selectedTransferPriceId": "a9252005-0a92-4ed1-9603-0f2f14295c29",
776 "transferPrices": [
777 {
778 "id": "a9252005-0a92-4ed1-9603-0f2f14295c29",
779 "name": "GROUP",
780 "adultPlaces": 1,
781 "childPlaces": 1,
782 "perPersonPrice": true,
783 "adultPrice": 0,
784 "childPrice": 0
785 },
786 {
787 "id": "9bc3625d-017e-4e72-a4bc-b1e57dc2a146",
788 "name": "MINIVAN",
789 "adultPlaces": 5,
790 "childPlaces": 0,
791 "perPersonPrice": false,
792 "adultPrice": 45.00000000,
793 "childPrice": 0
794 },
795 {
796 "id": "fc3815bb-af00-4733-9134-4b6334ce3854",
797 "name": "TOYOTA HIACE",
798 "adultPlaces": 9,
799 "childPlaces": 0,
800 "perPersonPrice": false,
801 "adultPrice": 50.00000000,
802 "childPrice": 0
803 },
804 {
805 "id": "1df09212-11e3-44b1-b615-fbb6338efaf2",
806 "name": "HIGER BUS (27 SEATERS)",
807 "adultPlaces": 27,
808 "childPlaces": 0,
809 "perPersonPrice": false,
810 "adultPrice": 85.00000000,
811 "childPrice": 0
812 },
813 {
814 "id": "bd26e2cf-15ed-41c0-8e6f-743834b12dfb",
815 "name": "HIGER 53",
816 "adultPlaces": 51,
817 "childPlaces": 0,
818 "perPersonPrice": false,
819 "adultPrice": 120.00000000,
820 "childPrice": 0
821 },
822 {
823 "id": "5d67ad4f-5e8a-4dd2-abc0-74e5389e8c04",
824 "name": "MERCEDES S CLASS 400",
825 "adultPlaces": 3,
826 "childPlaces": 0,
827 "perPersonPrice": false,
828 "adultPrice": 140.00000000,
829 "childPrice": 0
830 },
831 {
832 "id": "f6fe44b2-574d-47b5-a15c-b0560cfc71a6",
833 "name": "MERCEDES V CLASS",
834 "adultPlaces": 7,
835 "childPlaces": 0,
836 "perPersonPrice": false,
837 "adultPrice": 140.00000000,
838 "childPrice": 0
839 },
840 {
841 "id": "50cf907a-2145-4b46-bb67-0dde2e7b7326",
842 "name": "MERCEDES S CLASS 500",
843 "adultPlaces": 3,
844 "childPlaces": 0,
845 "perPersonPrice": false,
846 "adultPrice": 165.00000000,
847 "childPrice": 0
848 }
849 ]
850 }
851 ],
852 "description": "Teeeeest Teest"
853 }
854 ],
855 "visas": [
856 {
857 "prid": "00000000-0000-0000-0000-000000000000",
858 "prName": "WITHOUT VISA",
859 "prValue": 0.00000000,
860 "sortingOrder": 4
861 },
862 {
863 "prid": "40d3b511-c5b3-4395-b51f-11fb1b8e555b",
864 "prName": "TOURIST VISA",
865 "prValue": 80.01000000,
866 "sortingOrder": 2
867 },
868 {
869 "prid": "80490edd-a7ef-43dc-98cf-3f709efe68cb",
870 "prName": "SERVICE VISA",
871 "prValue": 120.08000000,
872 "sortingOrder": 3
873 }
874 ],
875 "terminals": [
876 {
877 "terminalCode": "DXB2",
878 "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
879 "districtUID": "e6ce358e-22d4-413f-a39f-983a14a8e28e",
880 "terminalName": "DXB2",
881 "countryCode": "AE"
882 },
883 {
884 "terminalCode": "DXB3",
885 "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
886 "districtUID": "e6ce358e-22d4-413f-a39f-983a14a8e28e",
887 "terminalName": "DXB3",
888 "countryCode": "AE"
889 },
890 {
891 "terminalCode": "ETD",
892 "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
893 "districtUID": "1fa8bb75-707b-40e6-8212-f705eeeaa16b",
894 "terminalName": "Etihad Main Office Dubai",
895 "countryCode": "AE",
896 "note": "Noor Islamic Bank MS"
897 },
898 {
899 "terminalCode": "XGD",
900 "cityUID": "28c794fe-3c7e-4da2-ba93-f24bd3d4730d",
901 "districtUID": "88ece1b0-cb91-49f3-86a0-eedc6c8e5aaf",
902 "terminalName": "Dnata - Clock Tower",
903 "countryCode": "AE"
904 },
905 {
906 "terminalCode": "Etihad Bus Station",
907 "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
908 "districtUID": "1fa8bb75-707b-40e6-8212-f705eeeaa16b",
909 "terminalName": "Etihad Bus Station",
910 "countryCode": "AE"
911 },
912 {
913 "terminalCode": "DXB1",
914 "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
915 "districtUID": "e6ce358e-22d4-413f-a39f-983a14a8e28e",
916 "terminalName": "DXB1",
917 "countryCode": "AE"
918 },
919 {
920 "terminalCode": "DWC",
921 "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
922 "districtUID": "42ace7f3-c109-4e81-8959-9c5adf193444",
923 "terminalName": "DWC",
924 "countryCode": "AE",
925 "note": "Al Maktoum intl. airport"
926 },
927 {
928 "terminalCode": "DXB",
929 "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
930 "districtUID": "e6ce358e-22d4-413f-a39f-983a14a8e28e",
931 "terminalName": "DXB",
932 "countryCode": "AE"
933 },
934 {
935 "terminalCode": "SHJ",
936 "cityUID": "f78ac3bc-f040-46d0-8319-2c52083080a6",
937 "districtUID": "18a915ca-74de-4613-a2fb-616ea300d16d",
938 "terminalName": "SHJ",
939 "countryCode": "AE"
940 },
941 {
942 "terminalCode": "AUH",
943 "cityUID": "28c794fe-3c7e-4da2-ba93-f24bd3d4730d",
944 "districtUID": "5460739a-fb6e-4d94-a35b-6f4e0612581b",
945 "terminalName": "AUH",
946 "countryCode": "AE"
947 },
948 {
949 "terminalCode": "QIW",
950 "cityUID": "9aabae22-f2f8-408c-b295-55cce1393c88",
951 "districtUID": "9834149a-17ef-431e-b1f2-ab093bd55d94",
952 "terminalName": "Um Al Quwain Terminal ",
953 "countryCode": "AE"
954 },
955 {
956 "terminalCode": "AUH3",
957 "cityUID": "28c794fe-3c7e-4da2-ba93-f24bd3d4730d",
958 "districtUID": "5460739a-fb6e-4d94-a35b-6f4e0612581b",
959 "terminalName": "AUH3",
960 "countryCode": "AE"
961 },
962 {
963 "terminalCode": "QAJ",
964 "cityUID": "a7e023c1-c654-4e1d-8a83-7e571bd3a78d",
965 "districtUID": "70e57708-9de2-4505-b550-f4627ae40877",
966 "terminalName": "Ajman Terminal ",
967 "countryCode": "AE"
968 },
969 {
970 "terminalCode": "RKT",
971 "cityUID": "607fbe3a-68e6-4523-bf6e-e419fac86a8b",
972 "districtUID": "7f82fcc7-65ee-48d8-b0ea-200fa2ffdb42",
973 "terminalName": "Ras Al Khaimah Terminal ",
974 "countryCode": "AE"
975 },
976 {
977 "terminalCode": "FJR",
978 "cityUID": "857a6d87-d1e4-4a17-a867-c65307559222",
979 "districtUID": "3a894ed3-8021-45c9-ae0c-aa5e7379bb82",
980 "terminalName": "Fujairah Terminal ",
981 "countryCode": "AE"
982 }
983 ],
984 "containsError": false,
985 "refreshPriceResult": "Success",
986 "reservationId": "3882a7ee-fec1-4bd3-9e73-ccc4613be36d",
987 "reservationDetailsUnavailable": false,
988 "error": false
989 }
990 {{/code}}
991
992
993 === Schema ===
994
995 {{success}}
996 CheckoutFormOut{
997
998 |error|boolean
999 |errorCode|string
1000 nullable: true
1001 |errorDescription|string
1002 nullable: true
1003 |userErrorDescription|string
1004 nullable: true
1005 |priceCurrency|string
1006 nullable: true
1007 |totalPrice|number($double)
1008 |agentCommissionPercent|number($double)
1009 |agentCommissionAmount|number($double)
1010 |requiredCitizenIdentifiers|[
1011 nullable: trueCitizenIdentifier{(((
1012 |countryCode|string
1013 nullable: true
1014 |identifierType|IdentifierTypeEnumstringEnum:
1015 [ TIN, FIN ]
1016
1017 }]
1018 )))
1019 |hotels|[
1020 nullable: trueCheckoutHotelOut{(((
1021 |hotelPriceId|string
1022 nullable: true
1023 |touristIds|[
1024 nullable: truestring($uuid)]
1025 |errorCode|string
1026 nullable: true
1027 |errorMessage|string
1028 nullable: true
1029 |description|string
1030 nullable: true
1031
1032 }]
1033 )))
1034 |tourists|[
1035 nullable: trueCheckoutTouristOut{(((
1036 |id|string($uuid)
1037 |age|integer($int32)
1038 nullable: true
1039 |isAdult|boolean
1040 |flightIds|[
1041 nullable: truestring]
1042 |flights|[
1043 nullable: trueCheckoutFlightOut{(((
1044 |flightId|string
1045 nullable: true
1046 |note|string
1047 nullable: true
1048
1049 }]
1050 )))
1051 |arrivalFlightInfo|ManualFlightInfo{(((
1052 |flightNumber|string
1053 nullable: true
1054 |terminalCode|string
1055 nullable: true
1056 |date|string($date-time)
1057 nullable: true
1058 |time|string
1059 nullable: true
1060
1061 }
1062 )))
1063 |departureFlightInfo|ManualFlightInfo{(((
1064 |flightNumber|string
1065 nullable: true
1066 |terminalCode|string
1067 nullable: true
1068 |date|string($date-time)
1069 nullable: true
1070 |time|string
1071 nullable: true
1072
1073 }
1074 )))
1075 |insurancePrice|InsurancePriceForTourist{(((
1076 |insuranceId|string($uuid)
1077 |insuranceServiceId|string($uuid)
1078 |insurancePriceId|string($uuid)
1079 |touristId|string($uuid)
1080 |insuranceName|string
1081 nullable: true
1082 |insuranceDescription|string
1083 nullable: true
1084 |contragentName|string
1085 nullable: true
1086 |contragentFullName|string
1087 nullable: true
1088 |actualStartDate|string($date-time)
1089 |actualEndDate|string($date-time)
1090 |costCurrencyCode|string
1091 nullable: true
1092 |costAmount|number($double)
1093 |priceCurrencyCode|string
1094 nullable: true
1095 |priceAmount|number($double)
1096 |coverageCurrencyCode|string
1097 nullable: true
1098 |coverageAmount|number($double)
1099
1100 }
1101 )))
1102 |selectedVisaId|string
1103 nullable: true
1104 |transfers|[
1105 nullable: trueCheckoutTransferOut{(((
1106 |id|string
1107 nullable: true
1108 |type|CheckoutTransferTypeEnumstringEnum:
1109 [ Arrival, Departure, HotelToHotel ]
1110 |flightId|string
1111 nullable: true
1112 |flightInfo|ManualFlightInfo{(((
1113 |flightNumber|string
1114 nullable: true
1115 |terminalCode|string
1116 nullable: true
1117 |date|string($date-time)
1118 nullable: true
1119 |time|string
1120 nullable: true
1121
1122 }
1123 )))
1124 |checkInHotelId|string
1125 nullable: true
1126 |checkOutHotelId|string
1127 nullable: true
1128 |selectedTransferPriceId|string
1129 nullable: true
1130 |transferPrices|[
1131 nullable: trueCheckoutTransferPrice{(((
1132 |id|string
1133 nullable: true
1134 |name|string
1135 nullable: true
1136 |adultPlaces|integer($int32)
1137 |childPlaces|integer($int32)
1138 |perPersonPrice|boolean
1139 |adultPrice|number($double)
1140 |childPrice|number($double)
1141
1142 }]
1143 )))
1144
1145 }]
1146 )))
1147 |errorCode|string
1148 nullable: true
1149 |errorMessage|string
1150 nullable: true
1151 |description|string
1152 nullable: true
1153
1154 }]
1155 )))
1156 |visas|[
1157 nullable: trueServicePrice{(((
1158 |prid|string($uuid)
1159 |prName|string
1160 nullable: true
1161 |prValue|number($double)
1162 |sortingOrder|integer($int32)
1163
1164 }]
1165 )))
1166 |terminals|[
1167 nullable: trueTerminal{(((
1168 |terminalCode|string
1169 nullable: true
1170 |cityUID|string($uuid)
1171 nullable: true
1172 |districtUID|string($uuid)
1173 nullable: true
1174 |terminalName|string
1175 nullable: true
1176 |countryCode|string
1177 nullable: true
1178 |note|string
1179 nullable: true
1180
1181 }]
1182 )))
1183 |containsError|boolean
1184 |refreshPriceResult|RefreshPriceResultEnumstringEnum:
1185 [ Success, HotelPriceNoMoreAvailable, FlightPriceNoMoreAvailable ]
1186 |reservationId|string($uuid)
1187 |reservationDetailsUnavailable|boolean
1188
1189 }
1190 {{/success}}
1191
1192
1193
1194 == Description ==
1195
1196
1197 === Request ===
1198
1199 (% class="table-bordered" %)
1200 |=Field Path|=Data Type|=Description
1201 |calcTourPackageRequests[*].refreshPrices|Boolean|Indicates whether to refresh the prices for the tour package.
1202 |calcTourPackageRequests[*].packageId|String|Unique identifier for the tour package.
1203 |calcTourPackageRequests[*].flightPassengers[*].id|String|Unique identifier for a flight passenger within the package.
1204 |calcTourPackageRequests[*].flightPassengers[*].selectedForwardBaggageCode|String|Code indicating the baggage option selected for the forward journey.
1205 |calcTourPackageRequests[*].flightPassengers[*].selectedBackwardBaggageCode|String|Code indicating the baggage option selected for the return journey.
1206 |calcTourPackageRequests[*].extraServicePriceCodes|Array|An array of codes for extra services priced within the package.
1207 |calcTourPackageRequests[*].includeInsurance|Boolean|Indicates if insurance is included in the tour package.
1208 |calcOnlyHotelPackageRequests|Array|Details about hotel-only package requests, if applicable.
1209 |calcOnlyAviaPackageRequests|Array|Details about avia-only package requests, if applicable.
1210 |hotels[*].note|String|Additional notes regarding the hotel booking.
1211 |hotels[*].agentConfirmationNumber|String|Confirmation number provided by the agent for the hotel booking.
1212 |hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
1213 |hotels[*].touristIds[*]|String|List of IDs for tourists staying at the hotel.
1214 |tourists[*].id|String|Unique identifier for the tourist.
1215 |tourists[*].isMale|Boolean|Indicates if the tourist is male.
1216 |tourists[*].firstName|String|First name of the tourist.
1217 |tourists[*].lastName|String|Last name of the tourist.
1218 |tourists[*].birthDate|String|Birth date of the tourist.
1219 |tourists[*].citizenship|String|Citizenship of the tourist.
1220 |tourists[*].passportNumber|String|Passport number of the tourist.
1221 |tourists[*].passportIssue|String|Issue date of the tourist's passport.
1222 |tourists[*].passportExpiry|String|Expiry date of the tourist's passport.
1223 |tourists[*].tin|String|Tax identification number of the tourist, if applicable.
1224 |tourists[*].selectedVisaId|String|ID of the selected visa option for the tourist.
1225 |tourists[*].flights[*].flightId|String|Identifier for flights associated with the tourist.
1226 |tourists[*].flights[*].note|String|Additional notes or details about the flight.
1227 |tourists[*].flightIds[*]|String|Array of flight IDs associated with the tourist.
1228 |tourists[*].insurancePrice.insuranceId|String|Identifier for the insurance plan selected for the tourist.
1229 |...|...|Additional fields for insurancePrice as detailed in previous responses.
1230 |tourists[*].departureFlightInfo.date|String|Departure date for the tourist's flight, if applicable.
1231 |tourists[*].departureFlightInfo.time|String|Departure time for the tourist's flight, if applicable.
1232 |tourists[*].departureFlightInfo.flightNumber|String|Flight number for the tourist's departure flight, if applicable.
1233 |tourists[*].departureFlightInfo.terminalCode|String|Terminal code for the tourist's departure flight, if applicable.
1234 |tourists[*].arrivalFlightInfo.date|String|Arrival date for the tourist's flight, if applicable.
1235 |tourists[*].arrivalFlightInfo.time|String|Arrival time for the tourist's flight, if applicable.
1236 |tourists[*].arrivalFlightInfo.flightNumber|String|Flight number for the tourist's arrival flight, if applicable.
1237 |tourists[*].arrivalFlightInfo.terminalCode|String|Terminal code for the tourist's arrival flight, if applicable.
1238 |tourists[*].transfers[*].id|String|Unique identifier for a transfer service associated with the tourist.
1239 |tourists[*].transfers[*].selectedTransferPriceId|String|ID of the selected pricing option for the transfer.
1240 |note|String|General note regarding the reservation, intended for testing or additional information.
1241 |contactPhone|String|Contact phone number associated with the reservation.
1242 |reservationId|String|Unique identifier for the entire reservation.
1243
1244 === Response ===
1245
1246 (% class="table-bordered" %)
1247 |=Field Path|=Data Type|=Description
1248 |priceCurrency|String|Currency code (ISO 4217) for all transactional amounts mentioned in the response.
1249 |totalPrice|Number|Total price of the reservation.
1250 |agentCommissionPercent|Number|The percentage of the total price allocated as commission for the agent.
1251 |agentCommissionAmount|Number|The total commission amount in priceCurrency.
1252 |requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code for which an identifier is required.
1253 |requiredCitizenIdentifiers[*].identifierType|String|Type of identifier required (e.g., "TIN", "FIN").
1254 |hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
1255 |hotels[*].touristIds[*]|Array|List of tourist IDs that are booked in this hotel.
1256 |hotels[*].description|String|Description of the hotel booking.
1257 |tourists[*].id|String|Unique identifier for a tourist.
1258 |tourists[*].age|Number|Age of the tourist.
1259 |tourists[*].isAdult|Boolean|Indicates whether the tourist is an adult.
1260 |tourists[*].flightIds[*]|Array|List of flight IDs associated with the tourist.
1261 |tourists[*].flights[*].flightId|String|Unique identifier for the flight.
1262 |tourists[*].flights[*].note|String|Notes or additional information about the flight.
1263 |tourists[*].insurancePrice.*|Various|Detailed information about the insurance price, including ID, name, coverage, and cost details.
1264 |tourists[*].selectedVisaId|String|Identifier for the selected visa option for the tourist.
1265 |tourists[*].transfers[*].id|String|Unique identifier for the transfer.
1266 |tourists[*].transfers[*].type|String|Type of transfer (e.g., "Arrival", "Departure").
1267 |tourists[*].transfers[*].flightId|String|The flight ID associated with the transfer.
1268 |tourists[*].transfers[*].checkInHotelId|String|Hotel ID for check-in associated with the transfer.
1269 |tourists[*].transfers[*].checkOutHotelId|String|Hotel ID for check-out associated with the transfer.
1270 |tourists[*].transfers[*].selectedTransferPriceId|String|The ID of the selected pricing option for the transfer.
1271 |tourists[*].transfers[*].transferPrices[*].*|Various|Detailed information about each transfer price option, including ID, name, and cost details.
1272 |visas[*].prid|String|Unique identifier for a visa option.
1273 |visas[*].prName|String|Name of the visa option.
1274 |visas[*].prValue|Number|The cost associated with this visa option.
1275 |visas[*].sortingOrder|Number|Sorting order for the visa options.
1276 |terminals[*].terminalCode|String|Code representing the terminal.
1277 |terminals[*].cityUID|String|Unique identifier for the city where the terminal is located.
1278 |terminals[*].districtUID|String|Unique identifier for the district of the terminal.
1279 |terminals[*].terminalName|String|Name of the terminal.
1280 |terminals[*].countryCode|String|The ISO 3166-1 alpha-2 country code for the terminal's country.
1281 |terminals[*].note|String|Additional notes or information about the terminal.
1282 |containsError|Boolean|Indicates if the response contains any errors.
1283 |refreshPriceResult|String|The result of attempting to refresh the price (e.g., "Success").
1284 |reservationId|String|Unique identifier for the reservation.
1285 |reservationDetailsUnavailable|Boolean|Indicates if the reservation details are currently unavailable.
1286 |error|Boolean|A generic error indicator, presumably redundant with containsError.
1287
1288