Developer documentation

Hotels API

8,50,000+ inventories aggregated from multiple bedbanks, OTA and GDS. Reference for every hotels method: search, pricing, booking and post-booking.

Flights APIHotels APIBus API

All requests share the same headers: Content-Type: application/json, Accept-encoding: gzip, your PID and x-api-key. Pass the end customer's IPv4 address as Customer-Ip.

GET

Geographical Location Search

The Geography APIs provide you with access to geographic definitions and property mappings for over 600,000 regions and airports. Returns the geographic definition and property mappings of regions matching the specified parameters as a paginated response.

Parameters

Acceptstringheaderrequired

application/json

Accept - Encodingstringheaderrequired

gzip

Authorizationstringheaderrequired

Your API Key

Your PID Key

Customer-Ipstringheaderrequired

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.

actionstringqueryrequired

"getLocations" as a parameter

limitnumberqueryrequired

Page limit.

Limit the number of records returned.

termstringqueryrequired

Relevant regions.

Specific information about the region e.g. whether it covers surrounding areas for a city. Only present when relevant for a region.

Request

GEThttps://your-end-point/api/v1/travel-api/hotels/
Request
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-PID-KEY',
'x-api-key:'ADD-API-YOUR-KEY'
);

GET: https://your-end-point/api/v1/travel-api/hotels/?action=getLocations&limit=5&locale=en&term=del

Response

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

200 · application/json
{
  "cities": [
    {
      "latinFullName": "New York, New York, United States of America",
      "regionid": 130452,
      "CountryCode": "US",
      "category": "cities",
      "class_Name": "cities",
      "search_type": 1,
      "PopularSearchCount": 13178
    },{

    ...

   },
    {
      "latinFullName": "Christchurch, New Zealand",
      "regionid": 144687,
      "CountryCode": "NZ",
      "category": "cities",
      "class_Name": "cities",
      "search_type": 1,
      "PopularSearchCount": 3639
    }
  ]
}
POST

Authenticate

Authenticate method will return the Token ID that needs to be echoed back in every subsequent request..

Parameters

Acceptstringheaderrequired

application/json

Accept - Encodingstringheaderrequired

gzip

Authorizationstringheaderrequired

Your API Key

actionstringqueryrequired

"createToken" as a parameter

Request

POSThttps://your-end-point/api/v1/travel-api/hotels/
Request
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-PID'
'x-api-key:'ADD-YOUR-KEY'
);

POST:
{
"action": "createToken"
}

Response

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

200 · application/json
{

      "TokenId": "b33c72c2-d87b-4e6a-a8a2-3a476ddb0fd0",
}
POST

Property Description

Use the information provided in this API to enhance your property description or to improve mapping between suppliers. The response includes high-level details about each property. This response is in JSONL format and is gzipped. The schema of each JSON object in the JSONL file is a subset of the schema of each JSON object from the Property Content call.

Parameters

Acceptstringheaderrequired

application/json

Accept - Encodingstringheaderrequired

gzip

Authorizationstringheaderrequired

Your PID

Your API Key

Customer-Ipstringheaderrequired

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.

apiKeystringqueryrequired

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.

ModeTypestringqueryrequired

either "Test" or "LIVE"

Your application *needs an approval from adivaha® Personnel.

pidstringqueryrequired

"{Your Partner ID}" as a parameter

actionstringqueryrequired

"hotelDetails" as a parameter

ResultIndexstringqueryrequired

the resultIndex of the property you want to gather information for.

hotelIdstringqueryrequired

the ID of the property you want to gather information for.

TraceIdstringqueryrequired

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

Trace id is valid for 15 Minutes only and should be same throughout the booking process.

Request

POSThttps://your-end-point/api/v1/travel-api/hotels/
Request
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-PID',
'x-api-key:'ADD-YOUR-KEY'
);

POST:
{
  "action": "hotelDetails",
  "mode": "Test",
  "ResultIndex": "3",
  "hotelId": "31620301",
  "TraceId": "a89bfa2b-936b-4e82-8ca4-c9aa55a947e7"
}

Response

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

