Introduction

The purpose of this document is to provide technical details about the API's. This document outlines the business processes supported by the API and details about specifications of API’s. It assumes that reader has a technical background and is familiar with JSON, API's.

Connection properties

The communication with the system is performed through https connections. The following table enlists the properties of the request that must be employed:

RequestvalueDescription
Request MethodPOSTThe requested method.
Content-Typeapplication/jsonThe content type.

Request/Response

It is recommended that at least all booking and cancellation transactions sent through the Test / Live environment should be logged and maintained by the travel agent for at least 6 months.


Go-Test/Live Process

In order to start testing, please notify our support team via e-mail at supportapi@technoheaven.net Please note that all transactions through the test system are simply test transactions.

Please be advised few activities are available in Test Environment, Do not compare the products with Live Environment The system functionality between the Test and Live system is exactly the same except for the fact that Bookings processed in the Test environment are not sent to the Suppliers. When you have completed your development, contact your Account Manager for the activation of the access IP address of Test/Live Server is essential for whitelisting

Client Requirements

  • Client requests must be issued from a public, static IP address registered with System.
  • Client requests must be made via an HTTPS POST request.
  • SSL.
  • All data sent and received via the interface will be encoded in UTF-8.

Development Phase

Once you receive your Access token, you can start the development of your application/framework. The whole process of communication consists of simple JSON messages exchange (request /response) between your application/framework and system. Each request needs to be posted (through POST method) using https protocols. For details regarding requests and answers formats please consult the dedicated area of each request. For further assistance in development process do not hesitate to contact our support team.

Implementation Approach

  1. Client review of the API specifications
    1. Review of API specifications
  2. Test Environment Integration
    1. API Integration
    2. Test Execution by your Tech Team
  3. Integration Testing
    1. Determining the necessary test cases based on the API's by Our Tech Team
    2. Test Execution.
    3. Certification by Our Tech Team
  4. Production Environment
    1. API Integration
    2. Schedule Go Live Date
    3. Transaction Monitoring and Issue Resolution

Documentation and Downloads

Status & Error Code

NoStatus CodeDescription
1200OK
2400Bad Request
3401Unauthorized
4403Forbidden
5404Not Found
6500Internal Server Error
7503Service Unavailable


Custom Error Code

NoError CodeDescription
1100AdultRate or ChildRate is lower than system price.
2101You do not have a sufficient credit limit. Please contact administrator.
3102Travel date should not be less than current date.
4103Adult should be more than zero.
5104Pickup Details is compulsory in Private and Sharing Transfer.
6105Start Time is compulsory.
7106You must pass Pax Type. /Invalid Pax Type.
8107This Tour is not Available.
9108Your Event Id and Start Date and Time should be correct.
10109You have put wrong City Id.
11110Tour is not available for this City.
12111Travel date should be Compulsory
13112Travel date should be MM-DD-YYYY
14113Invalid Transfer Type


Transfer Type

Every product has a default transfer type and the Below id is passed along with the specific product ids.

No.Transfer NameTransfer ID
1Without Transfer41865
2Sharing Transfer41843
3Private Transfer41844
4Private Boat Without Transfers43129
5Pvt Yach Without Transfer43110


  • Private Transfer: This non-shared, personalized transfer is reserved exclusively for you and your travel companions.
  • Shared Transfer: When you request for this transfer, you’ll share the ride with other guests who travel on the same route.
  • Without Transfer: Skip the transfer and travel to the selected attraction or destination on your own.

Booking Status

NoBooking Status Description
1VoucheredVouchered If your booking status is vouchered, you can get supplier confirmation number which is guaranteed proof of your reservation.
2RejectedRejected The booking can be rejected due to Following reasons : Price change, allocation not available, stop sale at last minute, inventory sold out and session timed out. On rejection the amount will be credited to your wallet instantly, you can use the amount for making new booking.
3CancelledCancelled The booking can be cancelled due to Following reasons : If it is not confirmed at supplier side. It is cancelled by the user.
4CompletedCompleted It is completed at their travel date.
5InQueueInQueue For Tours like Burj Khalifa, Supplier allows confirmation 30 days prior to travel date. If Booking Status is In Queue, the booking will be Confirmed or Vouchered after 30 days.


Image Path

Image Size

ImageImage Size
Front Image270px * 180px
Gallary900px * 500px
Background1902px * 572px

Date Format

  • Date format send to Payload MM/DD/YYY
  • GetTimeslot API Response YYYY-MM-DD T hh:mm:ss

Access Information

API NAMEAccess Type
Mandatory Optional
Static Data API
Price Request/Get Tour Price API
Tour Option API
Get Tour Time Slot API
Tour Availability Request API
Booking Request API
Booking Cancellation Request API

Frequently Asked Questions

Q: Do you offer any REST/SOAP API in order to provide a communication channel to the Rayna Tours platform?

A:We provide the REST API, request and response is in the JSON format ( JavaScript Object Notation).

Q: In case there is an API, what kinds of services are available through this API?

A:API Services having vast pool of UAE / Singapore / Malaysia /Thailand / Hong kong Tours to help you to distribute the product globally which contains attraction / activities.

Q: Is there a way to discover available ticket options through you service? For example adult ticket day pass, child day pass, weekly pass, etc.

