Wiki source code of 4. ConfirmCheckout

Version 3.1 by Giorgi Mdivnishvili on 2024/04/12 19:03

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