200 · application/json
{
  "status": "200",
  "status_message": "OK",
  "responseData": {
  "HotelInfoResult": {
    "ResponseStatus": 1,
    "Error": {
      "ErrorCode": 0,
      "ErrorMessage": ""
    },
    "TraceId": "a89bfa2b-936b-4e82-8ca4-c9aa55a947e7",
    "HotelDetails": {
      "HotelCode": "31620301",
      "HotelName": "Moustache Delhi",
      "StarRating": 1,
      "HotelURL": null,
      "Description": "
location:
 Located in the Delhi in a residential area, this hotel is actually on the main ring road of Delhi with easy access to the airport and city centre. The metro is 10 mins walk away.

rooms:
 The medium-sized bedrooms are in very good condition. There is a very tasteful, regal theme throughout, with all rooms containing a print of a royal crest and all furniture bearing a crown motif. The colour scheme is predominantly royal blue and all rooms have a small seating area and desk. Those bedrooms with French patio doors have been altered so that the doors only open a couple of inches.

restaurant:
 Whilst the front half of the restaurant maintains a light, airy and casual feel, the back half is more formal. Between the front and back of the restaurant is a brasserie-type room with wooden floors. The bar is also here. The whole atmosphere is that of a ship and is very easy on the eye.

exterior:
 This hotel was opened in 1992 and is a low rise modern building.
lobby:
 The lobby is small and furnished in simple, modern style.
general:
 This hotel is suitable for all markets, especially those on a budget looking for a hotel that does not resemble a budget hotel. 030807JG
",
      "Attractions": [
        {
          "Key": "1) ",
          "Value": "10 kms to city centre"
        },
        {
          "Key": "2) ",
          "Value": "15 kms to the nearest airport (schiphol airport)"
        },
        {
          "Key": "3) ",
          "Value": "15 minute walk to the nearest metro station (gaasperplas)"
        },
        {
          "Key": "4) ",
          "Value": "10 km to the nearest station (central station)"
        },
        {
          "Key": "5) ",
          "Value": "5 minute walk to the nearest bus stop"
        },
        {
          "Key": "6) ",
          "Value": "10 km to the nearest fair site (rai)"
        }
      ],
      "HotelFacilities": [
        "Small sized lobby",
        "Earliest check-in at 14:00",
        "2 lifts",
        "3 floors",
        "Coach parking",
        "Car parking (Payable to hotel, if applicable)",
        "Tennis",
        "Baby sitting",
        "Disabled facilities"
      ],
      "HotelPolicy": null,
      "SpecialInstructions": null,
      "HotelPicture": null,
      "Images": [
        "http://b2b.tektravels.com/imageresource.aspx?img=hpRBSdtPJNrQuwRo5I/exPbdtjJGoRI2R1Qo2/ mGLJmyqx45ZoqbxPjvgo2rvQho2ca1RGY2hWEfquloiGzaCA==",
        "http://b2b.tektravels.com/imageresource.aspx?img=hpRBSdtPJNrQuwRo5I/exPbdtjJGoRI2R1Qo2/ mGLJmyqx45ZoqbxPjvgo2rvQhoDizplENpfVb822OetiqfIg==",
        "http://b2b.tektravels.com/imageresource.aspx?img=hpRBSdtPJNrQuwRo5I/exPbdtjJGoRI2R1Qo2/ mGLJmyqx45ZoqbxPjvgo2rvQho4qr9ZiEedRCyAtDGrZD/Og==",
        "http://b2b.tektravels.com/imageresource.aspx?img=hpRBSdtPJNrQuwRo5I/exPbdtjJGoRI2R1Qo2/ mGLJmyqx45ZoqbxPjvgo2rvQhoCHy8YYNr91c8R5UcAzWheg==",
        "http://b2b.tektravels.com/imageresource.aspx?img=hpRBSdtPJNrQuwRo5I/exPbdtjJGoRI2R1Qo2/ mGLJmyqx45ZoqbxPjvgo2rvQho2cIT7qTX5R24fA8OVhM0SQ==",
        "http://b2b.tektravels.com/imageresource.aspx?img=hpRBSdtPJNrQuwRo5I/exPbdtjJGoRI2R1Qo2/ mGLJmyqx45ZoqbxPjvgo2rvQhoHthWAZEK/8aGZt0Ha4eeyA==",
        "http://b2b.tektravels.com/imageresource.aspx?img=VXg3tLzKw7A="
      ],
      "Address": "D-920, New Friends Colony,New Delhi,Delhi,IN",
      "CountryName": "India",
      "PinCode": null,
      "HotelContactNo": "91-11-3121416",
      "FaxNumber": "91-11-3121465",
      "Email": null,
      "Latitude": "28.56442",
      "Longitude": "77.26796",
      "RoomData": null,
      "RoomFacilities": null,
      "Services": null
    }
  }
}
}
POST