A:We provide tours time slots & tickets availability in the apis so you can select the timeslot, transfer option & tickets for adult , child , infant.

Q: Is there a sandbox environment available where we can perform some tests?

A:Yes , we provide Sandbox environment with test booking details.

Contact Us

Sales:

Email:online@raynab2b.com

Tel:+97142087555 Ext 253|+912066838800 Ext 253

Mobile:+919823111231

Support:

Email:Supportapi@technoheaven.net

Ticketing tours

tree




NonTicketing tours

tree

Static Data Request

Applicable to clients that will pull tour information as well (inclusions, description, policies, T&C)

Static data should be stored locally by the API clients. This static data must be updated daily at least ones as some of data field may change.

Please read below for more details.

tree

Country & City Static Data

JSON code Request URL:

Once the request is applied you will get the list of all country & city ID with respective of its name.


Static Data

After you have initiated the request of static data our system will process it and send you results.


Static Tour Data Request

Request URL:

https://dlvz9zmk16t7v.cloudfront.net/Tour/staging/statictourdata_13668.json

If you hit this URL you will get details of all tour for particular City.


If you want Abu Dhabi data then hit the same URL with Abu Dhabi city ID(13236)

So your request URL will be

statictourdata_13668.json : Here the mentioned ID 13668 is Dubai City ID

Here you can get response of all Static data


JSON Response Format:


Parent TagTag DescriptionOptionality
TourDetailsCityTourID String representing unique CityTourIDMandatory
TourName String representing unique TourNameMandatory
ChildFromAge String representing unique ChildFromAgeMandatory
ChildToAge String representing unique ChildToAgeMandatory
InfantFromAge String representing unique InfantFromAgeMandatory
InfantToAge String representing unique InfantToAgeMandatory
ImportantInformationString representing ImportantInformationMandatory
CityTourTypeId String representing unique CityTourTypeIdMandatory
IsComboTourIs this tour ComboTour.
Boolean field: True or False
Mandatory
IsTimeSlot String representing unique IsTimeSlotMandatory
SpecialNoteWF String representing unique SpecialNoteWFOptional
CancellationPolicyID String representing unique CancellationPolicyIDMandatory
UsefulInformationID String representing unique UsefulInformationIDOptional
TermsAndConditionID String representing unique TermsAndConditionIDMandatory
FAQCategoryID String representing unique FAQCategoryIDOptional
CityTourTypeString representing CityTourTypeMandatory
TourImageCityTourID String representing unique CityTourIDMandatory
ImageCaptionName String representing ImageCaptionNameOptional
ImagePath String representing image Url.Mandatory
IsFrontImage String representing IsFrontImage. Boolean field: TRUE or FALSE.Optional
ImagePathThumbNail String representing ImagePathThumbNailOptional
TourDescriptionCityTourID String representing unique CityTourIDMandatory
TourInclusionString representing TourInclusionMandatory
TourShortDesciptionString representing TourShortDescriptionMandatory
TourDescriptionString representing TourDescription Mandatory
TourTimeCityTourID String representing unique CityTourIDMandatory
TourTimeId String representing unique TourTimeIdMandatory
DeparturePoint String representing DeparturePointMandatory
DepartureTime String representing DepartureTimeMandatory
DurationString representing DurationMandatory
ReportingTime String representing ReportingTimeMandatory
Duration String representing DurationOptional
TourLanguage String representing TourLanguageOptional
Meals String representing MealsOptional
TourTimeOption TourTimeOptionIdString representing unique TourTimeOptionIdMandatory
TourTimeId String representing unique TourTimeIdMandatory
OptionName String representing OptionNameMandatory
Description String representing DescriptionOptional
DepartureTime String representing DepartureTimeOptional
DescriptionString representing DescriptionMandatory
DepartureTimeString representing DepartureTimeMandatory
ByOrder String representing unique ByOrderOptional
StartTime String representing StartTimeMandatory
CityTourID String representing unique CityTourIDMandatory
FreeSellString representing Freesell
Boolean field:True or False
Mandatory
TourTransferCityTourID String representing unique CityTourIDMandatory
TransferId String representing TransferIdMandatory
MinimumPax String representing MinimumPaxMandatory
IsDefault String representing IsDefaultMandatory
TransferNameString representing unique TransferNameMandatory
TourCancellationPolicy CancellationPolicyId String representing unique CancellationPolicyIdMandatory
CancellationPolicyString representing CancellationPolicyMandatory
Description String representing DescriptionMandatory
IsRefundable String representing IsRefundable Boolean field: TRUE or FALSE.Mandatory
RefundPolicy String representing RefundPolicyMandatory
TourUsefulInformationUsefulInformationDetail String representing UsefulInformationDetailOptional
FAQCategory String representing FAQCategoryOptional
UsefulInformationID String representing unique UsefulInformationIDMandatory
TermsAndConditionDetailTermsAndConditionDetail String representing TermsAndConditionDetailMandatory
TermsAndCondition String representing TermsAndConditionMandatory
TermsAndConditionID String representing unique TermsAndConditionIDMandatory
TourFAQCategoryFAQCategoryDetail String representing FAQCategoryDetailOptional
FAQCategory String representing FAQCategoryOptional
FAQCategoryID String representing unique FAQCategoryIDOptional
TicketingTourTermsAndCondition CityTourId String representing unique CityTourIdMandatory
TermsAndConditions String representing TermsAndConditionsMandatory

