4. CalcCheckout
Version 8.1 by Giorgi Mdivnishvili on 2024/04/11 12:48
Contents
Method Description
This method is used to calculate full package with hotels and flights, to recheck prices, availability, prices and cancelation policy before book.
Endpoint URL - [POST]
Request Parameters
Request Body
{
"reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"calcTourPackageRequests": [
{
"packageId": "string",
"extraServicePriceCodes": [
"string"
],
"flightPassengers": [
{
"id": "string",
"selectedForwardBaggageCode": "string",
"selectedBackwardBaggageCode": "string"
}
],
"includeInsurance": true,
"refreshPrices": true
}
],
"calcOnlyHotelPackageRequests": [
{
"packageId": "string",
"extraServicePriceCodes": [
"string"
],
"includeInsurance": true,
"refreshPrices": true
}
],
"calcOnlyAviaPackageRequests": [
{
"packageId": "string",
"refreshPrices": true,
"flightPassengers": [
{
"id": "string",
"selectedForwardBaggageCode": "string",
"selectedBackwardBaggageCode": "string"
}
]
}
],
"hotels": [
{
"hotelPriceId": "string",
"agentConfirmationNumber": "string",
"note": "string",
"touristIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
],
"tourists": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"firstName": "string",
"lastName": "string",
"birthDate": "2024-04-11T03:34:15.828Z",
"passportNumber": "string",
"passportExpiry": "2024-04-11T03:34:15.828Z",
"passportIssue": "2024-04-11T03:34:15.828Z",
"citizenship": "string",
"tin": "string",
"isMale": true,
"flightIds": [
"string"
],
"arrivalFlightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T03:34:15.828Z",
"time": "string"
},
"departureFlightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T03:34:15.828Z",
"time": "string"
},
"selectedVisaId": "string",
"transfers": [
{
"id": "string",
"selectedTransferPriceId": "string"
}
]
}
],
"note": "string",
"contactPhone": "string"
}
"reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"calcTourPackageRequests": [
{
"packageId": "string",
"extraServicePriceCodes": [
"string"
],
"flightPassengers": [
{
"id": "string",
"selectedForwardBaggageCode": "string",
"selectedBackwardBaggageCode": "string"
}
],
"includeInsurance": true,
"refreshPrices": true
}
],
"calcOnlyHotelPackageRequests": [
{
"packageId": "string",
"extraServicePriceCodes": [
"string"
],
"includeInsurance": true,
"refreshPrices": true
}
],
"calcOnlyAviaPackageRequests": [
{
"packageId": "string",
"refreshPrices": true,
"flightPassengers": [
{
"id": "string",
"selectedForwardBaggageCode": "string",
"selectedBackwardBaggageCode": "string"
}
]
}
],
"hotels": [
{
"hotelPriceId": "string",
"agentConfirmationNumber": "string",
"note": "string",
"touristIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
],
"tourists": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"firstName": "string",
"lastName": "string",
"birthDate": "2024-04-11T03:34:15.828Z",
"passportNumber": "string",
"passportExpiry": "2024-04-11T03:34:15.828Z",
"passportIssue": "2024-04-11T03:34:15.828Z",
"citizenship": "string",
"tin": "string",
"isMale": true,
"flightIds": [
"string"
],
"arrivalFlightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T03:34:15.828Z",
"time": "string"
},
"departureFlightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T03:34:15.828Z",
"time": "string"
},
"selectedVisaId": "string",
"transfers": [
{
"id": "string",
"selectedTransferPriceId": "string"
}
]
}
],
"note": "string",
"contactPhone": "string"
}
Request Body example
{
"calcTourPackageRequests": [
{
"refreshPrices": true,
"packageId": "tour:7caef71d-25e3-4882-b0db-81e766af2b72:fa7a89d5-1c20-4004-b3d2-f8d08163827f:53552191-59ea-469d-ae9d-5b848da8839d",
"flightPassengers": [
{
"id": "53552191-59ea-469d-ae9d-5b848da8839d-A1",
"selectedForwardBaggageCode": "INCLUDED",
"selectedBackwardBaggageCode": "INCLUDED"
},
{
"id": "53552191-59ea-469d-ae9d-5b848da8839d-A2",
"selectedForwardBaggageCode": "INCLUDED",
"selectedBackwardBaggageCode": "INCLUDED"
}
],
"extraServicePriceCodes": [],
"includeInsurance": true
}
],
"calcOnlyHotelPackageRequests": [],
"calcOnlyAviaPackageRequests": []
}
"calcTourPackageRequests": [
{
"refreshPrices": true,
"packageId": "tour:7caef71d-25e3-4882-b0db-81e766af2b72:fa7a89d5-1c20-4004-b3d2-f8d08163827f:53552191-59ea-469d-ae9d-5b848da8839d",
"flightPassengers": [
{
"id": "53552191-59ea-469d-ae9d-5b848da8839d-A1",
"selectedForwardBaggageCode": "INCLUDED",
"selectedBackwardBaggageCode": "INCLUDED"
},
{
"id": "53552191-59ea-469d-ae9d-5b848da8839d-A2",
"selectedForwardBaggageCode": "INCLUDED",
"selectedBackwardBaggageCode": "INCLUDED"
}
],
"extraServicePriceCodes": [],
"includeInsurance": true
}
],
"calcOnlyHotelPackageRequests": [],
"calcOnlyAviaPackageRequests": []
}
Response
{
"error": true,
"errorCode": "string",
"errorDescription": "string",
"userErrorDescription": "string",
"priceCurrency": "string",
"totalPrice": 0,
"agentCommissionPercent": 0,
"agentCommissionAmount": 0,
"requiredCitizenIdentifiers": [
{
"countryCode": "string",
"identifierType": "TIN"
}
],
"hotels": [
{
"hotelPriceId": "string",
"touristIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"errorCode": "string",
"errorMessage": "string",
"description": "string"
}
],
"tourists": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"age": 0,
"isAdult": true,
"flightIds": [
"string"
],
"flights": [
{
"flightId": "string",
"note": "string"
}
],
"arrivalFlightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T05:03:16.796Z",
"time": "string"
},
"departureFlightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T05:03:16.796Z",
"time": "string"
},
"insurancePrice": {
"insuranceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"insuranceServiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"insurancePriceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"insuranceName": "string",
"insuranceDescription": "string",
"contragentName": "string",
"contragentFullName": "string",
"actualStartDate": "2024-04-11T05:03:16.796Z",
"actualEndDate": "2024-04-11T05:03:16.796Z",
"costCurrencyCode": "string",
"costAmount": 0,
"priceCurrencyCode": "string",
"priceAmount": 0,
"coverageCurrencyCode": "string",
"coverageAmount": 0
},
"selectedVisaId": "string",
"transfers": [
{
"id": "string",
"type": "Arrival",
"flightId": "string",
"flightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T05:03:16.796Z",
"time": "string"
},
"checkInHotelId": "string",
"checkOutHotelId": "string",
"selectedTransferPriceId": "string",
"transferPrices": [
{
"id": "string",
"name": "string",
"adultPlaces": 0,
"childPlaces": 0,
"perPersonPrice": true,
"adultPrice": 0,
"childPrice": 0
}
]
}
],
"errorCode": "string",
"errorMessage": "string",
"description": "string"
}
],
"visas": [
{
"prid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"prName": "string",
"prValue": 0,
"sortingOrder": 0
}
],
"terminals": [
{
"terminalCode": "string",
"cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"terminalName": "string",
"countryCode": "string",
"note": "string"
}
],
"containsError": true,
"refreshPriceResult": "Success",
"reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reservationDetailsUnavailable": true
}
"error": true,
"errorCode": "string",
"errorDescription": "string",
"userErrorDescription": "string",
"priceCurrency": "string",
"totalPrice": 0,
"agentCommissionPercent": 0,
"agentCommissionAmount": 0,
"requiredCitizenIdentifiers": [
{
"countryCode": "string",
"identifierType": "TIN"
}
],
"hotels": [
{
"hotelPriceId": "string",
"touristIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"errorCode": "string",
"errorMessage": "string",
"description": "string"
}
],
"tourists": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"age": 0,
"isAdult": true,
"flightIds": [
"string"
],
"flights": [
{
"flightId": "string",
"note": "string"
}
],
"arrivalFlightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T05:03:16.796Z",
"time": "string"
},
"departureFlightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T05:03:16.796Z",
"time": "string"
},
"insurancePrice": {
"insuranceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"insuranceServiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"insurancePriceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"insuranceName": "string",
"insuranceDescription": "string",
"contragentName": "string",
"contragentFullName": "string",
"actualStartDate": "2024-04-11T05:03:16.796Z",
"actualEndDate": "2024-04-11T05:03:16.796Z",
"costCurrencyCode": "string",
"costAmount": 0,
"priceCurrencyCode": "string",
"priceAmount": 0,
"coverageCurrencyCode": "string",
"coverageAmount": 0
},
"selectedVisaId": "string",
"transfers": [
{
"id": "string",
"type": "Arrival",
"flightId": "string",
"flightInfo": {
"flightNumber": "string",
"terminalCode": "string",
"date": "2024-04-11T05:03:16.796Z",
"time": "string"
},
"checkInHotelId": "string",
"checkOutHotelId": "string",
"selectedTransferPriceId": "string",
"transferPrices": [
{
"id": "string",
"name": "string",
"adultPlaces": 0,
"childPlaces": 0,
"perPersonPrice": true,
"adultPrice": 0,
"childPrice": 0
}
]
}
],
"errorCode": "string",
"errorMessage": "string",
"description": "string"
}
],
"visas": [
{
"prid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"prName": "string",
"prValue": 0,
"sortingOrder": 0
}
],
"terminals": [
{
"terminalCode": "string",
"cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"terminalName": "string",
"countryCode": "string",
"note": "string"
}
],
"containsError": true,
"refreshPriceResult": "Success",
"reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reservationDetailsUnavailable": true
}
Response example
{
"package": {
"id": "tour:1d0fa533-4261-4254-93bb-83599d581ffc:193990fa-41a5-46e6-9805-50f82c3c377f:0c299240-6fc6-4f79-ba99-3548f2de3f57",
"priceCurrency": "USD",
"totalPrice": 937.16,
"agentCommissionPercent": 0.00,
"agentCommissionAmount": 0.00,
"includedExtrasAmount": 0,
"priceDifference": 0,
"hotel": {
"hotelPriceId": "193990fa-41a5-46e6-9805-50f82c3c377f",
"providerId": 13,
"hotelName": "Mercure Dubai Barsha Heights Suites Apartments",
"hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14",
"nigths": 2,
"mealPlan": "BB",
"hotelClass": "4",
"availabilityType": "StopSale",
"availableRoomsCount": 0,
"fewRooms": true,
"roomCategoryCode": "f8e1ffe5-25cc-46a4-80e8-586d1c049de4",
"roomCategoryName": "1 B/R Apartment City View",
"placementTypeName": "SNGL + CHILD(2-5.99)sharing",
"checkInDate": "2024-02-15T20:00:00.000Z",
"checkOutDate": "2024-02-17T20:00:00.000Z",
"adults": 1,
"children": 1,
"districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
"districtName": "Al Barsha",
"cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
"cityName": "Dubai",
"countryCode": "AE",
"countryName": "United Arab Emirates",
"hasAlcohol": false,
"hasFreeWifi": true,
"hasMetro": true,
"hasPool": true,
"hasMall": false,
"cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
"cancellationPolicy": {
"noShowChargeValue": 100.00,
"noShowChargeValueType": "%",
"earlyDepartureChargeValue": 100.00,
"earlyDepartureChargeValueType": "%",
"conditions": [
{
"timeunits": 5,
"timeunitType": "Day",
"timeOffsetTypeName": "Before Arrival",
"chargeValue": 100.00,
"chargeValueType": "%"
}
]
}
},
"flight": {
"id": "0c299240-6fc6-4f79-ba99-3548f2de3f57",
"departureDate": "2024-02-15T20:00:00.000Z",
"returnDate": "2024-02-17T20:00:00.000Z",
"departureTicketsLeft": 7,
"returnTicketsLeft": 7,
"departureAvailabilityType": "FewPlaces",
"returnAvailabilityType": "FewPlaces",
"isTwoWay": true,
"sameBaggageForAll": false,
"totalBaggage": true,
"departureSegments": [
{
"airlineCode": "KC",
"airlineName": "Air Astana-",
"flightCode": "KC899",
"class": "econom",
"lugageWeight": 20,
"handLugageWeight": 6,
"departureFlightDate": "2024-02-15T20:00:00.000Z",
"departureCountryName": "Kazakhstan",
"departureCityName": "Almaty",
"departureAirportCode": "ALA",
"departureAirportName": "Almaty Intl Airport",
"departureTerminalCode": "ALA",
"arrivalFlightDate": "2024-02-15T20:00:00.000Z",
"arrivalCountryName": "United Arab Emirates",
"arrivalCityName": "Dubai",
"arrivalAirportCode": "DXB",
"arrivalAirportName": "Dubai Intl Airport",
"arrivalTerminalCode": "DXB1",
"flightDuration": "0h 50m"
}
],
"returnSegments": [
{
"airlineCode": "KC",
"airlineName": "Air Astana-",
"flightCode": "KC900",
"class": "econom",
"lugageWeight": 20,
"handLugageWeight": 6,
"departureFlightDate": "2024-02-17T20:00:00.000Z",
"departureCountryName": "United Arab Emirates",
"departureCityName": "Dubai",
"departureAirportCode": "DXB",
"departureAirportName": "Dubai Intl Airport",
"departureTerminalCode": "DXB1",
"arrivalFlightDate": "2024-02-17T20:00:00.000Z",
"arrivalCountryName": "Kazakhstan",
"arrivalCityName": "Almaty",
"arrivalAirportCode": "ALA",
"arrivalAirportName": "Almaty Intl Airport",
"arrivalTerminalCode": "ALA",
"flightDuration": "8h 15m"
}
],
"passengers": [
{
"id": "42779531011000004-A1",
"isAdult": true,
"forwardBaggages": [
{
"baggageCode": "TOTAL_BAGGAGE",
"description": "1 piece included, UP TO 50 POUNDS/23 KILOGRAMS, OVER 62 LINEAR INCHES/158 LINEAR CENTIMETERS",
"price": 45.00,
"currency": "USD",
"included": false
}
],
"backwardBaggages": [
{
"baggageCode": "INCLUDED_IN_FORWARD",
"price": 0,
"included": false
}
]
},
{
"id": "42779531011000004-C1",
"isAdult": false,
"forwardBaggages": [
{
"baggageCode": "TOTAL_BAGGAGE",
"description": "1 piece included, UP TO 50 POUNDS/23 KILOGRAMS, OVER 62 LINEAR INCHES/158 LINEAR CENTIMETERS",
"price": 45.00,
"currency": "USD",
"included": false
}
],
"backwardBaggages": [
{
"baggageCode": "INCLUDED_IN_FORWARD",
"price": 0,
"included": false
}
]
}
]
},
"extraServices": [],
"insurancePrice": {
"name": "Medical INS (N10000)",
"price": 13.44,
"priceSurcarge": 0.00,
"actualStartDate": "2024-02-15T20:00:00.000Z",
"actualEndDate": "2024-02-17T20:00:00.000Z",
"optional": false,
"includedInPackagePrice": true
}
},
"altPackages": [
{
"id": "tour:1d0fa533-4261-4254-93bb-83599d581ffc:193990fa-41a5-46e6-9805-50f82c3c377f:63d79c94-1e19-443f-8a17-50e59e633ea8",
"priceCurrency": "USD",
"totalPrice": 968.40,
"agentCommissionPercent": 0.00,
"agentCommissionAmount": 0.00,
"includedExtrasAmount": 0,
"priceDifference": 31.24,
"hotel": {
"hotelPriceId": "193990fa-41a5-46e6-9805-50f82c3c377f",
"providerId": 13,
"hotelName": "Mercure Dubai Barsha Heights Suites Apartments",
"hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14",
"nigths": 2,
"mealPlan": "BB",
"hotelClass": "4",
"availabilityType": "StopSale",
"availableRoomsCount": 0,
"fewRooms": true,
"roomCategoryCode": "f8e1ffe5-25cc-46a4-80e8-586d1c049de4",
"roomCategoryName": "1 B/R Apartment City View",
"placementTypeName": "SNGL + CHILD(2-5.99)sharing",
"checkInDate": "2024-02-15T20:00:00.000Z",
"checkOutDate": "2024-02-17T20:00:00.000Z",
"adults": 1,
"children": 1,
"districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
"districtName": "Al Barsha",
"cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
"cityName": "Dubai",
"countryCode": "AE",
"countryName": "United Arab Emirates",
"hasAlcohol": false,
"hasFreeWifi": true,
"hasMetro": true,
"hasPool": true,
"hasMall": false,
"cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
"cancellationPolicy": {
"noShowChargeValue": 100.00,
"noShowChargeValueType": "%",
"earlyDepartureChargeValue": 100.00,
"earlyDepartureChargeValueType": "%",
"conditions": [
{
"timeunits": 5,
"timeunitType": "Day",
"timeOffsetTypeName": "Before Arrival",
"chargeValue": 100.00,
"chargeValueType": "%"
}
]
}
},
"flight": {
"id": "63d79c94-1e19-443f-8a17-50e59e633ea8",
"departureDate": "2024-02-15T20:00:00.000Z",
"returnDate": "2024-02-17T20:00:00.000Z",
"departureTicketsLeft": 50,
"returnTicketsLeft": 50,
"departureAvailabilityType": "FewPlaces",
"returnAvailabilityType": "FewPlaces",
"isTwoWay": true,
"sameBaggageForAll": false,
"totalBaggage": false,
"departureSegments": [
{
"airlineCode": "FZ",
"airlineName": "Fly Dubai.",
"flightCode": "FZ1722",
"class": "econom",
"lugageWeight": 20,
"handLugageWeight": 6,
"departureFlightDate": "2024-02-15T20:00:00.000Z",
"departureCountryName": "Kazakhstan",
"departureCityName": "Almaty",
"departureAirportCode": "ALA",
"departureAirportName": "Almaty Intl Airport",
"departureTerminalCode": "ALA",
"arrivalFlightDate": "2024-02-15T20:00:00.000Z",
"arrivalCountryName": "United Arab Emirates",
"arrivalCityName": "Dubai",
"arrivalAirportCode": "DXB",
"arrivalAirportName": "Dubai Intl Airport",
"arrivalTerminalCode": "DXB3",
"flightDuration": "0h 55m"
}
],
"returnSegments": [
{
"airlineCode": "FZ",
"airlineName": "Fly Dubai.",
"flightCode": "FZ1721",
"class": "econom",
"lugageWeight": 20,
"handLugageWeight": 6,
"departureFlightDate": "2024-02-17T20:00:00.000Z",
"departureCountryName": "United Arab Emirates",
"departureCityName": "Dubai",
"departureAirportCode": "DXB",
"departureAirportName": "Dubai Intl Airport",
"departureTerminalCode": "DXB3",
"arrivalFlightDate": "2024-02-18T20:00:00.000Z",
"arrivalCountryName": "Kazakhstan",
"arrivalCityName": "Almaty",
"arrivalAirportCode": "ALA",
"arrivalAirportName": "Almaty Intl Airport",
"arrivalTerminalCode": "DXB3",
"flightDuration": "8h 10m"
}
],
"passengers": [
{
"id": "42779547001000004-A1",
"isAdult": true,
"selectedForwardBaggageCode": "INCLUDED",
"selectedBackwardBaggageCode": "INCLUDED",
"forwardBaggages": [
{
"baggageCode": "INCLUDED",
"description": "20 KG INCLUDED",
"price": 0.0,
"currency": "USD",
"included": true
}
],
"backwardBaggages": [
{
"baggageCode": "INCLUDED",
"description": "20 KG INCLUDED",
"price": 0.0,
"currency": "USD",
"included": true
}
]
},
{
"id": "42779547001000004-C1",
"isAdult": false,
"selectedForwardBaggageCode": "INCLUDED",
"selectedBackwardBaggageCode": "INCLUDED",
"forwardBaggages": [
{
"baggageCode": "INCLUDED",
"description": "20 KG INCLUDED",
"price": 0.0,
"currency": "USD",
"included": true
}
],
"backwardBaggages": [
{
"baggageCode": "INCLUDED",
"description": "20 KG INCLUDED",
"price": 0.0,
"currency": "USD",
"included": true
}
]
}
]
},
"extraServices": [],
"insurancePrice": {
"name": "Medical INS (N10000)",
"price": 13.44,
"priceSurcarge": 0.00,
"actualStartDate": "2024-02-15T20:00:00.000Z",
"actualEndDate": "2024-02-17T20:00:00.000Z",
"optional": false,
"includedInPackagePrice": true
}
},
{
"package": {
"id": "tour:1d0fa533-4261-4254-93bb-83599d581ffc:193990fa-41a5-46e6-9805-50f82c3c377f:0c299240-6fc6-4f79-ba99-3548f2de3f57",
"priceCurrency": "USD",
"totalPrice": 937.16,
"agentCommissionPercent": 0.00,
"agentCommissionAmount": 0.00,
"includedExtrasAmount": 0,
"priceDifference": 0,
"hotel": {
"hotelPriceId": "193990fa-41a5-46e6-9805-50f82c3c377f",
"providerId": 13,
"hotelName": "Mercure Dubai Barsha Heights Suites Apartments",
"hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14",
"nigths": 2,
"mealPlan": "BB",
"hotelClass": "4",
"availabilityType": "StopSale",
"availableRoomsCount": 0,
"fewRooms": true,
"roomCategoryCode": "f8e1ffe5-25cc-46a4-80e8-586d1c049de4",
"roomCategoryName": "1 B/R Apartment City View",
"placementTypeName": "SNGL + CHILD(2-5.99)sharing",
"checkInDate": "2024-02-15T20:00:00.000Z",
"checkOutDate": "2024-02-17T20:00:00.000Z",
"adults": 1,
"children": 1,
"districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
"districtName": "Al Barsha",
"cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
"cityName": "Dubai",
"countryCode": "AE",
"countryName": "United Arab Emirates",
"hasAlcohol": false,
"hasFreeWifi": true,
"hasMetro": true,
"hasPool": true,
"hasMall": false,
"cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
"cancellationPolicy": {
"noShowChargeValue": 100.00,
"noShowChargeValueType": "%",
"earlyDepartureChargeValue": 100.00,
"earlyDepartureChargeValueType": "%",
"conditions": [
{
"timeunits": 5,
"timeunitType": "Day",
"timeOffsetTypeName": "Before Arrival",
"chargeValue": 100.00,
"chargeValueType": "%"
}
]
}
},
"flight": {
"id": "0c299240-6fc6-4f79-ba99-3548f2de3f57",
"departureDate": "2024-02-15T20:00:00.000Z",
"returnDate": "2024-02-17T20:00:00.000Z",
"departureTicketsLeft": 7,
"returnTicketsLeft": 7,
"departureAvailabilityType": "FewPlaces",
"returnAvailabilityType": "FewPlaces",
"isTwoWay": true,
"sameBaggageForAll": false,
"totalBaggage": true,
"departureSegments": [
{
"airlineCode": "KC",
"airlineName": "Air Astana-",
"flightCode": "KC899",
"class": "econom",
"lugageWeight": 20,
"handLugageWeight": 6,
"departureFlightDate": "2024-02-15T20:00:00.000Z",
"departureCountryName": "Kazakhstan",
"departureCityName": "Almaty",
"departureAirportCode": "ALA",
"departureAirportName": "Almaty Intl Airport",
"departureTerminalCode": "ALA",
"arrivalFlightDate": "2024-02-15T20:00:00.000Z",
"arrivalCountryName": "United Arab Emirates",
"arrivalCityName": "Dubai",
"arrivalAirportCode": "DXB",
"arrivalAirportName": "Dubai Intl Airport",
"arrivalTerminalCode": "DXB1",
"flightDuration": "0h 50m"
}
],
"returnSegments": [
{
"airlineCode": "KC",
"airlineName": "Air Astana-",
"flightCode": "KC900",
"class": "econom",
"lugageWeight": 20,
"handLugageWeight": 6,
"departureFlightDate": "2024-02-17T20:00:00.000Z",
"departureCountryName": "United Arab Emirates",
"departureCityName": "Dubai",
"departureAirportCode": "DXB",
"departureAirportName": "Dubai Intl Airport",
"departureTerminalCode": "DXB1",
"arrivalFlightDate": "2024-02-17T20:00:00.000Z",
"arrivalCountryName": "Kazakhstan",
"arrivalCityName": "Almaty",
"arrivalAirportCode": "ALA",
"arrivalAirportName": "Almaty Intl Airport",
"arrivalTerminalCode": "ALA",
"flightDuration": "8h 15m"
}
],
"passengers": [
{
"id": "42779531011000004-A1",
"isAdult": true,
"forwardBaggages": [
{
"baggageCode": "TOTAL_BAGGAGE",
"description": "1 piece included, UP TO 50 POUNDS/23 KILOGRAMS, OVER 62 LINEAR INCHES/158 LINEAR CENTIMETERS",
"price": 45.00,
"currency": "USD",
"included": false
}
],
"backwardBaggages": [
{
"baggageCode": "INCLUDED_IN_FORWARD",
"price": 0,
"included": false
}
]
},
{
"id": "42779531011000004-C1",
"isAdult": false,
"forwardBaggages": [
{
"baggageCode": "TOTAL_BAGGAGE",
"description": "1 piece included, UP TO 50 POUNDS/23 KILOGRAMS, OVER 62 LINEAR INCHES/158 LINEAR CENTIMETERS",
"price": 45.00,
"currency": "USD",
"included": false
}
],
"backwardBaggages": [
{
"baggageCode": "INCLUDED_IN_FORWARD",
"price": 0,
"included": false
}
]
}
]
},
"extraServices": [],
"insurancePrice": {
"name": "Medical INS (N10000)",
"price": 13.44,
"priceSurcarge": 0.00,
"actualStartDate": "2024-02-15T20:00:00.000Z",
"actualEndDate": "2024-02-17T20:00:00.000Z",
"optional": false,
"includedInPackagePrice": true
}
},
"altPackages": [
{
"id": "tour:1d0fa533-4261-4254-93bb-83599d581ffc:193990fa-41a5-46e6-9805-50f82c3c377f:63d79c94-1e19-443f-8a17-50e59e633ea8",
"priceCurrency": "USD",
"totalPrice": 968.40,
"agentCommissionPercent": 0.00,
"agentCommissionAmount": 0.00,
"includedExtrasAmount": 0,
"priceDifference": 31.24,
"hotel": {
"hotelPriceId": "193990fa-41a5-46e6-9805-50f82c3c377f",
"providerId": 13,
"hotelName": "Mercure Dubai Barsha Heights Suites Apartments",
"hotelCode": "5f125310-7025-4807-a4c6-49cd284c9c14",
"nigths": 2,
"mealPlan": "BB",
"hotelClass": "4",
"availabilityType": "StopSale",
"availableRoomsCount": 0,
"fewRooms": true,
"roomCategoryCode": "f8e1ffe5-25cc-46a4-80e8-586d1c049de4",
"roomCategoryName": "1 B/R Apartment City View",
"placementTypeName": "SNGL + CHILD(2-5.99)sharing",
"checkInDate": "2024-02-15T20:00:00.000Z",
"checkOutDate": "2024-02-17T20:00:00.000Z",
"adults": 1,
"children": 1,
"districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
"districtName": "Al Barsha",
"cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
"cityName": "Dubai",
"countryCode": "AE",
"countryName": "United Arab Emirates",
"hasAlcohol": false,
"hasFreeWifi": true,
"hasMetro": true,
"hasPool": true,
"hasMall": false,
"cancellationPolicyDescription": "Cancellation Policy: 5 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
"cancellationPolicy": {
"noShowChargeValue": 100.00,
"noShowChargeValueType": "%",
"earlyDepartureChargeValue": 100.00,
"earlyDepartureChargeValueType": "%",
"conditions": [
{
"timeunits": 5,
"timeunitType": "Day",
"timeOffsetTypeName": "Before Arrival",
"chargeValue": 100.00,
"chargeValueType": "%"
}
]
}
},
"flight": {
"id": "63d79c94-1e19-443f-8a17-50e59e633ea8",
"departureDate": "2024-02-15T20:00:00.000Z",
"returnDate": "2024-02-17T20:00:00.000Z",
"departureTicketsLeft": 50,
"returnTicketsLeft": 50,
"departureAvailabilityType": "FewPlaces",
"returnAvailabilityType": "FewPlaces",
"isTwoWay": true,
"sameBaggageForAll": false,
"totalBaggage": false,
"departureSegments": [
{
"airlineCode": "FZ",
"airlineName": "Fly Dubai.",
"flightCode": "FZ1722",
"class": "econom",
"lugageWeight": 20,
"handLugageWeight": 6,
"departureFlightDate": "2024-02-15T20:00:00.000Z",
"departureCountryName": "Kazakhstan",
"departureCityName": "Almaty",
"departureAirportCode": "ALA",
"departureAirportName": "Almaty Intl Airport",
"departureTerminalCode": "ALA",
"arrivalFlightDate": "2024-02-15T20:00:00.000Z",
"arrivalCountryName": "United Arab Emirates",
"arrivalCityName": "Dubai",
"arrivalAirportCode": "DXB",
"arrivalAirportName": "Dubai Intl Airport",
"arrivalTerminalCode": "DXB3",
"flightDuration": "0h 55m"
}
],
"returnSegments": [
{
"airlineCode": "FZ",
"airlineName": "Fly Dubai.",
"flightCode": "FZ1721",
"class": "econom",
"lugageWeight": 20,
"handLugageWeight": 6,
"departureFlightDate": "2024-02-17T20:00:00.000Z",
"departureCountryName": "United Arab Emirates",
"departureCityName": "Dubai",
"departureAirportCode": "DXB",
"departureAirportName": "Dubai Intl Airport",
"departureTerminalCode": "DXB3",
"arrivalFlightDate": "2024-02-18T20:00:00.000Z",
"arrivalCountryName": "Kazakhstan",
"arrivalCityName": "Almaty",
"arrivalAirportCode": "ALA",
"arrivalAirportName": "Almaty Intl Airport",
"arrivalTerminalCode": "DXB3",
"flightDuration": "8h 10m"
}
],
"passengers": [
{
"id": "42779547001000004-A1",
"isAdult": true,
"selectedForwardBaggageCode": "INCLUDED",
"selectedBackwardBaggageCode": "INCLUDED",
"forwardBaggages": [
{
"baggageCode": "INCLUDED",
"description": "20 KG INCLUDED",
"price": 0.0,
"currency": "USD",
"included": true
}
],
"backwardBaggages": [
{
"baggageCode": "INCLUDED",
"description": "20 KG INCLUDED",
"price": 0.0,
"currency": "USD",
"included": true
}
]
},
{
"id": "42779547001000004-C1",
"isAdult": false,
"selectedForwardBaggageCode": "INCLUDED",
"selectedBackwardBaggageCode": "INCLUDED",
"forwardBaggages": [
{
"baggageCode": "INCLUDED",
"description": "20 KG INCLUDED",
"price": 0.0,
"currency": "USD",
"included": true
}
],
"backwardBaggages": [
{
"baggageCode": "INCLUDED",
"description": "20 KG INCLUDED",
"price": 0.0,
"currency": "USD",
"included": true
}
]
}
]
},
"extraServices": [],
"insurancePrice": {
"name": "Medical INS (N10000)",
"price": 13.44,
"priceSurcarge": 0.00,
"actualStartDate": "2024-02-15T20:00:00.000Z",
"actualEndDate": "2024-02-17T20:00:00.000Z",
"optional": false,
"includedInPackagePrice": true
}
},
{
Schema
Descriptions
Request
Here's a table describing each parameter of the JSON request:
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. |
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
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"). |
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. |