Room Availability

Returns rates and availability on all room types for specified properties. Multiple rooms of the same type may be requested by including multiple instances of the occupancy parameter. No more than 8 rooms may be requested at a time - if you need to book more than 8 rooms at once, please consult with your account manager about our group booking partnership.

Parameters

Acceptstringheaderrequired

application/json

Accept - Encodingstringheaderrequired

gzip

Authorizationstringheaderrequired

Your PID

Your API Key

Customer-Ipstringheaderrequired

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.

apiKeystringqueryrequired

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.

ModeTypestringqueryrequired

either "Test" or "LIVE"

Your application *needs an approval from adivaha® Personnel.

pidstringqueryrequired

"{Your Partner ID}" as a parameter

actionstringqueryrequired

"roomAvalibility" as a parameter

ResultIndexstringqueryrequired

The ResultIndex of the property you want to gather information for.

hotelIdstringqueryrequired

The ID of the property you want to gather information for.

TraceIdstringqueryrequired

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

Trace id is valid for 15 Minutes only and should be same throughout the booking process.

Request

POSThttps://your-end-point/api/v1/travel-api/hotels/
Request
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-PID',
'x-api-key:'ADD-YOUR-KEY'
);

POST:
{
  "action": "roomAvalibility",
  "mode": "Test",
  "ResultIndex": "3",
  "hotelId": "31620301",
  "TraceId": "8e3db358-d185-4eda-a81d-15dcdba77217"
}

Response

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

200 · application/json
{
    "status": "200",
    "status_message": "OK",
    "responseData": {
        "GetHotelRoomResult": {
            "ResponseStatus": 1,
            "Error": {
                "ErrorCode": 0,
                "ErrorMessage": ""
            },
            "TraceId": "8e3db358-d185-4eda-a81d-15dcdba77217",
            "IsUnderCancellationAllowed": true,
            "IsPolicyPerStay": false,
            "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
                },
                {
                    "AvailabilityType": "Confirm",
                    "ChildCount": 0,
                    "RequireAllPaxDetails": true,
                    "RoomId": 0,
                    "RoomStatus": 0,
                    "RoomIndex": 5,
                    "RoomTypeCode": "214522540|250132890$37407^^1^^214522540|250132890|37407|141~!:~5",
                    "RoomDescription": "8 Bed Mixed Dorm Non Ac,1 Twin Bunk Bed,Nonsmoking",
                    "RoomTypeName": "8 Bed Mixed Dorm Non Ac,1 Twin Bunk Bed,Nonsmoking",
                    "RatePlanCode": "214522540|250132890|37407|141",
                    "RatePlan": 0,
                    "RatePlanName": "Free WiFi ",
                    "InfoSource": "FixedCombination",
                    "SequenceNo": "TH~~31620301~5",
                    "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": "8 Bed Mixed Dorm Non 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
                }

            ],
            "RoomCombinations": {
                "InfoSource": "FixedCombination",
                "IsPolicyPerStay": false,
                "RoomCombination": [
                    {
                        "RoomIndex": [
                            4
                        ]
                    },
                    {
                        "RoomIndex": [
                            5
                        ]
                    }
                ]
            }
        }
    }
}
POST

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

Acceptstringheaderrequired

application/json

Accept - Encodingstringheaderrequired

gzip

Authorizationstringheaderrequired

Your PID

Your API Key

Customer-Ipstringheaderrequired

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.

apiKeystringqueryrequired

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.

ModeTypestringqueryrequired

either "Test" or "LIVE"

Your application *needs an approval from adivaha® Personnel.

pidstringqueryrequired

"{Your Partner ID}" as a parameter

actionstringqueryrequired

"blockRoom" as a parameter

ResultIndexstringquery

Result Index

hotelIdstringqueryrequired

Unique hotel code.

HotelNamestringqueryrequired

Unique hotel Name.

