Changes for page 5. ConfirmCheckout

Last modified by Giorgi Mdivnishvili on 2024/08/30 12:58

From 6.1 to 5.1

From version 13.1

edited by Giorgi Mdivnishvili
on 2024/08/30 12:58

Change comment: There is no comment for this version

To version 6.1

edited by Giorgi Mdivnishvili
on 2024/04/11 09:19

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -6,16 +6,9 @@
  = Method Description =
++This method is used to calculate full package with hotels and flights, to recheck prices, availability, prices and cancelation policy before book.
--This API endpoint serves the purpose of registering a new reservation.
--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.
--
--{{warning}}
--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.
--{{/warning}}
--
--
  == Endpoint URL - [POST] ==
  {{info}}
@@ -997,7 +997,7 @@
  === Schema ===
  {{success}}
--CheckoutFormOut{
++CalcOnlyHotelPackageResponse{
  |error|boolean
  |errorCode|string
@@ -1006,287 +1006,128 @@
  nullable: true
  |userErrorDescription|string
  nullable: true
++|package|OnlyHotelPackage{(((
++|id|string
++nullable: true
  |priceCurrency|string
  nullable: true
  |totalPrice|number($double)
  |agentCommissionPercent|number($double)
  |agentCommissionAmount|number($double)
--|requiredCitizenIdentifiers|[
--nullable: trueCitizenIdentifier{(((
--|countryCode|string
--nullable: true
--|identifierType|IdentifierTypeEnumstringEnum:
--[ TIN, FIN ]
--
--}]
--)))
--|hotels|[
--nullable: trueCheckoutHotelOut{(((
++|hotel|PackageHotel{(((
  |hotelPriceId|string
  nullable: true
--|touristIds|[
--nullable: truestring($uuid)]
--|errorCode|string
++|providerId|integer($int32)
++|hotelName|string
  nullable: true
--|errorMessage|string
++|hotelCode|string
  nullable: true
--|description|string
++|nigths|integer($int32)
++|mealPlan|string
  nullable: true
--
--}]
--)))
--|tourists|[
--nullable: trueCheckoutTouristOut{(((
--|id|string($uuid)
--|age|integer($int32)
++|hotelClass|string
  nullable: true
--|isAdult|boolean
--|flightIds|[
--nullable: truestring]
--|flights|[
--nullable: trueCheckoutFlightOut{(((
--|flightId|string
++|availabilityType|RoomAvailabilityTypeEnumstringEnum:
++[ OnRequest, FreeSale, StopSale ]
++|availableRoomsCount|integer($int32)
++|fewRooms|boolean
++|roomCategoryCode|string
  nullable: true
--|note|string
++|roomCategoryName|string
  nullable: true
--
--}]
--)))
--|arrivalFlightInfo|ManualFlightInfo{(((
--|flightNumber|string
++|placementTypeName|string
  nullable: true
--|terminalCode|string
++|placementDescription|string
  nullable: true
--|date|string($date-time)
++|checkInDate|string($date-time)
++|checkOutDate|string($date-time)
++|adults|integer($int32)
++|children|integer($int32)
++|districtUID|string($uuid)
  nullable: true
--|time|string
++|districtName|string
  nullable: true
--
--}
--)))
--|departureFlightInfo|ManualFlightInfo{(((
--|flightNumber|string
++|cityUID|string($uuid)
  nullable: true
--|terminalCode|string
++|cityName|string
  nullable: true
--|date|string($date-time)
++|countryCode|string
  nullable: true
--|time|string
++|countryName|string
  nullable: true
--
--}
--)))
--|insurancePrice|InsurancePriceForTourist{(((
--|insuranceId|string($uuid)
--|insuranceServiceId|string($uuid)
--|insurancePriceId|string($uuid)
--|touristId|string($uuid)
--|insuranceName|string
++|hasAlcohol|boolean
++|hasFreeWifi|boolean
++|hasMetro|boolean
++|hasPool|boolean
++|hasMall|boolean
++|cancellationPolicyDescription|string
  nullable: true
--|insuranceDescription|string
++|cancellationPolicy|CancellationPolicyExchange{(((
++|cancellationPolicyCode|string
  nullable: true
--|contragentName|string
++|noShowChargeValue|number($double)
  nullable: true
--|contragentFullName|string
++|noShowChargeValueType|string
  nullable: true
--|actualStartDate|string($date-time)
--|actualEndDate|string($date-time)
--|costCurrencyCode|string
++|earlyDepartureChargeValue|number($double)
  nullable: true
--|costAmount|number($double)
--|priceCurrencyCode|string
++|earlyDepartureChargeValueType|string
  nullable: true
--|priceAmount|number($double)
--|coverageCurrencyCode|string
++|conditions|[
++nullable: trueCancellationPolicyConditionExchange{(((
++|timeunits|integer($int32)
++|timeunitType|string
  nullable: true
--|coverageAmount|number($double)
--
--}
--)))
--|selectedVisaId|string
++|timeOffsetTypeName|string
  nullable: true
--|transfers|[
--nullable: trueCheckoutTransferOut{(((
--|id|string
++|chargeValue|number($double)
  nullable: true
--|type|CheckoutTransferTypeEnumstringEnum:
--[ Arrival, Departure, HotelToHotel ]
--|flightId|string
++|chargeValueType|string
  nullable: true
--|flightInfo|ManualFlightInfo{(((
--|flightNumber|string
--nullable: true
--|terminalCode|string
--nullable: true
--|date|string($date-time)
--nullable: true
--|time|string
--nullable: true
++}]
++)))
++
  }
  )))
--|checkInHotelId|string
++
++}
++)))
++|extraServices|[
++nullable: trueHotelExtraServiceBase{(((
++|extraServiceCode|string
  nullable: true
--|checkOutHotelId|string
++|extraServiceTypeCode|string
  nullable: true
--|selectedTransferPriceId|string
++|isMandatory|integer($int32)
++|extraServiceName|string
  nullable: true
--|transferPrices|[
--nullable: trueCheckoutTransferPrice{(((
--|id|string
++|minimalServiceAmount|number($double)
++|includedPriceCode|string
  nullable: true
--|name|string
++|prices|[
++nullable: trueHotelExtraServicePriceBase{(((
++|extraServicePriceCode|string
  nullable: true
--|adultPlaces|integer($int32)
--|childPlaces|integer($int32)
--|perPersonPrice|boolean
--|adultPrice|number($double)
--|childPrice|number($double)
--
--}]
--)))
--
--}]
--)))
--|errorCode|string
++|displayName|string
  nullable: true
--|errorMessage|string
++|restrictionInfo|string
  nullable: true
--|description|string
++|additionalInfo|string
  nullable: true
++|price|number($double)
++|extraPrice|number($double)
++|currency|string
++nullable: true
  }]
  )))
--|visas|[
--nullable: trueServicePrice{(((
--|prid|string($uuid)
--|prName|string
--nullable: true
--|prValue|number($double)
--|sortingOrder|integer($int32)
  }]
  )))
--|terminals|[
--nullable: trueTerminal{(((
--|terminalCode|string
--nullable: true
--|cityUID|string($uuid)
--nullable: true
--|districtUID|string($uuid)
--nullable: true
--|terminalName|string
--nullable: true
--|countryCode|string
--nullable: true
--|note|string
--nullable: true
--}]
++}
  )))
--|containsError|boolean
--|refreshPriceResult|RefreshPriceResultEnumstringEnum:
--[ Success, HotelPriceNoMoreAvailable, FlightPriceNoMoreAvailable ]
--|reservationId|string($uuid)
--|reservationDetailsUnavailable|boolean
  }
  {{/success}}
--
--
--
--== Description ==
--
--
--=== Request ===
--
--(% class="table-bordered" %)
--|=Field Path|=Data Type|=Description
--|calcTourPackageRequests[*].refreshPrices|Boolean|Indicates whether to refresh the prices for the tour package.
--|calcTourPackageRequests[*].packageId|String|Unique identifier for the tour package.
--|calcTourPackageRequests[*].flightPassengers[*].id|String|Unique identifier for a flight passenger within the package.
--|calcTourPackageRequests[*].flightPassengers[*].selectedForwardBaggageCode|String|Code indicating the baggage option selected for the forward journey.
--|calcTourPackageRequests[*].flightPassengers[*].selectedBackwardBaggageCode|String|Code indicating the baggage option selected for the return journey.
--|calcTourPackageRequests[*].extraServicePriceCodes|Array|An array of codes for extra services priced within the package.
--|calcTourPackageRequests[*].includeInsurance|Boolean|Indicates if insurance is included in the tour package.
--|calcOnlyHotelPackageRequests|Array|Details about hotel-only package requests, if applicable.
--|calcOnlyAviaPackageRequests|Array|Details about avia-only package requests, if applicable.
--|hotels[*].note|String|Additional notes regarding the hotel booking.
--|hotels[*].agentConfirmationNumber|String|Confirmation number provided by the agent for the hotel booking.
--|hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
--|hotels[*].touristIds[*]|String|List of IDs for tourists staying at the hotel.
--|tourists[*].id|String|Unique identifier for the tourist.
--|tourists[*].isMale|Boolean|Indicates if the tourist is male.
--|tourists[*].firstName|String|First name of the tourist.
--|tourists[*].lastName|String|Last name of the tourist.
--|tourists[*].birthDate|String|Birth date of the tourist.
--|tourists[*].citizenship|String|Citizenship of the tourist.
--|tourists[*].passportNumber|String|Passport number of the tourist.
--|tourists[*].passportIssue|String|Issue date of the tourist's passport.
--|tourists[*].passportExpiry|String|Expiry date of the tourist's passport.
--|tourists[*].tin|String|Tax identification number of the tourist, if applicable.
--|tourists[*].selectedVisaId|String|ID of the selected visa option for the tourist.
--|tourists[*].flights[*].flightId|String|Identifier for flights associated with the tourist.
--|tourists[*].flights[*].note|String|Additional notes or details about the flight.
--|tourists[*].flightIds[*]|String|Array of flight IDs associated with the tourist.
--|tourists[*].insurancePrice.insuranceId|String|Identifier for the insurance plan selected for the tourist.
--|...|...|Additional fields for insurancePrice as detailed in previous responses.
--|tourists[*].departureFlightInfo.date|String|Departure date for the tourist's flight, if applicable.
--|tourists[*].departureFlightInfo.time|String|Departure time for the tourist's flight, if applicable.
--|tourists[*].departureFlightInfo.flightNumber|String|Flight number for the tourist's departure flight, if applicable.
--|tourists[*].departureFlightInfo.terminalCode|String|Terminal code for the tourist's departure flight, if applicable.
--|tourists[*].arrivalFlightInfo.date|String|Arrival date for the tourist's flight, if applicable.
--|tourists[*].arrivalFlightInfo.time|String|Arrival time for the tourist's flight, if applicable.
--|tourists[*].arrivalFlightInfo.flightNumber|String|Flight number for the tourist's arrival flight, if applicable.
--|tourists[*].arrivalFlightInfo.terminalCode|String|Terminal code for the tourist's arrival flight, if applicable.
--|tourists[*].transfers[*].id|String|Unique identifier for a transfer service associated with the tourist.
--|tourists[*].transfers[*].selectedTransferPriceId|String|ID of the selected pricing option for the transfer.
--|note|String|General note regarding the reservation, intended for testing or additional information.
--|contactPhone|String|Contact phone number associated with the reservation.
--|reservationId|String|Unique identifier for the entire reservation.
--
--=== Response ===
--
--(% class="table-bordered" %)
--|=Field Path|=Data Type|=Description
--|priceCurrency|String|Currency code (ISO 4217) for all transactional amounts mentioned in the response.
--|totalPrice|Number|Total price of the reservation.
--|agentCommissionPercent|Number|The percentage of the total price allocated as commission for the agent.
--|agentCommissionAmount|Number|The total commission amount in priceCurrency.
--|requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code for which an identifier is required.
--|requiredCitizenIdentifiers[*].identifierType|String|Type of identifier required (e.g., "TIN", "FIN").
--|hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
--|hotels[*].touristIds[*]|Array|List of tourist IDs that are booked in this hotel.
--|hotels[*].description|String|Description of the hotel booking.
--|tourists[*].id|String|Unique identifier for a tourist.
--|tourists[*].age|Number|Age of the tourist.
--|tourists[*].isAdult|Boolean|Indicates whether the tourist is an adult.
--|tourists[*].flightIds[*]|Array|List of flight IDs associated with the tourist.
--|tourists[*].flights[*].flightId|String|Unique identifier for the flight.
--|tourists[*].flights[*].note|String|Notes or additional information about the flight.
--|tourists[*].insurancePrice.*|Various|Detailed information about the insurance price, including ID, name, coverage, and cost details.
--|tourists[*].selectedVisaId|String|Identifier for the selected visa option for the tourist.
--|tourists[*].transfers[*].id|String|Unique identifier for the transfer.
--|tourists[*].transfers[*].type|String|Type of transfer (e.g., "Arrival", "Departure").
--|tourists[*].transfers[*].flightId|String|The flight ID associated with the transfer.
--|tourists[*].transfers[*].checkInHotelId|String|Hotel ID for check-in associated with the transfer.
--|tourists[*].transfers[*].checkOutHotelId|String|Hotel ID for check-out associated with the transfer.
--|tourists[*].transfers[*].selectedTransferPriceId|String|The ID of the selected pricing option for the transfer.
--|tourists[*].transfers[*].transferPrices[*].*|Various|Detailed information about each transfer price option, including ID, name, and cost details.
--|visas[*].prid|String|Unique identifier for a visa option.
--|visas[*].prName|String|Name of the visa option.
--|visas[*].prValue|Number|The cost associated with this visa option.
--|visas[*].sortingOrder|Number|Sorting order for the visa options.
--|terminals[*].terminalCode|String|Code representing the terminal.
--|terminals[*].cityUID|String|Unique identifier for the city where the terminal is located.
--|terminals[*].districtUID|String|Unique identifier for the district of the terminal.
--|terminals[*].terminalName|String|Name of the terminal.
--|terminals[*].countryCode|String|The ISO 3166-1 alpha-2 country code for the terminal's country.
--|terminals[*].note|String|Additional notes or information about the terminal.
--|containsError|Boolean|Indicates if the response contains any errors.
--|refreshPriceResult|String|The result of attempting to refresh the price (e.g., "Success").
--|reservationId|String|Unique identifier for the reservation.
--|reservationDetailsUnavailable|Boolean|Indicates if the reservation details are currently unavailable.
--|error|Boolean|A generic error indicator, presumably redundant with containsError.
--
--

Changes for page 5. ConfirmCheckout

Summary

Details

Applications

Navigation