CalcPackage

Version 8.1 by Giorgi Mdivnishvili on 2023/12/15 16:20

Method Description

The initial method of the integration process is authorization. You will be provided with a test user username and password to generate the access token that you will need to pass in all the following methods. 

Endpoint URL - [POST]

Request Parameters

None

Request Body

none{
 "packageId": "string",
 "extraServicePriceCodes": [
   "string"
  ]
}

Request Body example

{
 "packageId": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
 "extraServicePriceCodes": [
   
  ]
}

Response

{
 "error": true,
 "errorCode": "string",
 "errorDescription": "string",
 "userErrorDescription": "string",
 "package": {
   "id": "string",
   "priceCurrency": "string",
   "totalPrice": 0,
   "agentCommissionPercent": 0,
   "agentCommissionAmount": 0,
   "hotel": {
     "hotelPriceId": "string",
     "providerId": 0,
     "hotelName": "string",
     "hotelCode": "string",
     "nigths": 0,
     "mealPlan": "string",
     "hotelClass": "string",
     "availabilityType": "OnRequest",
     "availableRoomsCount": 0,
     "fewRooms": true,
     "roomCategoryCode": "string",
     "roomCategoryName": "string",
     "placementTypeName": "string",
     "placementDescription": "string",
     "checkInDate": "2023-12-14T08:49:36.703Z",
     "checkOutDate": "2023-12-14T08:49:36.703Z",
     "adults": 0,
     "children": 0,
     "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "districtName": "string",
     "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "cityName": "string",
     "countryCode": "string",
     "countryName": "string",
     "hasAlcohol": true,
     "hasFreeWifi": true,
     "hasMetro": true,
     "hasPool": true,
     "hasMall": true,
     "cancellationPolicyDescription": "string",
     "cancellationPolicy": {
       "cancellationPolicyCode": "string",
       "noShowChargeValue": 0,
       "noShowChargeValueType": "string",
       "earlyDepartureChargeValue": 0,
       "earlyDepartureChargeValueType": "string",
       "conditions": [
          {
           "timeunits": 0,
           "timeunitType": "string",
           "timeOffsetTypeName": "string",
           "chargeValue": 0,
           "chargeValueType": "string"
          }
        ]
      }
    },
   "extraServices": [
      {
       "extraServiceCode": "string",
       "extraServiceTypeCode": "string",
       "isMandatory": 0,
       "extraServiceName": "string",
       "minimalServiceAmount": 0,
       "includedPriceCode": "string",
       "prices": [
          {
           "extraServicePriceCode": "string",
           "displayName": "string",
           "restrictionInfo": "string",
           "additionalInfo": "string",
           "price": 0,
           "extraPrice": 0,
           "currency": "string"
          }
        ]
      }
    ]
  }
}

Response example

{
   "package": {
       "id": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
       "priceCurrency": "USD",
       "totalPrice": 381.70,
       "agentCommissionPercent": 0.00,
       "agentCommissionAmount": 0.00,
       "hotel": {
           "hotelPriceId": "504f63ca-6dd5-4d84-8245-cf7e77ccff73",
           "providerId": 13,
           "hotelName": "Golden Tulip Al Barsha Hotel",
           "hotelCode": "ed0820c5-29b0-4e1b-8bcf-9f3c181e7961",
           "nigths": 4,
           "mealPlan": "RO",
           "hotelClass": "4",
           "availabilityType": "FreeSale",
           "availableRoomsCount": 0,
           "fewRooms": true,
           "roomCategoryCode": "e63ea5ac-4883-4059-bb0a-795a534bbbfb",
           "roomCategoryName": "Superior Twin",
           "placementTypeName": "SNGL + CHILD(6-11.99)sharing",
           "checkInDate": "2024-02-17T08:00:00.000Z",
           "checkOutDate": "2024-02-21T08: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": true,
           "hasFreeWifi": true,
           "hasMetro": false,
           "hasPool": true,
           "hasMall": false,
           "cancellationPolicyDescription": "Cancellation Policy: 15 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
           "cancellationPolicy": {
               "noShowChargeValue": 100.00,
               "noShowChargeValueType": "%",
               "earlyDepartureChargeValue": 100.00,
               "earlyDepartureChargeValueType": "%",
               "conditions": [
                    {
                       "timeunits": 15,
                       "timeunitType": "Day",
                       "timeOffsetTypeName": "Before Arrival",
                       "chargeValue": 100.00,
                       "chargeValueType": "%"
                    }
                ]
            }
        },
       "extraServices": []
    },
   "error": false
}

Schema

Success

CalcOnlyHotelPackageResponse{

errorboolean
errorCodestring
nullable: true
errorDescriptionstring
nullable: true
userErrorDescriptionstring
nullable: true
packageOnlyHotelPackage{
idstring
nullable: true
priceCurrencystring
nullable: true
totalPricenumber($double)
agentCommissionPercentnumber($double)
agentCommissionAmountnumber($double)
hotelPackageHotel{
hotelPriceIdstring
nullable: true
providerIdinteger($int32)
hotelNamestring
nullable: true
hotelCodestring
nullable: true
nigthsinteger($int32)
mealPlanstring
nullable: true
hotelClassstring
nullable: true
availabilityTypeRoomAvailabilityTypeEnumstringEnum:
[ OnRequest, FreeSale, StopSale ]
availableRoomsCountinteger($int32)
fewRoomsboolean
roomCategoryCodestring
nullable: true
roomCategoryNamestring
nullable: true
placementTypeNamestring
nullable: true
placementDescriptionstring
nullable: true
checkInDatestring($date-time)
checkOutDatestring($date-time)
adultsinteger($int32)
childreninteger($int32)
districtUIDstring($uuid)
nullable: true
districtNamestring
nullable: true
cityUIDstring($uuid)
nullable: true
cityNamestring
nullable: true
countryCodestring
nullable: true
countryNamestring
nullable: true
hasAlcoholboolean
hasFreeWifiboolean
hasMetroboolean
hasPoolboolean
hasMallboolean
cancellationPolicyDescriptionstring
nullable: true
cancellationPolicyCancellationPolicyExchange{
cancellationPolicyCodestring
nullable: true
noShowChargeValuenumber($double)
nullable: true
noShowChargeValueTypestring
nullable: true
earlyDepartureChargeValuenumber($double)
nullable: true
earlyDepartureChargeValueTypestring
nullable: true
conditions[
nullable: trueCancellationPolicyConditionExchange{
timeunitsinteger($int32)
timeunitTypestring
nullable: true
timeOffsetTypeNamestring
nullable: true
chargeValuenumber($double)
nullable: true
chargeValueTypestring
nullable: true

}]

}

}

extraServices[
nullable: trueHotelExtraServiceBase{
extraServiceCodestring
nullable: true
extraServiceTypeCodestring
nullable: true
isMandatoryinteger($int32)
extraServiceNamestring
nullable: true
minimalServiceAmountnumber($double)
includedPriceCodestring
nullable: true
prices[
nullable: trueHotelExtraServicePriceBase{
extraServicePriceCodestring
nullable: true
displayNamestring
nullable: true
restrictionInfostring
nullable: true
additionalInfostring
nullable: true
pricenumber($double)
extraPricenumber($double)
currencystring
nullable: true

}]

}]

}

}