nationalitystringquery

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

roomsstringquery

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

TraceIdstringqueryrequired

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

HotelRoomDetailsArrayquery

Array of hotel room details

RoomIndexInteger

Index of the room

RatePlanCodestring

Rate plan code associated with room

RatePlanNamestring

Name of the Rate plan associated with room

RoomTypeCodestring

Room Type Code

RoomTypeNamestring

Room Type Name

BedTypesArrayquery

Array of bed types

(1.1)BedTypeCodestring

Bed type code

(1.2)BedTypeDescriptionstring

Bed type description(Optional)

SmokingPreferenceEnumeration

Smoking Preference associated with room

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

SupplementsStringList

List of supplements

PriceArray

Price detail of the room

(1.1)CurrencyCodestring

Currency in which minimum hotel price is returned

(1.2)RoomPricedecimal

Price of the room

(1.3)Taxdecimal

Tax applicable for the room

(1.4)ExtraGuestChargedecimal

Extra Guest Charges applicable for the room

(1.5)ChildChargedecimal

Child Charges applicable for the room

(1.6)OtherChargesdecimal

Other Charges applicable for the room

(1.7)Discountdecimal

Discount applicable for the room

(1.8)PublishedPricedecimal

Published Price of the room

(1.9)PublishedPriceRoundedOffInteger

Published Price (rounded off) of the room

(1.10)OfferedPricedecimal

Offered Price of the room

(1.11)OfferedPriceRoundedOffInteger

Offered Price (rounded off) of the room

(1.12)AgentCommissiondecimal

Commission applicable on the Room Price

(1.13)AgentMarkUpdecimal

Agent Mark Up applicable on the Room Price

(1.14)ServiceTaxdecimal

Service tax applicable for the room

(1.15)TDSdecimal

TDS applicable on Commission Earned

Request

POSThttps://your-end-point/api/v1/travel-api/hotels/
Request
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

200 · application/json
{
"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 policyGovernment-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental chargesSpecial requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteedThis 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 policyGovernment-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental chargesSpecial requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteedThis 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
        }
      ]
    }
  }
}
POST

Booking

Booking API allows you to book rooms & rates confirmed by the price check response. The primary itinerary method of the Booking API creates a reservation for the selected hotel, room, rate and occupancy.

Parameters

Acceptstringheader

application/json

Accept - Encodingstringheader

gzip

Authorizationstringheader

Your PID

Your API Key

Customer-Ipstringheader

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.

actionstringquery

"bookHotel" as parameter

Action methods in Web API controller can have one or more parameters of different types. It can be either primitive type or complex type. Web API binds action method parameters either with URL's query string or with request body depending on the parameter type.

apiKeystringquery

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.

ModeTypestringquery

either "Test" or "LIVE"

Your application must be approved from the Travlix team. All the transactions will be treated as LIVE once the parameter is set to LIVE.

requestBodyarrayquery

an array with the following parameters

ResultIndexstringqueryrequired

Result Index.

hotelIdstringqueryrequired

Unique hotel code.

HotelNamestringquery

Unique hotel Name.

hotelAddressstringquery

Hotel Address.

nationalitystringquery

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

roomsstringquery

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

chargablePricedecimalquery

Total Price

currencystringquery

Currency code

checkInstringquery

The date by which a guest must check in. Must follow YYYY-MM-DD format. ie. "checkIn:2019-05-30"

checkOutstringquery

The date by which a guest must check out. Must follow YYYY-MM-DD format. ie. "checkIn:2019-05-31"

TraceIdstringqueryrequired

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

HotelRoomsDetailsArrayqueryrequired

Array of hotel room details.

RoomIndexInteger

Index of the room

RatePlanCodestring

Rate plan code associated with room

RatePlanNamestring

Name of the Rate plan associated with room

RoomTypeCodestring

Room Type Code

RoomTypeNamestring

Room Type Name

BedTypesArrayquery

Array of bed types

(1.1)BedTypeCodestring

Bed type code

(1.2)BedTypeDescriptionstring

Bed type description(Optional)

SmokingPreferenceEnumeration

Smoking Preference associated with room

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

SupplementsStringList

List of supplements

PriceArray

Price detail of the room

(1.1)CurrencyCodestring

