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}}
...	...	@@ -638,102 +638,49 @@
638	638
639	639	=== Schema ===
640	640
641		-
642		-
643	643	{{success}}
644		-CheckoutFormIn{
645		-
646		-|reservationId|string($uuid)
	641	+|error|boolean
	642	+|errorCode|string
647	647	nullable: true
648		-|calcTourPackageRequests|[
649		-nullable: trueCalcTourPackageRequest{(((
650		-|packageId|string
	644	+|errorDescription|string
651	651	nullable: true
652		-|extraServicePriceCodes|[
653		-nullable: truestring]
654		-|flightPassengers|[
655		-nullable: trueFlightPassengerIn{(((
656		-|id|string
	646	+|userErrorDescription|string
657	657	nullable: true
658		-|selectedForwardBaggageCode|string
	648	+|priceCurrency|string
659	659	nullable: true
660		-|selectedBackwardBaggageCode|string
661		-nullable: true
	650	+|totalPrice|number($double)
	651	+|agentCommissionPercent|number($double)
	652	+|agentCommissionAmount|number($double)
	653	+|requiredCitizenIdentifiers|[
	654	+nullable: trueCitizenIdentifier{(((
	655	+|countryCode|[...]
	656	+|identifierType|IdentifierTypeEnumstringEnum:
	657	+[ TIN, FIN ]
662	662
663	663	}]
664	664	)))
665		-|includeInsurance|boolean
666		-nullable: true
667		-|refreshPrices|boolean
668		-
669		-}]
670		-)))
671		-|calcOnlyHotelPackageRequests|[
672		-nullable: trueCalcOnlyHotelPackageRequest{(((
673		-|packageId|string
674		-nullable: true
675		-|extraServicePriceCodes|[
676		-nullable: truestring]
677		-|includeInsurance|boolean
678		-|refreshPrices|boolean
679		-
680		-}]
681		-)))
682		-|calcOnlyAviaPackageRequests|[
683		-nullable: trueCalcOnlyAviaPackageRequest{(((
684		-|packageId|string
685		-nullable: true
686		-|refreshPrices|boolean
687		-|flightPassengers|[
688		-nullable: trueFlightPassengerIn{(((
689		-|id|string
690		-nullable: true
691		-|selectedForwardBaggageCode|string
692		-nullable: true
693		-|selectedBackwardBaggageCode|string
694		-nullable: true
695		-
696		-}]
697		-)))
698		-
699		-}]
700		-)))
701	701	|hotels|[
702		-nullable: trueCheckoutHotelIn{(((
	662	+nullable: trueCheckoutHotelOut{(((
703	703	|hotelPriceId|string
704	704	nullable: true
705		-|agentConfirmationNumber|string
706		-nullable: true
707		-|note|string
708		-nullable: true
709	709	|touristIds|[
710	710	nullable: truestring($uuid)]
	667	+|errorCode|string
	668	+nullable: true
	669	+|errorMessage|string
	670	+nullable: true
	671	+|description|string
	672	+nullable: true
711	711
712	712	}]
713	713	)))
714	714	|tourists|[
715		-nullable: trueCheckoutTouristIn{(((
716		-|id|string($uuid)
717		-|firstName|string
718		-nullable: true
719		-|lastName|string
720		-nullable: true
721		-|birthDate|string($date-time)
722		-nullable: true
723		-|passportNumber|string
724		-nullable: true
725		-|passportExpiry|string($date-time)
726		-nullable: true
727		-|passportIssue|string($date-time)
728		-nullable: true
729		-|citizenship|string
730		-nullable: true
731		-|tin|string
732		-nullable: true
733		-|isMale|boolean
734		-nullable: true
735		-|flightIds|[
736		-nullable: truestring]
	677	+nullable: trueCheckoutTouristOut{(((
	678	+|id|[...]
	679	+|age|[...]
	680	+|isAdult|[...]
	681	+|flightIds|[...]
	682	+|flights|[...]
737	737	|arrivalFlightInfo|ManualFlightInfo{(((
738	738	|flightNumber|string
739	739	nullable: true
...	...	@@ -758,60 +758,78 @@
758	758
759	759	}
760	760	)))
	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	+)))
761	761	|selectedVisaId|string
762	762	nullable: true
763	763	|transfers|[
764		-nullable: trueCheckoutTransferIn{(((
	737	+nullable: trueCheckoutTransferOut{(((
765	765	|id|string
766	766	nullable: true
767		-|selectedTransferPriceId|string
	740	+|type|CheckoutTransferTypeEnumstringEnum:
	741	+[ Arrival, Departure, HotelToHotel ]
	742	+|flightId|string
768	768	nullable: true
769		-
770		-}]
771		-)))
772		-
773		-}]
774		-)))
775		-|note|string
	744	+|flightInfo|ManualFlightInfo{(((
	745	+|flightNumber|string
776	776	nullable: true
777		-|contactPhone|string
	747	+|terminalCode|string
778	778	nullable: true
	749	+|date|string($date-time)
	750	+nullable: true
	751	+|time|string
	752	+nullable: true
779	779
780	780	}
781		-{{/success}}
782		-
783		-
784		-
785		-{{success}}
786		-CheckoutFormOut{
787		-
788		-|error|boolean
789		-|errorCode|string
	755	+)))
	756	+|checkInHotelId|string
790	790	nullable: true
791		-|errorDescription|string
	758	+|checkOutHotelId|string
792	792	nullable: true
793		-|userErrorDescription|string
	760	+|selectedTransferPriceId|string
794	794	nullable: true
795		-|priceCurrency|string
	762	+|transferPrices|[
	763	+nullable: trueCheckoutTransferPrice{(((
	764	+|id|string
796	796	nullable: true
797		-|totalPrice|number($double)
798		-|agentCommissionPercent|number($double)
799		-|agentCommissionAmount|number($double)
800		-|requiredCitizenIdentifiers|[
801		-nullable: trueCitizenIdentifier{(((
802		-|countryCode|string
	766	+|name|string
803	803	nullable: true
804		-|identifierType|IdentifierTypeEnumstringEnum:
805		-[ TIN, FIN ]
	768	+|adultPlaces|integer($int32)
	769	+|childPlaces|integer($int32)
	770	+|perPersonPrice|boolean
	771	+|adultPrice|number($double)
	772	+|childPrice|number($double)
806	806
807	807	}]
808	808	)))
809		-|hotels|[
810		-nullable: trueCheckoutHotelOut{(((
811		-|hotelPriceId|string
812		-nullable: true
813		-|touristIds|[
814		-nullable: truestring($uuid)]
	776	+
	777	+}]
	778	+)))
815	815	|errorCode|string
816	816	nullable: true
817	817	|errorMessage|string
...	...	@@ -821,8 +821,6 @@
821	821
822	822	}]
823	823	)))
824		-|tourists|[
825		-nullable: trueCheckoutTouristOut{...}]
826	826	|visas|[
827	827	nullable: trueServicePrice{(((
828	828	|prid|string($uuid)
...	...	@@ -862,12 +862,12 @@
862	862
863	863	== Descriptions ==
864	864
	827	+=== ===
865	865
866	866	=== Request ===
867	867
868	868	Here's a table describing each parameter of the JSON request:
869	869
870		-(% class="table-bordered" %)
871	871	|=Parameter|=Data Type|=Description
872	872	|calcTourPackageRequests|Array|An array of objects, each representing a tour package request.
873	873	|refreshPrices|Boolean|If true, the prices for the tour package will be refreshed.
...	...	@@ -874,7 +874,7 @@
874	874	|packageId|String|A unique identifier for the tour package.
875	875	|flightPassengers|Array|An array of objects, each representing a flight passenger.
876	876	|id|String|A unique identifier for each flight passenger.
877		-|selectedForwardBaggageCode|String|The selected baggage option for the forward journey. there is two optoions ""
	839	+|selectedForwardBaggageCode|String|The selected baggage option for the forward journey.
878	878	|selectedBackwardBaggageCode|String|The selected baggage option for the backward journey.
879	879	|extraServicePriceCodes|Array|An array of extra service price codes. If empty, no extra services are selected.
880	880	|includeInsurance|Boolean|If true, insurance will be included in the tour package.
...	...	@@ -881,9 +881,10 @@
881	881	|calcOnlyHotelPackageRequests|Array|An array of objects, each representing a hotel-only package request. If empty, no hotel-only packages are requested.
882	882	|calcOnlyAviaPackageRequests|Array|An array of objects, each representing an avia-only package request. If empty, no avia-only packages are requested.
883	883
	846	+=== ===
	847	+
884	884	=== Response ===
885	885
886		-(% class="table-bordered" %)
887	887	|=Parameter|=Data Type|=Description
888	888	|priceCurrency|String|The currency code (ISO 4217) for all prices mentioned in the response.
889	889	|totalPrice|Number|The total price of the booking.
...	...	@@ -890,7 +890,7 @@
890	890	|agentCommissionPercent|Number|The commission percentage for the agent.
891	891	|agentCommissionAmount|Number|The total commission amount for the agent in priceCurrency.
892	892	|requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code.
893		-|requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN"). **TIN (Taxpayer Identification Number) & FIN (Financial Identification Number)**
	856	+|requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN").
894	894	|hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
895	895	|hotels[*].touristIds[*]|String|List of tourist IDs that are booked in this hotel.
896	896	|hotels[*].description|String|A brief description of the hotel.