Price Request / Get tour price

The Gettourprice API has been designed to provide list of all tour with display Minimum price for particular city. The following sections describes the Get tour price request and response format

Request URL

This URL is for fetching dynamic data


JSON Request Format:


Parent TagTagDescriptionOptionality
apinameapinameapiname is the key factorMandatory
Payload
CityIdString representing Unique CityId Mandatory
travelDateIt is travel date. Date should be in the format: MM/DD/YYYY Example: 07-28-2018Mandatory
TokenYou have to put unique token which is provided by the systemMandatory

JSON Response Format:


Parent Tag TagDescription
TourPriceTourPrice
CityTourIdString representing unique CityTourId
CityTourTypeIdString representing unique CityTourTypeId
DurationYou will get approximate time period
TransferIdString representing unique ID for transfer type. IDs are as mention in Documents and Downloads section.
TransferNameString representing unique name provided for every transfer option. Transfer names are as mention in Documents and Downloads section.
IsDiscountDoes Tour option provides discount. For particular tour. Boolean field: 0 or 1. 0 – Not Available 1 – Available
RecommendedIs this tour Recommended (suggested). Boolean field: 0 or 1. 0 – Not Available 1 – Available
TourTimeOptionIdString representing unique TourTimeOptionId
FromPaxWhich give you start range of pax
ToPaxWhich give you end range of pax
FinalAdultAmountIt is display price for adult
FinalAdultAmountWithoutDiscountIt is display price for adult without discount
FinalChildAmountIt is display price for child
FinalChildAmountWithoutDiscountIt is display price for child without discount
SupplierNameString representing unique SupplierName

Tours Option

The Tour Option API provides a list of available Tour Options with their Transfer option and final adult and child amount.

Request URL

This URL is for fetching dynamic data


JSON Request Format:


Parent Tag TagDescriptionOptionality
apinameapinameapiname is the key factorMandatory
Payload
travelDateIt is travel date. Date should be in the format: MM/DD/YYYY Example: 07-28-2018Mandatory
TourIdString representing unique TourIdMandatory
TourTypeIdString representing unique identification for Tour category. Example: 1.City Tours 2.Desert SafariOptional
transferIdString representing unique ID for transfer type.
IDs are as mention in Documents and Downloads section
Default=0 (0 means all transfers of particular tour)
Optional
AdultYou need to pass the count Of adultsMandatory
ChildYou need to pass the count Of childMandatory
optionIdString representing unique optionId.
Default=0 (0 means all options of particular tour)
Optional
tourtimelotidString representing unique Id for particular slot of time. EventId&TourTimeSlotId are same.Optional
TokenYou have to put unique token which is provided by the systemMandatory


JSON Response Format:


Parent TagTagDescription
TourOptionPriceTourOptionPriceJsonArray contain the Default Transfer type option of tours with Price .
TourIdString representing unique TourID.
TransferIdString representing unique ID for transfer type. IDs are as mention in Documents and Downloads section
TransferMinPaxTransferMinPax Which shows you the min. pax occupancy of tour.
TourTimeOptionIdString representing unique TourTimeOptionID.
AdultAmountIt is the calculated price of particular tour option with transfer type and number of adults. (You need to pass this amount in the Booking request API)
ChildAmountIt is the calculated price of particular tour option with transfer type and number of child. (You need to pass this amount in the Booking request payload)
StartTimeStartTime is the tours Operating Time which mean that tours is started from that time.
CutOff- When the tours give you some cutoff time like 3 hr and my tours starttime is : 17:00:00 that means you can book this tours earlier of the starttime of the tour
InfantAgeAge of infant is described.
ChildAgeAge of Child is described.
TimeZoneTimeZone (UTC +04 : 00) destination time zone.
FromPax Describes start range of pax
ToPaxDescribes end range of pax
TourOptionPriceDetailsJsonArray contains Optional Transfer tour options Price.

Get Tour Time Slot

For the static data of the city where its specified true and false (Istimeslot), where ever its True, then you need to hit the API to get the multiple time slot.

Request URL



JSON Request Format:


Parent Tag TagDescriptionOptionality
apinameapinameapiname is the key factorMandatory
Payload
TourIDString representing Unique TourId.Mandatory
TourTimeOptionIdString representing TourTimeOptionId.Mandatory
travelDateIt is travel date. Date should be in following format: MM/DD/YYYY Example: 07-28-2018Mandatory
TokenYou have to put unique token which is provided by the systemMandatory

In response of gettourtimeslot API you get time slot id/Event id for particular tour option for the selected time and its availability for that particular time


JSON Response Format:


Parent TagTagDescription
TimeSlotTimeSlotJsonArray contain the Tours options timeslot.
EventIDString representing unique ID for particular slot/Event of time.
EventNameString representing EventName
StartDateTimeStartDateTime Format YYYY-MM-DDThh:mm:ss Example: 2018-07-28T00:05:00
EndDateTimeEndDateTime format YYYY-MM-DDThh:mm:ss Example : 2018-07-28T00:05:00
EventTypeIDString representing EventTypeID
ResourceIDString representing ResourceID
AvailableCount of Available Ticket.
StatusIf status = 0 tickets available & status = 2 tickets not available.
TourTimeOptionIdString representing unique TourTimeOptionId.
IsXmlSupplierIsXmlSupplier system processing parameter. Boolean field:  TRUE or FALSE.
TourTimeSlotIdString representing unique Id for particular slot of time. EventId &TourTimeSlotId are same.