Currency in which minimum hotel price is returned

(1.2)RoomPricedecimal

Price of the room

(1.3)Taxdecimal

Tax applicable for the room

(1.4)ExtraGuestChargedecimal

Extra Guest Charges applicable for the room

(1.5)ChildChargedecimal

Child Charges applicable for the room

(1.6)OtherChargesdecimal

Other Charges applicable for the room

(1.7)Discountdecimal

Discount applicable for the room

(1.8)PublishedPricedecimal

Published Price of the room

(1.9)PublishedPriceRoundedOffInteger

Published Price (rounded off) of the room

(1.10)OfferedPricedecimal

Offered Price of the room

(1.11)OfferedPriceRoundedOffInteger

Offered Price (rounded off) of the room

(1.12)AgentCommissiondecimal

Commission applicable on the Room Price

(1.13)AgentMarkUpdecimal

Agent Mark Up applicable on the Room Price

(1.14)ServiceTaxdecimal

Service tax applicable for the room

(1.15)TDSdecimal

TDS applicable on Commission Earned

HotelPassengerArray

Array of guest details for in the particular room as requested in hotel search

(1.1)Titlestring

Title of the guest

(1.2)FirstNamestring

First name of the guest

(1.3)MiddleNamestring

Middle name of the guest

(1.4)LastNamestring

Last name of the guest

(1.5)Phonenostring

Phone number

(1.6)Emailstring

Email id

(1.7)PaxTypeEnumeration

Guest Type

Mandatory - HotelPassenger - PaxType Adult = 1, Child = 2

(1.8)LeadPassengerBoolean

Represent the lead guest of the booking

(1.9)AgeInteger

Age of the guest

Mandatory * (only for child and age should be <= 12 years)

(1.10)PassportNoPassportNo

Age of the guest

Passport No

(1.11)PassportIssueDateDate

Passport Expiry Date

(provide in minimum date time format “0001-01- 01T00:00:00:00” )

(1.12)PassportExpDateDate

Passport Expiry Date

(provide in minimum date time format “0001-01- 01T00:00:00:00” )

(1.13)PANstring

PAN should be in correct format)

IsPackageFareboolean

In case you receive "IsPackageFare": true in Block response then you need to pass same in Book Request

IsPackageDetailsMandatory

if you get IsPackageDetailsMandatory": true in Block Response then following details need to be passed in Book request.

ArrivalTransport

ArrivalTransportType,TransportInfoId,Time

(1.1)ArrivalTransportTypeint

Flight = 0, surface = 1

(1.2)TransportInfoIdstring

Transfer Details

(1.3)Timestring

0001-01-01T00: 00: 00

Request

POSThttps://your-end-point/api/v1/travel-api/hotels/
Request
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-KEY',
'x-api-key:'ADD-YOUR-KEY'
);

POST:
{
  "action": "bookHotel",
  "mode": "Test",
  "ResultIndex": "4",
  "hotelId": "31620301",
  "HotelName": "Moustache Delhi",
  "hotelAddress": "231,delhi",
  "nationality": "IN",
  "rooms": "1",
  "chargablePrice": "5000",
  "currency": "INR",
  "checkIn": "2021-09-16",
  "checkOut": "2021-09-17",
  "IsPackageFare": false,
  "ArrivalTransport": null,
  "TraceId": "3b62998f-46dc-4482-bf79-23619a6f221f",
  "HotelRoomsDetails": [
    {
      "RoomIndex": 4,
      "RoomTypeCode": "990001490971:6804#$#15:146202:990001490971:6804#3925285|si-16848ff2-76cd-4856-ba00-bef4adc2d3f8#$#1#$#0",
      "RoomTypeName": "16 Bed Mixed Dorm Ac,1 Twin Bunk Bed,Nonsmoking",
      "RatePlanCode": "990001490971:6804#$#15:146202:990001490971:6804#3925285|si-16848ff2-76cd-4856-ba00-bef4adc2d3f8#$#1#$#0",
      "BedTypeCode": null,
      "SmokingPreference": "0",
      "Supplements": null,
      "Price": {
        "CurrencyCode": "INR",
        "RoomPrice": 5655.74,
        "Tax": 678,
        "ExtraGuestCharge": 0,
        "ChildCharge": 0,
        "OtherCharges": 0,
        "Discount": 210,
        "PublishedPrice": 6631.41,
        "PublishedPriceRoundedOff": 6631,
        "OfferedPrice": 6333.74,
        "OfferedPriceRoundedOff": 6334,
        "AgentCommission": 297.67,
        "AgentMarkUp": 0,
        "ServiceTax": 0,
        "TDS": 14.88,
        "ServiceCharge": 0,
        "TotalGSTAmount": 0
      },
      "HotelPassenger": [
        {
          "Title": "Mr",
          "FirstName": "Test",
          "Middlename": "",
          "LastName": "Booking",
          "Phoneno": "9988776655",
          "Email": "test@thewebconz.com",
          "PaxType": 1,
          "LeadPassenger": true,
          "Age": 25,
          "PassportNo": null,
          "PassportIssueDate": null,
          "PassportExpDate": null,
          "PAN": null
        }
      ]
    }
  ]
}

