Changes for page 4. CalcCheckout

Last modified by Giorgi Mdivnishvili on 2024/04/11 16:59

From version 10.5
edited by Giorgi Mdivnishvili
on 2024/04/11 16:58
Change comment: There is no comment for this version
To version 9.1
edited by Giorgi Mdivnishvili
on 2024/04/11 13:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -7,7 +7,7 @@
7 7  = Method Description =
8 8  
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.
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 12  
13 13  == Endpoint URL - [POST] ==
... ... @@ -638,102 +638,49 @@
638 638  
639 639  === Schema ===
640 640  
641 -
642 -
643 643  {{success}}
644 -CheckoutFormIn{
645 -
646 -|reservationId|string($uuid)
642 +|error|boolean
643 +|errorCode|string
647 647  nullable: true
648 -|calcTourPackageRequests|[
649 -nullable: trueCalcTourPackageRequest{(((
650 -|packageId|string
645 +|errorDescription|string
651 651  nullable: true
652 -|extraServicePriceCodes|[
653 -nullable: truestring]
654 -|flightPassengers|[
655 -nullable: trueFlightPassengerIn{(((
656 -|id|string
647 +|userErrorDescription|string
657 657  nullable: true
658 -|selectedForwardBaggageCode|string
649 +|priceCurrency|string
659 659  nullable: true
660 -|selectedBackwardBaggageCode|string
661 -nullable: true
651 +|totalPrice|number($double)
652 +|agentCommissionPercent|number($double)
653 +|agentCommissionAmount|number($double)
654 +|requiredCitizenIdentifiers|[
655 +nullable: trueCitizenIdentifier{(((
656 +|countryCode|[...]
657 +|identifierType|IdentifierTypeEnumstringEnum:
658 +[ 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{(((
663 +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)]
668 +|errorCode|string
669 +nullable: true
670 +|errorMessage|string
671 +nullable: true
672 +|description|string
673 +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]
678 +nullable: trueCheckoutTouristOut{(((
679 +|id|[...]
680 +|age|[...]
681 +|isAdult|[...]
682 +|flightIds|[...]
683 +|flights|[...]
737 737  |arrivalFlightInfo|ManualFlightInfo{(((
738 738  |flightNumber|string
739 739  nullable: true
... ... @@ -758,60 +758,78 @@
758 758  
759 759  }
760 760  )))
708 +|insurancePrice|InsurancePriceForTourist{(((
709 +|insuranceId|string($uuid)
710 +|insuranceServiceId|string($uuid)
711 +|insurancePriceId|string($uuid)
712 +|touristId|string($uuid)
713 +|insuranceName|string
714 +nullable: true
715 +|insuranceDescription|string
716 +nullable: true
717 +|contragentName|string
718 +nullable: true
719 +|contragentFullName|string
720 +nullable: true
721 +|actualStartDate|string($date-time)
722 +|actualEndDate|string($date-time)
723 +|costCurrencyCode|string
724 +nullable: true
725 +|costAmount|number($double)
726 +|priceCurrencyCode|string
727 +nullable: true
728 +|priceAmount|number($double)
729 +|coverageCurrencyCode|string
730 +nullable: true
731 +|coverageAmount|number($double)
732 +
733 +}
734 +)))
761 761  |selectedVisaId|string
762 762  nullable: true
763 763  |transfers|[
764 -nullable: trueCheckoutTransferIn{(((
738 +nullable: trueCheckoutTransferOut{(((
765 765  |id|string
766 766  nullable: true
767 -|selectedTransferPriceId|string
741 +|type|CheckoutTransferTypeEnumstringEnum:
742 +[ Arrival, Departure, HotelToHotel ]
743 +|flightId|string
768 768  nullable: true
769 -
770 -}]
771 -)))
772 -
773 -}]
774 -)))
775 -|note|string
745 +|flightInfo|ManualFlightInfo{(((
746 +|flightNumber|string
776 776  nullable: true
777 -|contactPhone|string
748 +|terminalCode|string
778 778  nullable: true
750 +|date|string($date-time)
751 +nullable: true
752 +|time|string
753 +nullable: true
779 779  
780 780  }
781 -{{/success}}
782 -
783 -
784 -
785 -{{success}}
786 -CheckoutFormOut{
787 -
788 -|error|boolean
789 -|errorCode|string
756 +)))
757 +|checkInHotelId|string
790 790  nullable: true
791 -|errorDescription|string
759 +|checkOutHotelId|string
792 792  nullable: true
793 -|userErrorDescription|string
761 +|selectedTransferPriceId|string
794 794  nullable: true
795 -|priceCurrency|string
763 +|transferPrices|[
764 +nullable: trueCheckoutTransferPrice{(((
765 +|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
767 +|name|string
803 803  nullable: true
804 -|identifierType|IdentifierTypeEnumstringEnum:
805 -[ TIN, FIN ]
769 +|adultPlaces|integer($int32)
770 +|childPlaces|integer($int32)
771 +|perPersonPrice|boolean
772 +|adultPrice|number($double)
773 +|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)]
777 +
778 +}]
779 +)))
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)
... ... @@ -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 ""
840 +|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.
... ... @@ -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.