Tour Availability Request

The Availability API enables to determine if the tour has availability in real time.

Request URL

This URL is for fetching dynamic data


JSON Request Format:


Parent Tag TagDescriptionOptionality
ApinameApinameApiname is the key factorMandatory
Payload
TourIDString representing unique TourIdMandatory
TourTimeOptionIdString representing unique TourTimeOptionIdMandatory
NoOfChildYou need to pass count Of childOptional
NoofinfantYou need to pass count Of InfantOptional
TourTimeSlotIdString representing unique TourTimeSlotIdOptional
NoOfAdultYou need to pass count Of AdultMandatory
TransferidString representing unique ID for transfer type. IDs are as mention in Documents and Downloads sectionMandatory
TravelDateIt is travel date. Date should be in the format: MM/DD/YYYY Example: 07-28-2018Mandatory
TokenYou have to put unique token which is provided by the systemMandatory


Response

Message :

1."success"

2. "You cannot book this tour for Friday".

Booking Request

The save booking method is used to generate a Booking which contains one or more successfully booked tours. Each booked tour will have a unique reference number (Booking Code) which can be individually vouchered & cancelled.

The format of the request and response for this method is explained in the following sections.

Request URL

This URL is for fetching dynamic data


JSON Code (Single Tours):




Multiple Tour :


Parent TagTagDescriptionOptionality
apinameapinameapiname is the key factorMandatory
PayloadlstPassenger
PaxTypeYou have to put PaxType like Adult, child, infant.Mandatory
Email You have to put Customer EmaildMandatory
FirstNameYou have to put Customer FirstName.Mandatory
LastNameYou have to put Customer LastName. Mandatory
MessageYou have to put Special Request from customer at time of booking.Mandatory
MobileYou have to put Customer Mobile number.Mandatory
PrefixYou have to put Customer Prefix like Mr., Miss, Ms. Mandatory
IsTourDataTourId String representing unique TourId.Mandatory
TransferIdString representing unique ID for transfer type. IDs are as mention in Documents and Downloads sectionMandatory
TourTimeOptionIdString representing unique TourTimeOptionId.Mandatory
NoOfAdultYou need to pass the count Of adults.Mandatory
NoOfChild You need to pass the count of child.Mandatory
NoOfInfantYou need to pass the count of infant.Mandatory
AdultRateYou have to put AdultRate from response of tour option APIMandatory
ChildRateYou have to put ChildRate from response of tour option APIMandatory
CheckInDateYou have to put travel DateMandatory
ServiceTotalYou have to put ServiceTotal. (i.e. addition of Adult rate and child rate)Optional
StartTime StartTime is the tours Operating Time which means that tours is started from that time. IT should be in the string format as following: hh:mm:ss Example: "18:00:00"Mandatory
EventIDYou have to put tours EventID which you get from timeslot APIMandatory (Valid only for Tours having time slot)
PickDetails You have to put tours PickDetailsMandatory (When Transfer type is sharing or private)
TokenTokenYou have to put Unique token which provided by system.Mandatory


Booking Response

The voucher generation booking method ofsavebooking is used to generate a unique booking number which contains one or more tours booked. Each tours booked will have a unique reference number which could be individually cancelled. Multiple tours booked in the same booking will be grouped together by a unique booking Number.

The general format of the response is shown below:

JSON Code for Non-Ticketing Tour (Tour not provide the BarCode Ticket) :

For Example: Desert Safari


JSON Code for Ticketing Tour (Tour provide the BarCode Ticket) :

For Example: Burj Khalifa


JSON Code for Ticketing Tour (Tour provide the BarCode Ticket) :

For Example: Dubai Dolphinarium


Parent TagTagDescription
BookingSuccessBookingSuccessYou will get the booking status.
BookingMasterIdYou will get BookingMasterId.
BookingdetailIdYou will get BookingdetailId.
AgentVoucherNoYou will get Ticket number .
StartTimeString representing StartTime
ReferenceNoYou will get the unique booking Number.
Bookingtickets
BookingMasterIdYou will get BookingMasterId
BarcodeImagedataYou will get Barcode image data
BarCodeYou will get unique Barcode
SlotYou will get time slot
TermsAndConditionsYou will get Terms and conditions
FromDateStart date of tour
ToDateEnd date of tour
TypeString representing Type
OptionIDSting representing OptionID
BookingticketsXML
BookingMasterIdYou will get BookingMasterId
BarcodeImagedataYou will get Barcode image data
BarCodeYou will get unique Barcode
SlotYou will get time slot
TermsAndConditionsYou will get Terms and conditions
FromDateStart date of tour
ToDateEnd date of tour
TypeString representing Type
OptionIDSting representing OptionID
ERRORBooking FailYou will get ERROR message.

Booking Cancellation Request

The tourcancel request can be used to cancel a booking that is confirmed & booking that is saved.

Request URL

This URL is for fetching dynamic data

JSON Code :


Parent Tag TagDescriptionOptionality
apinameapinameapiname is the key factorMandatory
Payload
BookingMasterIdYou have to put BookingMasterId to cancel vouchered booking Mandatory
tokenYou have to put unique token which is provided by the systemMandatory