Response

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

200 · application/json
{
  "status": 200,
  "status_message": "Booking has been confirmed",
  "responseData": {
    "BookResult": {
      "VoucherStatus": true,
      "ResponseStatus": 1,
      "Error": {
        "ErrorCode": 0,
        "ErrorMessage": ""
      },
      "TraceId": "3b62998f-46dc-4482-bf79-23619a6f221f",
      "Status": 1,
      "HotelBookingStatus": "Confirmed",
      "InvoiceNumber": "MW\/2021\/3122",
      "ConfirmationNo": "FLLBBV(7253958265303)",
      "BookingRefNo": "432493301682594",
      "BookingId": 1614235,
      "IsPriceChanged": false,
      "IsCancellationPolicyChanged": false
    }
  }
}
POST

Retrieve Booking

Discover how to use Retrieve API calls to retrieve existing itineraries. This can be called directly with your API key with booking reference id. It returns details about a booking details associated with the itinerary id along with cancel links to cancel the booking.

Parameters

Acceptstringheader

application/json

Accept - Encodingstringheader

gzip

Authorizationstringheader

Your PID

Your API Key

Customer-Ipstringheader

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.

actionstringquery

"getBookDetails" as parameter

Action methods in Web API controller can have one or more parameters of different types. It can be either primitive type or complex type. Web API binds action method parameters either with URL's query string or with request body depending on the parameter type.

apiKeystringquery

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.

ModeTypestringquery

either "Test" or "LIVE"

Your application must be approved from the Travlix team. All the transactions will be treated as LIVE once the parameter is set to LIVE.

requestBodyarrayquery

an array with the following parameters

BookingIdstringquery

The BookingId ID generated at the time of booking.

itineraryIdstringquery

The Itinerary ID generated at the time of booking.

Request

POSThttps://your-end-point/api/v1/travel-api/hotels/
Request
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-PID',
'x-api-key:'ADD-YOUR-KEY'
);

POST:
{
  "action": "getBookDetails",
  "mode": "Test",
  "itineraryId": "346896543",
  "BookingId": "31620301"
}

Response

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

