Changes for page 4. CalcCheckout

Summary

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

Details

Page properties

Content

...	...	@@ -6,10 +6,9 @@
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.
9	9
10		-Once the desired tour variation has been selected, the next step involves calculating the package price in greater detail, typically just before proceeding with the reservation. To accomplish this, the CalcCheckout method must be utilized. This stage marks the pre-booking phase of the process.
11	11
12		-
13	13	== Endpoint URL - [POST] ==
14	14
15	15	{{info}}
...	...	@@ -639,8 +639,6 @@
639	639	=== Schema ===
640	640
641	641	{{success}}
642		-CheckoutFormOut{
643		-
644	644	|error|boolean
645	645	|errorCode|string
646	646	nullable: true
...	...	@@ -655,8 +655,7 @@
655	655	|agentCommissionAmount|number($double)
656	656	|requiredCitizenIdentifiers|[
657	657	nullable: trueCitizenIdentifier{(((
658		-|countryCode|string
659		-nullable: true
	655	+|countryCode|[...]
660	660	|identifierType|IdentifierTypeEnumstringEnum:
661	661	[ TIN, FIN ]
662	662
...	...	@@ -678,7 +678,117 @@
678	678	}]
679	679	)))
680	680	|tourists|[
681		-nullable: trueCheckoutTouristOut{...}]
	677	+nullable: trueCheckoutTouristOut{(((
	678	+|id|[...]
	679	+|age|[...]
	680	+|isAdult|[...]
	681	+|flightIds|[...]
	682	+|flights|[...]
	683	+|arrivalFlightInfo|ManualFlightInfo{(((
	684	+|flightNumber|string
	685	+nullable: true
	686	+|terminalCode|string
	687	+nullable: true
	688	+|date|string($date-time)
	689	+nullable: true
	690	+|time|string
	691	+nullable: true
	692	+
	693	+}
	694	+)))
	695	+|departureFlightInfo|ManualFlightInfo{(((
	696	+|flightNumber|string
	697	+nullable: true
	698	+|terminalCode|string
	699	+nullable: true
	700	+|date|string($date-time)
	701	+nullable: true
	702	+|time|string
	703	+nullable: true
	704	+
	705	+}
	706	+)))
	707	+|insurancePrice|InsurancePriceForTourist{(((
	708	+|insuranceId|string($uuid)
	709	+|insuranceServiceId|string($uuid)
	710	+|insurancePriceId|string($uuid)
	711	+|touristId|string($uuid)
	712	+|insuranceName|string
	713	+nullable: true
	714	+|insuranceDescription|string
	715	+nullable: true
	716	+|contragentName|string
	717	+nullable: true
	718	+|contragentFullName|string
	719	+nullable: true
	720	+|actualStartDate|string($date-time)
	721	+|actualEndDate|string($date-time)
	722	+|costCurrencyCode|string
	723	+nullable: true
	724	+|costAmount|number($double)
	725	+|priceCurrencyCode|string
	726	+nullable: true
	727	+|priceAmount|number($double)
	728	+|coverageCurrencyCode|string
	729	+nullable: true
	730	+|coverageAmount|number($double)
	731	+
	732	+}
	733	+)))
	734	+|selectedVisaId|string
	735	+nullable: true
	736	+|transfers|[
	737	+nullable: trueCheckoutTransferOut{(((
	738	+|id|string
	739	+nullable: true
	740	+|type|CheckoutTransferTypeEnumstringEnum:
	741	+[ Arrival, Departure, HotelToHotel ]
	742	+|flightId|string
	743	+nullable: true
	744	+|flightInfo|ManualFlightInfo{(((
	745	+|flightNumber|string
	746	+nullable: true
	747	+|terminalCode|string
	748	+nullable: true
	749	+|date|string($date-time)
	750	+nullable: true
	751	+|time|string
	752	+nullable: true
	753	+
	754	+}
	755	+)))
	756	+|checkInHotelId|string
	757	+nullable: true
	758	+|checkOutHotelId|string
	759	+nullable: true
	760	+|selectedTransferPriceId|string
	761	+nullable: true
	762	+|transferPrices|[
	763	+nullable: trueCheckoutTransferPrice{(((
	764	+|id|string
	765	+nullable: true
	766	+|name|string
	767	+nullable: true
	768	+|adultPlaces|integer($int32)
	769	+|childPlaces|integer($int32)
	770	+|perPersonPrice|boolean
	771	+|adultPrice|number($double)
	772	+|childPrice|number($double)
	773	+
	774	+}]
	775	+)))
	776	+
	777	+}]
	778	+)))
	779	+|errorCode|string
	780	+nullable: true
	781	+|errorMessage|string
	782	+nullable: true
	783	+|description|string
	784	+nullable: true
	785	+
	786	+}]
	787	+)))
