Changes for page 5. ConfirmCheckout

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -6,9 +6,16 @@
6	6
7	7	= Method Description =
8	8
9		-This method is used to calculate full package with hotels and flights, to recheck prices, availability, prices and cancelation policy before book.
10	10
	10	+This API endpoint serves the purpose of registering a new reservation.
11	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	+
12	12	== Endpoint URL - [POST] ==
13	13
14	14	{{info}}
...	...	@@ -990,7 +990,7 @@
990	990	=== Schema ===
991	991
992	992	{{success}}
993		-CalcOnlyHotelPackageResponse{
	1000	+CheckoutFormOut{
994	994
995	995	|error|boolean
996	996	|errorCode|string
...	...	@@ -999,128 +999,287 @@
999	999	nullable: true
1000	1000	|userErrorDescription|string
1001	1001	nullable: true
1002		-|package|OnlyHotelPackage{(((
1003		-|id|string
1004		-nullable: true
1005	1005	|priceCurrency|string
1006	1006	nullable: true
1007	1007	|totalPrice|number($double)
1008	1008	|agentCommissionPercent|number($double)
1009	1009	|agentCommissionAmount|number($double)
1010		-|hotel|PackageHotel{(((
	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{(((
1011	1011	|hotelPriceId|string
1012	1012	nullable: true
1013		-|providerId|integer($int32)
1014		-|hotelName|string
	1027	+|touristIds|[
	1028	+nullable: truestring($uuid)]
	1029	+|errorCode|string
1015	1015	nullable: true
1016		-|hotelCode|string
	1031	+|errorMessage|string
1017	1017	nullable: true
1018		-|nigths|integer($int32)
1019		-|mealPlan|string
	1033	+|description|string
1020	1020	nullable: true
1021		-|hotelClass|string
	1035	+
	1036	+}]
	1037	+)))
	1038	+|tourists|[
	1039	+nullable: trueCheckoutTouristOut{(((
	1040	+|id|string($uuid)
	1041	+|age|integer($int32)
1022	1022	nullable: true
1023		-|availabilityType|RoomAvailabilityTypeEnumstringEnum:
1024		-[ OnRequest, FreeSale, StopSale ]
1025		-|availableRoomsCount|integer($int32)
1026		-|fewRooms|boolean
1027		-|roomCategoryCode|string
	1043	+|isAdult|boolean
	1044	+|flightIds|[
	1045	+nullable: truestring]
	1046	+|flights|[
	1047	+nullable: trueCheckoutFlightOut{(((
	1048	+|flightId|string
1028	1028	nullable: true
1029		-|roomCategoryName|string
	1050	+|note|string
1030	1030	nullable: true
1031		-|placementTypeName|string
	1052	+
	1053	+}]
	1054	+)))
	1055	+|arrivalFlightInfo|ManualFlightInfo{(((
	1056	+|flightNumber|string
1032	1032	nullable: true
1033		-|placementDescription|string
	1058	+|terminalCode|string
1034	1034	nullable: true
1035		-|checkInDate|string($date-time)
1036		-|checkOutDate|string($date-time)
1037		-|adults|integer($int32)
1038		-|children|integer($int32)
1039		-|districtUID|string($uuid)
	1060	+|date|string($date-time)
1040	1040	nullable: true
1041		-|districtName|string
	1062	+|time|string
1042	1042	nullable: true
1043		-|cityUID|string($uuid)
	1064	+
	1065	+}
	1066	+)))
	1067	+|departureFlightInfo|ManualFlightInfo{(((
	1068	+|flightNumber|string
1044	1044	nullable: true
1045		-|cityName|string
	1070	+|terminalCode|string
1046	1046	nullable: true
1047		-|countryCode|string
	1072	+|date|string($date-time)
1048	1048	nullable: true
1049		-|countryName|string
	1074	+|time|string
1050	1050	nullable: true
1051		-|hasAlcohol|boolean
1052		-|hasFreeWifi|boolean
1053		-|hasMetro|boolean
1054		-|hasPool|boolean
1055		-|hasMall|boolean
1056		-|cancellationPolicyDescription|string
	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
1057	1057	nullable: true
1058		-|cancellationPolicy|CancellationPolicyExchange{(((
1059		-|cancellationPolicyCode|string
	1086	+|insuranceDescription|string
1060	1060	nullable: true
1061		-|noShowChargeValue|number($double)
	1088	+|contragentName|string
1062	1062	nullable: true
1063		-|noShowChargeValueType|string
	1090	+|contragentFullName|string
1064	1064	nullable: true
1065		-|earlyDepartureChargeValue|number($double)
	1092	+|actualStartDate|string($date-time)
	1093	+|actualEndDate|string($date-time)
	1094	+|costCurrencyCode|string
1066	1066	nullable: true
1067		-|earlyDepartureChargeValueType|string
	1096	+|costAmount|number($double)
	1097	+|priceCurrencyCode|string
1068	1068	nullable: true
1069		-|conditions|[
1070		-nullable: trueCancellationPolicyConditionExchange{(((
1071		-|timeunits|integer($int32)
1072		-|timeunitType|string
	1099	+|priceAmount|number($double)
	1100	+|coverageCurrencyCode|string
1073	1073	nullable: true
1074		-|timeOffsetTypeName|string
	1102	+|coverageAmount|number($double)
	1103	+
	1104	+}
	1105	+)))
	1106	+|selectedVisaId|string
1075	1075	nullable: true
1076		-|chargeValue|number($double)
	1108	+|transfers|[
	1109	+nullable: trueCheckoutTransferOut{(((
	1110	+|id|string
1077	1077	nullable: true
1078		-|chargeValueType|string
	1112	+|type|CheckoutTransferTypeEnumstringEnum:
	1113	+[ Arrival, Departure, HotelToHotel ]
	1114	+|flightId|string
1079	1079	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
1080	1080
1081		-}]
1082		-)))
1083		-
1084	1084	}
1085	1085	)))
1086		-
1087		-}
1088		-)))
1089		-|extraServices|[
1090		-nullable: trueHotelExtraServiceBase{(((
1091		-|extraServiceCode|string
	1128	+|checkInHotelId|string
1092	1092	nullable: true
1093		-|extraServiceTypeCode|string
	1130	+|checkOutHotelId|string
1094	1094	nullable: true
1095		-|isMandatory|integer($int32)
1096		-|extraServiceName|string
	1132	+|selectedTransferPriceId|string
1097	1097	nullable: true
1098		-|minimalServiceAmount|number($double)
1099		-|includedPriceCode|string
	1134	+|transferPrices|[
	1135	+nullable: trueCheckoutTransferPrice{(((
	1136	+|id|string
1100	1100	nullable: true
1101		-|prices|[
1102		-nullable: trueHotelExtraServicePriceBase{(((
1103		-|extraServicePriceCode|string
	1138	+|name|string
1104	1104	nullable: true
1105		-|displayName|string
	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
1106	1106	nullable: true
1107		-|restrictionInfo|string
	1153	+|errorMessage|string
1108	1108	nullable: true
1109		-|additionalInfo|string
	1155	+|description|string
1110	1110	nullable: true
1111		-|price|number($double)
1112		-|extraPrice|number($double)
1113		-|currency|string
1114		-nullable: true
1115	1115
1116	1116	}]
1117	1117	)))
	1160	+|visas|[
	1161	+nullable: trueServicePrice{(((
	1162	+|prid|string($uuid)
	1163	+|prName|string
	1164	+nullable: true
	1165	+|prValue|number($double)
	1166	+|sortingOrder|integer($int32)
1118	1118
1119	1119	}]
1120	1120	)))
	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
1121	1121
1122		-}
	1185	+}]
1123	1123	)))
	1187	+|containsError|boolean
	1188	+|refreshPriceResult|RefreshPriceResultEnumstringEnum:
	1189	+[ Success, HotelPriceNoMoreAvailable, FlightPriceNoMoreAvailable ]
	1190	+|reservationId|string($uuid)
	1191	+|reservationDetailsUnavailable|boolean
1124	1124
1125	1125	}
1126	1126	{{/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	+