200 · application/json
{
    "Status": 600,
    "status_message": "Booking has been confirmed ",
    "responseData": {
    "GetBookingDetailResult": {
    "VoucherStatus": true,
    "ResponseStatus": 1,
    "Error": {
      "ErrorCode": 0,
      "ErrorMessage": ""
    },
    "TraceId": "3b62998f-46dc-4482-bf79-23619a6f221f",
    "Status": 1,
    "HotelBookingStatus": "Confirmed",
    "ConfirmationNo": "FLLBBV(7253958265303)",
    "BookingRefNo": "432493301682594",
    "BookingId": 1614235,
    "IsPriceChanged": false,
    "IsCancellationPolicyChanged": false,
    "HotelRoomsDetails": [
      {
        "AdultCount": 1,
        "AvailabilityType": "Confirm",
        "ChildCount": 0,
        "HotelPassenger": [
          {
            "Age": 0,
            "Email": "test@thewebconz.com",
            "FirstName": "Abhishek",
            "GSTCompanyAddress": null,
            "GSTCompanyContactNumber": null,
            "GSTCompanyEmail": null,
            "GSTCompanyName": null,
            "GSTNumber": null,
            "LastName": "Sharma",
            "LeadPassenger": true,
            "MiddleName": "",
            "PAN": null,
            "PassportExpDate": null,
            "PassportIssueDate": null,
            "PassportNo": null,
            "PaxId": 139023,
            "PaxType": 1,
            "Phoneno": "08877665544",
            "Title": "Mr"
          }
        ],
        "RequireAllPaxDetails": false,
        "RoomId": 107348,
        "RoomStatus": 0,
        "RoomIndex": 1,
        "RoomTypeCode": "202414827|",
        "RoomDescription": "",
        "RoomTypeName": "Double Room (Non Ac),2 Twin Beds,Nonsmoking",
        "RatePlanCode": "202414827|212286584|37341",
        "RatePlan": 0,
        "DayRates": [
          {
            "Amount": 1501.32,
            "Date": "2020-07-09T00:00:00"
          }
        ],
        "IsPerStay": false,
        "SupplierPrice": null,
        "Price": {
          "CurrencyCode": "INR",
          "RoomPrice": 1501.32,
          "Tax": 179.97,
          "ExtraGuestCharge": 0,
          "ChildCharge": 0,
          "OtherCharges": 420.63,
          "Discount": 0,
          "PublishedPrice": 2101.92,
          "PublishedPriceRoundedOff": 2102,
          "OfferedPrice": 2101.92,
          "OfferedPriceRoundedOff": 2102,
          "AgentCommission": 0,
          "AgentMarkUp": 0,
          "ServiceTax": 75.7,
          "TDS": 0,
          "ServiceCharge": 0,
          "TotalGSTAmount": 75.7,
          "GST": {
            "CGSTAmount": 0,
            "CGSTRate": 0.00,
            "CessAmount": 0,
            "CessRate": 0.00,
            "IGSTAmount": 75.7,
            "IGSTRate": 18.00,
            "SGSTAmount": 0,
            "SGSTRate": 0.00,
            "TaxableAmount": 420.63
          }
        },
        "RoomPromotion": "",
        "Amenities": [
          "Room Only"
        ],
        "Amenity": [
          "Room Only"
        ],
        "SmokingPreference": "NoPreference",
        "BedTypes": [

        ],
        "HotelSupplements": null,
        "LastCancellationDate": "2020-07-06T23:59:59",
        "CancellationPolicies": [
          {
            "Charge": 100.0000,
            "ChargeType": 2,
            "Currency": "INR",
            "FromDate": "2020-07-07T00:00:00",
            "ToDate": "2020-07-10T23:59:59"
          }
        ],
        "LastVoucherDate": "2020-07-07T00:00:00",
        "CancellationPolicy": "Double Room (Non Ac),2 Twin Beds,Nonsmoking#^#100.00% of total amount will be charged, If cancelled between 07-Jul-2020 00:00:00 and 10-Jul-2020 23:59:59.|#!#",
        "Inclusion": [
          "Room Only"
        ]
      }
    ],
    "AgentRemarks": "",
    "BookingSource": "TBOHApi3",
    "GuestNationality": "IN",
    "HotelPolicyDetail": "india - land of mystries \"\/\/\" \"  \/\/\/ \"  |CheckIn Time-Begin: 12:00 PM  CheckIn Time-End: 12:00 PMCheckOut Time: 11:00 AMCheckIn Instructions: Extra-person charges may apply and vary depending on property policy. <br \/>Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges. <br \/>Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <ul> Only bookings from non-local guests are accepted. Guests whose residence is within the same city as the property will not be allowed to check in. Please note that cultural norms and guest policies may differ by country and by property. The policies listed are provided by the property. <\/ul>  Special Instructions : Front desk staff will greet guests on arrival. For more details, please contact the property using the information on the booking confirmation.  Please note that PAN cards are not accepted as identification at this property.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>Rollaway bed fee: INR 300 per night<\/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: Mastercard,Visa<ul>  <li>Couples wishing to share a room must provide proof of marriage. <\/li><li>Only registered guests are allowed in the guestrooms. <\/li>  <\/ul>,Pets not allowed,No cribs (infant beds) availablePlease refer to the following Terms of Use - http:\/\/mytravelagent.online\/termsofuse.pdfPlease note that bedding type will be Early check out will attract full cancellation charge unless otherwise specified.|",
    "IntHotelPassportDetails": null,
    "InvoiceAmount": 2178,
    "InvoiceCreatedOn": "2020-07-07T11:56:15",
    "InvoiceNo": "MW\/2021\/3122",
    "IsCorporate": false,
    "HotelConfirmationNo": null,
    "HotelCode": "1124262",
    "HotelId": 93619,
    "HotelName": "Dreamland Hotel",
    "TBOHotelCode": "",
    "StarRating": 2,
    "AddressLine1": "163 P D'Mello Road,Fort,Mumbai,Maharashtra,IN",
    "AddressLine2": "Phone No: 91-22-2261775",
    "CountryCode": "IN",
    "Latitude": "18.946796",
    "Longitude": "72.8401",
    "City": "Mumbai",
    "CityId": 144306,
    "CheckInDate": "2020-07-09T00:00:00",
    "InitialCheckInDate": "2020-07-09T00:00:00",
    "CheckOutDate": "2020-07-10T00:00:00",
    "InitialCheckOutDate": "2020-07-10T00:00:00",
    "LastCancellationDate": "2020-07-06T23:59:59",
    "LastVoucherDate": "2020-07-07T00:00:00",
    "NoOfRooms": 1,
    "BookingDate": "2020-07-07T11:56:14",
    "SpecialRequest": "",
    "IsDomestic": true,
    "FlightInfo": "Ab 777|#2020-12-20T18:18:00",
    "BookingAllowedForRoamer": true
  }
    }
}
POST

