VerticalAPI

BlockRoom Details

BlockRoom method is used to get the updated prices and cancellation policies for the selected rooms before proceeding with the hotel booking

Parameters

Name

Description

Accept

string

( header )

*required application/json

Accept - Encoding

string

( header )

*required gzip

Authorization

string

( header )

*required Your PID

*required Your API Key

Customer-Ip

string

( header )

*required IP address of the customer, as captured by your integration. Send IPV4 addresses only.

Ensure your integration passes the customer’s IP, not your own. This value helps determine their location and other settings.

Also used for fraud recovery and other important analytics.

apiKey

string

( query )

*required a valid API Key

The API Key provided to you is critical to the security of your request data – treat it like a password. Never include the raw value in any publicly accessible site or app code. You will be provided with an API key when you are approved to integrate TPS API.

ModeType

string

( query )

*required either "Test" or "LIVE"

Your application *needs an approval from adivaha® Personnel.

pid

string

( query )

*required "{Your Partner ID}" as a parameter

action

string

( query )

*required "blockRoom" as a parameter

ResultIndex

string

( query )

Result Index

hotelId

string

( query )

*required Unique hotel code.

HotelName

string

( query )

*required Unique hotel Name.

nationality

string

( query )

ISO Country Code (Ex. India = IN, Great Britain = GB)

rooms

string

( query )

Number of rooms to be set for the search, can be between 1-7

TraceId

string

( query )

*required The TraceId of the property you want to gather information for.

HotelRoomDetails

Array

( query )

Array of hotel room details

RoomIndex

Integer

Index of the room

RatePlanCode

string

Rate plan code associated with room

RatePlanName

string

Name of the Rate plan associated with room

RoomTypeCode

string

Room Type Code

RoomTypeName

string

Room Type Name

BedTypes

Array

( query )

Array of bed types

(1.1)BedTypeCode

string

Bed type code

(1.2)BedTypeDescription

string

Bed type description(Optional)

SmokingPreference

Enumeration

Smoking Preference associated with room

Mandatory SmokingPreference NoPreference = 0, Smoking = 1, NonSmoking = 2, Either = 3

Supplements

StringList

List of supplements

Price

Array

Price detail of the room

(1.1)CurrencyCode

string

Currency in which minimum hotel price is returned

(1.2)RoomPrice

decimal

Price of the room

(1.3)Tax

decimal

Tax applicable for the room

(1.4)ExtraGuestCharge

decimal

Extra Guest Charges applicable for the room

(1.5)ChildCharge

decimal

Child Charges applicable for the room

(1.6)OtherCharges

decimal

Other Charges applicable for the room

(1.7)Discount

decimal

Discount applicable for the room

(1.8)PublishedPrice

decimal

Published Price of the room

(1.9)PublishedPriceRoundedOff

Integer

Published Price (rounded off) of the room

(1.10)OfferedPrice

decimal

Offered Price of the room

(1.11)OfferedPriceRoundedOff

Integer

Offered Price (rounded off) of the room

(1.12)AgentCommission

decimal

Commission applicable on the Room Price

(1.13)AgentMarkUp

decimal

Agent Mark Up applicable on the Room Price

(1.14)ServiceTax

decimal

Service tax applicable for the room

(1.15)TDS

decimal

TDS applicable on Commission Earned

REQUEST

API Endpoint: https://your-end-point/api/v1/travel-api/hotels/

header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-PID',
'x-api-key:'ADD-YOUR-KEY'
);

POST: 
{
  "action": "blockRoom",
  "ResultIndex": "3",
  "hotelId": "31620301",
  "HotelName": "Moustache Delhi",
  "nationality": "IN",
  "rooms": "1",
  "TraceId": "3b62998f-46dc-4482-bf79-23619a6f221f",
  "HotelRoomsDetails": [
    {
      "RoomIndex": 4,
      "RoomTypeName": "16 Bed Mixed Dorm Ac,1 Twin Bunk Bed,Nonsmoking",
      "RatePlanCode": "214522545|250132887|37407|141",
      "RoomTypeCode": "214522545|250132887$37407^^1^^214522545|250132887|37407|141~!:~4",
      "BedTypeCode": null,
      "SmokingPreference": "0",
      "Supplements": null,
      "Price": {
        "CurrencyCode": "INR",
        "RoomPrice": 386.32,
        "Tax": 8.57,
        "ExtraGuestCharge": 0,
        "ChildCharge": 0,
        "OtherCharges": 59.27,
        "Discount": 0,
        "PublishedPrice": 454.16,
        "PublishedPriceRoundedOff": 454,
        "OfferedPrice": 454.16,
        "OfferedPriceRoundedOff": 454,
        "AgentCommission": 0,
        "AgentMarkUp": 0,
        "ServiceTax": 16.43,
        "TCS": 0,
        "TDS": 0,
        "ServiceCharge": 0,
        "TotalGSTAmount": 16.43,
        "GST": {
          "CGSTAmount": 0,
          "CGSTRate": 0,
          "CessAmount": 5.71,
          "CessRate": 10,
          "IGSTAmount": 10.71,
          "IGSTRate": 18,
          "SGSTAmount": 0,
          "SGSTRate": 0,
          "TaxableAmount": 59.24
        }
      }
    }
  ]
}

