Changes for page 4. CalcCheckout

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

From version 9.1
edited by Giorgi Mdivnishvili
on 2024/04/11 13:22
Change comment: There is no comment for this version
To version 11.1
edited by Giorgi Mdivnishvili
on 2024/04/11 16:59
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,49 +638,102 @@
638 638  
639 639  === Schema ===
640 640  
641 +
642 +
641 641  {{success}}
642 -|error|boolean
643 -|errorCode|string
644 +CheckoutFormIn{
645 +
646 +|reservationId|string($uuid)
644 644  nullable: true
645 -|errorDescription|string
648 +|calcTourPackageRequests|[
649 +nullable: trueCalcTourPackageRequest{(((
650 +|packageId|string
646 646  nullable: true
647 -|userErrorDescription|string
652 +|extraServicePriceCodes|[
653 +nullable: truestring]
654 +|flightPassengers|[
655 +nullable: trueFlightPassengerIn{(((
656 +|id|string
648 648  nullable: true
649 -|priceCurrency|string
658 +|selectedForwardBaggageCode|string
650 650  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 ]
660 +|selectedBackwardBaggageCode|string
661 +nullable: true
659 659  
660 660  }]
661 661  )))
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 +)))
662 662  |hotels|[
663 -nullable: trueCheckoutHotelOut{(((
702 +nullable: trueCheckoutHotelIn{(((
664 664  |hotelPriceId|string
665 665  nullable: true
666 -|touristIds|[
667 -nullable: truestring($uuid)]
668 -|errorCode|string
705 +|agentConfirmationNumber|string
669 669  nullable: true
670 -|errorMessage|string
707 +|note|string
671 671  nullable: true
672 -|description|string
673 -nullable: true
709 +|touristIds|[
710 +nullable: truestring($uuid)]
674 674  
675 675  }]
676 676  )))
677 677  |tourists|[
678 -nullable: trueCheckoutTouristOut{(((
679 -|id|[...]
680 -|age|[...]
681 -|isAdult|[...]
682 -|flightIds|[...]
683 -|flights|[...]
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]
684 684  |arrivalFlightInfo|ManualFlightInfo{(((
685 685  |flightNumber|string
686 686  nullable: true
... ... @@ -705,78 +705,60 @@
705 705  
706 706  }
707 707  )))
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 -)))
735 735  |selectedVisaId|string
736 736  nullable: true
737 737  |transfers|[
738 -nullable: trueCheckoutTransferOut{(((
764 +nullable: trueCheckoutTransferIn{(((
739 739  |id|string
740 740  nullable: true
741 -|type|CheckoutTransferTypeEnumstringEnum:
742 -[ Arrival, Departure, HotelToHotel ]
743 -|flightId|string
767 +|selectedTransferPriceId|string
744 744  nullable: true
745 -|flightInfo|ManualFlightInfo{(((
746 -|flightNumber|string
769 +
770 +}]
771 +)))
772 +
773 +}]
774 +)))
775 +|note|string
747 747  nullable: true
748 -|terminalCode|string
777 +|contactPhone|string
749 749  nullable: true
750 -|date|string($date-time)
751 -nullable: true
752 -|time|string
753 -nullable: true
754 754  
755 755  }
756 -)))
757 -|checkInHotelId|string
781 +{{/success}}
782 +
783 +
784 +
785 +{{success}}
786 +CheckoutFormOut{
787 +
788 +|error|boolean
789 +|errorCode|string
758 758  nullable: true
759 -|checkOutHotelId|string
791 +|errorDescription|string
760 760  nullable: true
761 -|selectedTransferPriceId|string
793 +|userErrorDescription|string
762 762  nullable: true
763 -|transferPrices|[
764 -nullable: trueCheckoutTransferPrice{(((
765 -|id|string
795 +|priceCurrency|string
766 766  nullable: true
767 -|name|string
797 +|totalPrice|number($double)
798 +|agentCommissionPercent|number($double)
799 +|agentCommissionAmount|number($double)
800 +|requiredCitizenIdentifiers|[
801 +nullable: trueCitizenIdentifier{(((
802 +|countryCode|string
768 768  nullable: true
769 -|adultPlaces|integer($int32)
770 -|childPlaces|integer($int32)
771 -|perPersonPrice|boolean
772 -|adultPrice|number($double)
773 -|childPrice|number($double)
804 +|identifierType|IdentifierTypeEnumstringEnum:
805 +[ TIN, FIN ]
774 774  
775 775  }]
776 776  )))
777 -
778 -}]
779 -)))
809 +|hotels|[
810 +nullable: trueCheckoutHotelOut{(((
811 +|hotelPriceId|string
812 +nullable: true
813 +|touristIds|[
814 +nullable: truestring($uuid)]
780 780  |errorCode|string
781 781  nullable: true
782 782  |errorMessage|string
... ... @@ -786,6 +786,8 @@
786 786  
787 787  }]
788 788  )))
824 +|tourists|[
825 +nullable: trueCheckoutTouristOut{...}]
789 789  |visas|[
790 790  nullable: trueServicePrice{(((
791 791  |prid|string($uuid)
... ... @@ -837,7 +837,7 @@
837 837  |packageId|String|A unique identifier for the tour package.
838 838  |flightPassengers|Array|An array of objects, each representing a flight passenger.
839 839  |id|String|A unique identifier for each flight passenger.
840 -|selectedForwardBaggageCode|String|The selected baggage option for the forward journey.
877 +|selectedForwardBaggageCode|String|The selected baggage option for the forward journey. there is two optoions ""
841 841  |selectedBackwardBaggageCode|String|The selected baggage option for the backward journey.
842 842  |extraServicePriceCodes|Array|An array of extra service price codes. If empty, no extra services are selected.
843 843  |includeInsurance|Boolean|If true, insurance will be included in the tour package.
... ... @@ -853,7 +853,7 @@
853 853  |agentCommissionPercent|Number|The commission percentage for the agent.
854 854  |agentCommissionAmount|Number|The total commission amount for the agent in priceCurrency.
855 855  |requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code.
856 -|requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN").
893 +|requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN"). **TIN (Taxpayer Identification Number) & FIN (Financial Identification Number)**
857 857  |hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
858 858  |hotels[*].touristIds[*]|String|List of tourist IDs that are booked in this hotel.
859 859  |hotels[*].description|String|A brief description of the hotel.