Skip to Content

Changes for page 6. GetReservationDetails

Last modified by Giorgi Mdivnishvili on 2024/07/11 10:45
From version 4.1
edited by Giorgi Mdivnishvili
on 2024/04/11 06:45
Change comment: There is no comment for this version
To version 8.1
edited by Giorgi Mdivnishvili
on 2024/04/11 13:11
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,9 +6,12 @@
6 6  
7 7  = Method Description =
8 8  
9 -This method is used to calculate full package with hotels and flights, to recheck prices, availability, prices and cancelation policy before book.
10 10  
10 +This API endpoint facilitates the retrieval of information pertaining to a previously booked reservation for data verification purposes.
11 11  
12 +To utilize this functionality, simply provide the reservationId parameter obtained following the initial reservation request and submit the API request.
13 +
14 +
12 12  == Endpoint URL - [POST] ==
13 13  
14 14  {{info}}
... ... @@ -489,3 +489,69 @@
489 489  
490 490  }
491 491  {{/success}}
495 +
496 +
497 +== Description ==
498 +
499 +
500 +(% class="table-bordered" %)
501 +|=Parameter|=Value Type|=Description
502 +|id|String|The unique identifier for the reservation, typically a UUID or similar.
503 +|rfNumber|String|The reference number for the reservation, usually generated by the system.
504 +|contactNumber|String|The contact number associated with the reservation, used for communication purposes.
505 +|agentName|String|The name of the agent who made the reservation, useful for tracking and accountability.
506 +|totalPrice|Number|The total price of the reservation, calculated based on the services and products included.
507 +|agentCommission|Number|The commission earned by the agent for this reservation, calculated as a percentage of the total price.
508 +|currency|String|The currency in which the price and commission are denominated, typically in ISO 4217 format (e.g., USD, EUR).
509 +|tourists[].id|String|The unique identifier for each tourist, typically a UUID.
510 +|tourists[].gender|String|The gender of the tourist, usually : [ None, Male, Female ]
511 +|tourists[].ageCategory|String|The age category of the tourist, such as 'Adult', 'Child', or 'Infant'.
512 +|tourists[].firstName|String|The first name of the tourist, as it appears on their passport.
513 +|tourists[].lastName|String|The last name of the tourist, as it appears on their passport.
514 +|tourists[].birthDate|String (Date)|The birth date of the tourist, typically in ISO 8601 format (YYYY-MM-DD).
515 +|tourists[].passportNumber|String|The passport number of the tourist, as it appears on their passport.
516 +|tourists[].passportExpiryDate|String (Date)|The expiry date of the tourist's passport, typically in ISO 8601 format (YYYY-MM-DD).
517 +|tourists[].citizenshipCountryCode|String|The ISO 3166-1 alpha-2 code of the tourist's country of citizenship (e.g., US, GB).
518 +|tourists[].citizenshipCountryName|String|The full name of the tourist's country of citizenship.
519 +|tourists[].arrivalDate|String (Date)|The date of the tourist's arrival, typically in ISO 8601 format (YYYY-MM-DD).
520 +|tourists[].arrivalFlightNumber|String|The flight number for the tourist's arrival, as provided by the airline.
521 +|tourists[].arrivalTerminalCode|String|The terminal code for the tourist's arrival, as provided by the airport.
522 +|tourists[].returnDate|String (Date)|The date of the tourist's return, typically in ISO 8601 format (YYYY-MM-DD).
523 +|tourists[].returnFlightNumber|String|The flight number for the tourist's return, as provided by the airline.
524 +|tourists[].returnTerminalCode|String|The terminal code for the tourist's return, as provided by the airport.
525 +|tourists[].showReturn|Boolean|A boolean indicating whether the return information should be displayed, useful for one-way trips.
526 +|hotels[].id|String|The unique identifier for each hotel booking, typically a UUID or similar.
527 +|hotels[].hotelName|String|The name of the hotel where the booking is made.
528 +|hotels[].cityName|String|The city where the hotel is located.
529 +|hotels[].hotelClass|String|The class or rating of the hotel, such as '3-star', '4-star', '5-star', etc.
530 +|hotels[].checkInDate|String (Date)|The check-in date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
531 +|hotels[].checkOutDate|String (Date)|The check-out date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
532 +|hotels[].roomCategoryName|String|The category of the room booked, such as 'Standard', 'Deluxe', 'Suite', etc.
533 +|hotels[].placementName|String|The type of placement, such as 'DBL' for double room, 'SGL' for single room, etc.
534 +|hotels[].mealPlan|String|The meal plan for the hotel booking, such as 'RO' for Room Only, 'BB' for Bed and Breakfast, etc.
535 +|flights[].id|String|The unique identifier for each flight, typically a UUID or similar.
536 +|flights[].isArrival|Boolean|A boolean indicating whether this flight is an arrival flight, useful for distinguishing between arrival and departure flights.
537 +|flights[].touristId|String|The id of the tourist taking this flight, linking the flight to a specific tourist.
538 +|flights[].touristName|String|The name of the tourist taking this flight, useful for passenger lists.
539 +|flights[].date|String (Date)|The date and time of the flight, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
540 +|flights[].departureAirport|String|The IATA code of the airport from which the flight departs (e.g., JFK, LHR).
541 +|flights[].departureTerminal|String|The terminal from which the flight departs, as provided by the airport.
542 +|flights[].arrivalAirport|String|The IATA code of the airport at which the flight arrives (e.g., JFK, LHR).
543 +|flights[].arrivalTerminal|String|The terminal at which the flight arrives, as provided by the airport.
544 +|flights[].note|String|Any additional notes about the flight, such as 'Overnight flight', 'Meal included', etc.
545 +|transfers[].id|String|The unique identifier for each transfer, typically a UUID or similar.
546 +|transfers[].transferType|String|The type of transfer, such as 'ARRIVAL' for airport to hotel transfers, 'DEPARTURE' for hotel to airport transfers.
547 +|transfers[].vehicleName|String|The name of the vehicle used for the transfer, such as 'Private Car', 'Shared Shuttle', etc.
548 +|transfers[].touristId|String|The id of the tourist using this transfer, linking the transfer to a specific tourist.
549 +|transfers[].touristName|String|The name of the tourist using this transfer, useful for passenger lists.
550 +|transfers[].date|String (Date)|The date and time of the transfer, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
551 +|transfers[].fromTerminal|String|The terminal from which the transfer starts, as provided by the airport or hotel.
552 +|transfers[].fromCityName|String|The city from which the transfer starts.
553 +|transfers[].toHotelName|String|The hotel to which the transfer goes.
554 +|transfers[].toCityName|String|The city to which the transfer goes.
555 +|transfers[].note|String|Any additional notes about the transfer, such as 'Private transfer', 'Shared transfer', etc.
556 +|services[].id|String|The unique identifier for each service, typically a UUID or similar.
557 +|services[].serviceDate|String (Date)|The date and time of the service, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
558 +|services[].serviceName|String|The name of the service, such as insurance in this example.
559 +|services[].touristId|String|The id of the tourist using this service, linking the service to a specific tourist.
560 +|services[].touristName|String|The name of the tourist using this service, useful for booking confirmations.