Booking Cancellation Response

After you initiate the request of tourcancel, our system will process the request . and it will return status of the booking & Message The general format of the response is shown below:

JSON Response Format:


Tag Description
StatusYou will return the status of booking Cancellation
MessageYou will return the Message of booking Cancellation

Introduction

The purpose of this document is to provide technical details about the API's. This document outlines the business processes supported by the API and details about specifications of API’s. It assumes that reader has a technical background and is familiar with JSON, API's.

Connection properties

RequestvalueDescription
Request MethodPOSTThe requested method.
Content-Typeapplication/jsonThe content type.

Request/Response

It is recommended that at least all booking and cancellation transactions sent through the Test / Live environment should be logged and maintained by the travel agent for at least 6 months.


Go-Test/Live Process

In order to start testing, please notify our support team via e-mail at supportapi@technoheaven.net

      When you have completed your development, contact your Account Manager for the activation of the access IP address of Test/Live Server is essential for whitelisting

Client Requirements

  • Client requests must be issued from a public, static IP address registered with System.
  • Client requests must be made via an HTTPS POST request.
  • SSL.
  • All data sent and received via the interface will be encoded in UTF-8.
  • We use deflate compression for response.

Development Phase

Once you receive your Access token, you can start the development of your application/framework. The whole process of communication consists of simple JSON messages exchange (request /response) between your application/framework and system. Each request needs to be posted (through POST method) using https protocols. For details regarding requests and answers formats please consult the dedicated area of each request. For further assistance in development process do not hesitate to contact our support team.

Process Flow Diagram

img

Implementation Approach

  1. Client review of the API specifications
    1. Review of API specifications
  2. Test Environment Integration
    1. API Integration
    2. Test Execution by your Tech Team
  3. Integration Testing
    1. Determining the necessary test cases based on the API's by Our Tech Team
    2. Test Execution.
    3. Certification by Our Tech Team
  4. Production Environment
    1. API Integration
    2. Schedule Go Live Date
    3. Transaction Monitoring and Issue Resolution

Important note

  • Follow these guidelines when searching for properties for your test bookings, even for static tests. Being diligent in your property selection will help you avoid incurring any accidental charges during your booking tests.
  • Please use city id : 13668 = Dubai. for testing purpose.
  • To use different nationality of different countries use same name in countries api response.
  • Verify the booking will be outside of the hotel's cancellation policy.
  • Never pick next-day or same-day availabilities, even to test promos.
  • Shop a few months ahead whenever possible.
  • Use first name as Apitest.
  • Never automate static booking tests -we may flag or temporarily disable your account.
  • Shopping at least a few months ahead and paying attention to Policy will help you avoid the most common problems with test bookings. Remember, client is not responsible for any unintentional live or nonrefundable bookings you place during testing.
  • Make sure you cancel each test booking using api, if face any issue in cancellation contact us immediately.
  • Always do refundable feature booking and cancel booking after done.
  • No duplication allowed for internalreference, it must be unique for each time you hit that api.

Contact Us

Sales:

Email:online@raynab2b.com

Tel:+97142087555 Ext 253|+912066838800 Ext 253

Mobile:+919823111231

Support:

Email:Supportapi@technoheaven.net

Documentation and Downloads

Status & Error Code

NoStatus CodeDescription
1200OK
2400Bad Request
3401Unauthorized
4403Forbidden
5404Not Found
6500Internal Server Error
7503Service Unavailable


JSON Request Format:-


JSON Response Format:-


Date Format

  • Date format send to Payload MM-DD-YYYY

Error and Description

ErrorCode ErrorType ErrorDescription
INTERNAL_ERRORAPI_ERROR The server was unable to process the request due to an internal error
NOTPERMITTED_ERRORPermission1.Bookings within cancellation deadline are not permitted for this User.

2.Bookings are not permitted for this User.
CacheNotAvailableCacheNotAvailableAccess to one of the cache failed. The cache for this search key is no longer available
DUPLICATION_ERRORDuplicate1.Bookings within cancellation deadline are not permitted for this User

2.Booking token already exist for this criteria
MISMATCH_ERRORMismatch1.Pricing could not complete - rate missing.

2.Data mismatch from previous response.
CacheNotAvailableCacheNotAvailableAccess to one of the cache failed. The cache for this search key is no longer available
INVALID_REQUESTRequestErrorRequest is not well formed please check and try again.
NOCOUNT_ERRORGENERAL1.No record found for given criteria

2.No availability found for given criteria try search with other criteria

Countries

The Countries API has been designed to provide All Countries data. The following sections describe the Countries API Request and Response Format.

JSON Request format:

TagDescription Optionality
TokenYou have to put unique token which is provided by the systemMandatory

JSON Response format:


TagDescription
CountryIdRepresent unique CountryId.
NameRepresent Name

Cities

The Hotel List Search API has been designed to provide list of all Hotels with display Minimum price for particular city. The following sections describe the Hotel List Search request and response format

Request URL



JSON Request Format:


Parent TagTag DescriptionOptionality
RequestCountryIdRepresents unique CountryId Mandatory
TokenTokenYou have to put unique token which is provided by the systemMandatory

JSON Response Format:

TagDescription
CityIdRepresents unique CityId.
NameRepresents unique city name.

All Cities with Country

AllCitieswithCountry API has been designed to provide list of all cities with country .The following sections describe the AllCitieswithCountry in one API call request and response format.


JSON Request Format:



Parent TagTag DescriptionOptionality
TokenTokenYou have to put unique token which is provided by the system. Mandatory
RequestonlyhotelRepresents onlyhotelonlyhotel: 1 you will get all cities
onlyhotel: 0 you will get active cities

JSON Response Format:

Tag Description
cityidRepresents cityid
citynameRepresents cityname
CountryidRepresents Country id
countrynameRepresents country name.

All Hotels By City

AllHotelsByCity API has been designed to provide list of all Hotel details for that particular City.
  The following sections describe the AllHotelsByCity API request and response format.


JSON Request Format:



Parent TagTag DescriptionOptionality
RequestCityIdRepresents unique CityIdMandatory
TokenTokenYou have to put unique token which is provided by the system.Mandatory

JSON Response Format:

Tag DescriptionOptionality
HotelIdRepresents HotelIdMandatory
HotelNameRepresents HotelName Mandatory
LatitudeRepresents LatitudeMandatory
longitudeRepresents longitudeMandatory
AddressRepresents AddressMandatory
RatingRepresents RatingMandatory
IsRecomondedHotel-Mandatory

Availability

      The Availability API has been designed to provide list of all Hotels The following sections describe the hotellistsearch API request and response format. Currency set up done only once account is created and you have to use that Currency for transaction with api.


JSON Request Format:



Parent TagTag DescriptionOptionality
RoomAn array represents Room Mandatory
RoomNoRepresents RoomNo Mandatory
NoofAdultsRepresents total number of AdultsMandatory
NoOfChildRepresents total number of child. Mandatory
ChildAgeArray represents child Age.Mandatory
CityIDRepresents unique CityID.Mandatory
NationalityRepresents unique Nationality.Mandatory
CheckInDateRepresents CheckInDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018Mandatory
CheckOutDateRepresents CheckOutDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018Mandatory
NoofNightsRepresents number of NightsMandatory
currencyRepresents currency Mandatory
IsShowRooms1 Show Rooms 0 HotelOnly Mandatory
IsRecommendedOnly1 Only Preferred Hotels 0 All Hotels Mandatory
IsOnlyAvailable1 Available only 0 Include OnrequestMandatory
StarRatingSelection of star rating between two categories.
Minmin=min star rating0 star rating for unspecified or apartment
maxmax=max star ratingMandatory
HotelIDsRepresents list of comma seperated HotelIDs by cityOptional
CustomerIpAddressRepresents CustomerIpAddress Ip address of final end user Mandatory
currencyRepresents currency Mandatory

JSON Response Format:

Tag Description
CountRepresents Count.
SearchKeySearchKey will use in next steps ,expires after 25 minutes. You have to do booking within that time limits.
Start priceRepresents unique Price
HotelIDRepresents unique Hotel id
HotelCodeRepresents unique hotel code
CurrencyRepresents Currency.
HoteloptionArray display detail.
HoteloptionIdRepresents unique hoteloptionid
MinPriceRepresent Min Price
IsCombinedTrue = Multiple rooms are combined in one
False = recieve list of rooms
HotelRoomsArray display details
RoomNoRepresents room number. You will get some combine rooms for multiple rooms search.
RoomTypeNameRepresents room type
MealNameRepresents MealName
PriceRepresents Price
BookingStatusRepresents BookingStatus.
RoomTokenIt display unique AvailToken which is provided by the system

Note:

As we have both direct inventories and dynamic rates also so for some cases you will receive combined room in multiple room search ,

so for easy to identify these rates we have now added new parameter in availability response IsCombined (true,false) if its true then rooms are combined to one room .

for example : if search is for

rooms :2

room 1 : 1 adult

room 2 : 2 adult

then id IsCombined =true that means both rooms are combined in one (roomNo: "1") ;

if False : then you recieve list of rooms(RoomNo:1,RoomNo:2).

and when you try to book such combined room you have to pass pax details separately for both the rooms.

Cancellation Policy

The CancellationPolicy for Hotel API has been designed to provide Price of cancellation for particular Room. The following section describes API request and response format.


JSON Request Format:



Parent TagTag DescriptionOptionality
TokenTokenToken Mandatory
RequestSearch key
HotelOptionIdRepresents unique HotelOptionID. Mandatory
RoomTokenUnique RoomToken which is provided by the system.Mandatory
currencyRepresents currency Mandatory
CustomerIpAddressRepresents CustomerIpAddress Ip address of final end user Mandatory

JSON Response Format:

Parent TagTag Description
CancellationPolicyFromDateRepresents FromDate
ToDateRepresents ToDate.
CancellationPriceRepresents cancellation price.
CurrencyRepresents Currency.

Cancellation Policy Multi

The CancellationPolicyMulti for Hotel API has been designed to provide Price of cancellation for multiple Room in single request. The following section describes API request and response format.


JSON Request Format:



Parent TagTag DescriptionOptionality
TokenTokenToken Mandatory
RequestSearch key
HotelOptionIdRepresents unique HotelOptionID. Mandatory
HotelRoomsRepresents HotelRoomsMandatory
RoomTokenRepresents RoomNoMandatory
RoomTokenUnique RoomToken which is provided by the system.Mandatory
AdvancedOptions
CustomerIpAddressRepresents CustomerIpAddress Ip address of final end user Mandatory
currencyRepresents currency Mandatory

JSON Response Format:

Parent TagTag Description
Error
ToDateRepresents ToDate.
CurrencyRepresents Currency
CancellationRS
RoomNoRepresents RoomNo
RoomTypeNameRepresents RoomTypeName
MealNameRepresents MealName
EssentialInformationRepresents EssentialInformation
CancellationPolicyFromDateRepresents FromDate
ToDateRepresents ToDate
CancellationPriceRepresents cancellation price.

PreBook

The PreBook API has been designed to check availability status of booking before book.This APImust hit once for one booking or you will get duplication error.The following section describesAPI request and response format.in case of isCombineRoom= true we are going to do one change inprevious response we sending price = 0 in other rooms and in roomNo=1 we giving you total price , butin new response we divide price in each room Total price will not change.only price is divided insideroom.

JSON Request Format:


Parent TagTag DescriptionOptionality
TokenTokenToken Mandatory
RequestSearch key
HotelOptionIdRepresents unique HotelID.Mandatory
HotelRoomsAn array represents room details Mandatory
RoomNoRepresents room numberMandatory
RoomTokenUnique RoomToken which is provided by the system. Mandatory
CustomerIpAddressRepresents CustomerIpAddress Ip address of final end user Mandatory
currencyRepresents currency Mandatory

JSON Response Format:


JSON Response (Example ) IsCombineRoom=true


Parent TagTag Description
PreBookRS
HotelOption
HotelNameRepresents HotelName
Nationality Represents Nationality
BookingTokenUnique BookingToken which is provided by the system. And used for final booking request
Status If status is bookable than only proceed for booking.
IsPriceChange0 Represents Not Change in IsPriceChange
1 you have to notify price to customer before booking
CheckInDate Represents CheckInDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
CheckOutDateRepresents CheckOutDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
TotalPriceRepresents TotalPrice
HotelRoomsArrary represents Hotelrooms
UniqueIdRepresents UniqueId
RoomNoRepresents RoomNo
RoomTypeNameRepresents RoomTypeName
MealNameRepresents MealName
PriceRepresents Price
PriceChange Represents PriceChange
OldPrice Represents OldPrice
NewPrice Represents NewPrice
Currency Represents Currency.

Book

The Book API has been designed to give booking details .The following section describes API request and response format. After getting response or error in book response. you have to mandatory perform booking detail api to get the actual status of booking using your internal reference or reference number from Bookresponse.

JSON Request Format:


Parent TagTag DescriptionOptionality
TokenTokenToken Mandatory
RequestSearch key
BookBookingTokenUnique BookingToken which is provided by the system.Mandatory
TotalPriceRepresents Price Mandatory
InternalReferenceyour internal reference. should be 10 max character (No duplication allowed)Mandatory
HotelRoomsAn array represent HotelRoom Details. Mandatory
UniqueIdRepresents UniqeIdMandatory
RoomNoRepresents RoomNoMandatory
IsLead0 Represents No IsLead
For 1 booking you have to set ISLead = 1 and IsLead passeger must adult.
Mandatory
PaxTypeRepresents Adult / Child.Mandatory
PrefixRepresents Mr. / Mrs. /Ms.Mandatory
FirstNameRepresents FirstNameMandatory
LastNameRepresents LastNameMandatory
ChildAgeRepresents ChildAgeMandatory
UniqueIdRepresents UniqeIdMandatory
CustomerIpAddressRepresents CustomerIpAddress Ip address of final end user Mandatory
currencyRepresents currency Mandatory

JSON Response Format:


Parent Tag TagDescription
BookRS
BookingId Represents BookingId
ReferenceNoYou need to show reference number on your voucher.
BookingStatusRepresents booking status with details
vouchered : confirmed
confirmed : confirmed
completed : Travel done.
cancelled : booking cancelled
on request : on request
not confirm : not confirmed
cancel charges: cancel charges if any for booking
InternalReferenceRepresents InternalReference
CurrencyRepresents Currency.
ErrorArray Represents Error

Booking Detail

API has been designed to Generate bookingDetails .The following section describes API request and response format. Only one ID can be passed. You can get booking details using either BookigID or your internalReference

JSON Request Format:


Parent TagTag DescriptionOptionality
TokenTokenToken Mandatory
Request
BookingDetailRQ
BookingIdRepresents BookingId Optional
InternalReferenceRepresents InternalReference optional
ReferenceNoRepresents ReferenceNooptional
CustomerIpAddressRepresents CustomerIpAddress Ip address of final end user Mandatory
currencyRepresents currency Mandatory

JSON Response Format:


Parent TagTag Description
BookingDetailRS
HotelOption
HotelNameRepresent HotelName
HotelId Represent HotelId
Nationality Represent Nationality
BookingId Represent BookingId
InternalReferenceRepresents InternalReference
CheckInDate Represents CheckOutDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
CheckOutDateRepresents CheckOutDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
BookingDateRepresents BookingDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
LeadPaxNameRepresents LeadPaxName
TotalPriceRepresents TotalPrice
HotelRooms Array Represents HotelRooms
RoomNoRepresents RoomNo
RoomTypeNameRepresents RoomTypeName
MealName Represents MealName
Price Represents Price
CancellationPolicy Array represents CancellationPolicy
FromDate Represents FromDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
ToDate Represents ToDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
CancellationPriceRepresents CancellationPrice
PassengerNo special character allowed max length 20 character. Douplication passenger not allowed.
IsLeadRepresents lead pax
PaxTypeRepresents Adult / Child
PrefixRepresents Mr./Ms./Miss
NameRepresents Name
ChildAgeRepresents ChildAge
CurrencyRepresents Currency.
ErrorArray Represents Error

Check HotelCancellation Charges

JSON Request Format:


Parent TagTag DescriptionOptionality
TokenTokenToken Mandatory
Request
CheckHotelCancellationChargesRQ
BookingIdRepresents BookingId Mandatory
InternalReferenceyour internal reference.Mandatory
ReferenceNoMandatory
CustomerIpAddressRepresents CustomerIpAddress Ip address of final end user Mandatory
currencyRepresents currency Mandatory

JSON Response Format:


Parent Tag TagDescription
CheckHotelCancellationChargesRS
HotelOptionRepresents HotelOption
BookingIdRepresents BookingId
TotalPriceRepresents TotalPrice
TotalChargeRepresents TotalCharge
TotalRefundRepresents TotalRefund
CancelCodeRepresents CancelCode
HotelRoomsAn Array Represents HotelRooms
BookingDetailIdRepresents BookingDetailId
RoomTypeNameRepresents RoomTypeName
PriceRepresent Price
RefundAmountRepresents RefundAmount
CurrencyRepresents Currency.
ErrorAn Array Represent Error

Cancel Booking

API has been designed to cancle booking .The following section describes API request and response format.

JSON Request Format:


Parent TagTag DescriptionOptionality
TokenTokenToken Mandatory
Request
CancelRQBookingIDRepresent BookingIDMandatory
BookingDetailIdBookingDetailIdValue = 0 to cancel whole booking.
CancelCodeCancelCodeMandatory
ReasonRepresents ReasonMandatory
CancelAllCancelAllValue = 1 to cancel whole booking.
CustomerIpAddressRepresents CustomerIpAddress Ip address of final end user Mandatory
currencyRepresents currency Mandatory
Note : To cancel whole booking you must have to pass cancelAll with value 1 and BookingDetailId=0

JSON Response Format:


Parent TagTag Description
CancelRS
HotelOption
BookingId Represents BookingId
HotelRoomsArray Represents HotelRooms
RoomTypeName Represents RoomTypeName
MessageRepresents Message
CancelStatus1 Represents booking cancel
Currency Represents Currency.
ErrorArray Represents Error

Booking Search

API has been designed to Generate bookingDetails .Date range allowed 31 days. The following section describes API request and response format.

JSON Request Format:


Parent TagTag DescriptionOptionality
TokenTokenToken Mandatory
RequestMandatory
BookingSearchRQMandatory
SearchBySearch By BookingDate or CheckingDate Mandatory
OnlyAPI0 Represents All booking
1 Represents only apibookings
Mandatory
SearchCriteria
Dates
FromDateRepresents FromDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
Mandatory
ToDate Represents ToDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
Mandatory
AdvancedOptionsCurrency Represents CurrencyMandatory
Note : OnlyAPI = 0 Represents All booking OnlyAPI = 1 Represents Api booking

JSON Response Format:


Parent TagTag Description
Error
BookingSearchRS
BookingList
HotelName
HotelIdRepresents HotelId
InternalReference Represent InternalReference
ReferenceNo Represent ReferenceNo
CheckinDate Represents CheckinDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
CheckOutDate Represents CheckOutDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
BookingDate Represents BookingDate.
Date should be in the format:
MM-DD-YYYY
Example: 08-12-2018
TotalPrice Represents TotalPrice
BookingStatus Represents BookingStatus
IsAPI IsAPI = True Represents booking made via api IsAPI = False Represents booking made direct on client portal
Currency Represents Currency.

Certification process

Please go through certification process in order to get live access.

Step 1 : Work Flow.

To ensure what API methods you are using, flow of method calls for these methods. This will help us to verify the integration.

Step 2 : Test Cases Execution by client.

Here we are providing a list of test cases needs to be executed .
Request / response for these cases will be required for verification .

[Test 1] :

Room 1 – Adult 1 (1 night)

[Test 2] :

Room 1 – Adult 2, Child 2 (3 night)

[Test 3] :

Room 1 – Adult 1 | Room 2 – Adult 1 both (2 night)

[Test 4] :

Room 1 – Adult 1, Child 1 | Room 2 – Adult 1 (1 night)

Provide Logs As below

[Test 1] : Availability→CancellationPolicyMulti→PreBook→Book BookingDetail→CheckHotelCancellationCharges→CancelBooking.

Step 3: Test Verification

Technical team will verify the test cases using Request / Response and suggest if there is any change required.

Step 4: Client Portal verification

After completion of step 3, you have to provide test link of your integration website to verify the integration flow.

Step 5: Sign off and Live access

On successful completion of all the above steps, we will give sign off and provide Live access details.

SEARCH NOWSEARCH NOW
Notification
×
Password Reset Notification!!
×
SEARCH NOW
×