Skip to Content

Changes for page 4. CalcCheckout

Last modified by Giorgi Mdivnishvili on 2024/04/11 16:59
From version 8.1
edited by Giorgi Mdivnishvili
on 2024/04/11 12:48
Change comment: There is no comment for this version
To version 5.1
edited by Giorgi Mdivnishvili
on 2024/04/11 07:33
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -164,126 +164,353 @@
164 164   "errorCode": "string",
165 165   "errorDescription": "string",
166 166   "userErrorDescription": "string",
167 - "priceCurrency": "string",
168 - "totalPrice": 0,
169 - "agentCommissionPercent": 0,
170 - "agentCommissionAmount": 0,
171 - "requiredCitizenIdentifiers": [
172 - {
173 - "countryCode": "string",
174 - "identifierType": "TIN"
175 - }
176 - ],
177 - "hotels": [
178 - {
167 + "package": {
168 + "cacheKey": "string",
169 + "id": "string",
170 + "priceCurrency": "string",
171 + "totalPrice": 0,
172 + "agentCommissionPercent": 0,
173 + "agentCommissionAmount": 0,
174 + "includedExtrasAmount": 0,
175 + "priceDifference": 0,
176 + "hotel": {
179 179   "hotelPriceId": "string",
180 - "touristIds": [
181 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
178 + "providerId": 0,
179 + "hotelName": "string",
180 + "hotelCode": "string",
181 + "nigths": 0,
182 + "mealPlan": "string",
183 + "hotelClass": "string",
184 + "availabilityType": "OnRequest",
185 + "availableRoomsCount": 0,
186 + "fewRooms": true,
187 + "roomCategoryCode": "string",
188 + "roomCategoryName": "string",
189 + "placementTypeName": "string",
190 + "placementDescription": "string",
191 + "checkInDate": "2023-12-26T12:55:59.433Z",
192 + "checkOutDate": "2023-12-26T12:55:59.433Z",
193 + "adults": 0,
194 + "children": 0,
195 + "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
196 + "districtName": "string",
197 + "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
198 + "cityName": "string",
199 + "countryCode": "string",
200 + "countryName": "string",
201 + "hasAlcohol": true,
202 + "hasFreeWifi": true,
203 + "hasMetro": true,
204 + "hasPool": true,
205 + "hasMall": true,
206 + "cancellationPolicyDescription": "string",
207 + "cancellationPolicy": {
208 + "cancellationPolicyCode": "string",
209 + "noShowChargeValue": 0,
210 + "noShowChargeValueType": "string",
211 + "earlyDepartureChargeValue": 0,
212 + "earlyDepartureChargeValueType": "string",
213 + "conditions": [
214 + {
215 + "timeunits": 0,
216 + "timeunitType": "string",
217 + "timeOffsetTypeName": "string",
218 + "chargeValue": 0,
219 + "chargeValueType": "string"
220 + }
221 + ]
222 + }
223 + },
224 + "flight": {
225 + "id": "string",
226 + "departureDate": "2023-12-26T12:55:59.433Z",
227 + "returnDate": "2023-12-26T12:55:59.433Z",
228 + "departureTicketsLeft": 0,
229 + "returnTicketsLeft": 0,
230 + "departureAvailabilityType": "OnRequest",
231 + "returnAvailabilityType": "OnRequest",
232 + "isTwoWay": true,
233 + "sameBaggageForAll": true,
234 + "totalBaggage": true,
235 + "departureSegments": [
236 + {
237 + "airlineCode": "string",
238 + "airlineName": "string",
239 + "flightCode": "string",
240 + "class": "string",
241 + "lugageWeight": 0,
242 + "handLugageWeight": 0,
243 + "departureFlightDate": "2023-12-26T12:55:59.433Z",
244 + "departureCountryName": "string",
245 + "departureCityName": "string",
246 + "departureAirportCode": "string",
247 + "departureAirportName": "string",
248 + "departureTerminalCode": "string",
249 + "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
250 + "arrivalCountryName": "string",
251 + "arrivalCityName": "string",
252 + "arrivalAirportCode": "string",
253 + "arrivalAirportName": "string",
254 + "arrivalTerminalCode": "string",
255 + "flightDuration": "string"
256 + }
182 182   ],
183 - "errorCode": "string",
184 - "errorMessage": "string",
185 - "description": "string"
186 - }
187 - ],
188 - "tourists": [
189 - {
190 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
191 - "age": 0,
192 - "isAdult": true,
193 - "flightIds": [
194 - "string"
195 - ],
196 - "flights": [
258 + "returnSegments": [
197 197   {
198 - "flightId": "string",
199 - "note": "string"
260 + "airlineCode": "string",
261 + "airlineName": "string",
262 + "flightCode": "string",
263 + "class": "string",
264 + "lugageWeight": 0,
265 + "handLugageWeight": 0,
266 + "departureFlightDate": "2023-12-26T12:55:59.433Z",
267 + "departureCountryName": "string",
268 + "departureCityName": "string",
269 + "departureAirportCode": "string",
270 + "departureAirportName": "string",
271 + "departureTerminalCode": "string",
272 + "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
273 + "arrivalCountryName": "string",
274 + "arrivalCityName": "string",
275 + "arrivalAirportCode": "string",
276 + "arrivalAirportName": "string",
277 + "arrivalTerminalCode": "string",
278 + "flightDuration": "string"
200 200   }
201 201   ],
202 - "arrivalFlightInfo": {
203 - "flightNumber": "string",
204 - "terminalCode": "string",
205 - "date": "2024-04-11T05:03:16.796Z",
206 - "time": "string"
281 + "passengers": [
282 + {
283 + "id": "string",
284 + "isAdult": true,
285 + "selectedForwardBaggageCode": "string",
286 + "selectedBackwardBaggageCode": "string",
287 + "forwardBaggages": [
288 + {
289 + "baggageCode": "string",
290 + "description": "string",
291 + "price": 0,
292 + "currency": "string",
293 + "included": true
294 + }
295 + ],
296 + "backwardBaggages": [
297 + {
298 + "baggageCode": "string",
299 + "description": "string",
300 + "price": 0,
301 + "currency": "string",
302 + "included": true
303 + }
304 + ]
305 + }
306 + ]
307 + },
308 + "extraServices": [
309 + {
310 + "extraServiceCode": "string",
311 + "extraServiceTypeCode": "string",
312 + "isMandatory": 0,
313 + "extraServiceName": "string",
314 + "minimalServiceAmount": 0,
315 + "includedPriceCode": "string",
316 + "prices": [
317 + {
318 + "extraServicePriceCode": "string",
319 + "displayName": "string",
320 + "restrictionInfo": "string",
321 + "additionalInfo": "string",
322 + "price": 0,
323 + "extraPrice": 0,
324 + "currency": "string"
325 + }
326 + ]
327 + }
328 + ],
329 + "insurancePrice": {
330 + "name": "string",
331 + "price": 0,
332 + "priceSurcarge": 0,
333 + "actualStartDate": "2023-12-26T12:55:59.433Z",
334 + "actualEndDate": "2023-12-26T12:55:59.433Z",
335 + "optional": true,
336 + "includedInPackagePrice": true
337 + }
338 + },
339 + "altPackages": [
340 + {
341 + "cacheKey": "string",
342 + "id": "string",
343 + "priceCurrency": "string",
344 + "totalPrice": 0,
345 + "agentCommissionPercent": 0,
346 + "agentCommissionAmount": 0,
347 + "includedExtrasAmount": 0,
348 + "priceDifference": 0,
349 + "hotel": {
350 + "hotelPriceId": "string",
351 + "providerId": 0,
352 + "hotelName": "string",
353 + "hotelCode": "string",
354 + "nigths": 0,
355 + "mealPlan": "string",
356 + "hotelClass": "string",
357 + "availabilityType": "OnRequest",
358 + "availableRoomsCount": 0,
359 + "fewRooms": true,
360 + "roomCategoryCode": "string",
361 + "roomCategoryName": "string",
362 + "placementTypeName": "string",
363 + "placementDescription": "string",
364 + "checkInDate": "2023-12-26T12:55:59.433Z",
365 + "checkOutDate": "2023-12-26T12:55:59.433Z",
366 + "adults": 0,
367 + "children": 0,
368 + "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
369 + "districtName": "string",
370 + "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
371 + "cityName": "string",
372 + "countryCode": "string",
373 + "countryName": "string",
374 + "hasAlcohol": true,
375 + "hasFreeWifi": true,
376 + "hasMetro": true,
377 + "hasPool": true,
378 + "hasMall": true,
379 + "cancellationPolicyDescription": "string",
380 + "cancellationPolicy": {
381 + "cancellationPolicyCode": "string",
382 + "noShowChargeValue": 0,
383 + "noShowChargeValueType": "string",
384 + "earlyDepartureChargeValue": 0,
385 + "earlyDepartureChargeValueType": "string",
386 + "conditions": [
387 + {
388 + "timeunits": 0,
389 + "timeunitType": "string",
390 + "timeOffsetTypeName": "string",
391 + "chargeValue": 0,
392 + "chargeValueType": "string"
393 + }
394 + ]
395 + }
207 207   },
208 - "departureFlightInfo": {
209 - "flightNumber": "string",
210 - "terminalCode": "string",
211 - "date": "2024-04-11T05:03:16.796Z",
212 - "time": "string"
397 + "flight": {
398 + "id": "string",
399 + "departureDate": "2023-12-26T12:55:59.433Z",
400 + "returnDate": "2023-12-26T12:55:59.433Z",
401 + "departureTicketsLeft": 0,
402 + "returnTicketsLeft": 0,
403 + "departureAvailabilityType": "OnRequest",
404 + "returnAvailabilityType": "OnRequest",
405 + "isTwoWay": true,
406 + "sameBaggageForAll": true,
407 + "totalBaggage": true,
408 + "departureSegments": [
409 + {
410 + "airlineCode": "string",
411 + "airlineName": "string",
412 + "flightCode": "string",
413 + "class": "string",
414 + "lugageWeight": 0,
415 + "handLugageWeight": 0,
416 + "departureFlightDate": "2023-12-26T12:55:59.433Z",
417 + "departureCountryName": "string",
418 + "departureCityName": "string",
419 + "departureAirportCode": "string",
420 + "departureAirportName": "string",
421 + "departureTerminalCode": "string",
422 + "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
423 + "arrivalCountryName": "string",
424 + "arrivalCityName": "string",
425 + "arrivalAirportCode": "string",
426 + "arrivalAirportName": "string",
427 + "arrivalTerminalCode": "string",
428 + "flightDuration": "string"
429 + }
430 + ],
431 + "returnSegments": [
432 + {
433 + "airlineCode": "string",
434 + "airlineName": "string",
435 + "flightCode": "string",
436 + "class": "string",
437 + "lugageWeight": 0,
438 + "handLugageWeight": 0,
439 + "departureFlightDate": "2023-12-26T12:55:59.433Z",
440 + "departureCountryName": "string",
441 + "departureCityName": "string",
442 + "departureAirportCode": "string",
443 + "departureAirportName": "string",
444 + "departureTerminalCode": "string",
445 + "arrivalFlightDate": "2023-12-26T12:55:59.433Z",
446 + "arrivalCountryName": "string",
447 + "arrivalCityName": "string",
448 + "arrivalAirportCode": "string",
449 + "arrivalAirportName": "string",
450 + "arrivalTerminalCode": "string",
451 + "flightDuration": "string"
452 + }
453 + ],
454 + "passengers": [
455 + {
456 + "id": "string",
457 + "isAdult": true,
458 + "selectedForwardBaggageCode": "string",
459 + "selectedBackwardBaggageCode": "string",
460 + "forwardBaggages": [
461 + {
462 + "baggageCode": "string",
463 + "description": "string",
464 + "price": 0,
465 + "currency": "string",
466 + "included": true
467 + }
468 + ],
469 + "backwardBaggages": [
470 + {
471 + "baggageCode": "string",
472 + "description": "string",
473 + "price": 0,
474 + "currency": "string",
475 + "included": true
476 + }
477 + ]
478 + }
479 + ]
213 213   },
214 - "insurancePrice": {
215 - "insuranceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
216 - "insuranceServiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
217 - "insurancePriceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
218 - "touristId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
219 - "insuranceName": "string",
220 - "insuranceDescription": "string",
221 - "contragentName": "string",
222 - "contragentFullName": "string",
223 - "actualStartDate": "2024-04-11T05:03:16.796Z",
224 - "actualEndDate": "2024-04-11T05:03:16.796Z",
225 - "costCurrencyCode": "string",
226 - "costAmount": 0,
227 - "priceCurrencyCode": "string",
228 - "priceAmount": 0,
229 - "coverageCurrencyCode": "string",
230 - "coverageAmount": 0
231 - },
232 - "selectedVisaId": "string",
233 - "transfers": [
481 + "extraServices": [
234 234   {
235 - "id": "string",
236 - "type": "Arrival",
237 - "flightId": "string",
238 - "flightInfo": {
239 - "flightNumber": "string",
240 - "terminalCode": "string",
241 - "date": "2024-04-11T05:03:16.796Z",
242 - "time": "string"
243 - },
244 - "checkInHotelId": "string",
245 - "checkOutHotelId": "string",
246 - "selectedTransferPriceId": "string",
247 - "transferPrices": [
483 + "extraServiceCode": "string",
484 + "extraServiceTypeCode": "string",
485 + "isMandatory": 0,
486 + "extraServiceName": "string",
487 + "minimalServiceAmount": 0,
488 + "includedPriceCode": "string",
489 + "prices": [
248 248   {
249 - "id": "string",
250 - "name": "string",
251 - "adultPlaces": 0,
252 - "childPlaces": 0,
253 - "perPersonPrice": true,
254 - "adultPrice": 0,
255 - "childPrice": 0
491 + "extraServicePriceCode": "string",
492 + "displayName": "string",
493 + "restrictionInfo": "string",
494 + "additionalInfo": "string",
495 + "price": 0,
496 + "extraPrice": 0,
497 + "currency": "string"
256 256   }
257 257   ]
258 258   }
259 259   ],
260 - "errorCode": "string",
261 - "errorMessage": "string",
262 - "description": "string"
502 + "insurancePrice": {
503 + "name": "string",
504 + "price": 0,
505 + "priceSurcarge": 0,
506 + "actualStartDate": "2023-12-26T12:55:59.433Z",
507 + "actualEndDate": "2023-12-26T12:55:59.433Z",
508 + "optional": true,
509 + "includedInPackagePrice": true
510 + }
263 263   }
264 264   ],
265 - "visas": [
266 - {
267 - "prid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
268 - "prName": "string",
269 - "prValue": 0,
270 - "sortingOrder": 0
271 - }
272 - ],
273 - "terminals": [
274 - {
275 - "terminalCode": "string",
276 - "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
277 - "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
278 - "terminalName": "string",
279 - "countryCode": "string",
280 - "note": "string"
281 - }
282 - ],
283 - "containsError": true,
284 - "refreshPriceResult": "Success",
285 - "reservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
286 - "reservationDetailsUnavailable": true
513 + "refreshPriceResult": "Success"
287 287  }
288 288  {{/code}}
289 289  
... ... @@ -820,71 +820,3 @@
820 820  
821 821  }
822 822  {{/success}}
823 -
824 -
825 -== Descriptions ==
826 -
827 -
828 -=== Request ===
829 -
830 -Here's a table describing each parameter of the JSON request:
831 -
832 -(% class="table-bordered" %)
833 -|=Parameter|=Data Type|=Description
834 -|calcTourPackageRequests|Array|An array of objects, each representing a tour package request.
835 -|refreshPrices|Boolean|If true, the prices for the tour package will be refreshed.
836 -|packageId|String|A unique identifier for the tour package.
837 -|flightPassengers|Array|An array of objects, each representing a flight passenger.
838 -|id|String|A unique identifier for each flight passenger.
839 -|selectedForwardBaggageCode|String|The selected baggage option for the forward journey.
840 -|selectedBackwardBaggageCode|String|The selected baggage option for the backward journey.
841 -|extraServicePriceCodes|Array|An array of extra service price codes. If empty, no extra services are selected.
842 -|includeInsurance|Boolean|If true, insurance will be included in the tour package.
843 -|calcOnlyHotelPackageRequests|Array|An array of objects, each representing a hotel-only package request. If empty, no hotel-only packages are requested.
844 -|calcOnlyAviaPackageRequests|Array|An array of objects, each representing an avia-only package request. If empty, no avia-only packages are requested.
845 -
846 -
847 -=== Response ===
848 -
849 -(% class="table-bordered" %)
850 -|=Parameter|=Data Type|=Description
851 -|priceCurrency|String|The currency code (ISO 4217) for all prices mentioned in the response.
852 -|totalPrice|Number|The total price of the booking.
853 -|agentCommissionPercent|Number|The commission percentage for the agent.
854 -|agentCommissionAmount|Number|The total commission amount for the agent in priceCurrency.
855 -|requiredCitizenIdentifiers[*].countryCode|String|The ISO 3166-1 alpha-2 country code.
856 -|requiredCitizenIdentifiers[*].identifierType|String|The type of identifier required (e.g., "TIN", "FIN").
857 -|hotels[*].hotelPriceId|String|Unique identifier for the hotel price.
858 -|hotels[*].touristIds[*]|String|List of tourist IDs that are booked in this hotel.
859 -|hotels[*].description|String|A brief description of the hotel.
860 -|tourists[*].id|String|Unique identifier for the tourist.
861 -|tourists[*].isAdult|Boolean|Indicates if the tourist is an adult.
862 -|tourists[*].flightIds[*]|String|Identifiers for flights associated with the tourist.
863 -|tourists[*].flights[*].flightId|String|Unique identifier for the flight.
864 -|tourists[*].flights[*].note|String|Additional information about the flight, such as baggage allowance.
865 -|tourists[*].insurancePrice.insuranceId|String|Unique identifier for the insurance product.
866 -|tourists[*].insurancePrice.insuranceServiceId|String|Identifier for the insurance service provider.
867 -|...|...|Additional fields for insurancePrice as detailed previously.
868 -|tourists[*].transfers[*].id|String|Unique identifier for the transfer service.
869 -|tourists[*].transfers[*].type|String|The type of transfer (e.g., "Arrival", "Departure").
870 -|tourists[*].transfers[*].flightId|String|Identifier of the flight associated with this transfer.
871 -|tourists[*].transfers[*].checkInHotelId|String|Hotel ID for check-in associated with this transfer (for arrival type).
872 -|tourists[*].transfers[*].checkOutHotelId|String|Hotel ID for check-out associated with this transfer (for departure type).
873 -|tourists[*].transfers[*].selectedTransferPriceId|String|The ID of the selected pricing option for the transfer.
874 -|tourists[*].transfers[*].transferPrices[*].id|String|Unique identifier for the transfer price option.
875 -|tourists[*].transfers[*].transferPrices[*].name|String|The name of the transfer service (e.g., "GROUP", "MINIVAN").
876 -|...|...|Additional fields for transferPrices as detailed previously.
877 -|visas[*].prid|String|Unique identifier for the visa option.
878 -|visas[*].prName|String|The name of the visa option.
879 -|visas[*].prValue|Number|The cost associated with this visa option.
880 -|visas[*].sortingOrder|Number|Used to sort visa options in the response or UI.
881 -|terminals[*].terminalCode|String|The code representing the terminal.
882 -|terminals[*].cityUID|String|Unique identifier for the city where the terminal is located.
883 -|...|...|Additional fields for terminals as detailed previously.
884 -|containsError|Boolean|Indicates if the response contains any errors.
885 -|refreshPriceResult|String|The result of attempting to refresh the price (e.g., "Success").
886 -|reservationId|String|Unique identifier for the reservation.
887 -|reservationDetailsUnavailable|Boolean|Indicates if the reservation details are currently unavailable.
888 -|error|Boolean|A generic error indicator, presumably redundant with containsError.
889 -
890 -