Wiki source code of 4. ConfirmCheckout

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