682	682	|visas|[
683	683	nullable: trueServicePrice{(((
684	684	|prid|string($uuid)
...	...	@@ -714,70 +714,3 @@
714	714
715	715	}
716	716	{{/success}}
717		-
718		-
719		-== Descriptions ==
720		-
721		-
722		-=== Request ===
723		-
724		-Here's a table describing each parameter of the JSON request:
725		-
726		-(% class="table-bordered" %)
727		-|=Parameter|=Data Type|=Description
728		-|calcTourPackageRequests|Array|An array of objects, each representing a tour package request.
729		-|refreshPrices|Boolean|If true, the prices for the tour package will be refreshed.
730		-|packageId|String|A unique identifier for the tour package.
731		-|flightPassengers|Array|An array of objects, each representing a flight passenger.
732		-|id|String|A unique identifier for each flight passenger.
733		-|selectedForwardBaggageCode|String|The selected baggage option for the forward journey.
734		-|selectedBackwardBaggageCode|String|The selected baggage option for the backward journey.
735		-|extraServicePriceCodes|Array|An array of extra service price codes. If empty, no extra services are selected.
736		-|includeInsurance|Boolean|If true, insurance will be included in the tour package.
737		-|calcOnlyHotelPackageRequests|Array|An array of objects, each representing a hotel-only package request. If empty, no hotel-only packages are requested.
738		-|calcOnlyAviaPackageRequests|Array|An array of objects, each representing an avia-only package request. If empty, no avia-only packages are requested.
739		-
740		-=== Response ===
741		-
742		-(% class="table-bordered" %)
743		-|=Parameter|=Data Type|=Description
744		-|priceCurrency|String|The currency code (ISO 4217) for all prices mentioned in the response.
745		-|totalPrice|Number|The total price of the booking.
746		-|agentCommissionPercent|Number|The commission percentage for the agent.
747		-|agentCommissionAmount|Number|The total commission amount for the agent in priceCurrency.
748		-|requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code.
749		-|requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN").
750		-|hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
751		-|hotels[*].touristIds[*]|String|List of tourist IDs that are booked in this hotel.
752		-|hotels[*].description|String|A brief description of the hotel.
753		-|tourists[*].id|String|Unique identifier for the tourist.
754		-|tourists[*].isAdult|Boolean|Indicates if the tourist is an adult.
755		-|tourists[*].flightIds[*]|String|Identifiers for flights associated with the tourist.
756		-|tourists[*].flights[*].flightId|String|Unique identifier for the flight.
757		-|tourists[*].flights[*].note|String|Additional information about the flight, such as baggage allowance.
758		-|tourists[*].insurancePrice.insuranceId|String|Unique identifier for the insurance product.
759		-|tourists[*].insurancePrice.insuranceServiceId|String|Identifier for the insurance service provider.
760		-|...|...|Additional fields for insurancePrice as detailed previously.
761		-|tourists[*].transfers[*].id|String|Unique identifier for the transfer service.
762		-|tourists[*].transfers[*].type|String|The type of transfer (e.g., "Arrival", "Departure").
763		-|tourists[*].transfers[*].flightId|String|Identifier of the flight associated with this transfer.
764		-|tourists[*].transfers[*].checkInHotelId|String|Hotel ID for check-in associated with this transfer (for arrival type).
765		-|tourists[*].transfers[*].checkOutHotelId|String|Hotel ID for check-out associated with this transfer (for departure type).
766		-|tourists[*].transfers[*].selectedTransferPriceId|String|The ID of the selected pricing option for the transfer.
767		-|tourists[*].transfers[*].transferPrices[*].id|String|Unique identifier for the transfer price option.
768		-|tourists[*].transfers[*].transferPrices[*].name|String|The name of the transfer service (e.g., "GROUP", "MINIVAN").
769		-|...|...|Additional fields for transferPrices as detailed previously.
770		-|visas[*].prid|String|Unique identifier for the visa option.
771		-|visas[*].prName|String|The name of the visa option.
772		-|visas[*].prValue|Number|The cost associated with this visa option.
773		-|visas[*].sortingOrder|Number|Used to sort visa options in the response or UI.
774		-|terminals[*].terminalCode|String|The code representing the terminal.
775		-|terminals[*].cityUID|String|Unique identifier for the city where the terminal is located.
776		-|...|...|Additional fields for terminals as detailed previously.
777		-|containsError|Boolean|Indicates if the response contains any errors.
778		-|refreshPriceResult|String|The result of attempting to refresh the price (e.g., "Success").
779		-|reservationId|String|Unique identifier for the reservation.
780		-|reservationDetailsUnavailable|Boolean|Indicates if the reservation details are currently unavailable.
781		-|error|Boolean|A generic error indicator, presumably redundant with containsError.
782		-
783		-