Cancel Booking

Discover how to use Cancel API calls to cancel existing itineraries. This can be called directly with your API key with booking reference id. It returns details about a booking details associated with the itinerary id along with cancel links to cancel the booking.

Parameters

Acceptstringheader

application/json

Accept - Encodingstringheader

gzip

Authorizationstringheader

Your PID

Your API Key

Customer-Ipstringheader

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.

actionstringquery

"cancelHotelBooking" as parameter

Action methods in Web API controller can have one or more parameters of different types. It can be either primitive type or complex type. Web API binds action method parameters either with URL's query string or with request body depending on the parameter type.

apiKeystringquery

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.

ModeTypestringquery

either "Test" or "LIVE"

Your application must be approved from the Travlix team. All the transactions will be treated as LIVE once the parameter is set to LIVE.

requestBodyarrayquery

an array with the following parameters

itineraryIdstringquery

The Itinerary ID generated at the time of booking.

reasonstringquery

The reason behind cancellation

Request

POSThttps://your-end-point/api/v1/travel-api/hotels/
Request
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-PID',
'x-api-key:'ADD-YOUR-KEY'
);

POST:
{
  "action": "cancelHotelBooking",
  "mode": "Test",
  "itineraryId": "104519726",
  "BookingId": "46615902",
  "reason": "others",
}

Response

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

200 · application/json
{
    "Status": 605,
    "status_message": "Booking has been cancelled ",
    "responseData": {
  "HotelChangeRequestResult": {
    "B2B2BStatus": false,
    "CancellationChargeBreakUp": {
      "CancellationFees": 0.00,
      "CancellationServiceCharge": 0.00
    },
    "TotalServiceCharge": 0.00,
    "ResponseStatus": 1,
    "Error": {
      "ErrorCode": 0,
      "ErrorMessage": ""
    },
    "TraceId": "3b62998f-46dc-4482-bf79-23619a6f221f",
    "ChangeRequestId": 7665834,
    "RefundedAmount": 699.00,
    "TotalPrice": 698.54,
    "ChangeRequestStatus": 3,
    "CreditNoteNo": "MZ\/2122\/29250",
    "CreditNoteCreatedOn": "2021-07-09T13:10:54",
    "GST": {
      "CGSTAmount": 0.00,
      "CGSTRate": 0.00,
      "CessAmount": 0.00,
      "CessRate": 0.00,
      "IGSTAmount": 0.00,
      "IGSTRate": 18.00,
      "SGSTAmount": 0.00,
      "SGSTRate": 0.00,
      "TaxableAmount": 0.00
    }
  }
}

}
Ready to get started?

Start your own travel agency with Travlix.

Trusted by 100+ travel agencies globally, with 25% growth every month. Book a free live demo of the Travlix admin portal.

Book a free demo Chat on WhatsApp