Skip to Content

Changes for page 6. GetReservationDetails

Last modified by Giorgi Mdivnishvili on 2024/07/11 10:45
From version 3.1
edited by Giorgi Mdivnishvili
on 2024/04/11 06:44
Change comment: There is no comment for this version
To version 10.1
edited by Giorgi Mdivnishvili
on 2024/07/11 10:45
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}}
... ... @@ -27,7 +27,7 @@
27 27  == Request Body ==
28 28  
29 29  {{code language="Json"}}
30 -{"id":"3882a7ee-fec1-4bd3-9e73-ccc4613be36d"}
33 +{"id":"07fff3fd-7ae9-409f-b50b-2cc7a948b8d0"}
31 31  {{/code}}
32 32  
33 33  (% class="wikigeneratedid" id="HRequestBodyexample" %)
... ... @@ -38,7 +38,7 @@
38 38  == Request Body example ==
39 39  
40 40  {{code language="Json"}}
41 -{"id":"3882a7ee-fec1-4bd3-9e73-ccc4613be36d"}
44 +{"id":"07fff3fd-7ae9-409f-b50b-2cc7a948b8d0"}
42 42  {{/code}}
43 43  
44 44  
... ... @@ -46,357 +46,98 @@
46 46  
47 47  {{code language="json"}}
48 48  {
49 - "error": true,
50 - "errorCode": "string",
51 - "errorDescription": "string",
52 - "userErrorDescription": "string",
53 - "package": {
54 - "cacheKey": "string",
55 - "id": "string",
56 - "priceCurrency": "string",
52 + "reservation": {
53 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
54 + "rfNumber": "string",
55 + "contactNumber": "string",
56 + "agentName": "string",
57 57   "totalPrice": 0,
58 - "agentCommissionPercent": 0,
59 - "agentCommissionAmount": 0,
60 - "includedExtrasAmount": 0,
61 - "priceDifference": 0,
62 - "hotel": {
63 - "hotelPriceId": "string",
64 - "providerId": 0,
65 - "hotelName": "string",
66 - "hotelCode": "string",
67 - "nigths": 0,
68 - "mealPlan": "string",
69 - "hotelClass": "string",
70 - "availabilityType": "OnRequest",
71 - "availableRoomsCount": 0,
72 - "fewRooms": true,
73 - "roomCategoryCode": "string",
74 - "roomCategoryName": "string",
75 - "placementTypeName": "string",
76 - "placementDescription": "string",
77 - "checkInDate": "2023-12-26T12:55:59.433Z",
78 - "checkOutDate": "2023-12-26T12:55:59.433Z",
79 - "adults": 0,
80 - "children": 0,
81 - "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
82 - "districtName": "string",
83 - "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
84 - "cityName": "string",
85 - "countryCode": "string",
86 - "countryName": "string",
87 - "hasAlcohol": true,
88 - "hasFreeWifi": true,
89 - "hasMetro": true,
90 - "hasPool": true,
91 - "hasMall": true,
92 - "cancellationPolicyDescription": "string",
93 - "cancellationPolicy": {
94 - "cancellationPolicyCode": "string",
95 - "noShowChargeValue": 0,
96 - "noShowChargeValueType": "string",
97 - "earlyDepartureChargeValue": 0,
98 - "earlyDepartureChargeValueType": "string",
99 - "conditions": [
100 - {
101 - "timeunits": 0,
102 - "timeunitType": "string",
103 - "timeOffsetTypeName": "string",
104 - "chargeValue": 0,
105 - "chargeValueType": "string"
106 - }
107 - ]
108 - }
109 - },
110 - "flight": {
111 - "id": "string",
112 - "departureDate": "2023-12-26T12:55:59.433Z",
113 - "returnDate": "2023-12-26T12:55:59.433Z",
114 - "departureTicketsLeft": 0,
115 - "returnTicketsLeft": 0,
116 - "departureAvailabilityType": "OnRequest",
117 - "returnAvailabilityType": "OnRequest",
118 - "isTwoWay": true,
119 - "sameBaggageForAll": true,
120 - "totalBaggage": true,
121 - "departureSegments": [
122 - {
123 - "airlineCode": "string",
124 - "airlineName": "string",
125 - "flightCode": "string",
126 - "class": "string",
127 - "lugageWeight": 0,
128 - "handLugageWeight": 0,
129 - "departureFlightDate": "2023-12-26T12:55:59.433Z",
130 - "departureCountryName": "string",
131 - "departureCityName": "string",
132 - "departureAirportCode": "string",
133 - "departureAirportName": "string",
134 - "departureTerminalCode": "string",
135 - "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
136 - "arrivalCountryName": "string",
137 - "arrivalCityName": "string",
138 - "arrivalAirportCode": "string",
139 - "arrivalAirportName": "string",
140 - "arrivalTerminalCode": "string",
141 - "flightDuration": "string"
142 - }
143 - ],
144 - "returnSegments": [
145 - {
146 - "airlineCode": "string",
147 - "airlineName": "string",
148 - "flightCode": "string",
149 - "class": "string",
150 - "lugageWeight": 0,
151 - "handLugageWeight": 0,
152 - "departureFlightDate": "2023-12-26T12:55:59.433Z",
153 - "departureCountryName": "string",
154 - "departureCityName": "string",
155 - "departureAirportCode": "string",
156 - "departureAirportName": "string",
157 - "departureTerminalCode": "string",
158 - "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
159 - "arrivalCountryName": "string",
160 - "arrivalCityName": "string",
161 - "arrivalAirportCode": "string",
162 - "arrivalAirportName": "string",
163 - "arrivalTerminalCode": "string",
164 - "flightDuration": "string"
165 - }
166 - ],
167 - "passengers": [
168 - {
169 - "id": "string",
170 - "isAdult": true,
171 - "selectedForwardBaggageCode": "string",
172 - "selectedBackwardBaggageCode": "string",
173 - "forwardBaggages": [
174 - {
175 - "baggageCode": "string",
176 - "description": "string",
177 - "price": 0,
178 - "currency": "string",
179 - "included": true
180 - }
181 - ],
182 - "backwardBaggages": [
183 - {
184 - "baggageCode": "string",
185 - "description": "string",
186 - "price": 0,
187 - "currency": "string",
188 - "included": true
189 - }
190 - ]
191 - }
192 - ]
193 - },
194 - "extraServices": [
58 + "agentCommission": 0,
59 + "netPrice": 0,
60 + "currency": "string",
61 + "tourists": [
195 195   {
196 - "extraServiceCode": "string",
197 - "extraServiceTypeCode": "string",
198 - "isMandatory": 0,
199 - "extraServiceName": "string",
200 - "minimalServiceAmount": 0,
201 - "includedPriceCode": "string",
202 - "prices": [
203 - {
204 - "extraServicePriceCode": "string",
205 - "displayName": "string",
206 - "restrictionInfo": "string",
207 - "additionalInfo": "string",
208 - "price": 0,
209 - "extraPrice": 0,
210 - "currency": "string"
211 - }
212 - ]
63 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
64 + "gender": "None",
65 + "ageCategory": "Adult",
66 + "firstName": "string",
67 + "lastName": "string",
68 + "birthDate": "2024-04-11T02:39:52.147Z",
69 + "passportNumber": "string",
70 + "passportExpiryDate": "2024-04-11T02:39:52.147Z",
71 + "tin": "string",
72 + "citizenshipCountryCode": "string",
73 + "citizenshipCountryName": "string",
74 + "mobile": "string",
75 + "email": "string",
76 + "arrivalDate": "2024-04-11T02:39:52.147Z",
77 + "arrivalFlightNumber": "string",
78 + "arrivalTerminalCode": "string",
79 + "returnDate": "2024-04-11T02:39:52.147Z",
80 + "returnFlightNumber": "string",
81 + "returnTerminalCode": "string",
82 + "showReturn": true
213 213   }
214 214   ],
215 - "insurancePrice": {
216 - "name": "string",
217 - "price": 0,
218 - "priceSurcarge": 0,
219 - "actualStartDate": "2023-12-26T12:55:59.433Z",
220 - "actualEndDate": "2023-12-26T12:55:59.433Z",
221 - "optional": true,
222 - "includedInPackagePrice": true
223 - }
224 - },
225 - "altPackages": [
226 - {
227 - "cacheKey": "string",
228 - "id": "string",
229 - "priceCurrency": "string",
230 - "totalPrice": 0,
231 - "agentCommissionPercent": 0,
232 - "agentCommissionAmount": 0,
233 - "includedExtrasAmount": 0,
234 - "priceDifference": 0,
235 - "hotel": {
236 - "hotelPriceId": "string",
237 - "providerId": 0,
85 + "hotels": [
86 + {
87 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
238 238   "hotelName": "string",
239 - "hotelCode": "string",
240 - "nigths": 0,
241 - "mealPlan": "string",
89 + "cityName": "string",
242 242   "hotelClass": "string",
243 - "availabilityType": "OnRequest",
244 - "availableRoomsCount": 0,
245 - "fewRooms": true,
246 - "roomCategoryCode": "string",
91 + "checkInDate": "2024-04-11T02:39:52.147Z",
92 + "checkOutDate": "2024-04-11T02:39:52.147Z",
247 247   "roomCategoryName": "string",
248 - "placementTypeName": "string",
249 - "placementDescription": "string",
250 - "checkInDate": "2023-12-26T12:55:59.433Z",
251 - "checkOutDate": "2023-12-26T12:55:59.433Z",
252 - "adults": 0,
253 - "children": 0,
254 - "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
255 - "districtName": "string",
256 - "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
257 - "cityName": "string",
258 - "countryCode": "string",
259 - "countryName": "string",
260 - "hasAlcohol": true,
261 - "hasFreeWifi": true,
262 - "hasMetro": true,
263 - "hasPool": true,
264 - "hasMall": true,
265 - "cancellationPolicyDescription": "string",
266 - "cancellationPolicy": {
267 - "cancellationPolicyCode": "string",
268 - "noShowChargeValue": 0,
269 - "noShowChargeValueType": "string",
270 - "earlyDepartureChargeValue": 0,
271 - "earlyDepartureChargeValueType": "string",
272 - "conditions": [
273 - {
274 - "timeunits": 0,
275 - "timeunitType": "string",
276 - "timeOffsetTypeName": "string",
277 - "chargeValue": 0,
278 - "chargeValueType": "string"
279 - }
280 - ]
281 - }
282 - },
283 - "flight": {
284 - "id": "string",
285 - "departureDate": "2023-12-26T12:55:59.433Z",
286 - "returnDate": "2023-12-26T12:55:59.433Z",
287 - "departureTicketsLeft": 0,
288 - "returnTicketsLeft": 0,
289 - "departureAvailabilityType": "OnRequest",
290 - "returnAvailabilityType": "OnRequest",
291 - "isTwoWay": true,
292 - "sameBaggageForAll": true,
293 - "totalBaggage": true,
294 - "departureSegments": [
295 - {
296 - "airlineCode": "string",
297 - "airlineName": "string",
298 - "flightCode": "string",
299 - "class": "string",
300 - "lugageWeight": 0,
301 - "handLugageWeight": 0,
302 - "departureFlightDate": "2023-12-26T12:55:59.433Z",
303 - "departureCountryName": "string",
304 - "departureCityName": "string",
305 - "departureAirportCode": "string",
306 - "departureAirportName": "string",
307 - "departureTerminalCode": "string",
308 - "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
309 - "arrivalCountryName": "string",
310 - "arrivalCityName": "string",
311 - "arrivalAirportCode": "string",
312 - "arrivalAirportName": "string",
313 - "arrivalTerminalCode": "string",
314 - "flightDuration": "string"
315 - }
316 - ],
317 - "returnSegments": [
318 - {
319 - "airlineCode": "string",
320 - "airlineName": "string",
321 - "flightCode": "string",
322 - "class": "string",
323 - "lugageWeight": 0,
324 - "handLugageWeight": 0,
325 - "departureFlightDate": "2023-12-26T12:55:59.433Z",
326 - "departureCountryName": "string",
327 - "departureCityName": "string",
328 - "departureAirportCode": "string",
329 - "departureAirportName": "string",
330 - "departureTerminalCode": "string",
331 - "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
332 - "arrivalCountryName": "string",
333 - "arrivalCityName": "string",
334 - "arrivalAirportCode": "string",
335 - "arrivalAirportName": "string",
336 - "arrivalTerminalCode": "string",
337 - "flightDuration": "string"
338 - }
339 - ],
340 - "passengers": [
341 - {
342 - "id": "string",
343 - "isAdult": true,
344 - "selectedForwardBaggageCode": "string",
345 - "selectedBackwardBaggageCode": "string",
346 - "forwardBaggages": [
347 - {
348 - "baggageCode": "string",
349 - "description": "string",
350 - "price": 0,
351 - "currency": "string",
352 - "included": true
353 - }
354 - ],
355 - "backwardBaggages": [
356 - {
357 - "baggageCode": "string",
358 - "description": "string",
359 - "price": 0,
360 - "currency": "string",
361 - "included": true
362 - }
363 - ]
364 - }
365 - ]
366 - },
367 - "extraServices": [
368 - {
369 - "extraServiceCode": "string",
370 - "extraServiceTypeCode": "string",
371 - "isMandatory": 0,
372 - "extraServiceName": "string",
373 - "minimalServiceAmount": 0,
374 - "includedPriceCode": "string",
375 - "prices": [
376 - {
377 - "extraServicePriceCode": "string",
378 - "displayName": "string",
379 - "restrictionInfo": "string",
380 - "additionalInfo": "string",
381 - "price": 0,
382 - "extraPrice": 0,
383 - "currency": "string"
384 - }
385 - ]
386 - }
387 - ],
388 - "insurancePrice": {
389 - "name": "string",
390 - "price": 0,
391 - "priceSurcarge": 0,
392 - "actualStartDate": "2023-12-26T12:55:59.433Z",
393 - "actualEndDate": "2023-12-26T12:55:59.433Z",
394 - "optional": true,
395 - "includedInPackagePrice": true
94 + "placementName": "string",
95 + "mealPlan": "string",
96 + "agentConfirmationNumber": "string"
396 396   }
397 - }
398 - ],
399 - "refreshPriceResult": "Success"
98 + ],
99 + "flights": [
100 + {
101 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
102 + "isArrival": true,
103 + "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
104 + "touristName": "string",
105 + "date": "2024-04-11T02:39:52.147Z",
106 + "departureAirport": "string",
107 + "departureTerminal": "string",
108 + "arrivalAirport": "string",
109 + "arrivalTerminal": "string",
110 + "agentConfirmationNumber": "string",
111 + "bookingConfirmationNumber": "string",
112 + "note": "string"
113 + }
114 + ],
115 + "transfers": [
116 + {
117 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
118 + "transferType": "string",
119 + "vehicleName": "string",
120 + "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
121 + "touristName": "string",
122 + "date": "2024-04-11T02:39:52.147Z",
123 + "fromTerminal": "string",
124 + "fromCityName": "string",
125 + "fromHotelName": "string",
126 + "toHotelName": "string",
127 + "toTerminal": "string",
128 + "toCityName": "string",
129 + "agentConfirmationNumber": "string",
130 + "note": "string"
131 + }
132 + ],
133 + "services": [
134 + {
135 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
136 + "serviceDate": "2024-04-11T02:39:52.147Z",
137 + "serviceName": "string",
138 + "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
139 + "touristName": "string",
140 + "note": "string"
141 + }
142 + ]
143 + }
400 400  }
401 401  {{/code}}
402 402  
... ... @@ -748,3 +748,69 @@
748 748  
749 749  }
750 750  {{/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.