Changes for page 4. CalcCheckout

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

From 6.1 to 5.1 From 11.1 to 10.5

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 6.1

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

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,10 +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.
--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.
--
  == Endpoint URL - [POST] ==
  {{info}}
@@ -638,102 +638,49 @@
  === Schema ===
--
--
  {{success}}
--CheckoutFormIn{
--
--|reservationId|string($uuid)
++|error|boolean
++|errorCode|string
  nullable: true
--|calcTourPackageRequests|[
--nullable: trueCalcTourPackageRequest{(((
--|packageId|string
++|errorDescription|string
  nullable: true
--|extraServicePriceCodes|[
--nullable: truestring]
--|flightPassengers|[
--nullable: trueFlightPassengerIn{(((
--|id|string
++|userErrorDescription|string
  nullable: true
--|selectedForwardBaggageCode|string
++|priceCurrency|string
  nullable: true
--|selectedBackwardBaggageCode|string
--nullable: true
++|totalPrice|number($double)
++|agentCommissionPercent|number($double)
++|agentCommissionAmount|number($double)
++|requiredCitizenIdentifiers|[
++nullable: trueCitizenIdentifier{(((
++|countryCode|[...]
++|identifierType|IdentifierTypeEnumstringEnum:
++[ TIN, FIN ]
  }]
  )))
--|includeInsurance|boolean
--nullable: true
--|refreshPrices|boolean
--
--}]
--)))
--|calcOnlyHotelPackageRequests|[
--nullable: trueCalcOnlyHotelPackageRequest{(((
--|packageId|string
--nullable: true
--|extraServicePriceCodes|[
--nullable: truestring]
--|includeInsurance|boolean
--|refreshPrices|boolean
--
--}]
--)))
--|calcOnlyAviaPackageRequests|[
--nullable: trueCalcOnlyAviaPackageRequest{(((
--|packageId|string
--nullable: true
--|refreshPrices|boolean
--|flightPassengers|[
--nullable: trueFlightPassengerIn{(((
--|id|string
--nullable: true
--|selectedForwardBaggageCode|string
--nullable: true
--|selectedBackwardBaggageCode|string
--nullable: true
--
--}]
--)))
--
--}]
--)))
  |hotels|[
--nullable: trueCheckoutHotelIn{(((
++nullable: trueCheckoutHotelOut{(((
  |hotelPriceId|string
  nullable: true
--|agentConfirmationNumber|string
--nullable: true
--|note|string
--nullable: true
  |touristIds|[
  nullable: truestring($uuid)]
++|errorCode|string
++nullable: true
++|errorMessage|string
++nullable: true
++|description|string
++nullable: true
  }]
  )))
  |tourists|[
--nullable: trueCheckoutTouristIn{(((
--|id|string($uuid)
--|firstName|string
--nullable: true
--|lastName|string
--nullable: true
--|birthDate|string($date-time)
--nullable: true
--|passportNumber|string
--nullable: true
--|passportExpiry|string($date-time)
--nullable: true
--|passportIssue|string($date-time)
--nullable: true
--|citizenship|string
--nullable: true
--|tin|string
--nullable: true
--|isMale|boolean
--nullable: true
--|flightIds|[
--nullable: truestring]
++nullable: trueCheckoutTouristOut{(((
++|id|[...]
++|age|[...]
++|isAdult|[...]
++|flightIds|[...]
++|flights|[...]
  |arrivalFlightInfo|ManualFlightInfo{(((
  |flightNumber|string
  nullable: true
@@ -758,60 +758,78 @@
  }
  )))
++|insurancePrice|InsurancePriceForTourist{(((
++|insuranceId|string($uuid)
++|insuranceServiceId|string($uuid)
++|insurancePriceId|string($uuid)
++|touristId|string($uuid)
++|insuranceName|string
++nullable: true
++|insuranceDescription|string
++nullable: true
++|contragentName|string
++nullable: true
++|contragentFullName|string
++nullable: true
++|actualStartDate|string($date-time)
++|actualEndDate|string($date-time)
++|costCurrencyCode|string
++nullable: true
++|costAmount|number($double)
++|priceCurrencyCode|string
++nullable: true
++|priceAmount|number($double)
++|coverageCurrencyCode|string
++nullable: true
++|coverageAmount|number($double)
++
++}
++)))
  |selectedVisaId|string
  nullable: true
  |transfers|[
--nullable: trueCheckoutTransferIn{(((
++nullable: trueCheckoutTransferOut{(((
  |id|string
  nullable: true
--|selectedTransferPriceId|string
++|type|CheckoutTransferTypeEnumstringEnum:
++[ Arrival, Departure, HotelToHotel ]
++|flightId|string
  nullable: true
--
--}]
--)))
--
--}]
--)))
--|note|string
++|flightInfo|ManualFlightInfo{(((
++|flightNumber|string
  nullable: true
--|contactPhone|string
++|terminalCode|string
  nullable: true
++|date|string($date-time)
++nullable: true
++|time|string
++nullable: true
  }
--{{/success}}
--
--
--
--{{success}}
--CheckoutFormOut{
--
--|error|boolean
--|errorCode|string
++)))
++|checkInHotelId|string
  nullable: true
--|errorDescription|string
++|checkOutHotelId|string
  nullable: true
--|userErrorDescription|string
++|selectedTransferPriceId|string
  nullable: true
--|priceCurrency|string
++|transferPrices|[
++nullable: trueCheckoutTransferPrice{(((
++|id|string
  nullable: true
--|totalPrice|number($double)
--|agentCommissionPercent|number($double)
--|agentCommissionAmount|number($double)
--|requiredCitizenIdentifiers|[
--nullable: trueCitizenIdentifier{(((
--|countryCode|string
++|name|string
  nullable: true
--|identifierType|IdentifierTypeEnumstringEnum:
--[ TIN, FIN ]
++|adultPlaces|integer($int32)
++|childPlaces|integer($int32)
++|perPersonPrice|boolean
++|adultPrice|number($double)
++|childPrice|number($double)
  }]
  )))
--|hotels|[
--nullable: trueCheckoutHotelOut{(((
--|hotelPriceId|string
--nullable: true
--|touristIds|[
--nullable: truestring($uuid)]
++
++}]
++)))
  |errorCode|string
  nullable: true
  |errorMessage|string
@@ -821,8 +821,6 @@
  }]
  )))
--|tourists|[
--nullable: trueCheckoutTouristOut{...}]
  |visas|[
  nullable: trueServicePrice{(((
  |prid|string($uuid)
@@ -858,70 +858,3 @@
  }
  {{/success}}
--
--
--== Descriptions ==
--
--
--=== Request ===
--
--Here's a table describing each parameter of the JSON request:
--
--(% class="table-bordered" %)
--|=Parameter|=Data Type|=Description
--|calcTourPackageRequests|Array|An array of objects, each representing a tour package request.
--|refreshPrices|Boolean|If true, the prices for the tour package will be refreshed.
--|packageId|String|A unique identifier for the tour package.
--|flightPassengers|Array|An array of objects, each representing a flight passenger.
--|id|String|A unique identifier for each flight passenger.
--|selectedForwardBaggageCode|String|The selected baggage option for the forward journey. there is two optoions ""
--|selectedBackwardBaggageCode|String|The selected baggage option for the backward journey.
--|extraServicePriceCodes|Array|An array of extra service price codes. If empty, no extra services are selected.
--|includeInsurance|Boolean|If true, insurance will be included in the tour package.
--|calcOnlyHotelPackageRequests|Array|An array of objects, each representing a hotel-only package request. If empty, no hotel-only packages are requested.
--|calcOnlyAviaPackageRequests|Array|An array of objects, each representing an avia-only package request. If empty, no avia-only packages are requested.
--
--=== Response ===
--
--(% class="table-bordered" %)
--|=Parameter|=Data Type|=Description
--|priceCurrency|String|The currency code (ISO 4217) for all prices mentioned in the response.
--|totalPrice|Number|The total price of the booking.
--|agentCommissionPercent|Number|The commission percentage for the agent.
--|agentCommissionAmount|Number|The total commission amount for the agent in priceCurrency.
--|requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code.
--|requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN"). **TIN (Taxpayer Identification Number) & FIN (Financial Identification Number)**
--|hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
--|hotels[*].touristIds[*]|String|List of tourist IDs that are booked in this hotel.
--|hotels[*].description|String|A brief description of the hotel.
--|tourists[*].id|String|Unique identifier for the tourist.
--|tourists[*].isAdult|Boolean|Indicates if the tourist is an adult.
--|tourists[*].flightIds[*]|String|Identifiers for flights associated with the tourist.
--|tourists[*].flights[*].flightId|String|Unique identifier for the flight.
--|tourists[*].flights[*].note|String|Additional information about the flight, such as baggage allowance.
--|tourists[*].insurancePrice.insuranceId|String|Unique identifier for the insurance product.
--|tourists[*].insurancePrice.insuranceServiceId|String|Identifier for the insurance service provider.
--|...|...|Additional fields for insurancePrice as detailed previously.
--|tourists[*].transfers[*].id|String|Unique identifier for the transfer service.
--|tourists[*].transfers[*].type|String|The type of transfer (e.g., "Arrival", "Departure").
--|tourists[*].transfers[*].flightId|String|Identifier of the flight associated with this transfer.
--|tourists[*].transfers[*].checkInHotelId|String|Hotel ID for check-in associated with this transfer (for arrival type).
--|tourists[*].transfers[*].checkOutHotelId|String|Hotel ID for check-out associated with this transfer (for departure type).
--|tourists[*].transfers[*].selectedTransferPriceId|String|The ID of the selected pricing option for the transfer.
--|tourists[*].transfers[*].transferPrices[*].id|String|Unique identifier for the transfer price option.
--|tourists[*].transfers[*].transferPrices[*].name|String|The name of the transfer service (e.g., "GROUP", "MINIVAN").
--|...|...|Additional fields for transferPrices as detailed previously.
--|visas[*].prid|String|Unique identifier for the visa option.
--|visas[*].prName|String|The name of the visa option.
--|visas[*].prValue|Number|The cost associated with this visa option.
--|visas[*].sortingOrder|Number|Used to sort visa options in the response or UI.
--|terminals[*].terminalCode|String|The code representing the terminal.
--|terminals[*].cityUID|String|Unique identifier for the city where the terminal is located.
--|...|...|Additional fields for terminals as detailed previously.
--|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 4. CalcCheckout

Summary

Details

Applications

Navigation