Wiki source code of 5. ConfirmCheckout

Last modified by Giorgi Mdivnishvili on 2024/08/30 12:58

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