Response

The API returns an HTTP response, which generally includes the result of the request invocation

{
"status": "200",
"status_message": "OK",
  "responseData": {
    "BlockRoomResult": {
      "TraceId": "3b62998f-46dc-4482-bf79-23619a6f221f",
      "ResponseStatus": 1,
      "Error": {
        "ErrorCode": 0,
        "ErrorMessage": ""
      },
      "IsCancellationPolicyChanged": false,
      "IsHotelPolicyChanged": true,
      "IsPriceChanged": false,
      "IsPackageFare": false,
      "IsDepartureDetailsMandatory": false,
      "IsPackageDetailsMandatory": false,
      "AvailabilityType": "Confirm",
      "GSTAllowed": true,
      "HotelNorms": "CheckIn Time-Begin: 1:00 PM | CheckIn Time-End: 5:30 AM|CheckOut Time: 11:00 AM|CheckIn Instructions: 
      
  • Extra-person charges may apply and vary depending on property policy
  • Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges
  • Special requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteed
  • This property accepts credit cards and cash
    •   
 | Special Instructions : Front desk staff will greet guests on arrival.|Minimum CheckIn Age : 18| Optional Fees: 
The following fees and deposits are charged by the property at time of service, check-in, or check-out. 
 
     
  • Fee for continental breakfast: INR 100 per person (approximately)
    •      
  • Airport shuttle fee: INR 899 per vehicle (one-way)
    •                          
 
The above list may not be comprehensive. Fees and deposits may not include tax and are subject to change. 
|Cards Accepted: Visa,Debit cards not accepted,Cash,Mastercard|
      
  • This property offers transfers from the airport (surcharges may apply). Guests must contact the property with arrival details before travel, using the contact information on the booking confirmation. 
    •  
  • Children 17 years old and younger are not permitted at this property. 
    •  
,Pets not allowed,No cribs (infant beds) available,No rollaway/extra beds available,Children not allowed,No elevators| | CheckIn Time-Begin: 1:00 PM  CheckIn Time-End: 5:30 AMCheckOut Time: 11:00 AMCheckIn Instructions: <ul>  <li>Extra-person charges may apply and vary depending on property policy</li><li>Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges</li><li>Special requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteed</li><li>This property accepts credit cards and cash</li>  </ul>  Special Instructions : Front desk staff will greet guests on arrival.Minimum CheckIn Age : 18 Optional Fees: <p>The following fees and deposits are charged by the property at time of service, check-in, or check-out. </p> <ul> <li>Fee for continental breakfast: INR 100 per person (approximately)</li>     <li>Airport shuttle fee: INR 899 per vehicle (one-way)</li>                         </ul> <p>The above list may not be comprehensive. Fees and deposits may not include tax and are subject to change. </p>Cards Accepted: Visa,Debit cards not accepted,Cash,Mastercard<ul>  <li>This property offers transfers from the airport (surcharges may apply). Guests must contact the property with arrival details before travel, using the contact information on the booking confirmation. </li> <li>Children 17 years old and younger are not permitted at this property. </li> </ul>,Pets not allowed,No cribs (infant beds) available,No rollaway/extra beds available,Children not allowed,No elevatorsPlease refer to the following Terms of Use - http://mytravelagent.online/termsofuse.pdfEarly check out will attract full cancellation charge unless otherwise specified.|",
      "HotelName": "Moustache Delhi",
      "AddressLine1": "D-920, New Friends Colony,New Delhi,Delhi,IN",
      "AddressLine2": null,
      "StarRating": 1,
      "HotelPolicyDetail": "india - land of mystries \"//\" \"  /// \"  |CheckIn Time-Begin: 1:00 PM | CheckIn Time-End: 5:30 AM|CheckOut Time: 11:00 AM|CheckIn Instructions: 
      
  • Extra-person charges may apply and vary depending on property policy
  • Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges
  • Special requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteed
  • This property accepts credit cards and cash
    •   
 | Special Instructions : Front desk staff will greet guests on arrival.|Minimum CheckIn Age : 18| Optional Fees: 
The following fees and deposits are charged by the property at time of service, check-in, or check-out. 
 
     
  • Fee for continental breakfast: INR 100 per person (approximately)
    •      
  • Airport shuttle fee: INR 899 per vehicle (one-way)
    •                          
 
The above list may not be comprehensive. Fees and deposits may not include tax and are subject to change. 
|Cards Accepted: Visa,Debit cards not accepted,Cash,Mastercard|
      
  • This property offers transfers from the airport (surcharges may apply). Guests must contact the property with arrival details before travel, using the contact information on the booking confirmation. 
    •  
  • Children 17 years old and younger are not permitted at this property. 
    •  
,Pets not allowed,No cribs (infant beds) available,No rollaway/extra beds available,Children not allowed,No elevators| | CheckIn Time-Begin: 1:00 PM  CheckIn Time-End: 5:30 AMCheckOut Time: 11:00 AMCheckIn Instructions: <ul>  <li>Extra-person charges may apply and vary depending on property policy</li><li>Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges</li><li>Special requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteed</li><li>This property accepts credit cards and cash</li>  </ul>  Special Instructions : Front desk staff will greet guests on arrival.Minimum CheckIn Age : 18 Optional Fees: <p>The following fees and deposits are charged by the property at time of service, check-in, or check-out. </p> <ul> <li>Fee for continental breakfast: INR 100 per person (approximately)</li>     <li>Airport shuttle fee: INR 899 per vehicle (one-way)</li>                         </ul> <p>The above list may not be comprehensive. Fees and deposits may not include tax and are subject to change. </p>Cards Accepted: Visa,Debit cards not accepted,Cash,Mastercard<ul>  <li>This property offers transfers from the airport (surcharges may apply). Guests must contact the property with arrival details before travel, using the contact information on the booking confirmation. </li> <li>Children 17 years old and younger are not permitted at this property. </li> </ul>,Pets not allowed,No cribs (infant beds) available,No rollaway/extra beds available,Children not allowed,No elevatorsPlease refer to the following Terms of Use - http://mytravelagent.online/termsofuse.pdfEarly check out will attract full cancellation charge unless otherwise specified.|",
      "Latitude": "28.56442",
      "Longitude": "77.26796",
      "BookingAllowedForRoamer": false,
      "AncillaryServices": [
        
      ],
      "HotelRoomsDetails": [
        {
          "AvailabilityType": "Confirm",
          "ChildCount": 0,
          "RequireAllPaxDetails": true,
          "RoomId": 0,
          "RoomStatus": 0,
          "RoomIndex": 4,
          "RoomTypeCode": "214522545|250132887$37407^^1^^214522545|250132887|37407|141~!:~4",
          "RoomDescription": "16 Bed Mixed Dorm Ac,1 Twin Bunk Bed,Nonsmoking",
          "RoomTypeName": "16 Bed Mixed Dorm Ac,1 Twin Bunk Bed,Nonsmoking",
          "RatePlanCode": "214522545|250132887|37407|141",
          "RatePlan": 0,
          "RatePlanName": "Free WiFi ",
          "InfoSource": "FixedCombination",
          "SequenceNo": "TH~~31620301~4",
          "DayRates": [
            {
              "Amount": 386.32,
              "Date": "2021-09-16T00:00:00"
            }
          ],
          "IsPerStay": false,
          "SupplierPrice": null,
          "Price": {
            "CurrencyCode": "INR",
            "RoomPrice": 386.32,
            "Tax": 8.57,
            "ExtraGuestCharge": 0,
            "ChildCharge": 0,
            "OtherCharges": 59.27,
            "Discount": 0,
            "PublishedPrice": 454.16,
            "PublishedPriceRoundedOff": 454,
            "OfferedPrice": 454.16,
            "OfferedPriceRoundedOff": 454,
            "AgentCommission": 0,
            "AgentMarkUp": 0,
            "ServiceTax": 16.43,
            "TCS": 0,
            "TDS": 0,
            "ServiceCharge": 0,
            "TotalGSTAmount": 16.43,
            "GST": {
              "CGSTAmount": 0,
              "CGSTRate": 0,
              "CessAmount": 5.71,
              "CessRate": 10,
              "IGSTAmount": 10.71,
              "IGSTRate": 18,
              "SGSTAmount": 0,
              "SGSTRate": 0,
              "TaxableAmount": 59.24
            }
          },
          "RoomPromotion": "",
          "Amenities": [
            "Free WiFi "
          ],
          "Amenity": [
            "Free WiFi "
          ],
          "SmokingPreference": "NoPreference",
          "BedTypes": [
            
          ],
          "HotelSupplements": [
            
          ],
          "LastCancellationDate": "2021-08-10T23:59:59",
          "CancellationPolicies": [
            {
              "Charge": 100,
              "ChargeType": 2,
              "Currency": "INR",
              "FromDate": "2021-08-11T00:00:00",
              "ToDate": "2021-09-05T23:59:59"
            },
            {
              "Charge": 100,
              "ChargeType": 2,
              "Currency": "INR",
              "FromDate": "2021-09-06T00:00:00",
              "ToDate": "2021-09-17T23:59:59"
            }
          ],
          "LastVoucherDate": "2021-08-11T00:00:00",
          "CancellationPolicy": "16 Bed Mixed Dorm Ac,1 Twin Bunk Bed,Nonsmoking#^#100.00% of total amount will be charged, If cancelled between 11-Aug-2021 00:00:00 and 05-Sep-2021 23:59:59.|100.00% of total amount will be charged, If cancelled between 06-Sep-2021 00:00:00 and 17-Sep-2021 23:59:59.|#!#",
          "Inclusion": [
            "Free WiFi "
          ],
          "IsPassportMandatory": false,
          "IsPANMandatory": true
        }
      ]
    }
  }
}