SEARCH NOWSEARCH NOWSEARCH NOW

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 [email protected]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
2400Download API CollectionW3Schools
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


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

Booking Status

NoBooking Status Description
1SuccessIf your booking status is success, you will get referenceNo 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.
4InQueueInQueue 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
    1) MM/dd/yyyy
    2) MM-dd-yyyy
    3) yyyy-MM-dd
    4) yyyy/MM/dd
    5) MM.dd.yyyy

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:[email protected]

Tel:+97142087555 Ext 253|+912066838800 Ext 253

Mobile:+919823111231

Support:

Email:[email protected]

Ticketing tours





NonTicketing tours

Country / City

Country

The following sections describes the Country request and response format

Request URL

This URL is for fetching Country data


JSON Response Format:


Parent TagTagTypeDescription
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path. (Note: If required)
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for available country searches.
countryIdintTour's country id.
countryNamestringTour's country name.

City

The following sections describes the City request and response format

Request URL

This URL is for fetching City data


JSON Request Format:


TagDescriptionOptionality
CountryIdTour's country id, You will get countryId from {{BaseURL}}/api/Tour/countries API.Mandatory

JSON Response Format:


Parent Tag TagTypeDescription
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path. (Note: If required)
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for available city searches.
cityIdintTour's city id.
cityNamestringTour's city name.

Static Data

Tour Static Data

The following sections describes the Tour static data request and response format

Request URL

This URL is for fetching Tour Static Data


JSON Request Format:


TagTypeDescriptionOptionality
CountryIdintTour's country id, You will get countryId from {{BaseURL}}/api/Tour/countries API.Mandatory
CityIdintTour's city id, You will get cityId from {{BaseURL}}/api/Tour/cities API.Mandatory

JSON Response Format:


Parent Tag TagTypeDescriptionNote:
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path. (Note: If required)If required.
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for available tour static searches.
tourIdintUnique identifier of the tour.
countryIdintTour's country id.
countryNamestringTour's country name.
cityIdintTour's city id.
cityNamestringTour's city name.
tourNamestringTour name.
reviewCountintAverage review of tours.
ratingdoubleRetrieving the reviews of all available travel group & customer.
durationstringTime duration between tour available.
imagePathstringImage url of tour's.
imageCaptionNamestringImage caption name.
cityTourTypeIdintUnique identifier of the tour types.
cityTourTypestringName of city tour types.
tourShortDescriptionstringShort information about the tour.
cancellationPolicyNamestringCancellation policy name of the tours.
isSlotboolIf "isSlot" true, you will get multiple time slote list.Required tour timeslot should pass.
onlyChildboolIf "true", Only child inventory can book.Tour can book for child without adult.
contractIdintContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.

Tour Static Data by Id

The following sections describes the Tour Static Data by Id request and response format

Request URL

This URL is for fetching Tour Static Data by Id


JSON Request Format:


TagTypeDescriptionOptionality
countryIdintTour's country id, You will get countryId from {{BaseURL}}/api/Tour/countries API.Mandatory
cityIdintTour's city id, You will get cityId from {{BaseURL}}/api/Tour/cities API.Mandatory
tourIdintUnique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.Mandatory
contractIdintContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.
travelDatestringTour travel date with Formats.Mandatory

JSON Response Format:


Parent Tag TagChild TagTypeDescriptionNote:
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path.If required.
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for available tour static searches.
tourIdintUnique identifier of the tour.
countryIdintTour's country id.
countryNamestringTour's country name.
cityIdintTour's city id.
cityNamestringTour's city name.
tourNamestringTour name.
reviewCountintTotal number of tours review.
ratingdoubleRetrieving the reviews of all available travel group & customer.
durationstringTime duration of tours.
departurePointstringLocation of tours.
reportingTimestringTours reporting time.
tourLanguagestringAvailable language for tour.
imagePathstringImage url of tour's.
imageCaptionNamestringImage caption name.
cityTourTypeIdintUnique identifier of the tour types.
cityTourTypestringName of city tour types.
tourDescriptionstringInformation about the tour.
tourInclusionstringTour inclusion.
tourShortDescriptionstringShort description about the tours.
raynaToursAdvantagestringAdvantages of the tours.
whatsInThisTourstring
importantInformationstringImportant information about the tours.
itenararyDescriptionstringItenarary description about the tours.
usefulInformationstringUsefull information about the tours.
faqDetailsstringFAQ details of the tours.
termsAndConditionsstringTerms and conditions of tours.
cancellationPolicyNamestringCancellation policy name of the tours.
cancellationPolicyDescriptionstringCancellation policy description of the tours.
childCancellationPolicyNamestringChild cancellation policy name of the tours.
childCancellationPolicyDescriptionstringChild cancellation policy description of the tours.
childAgestringAs per child policy.
infantAgestringAs per child policy.
infantCountintTotal number of infant.
isSlotboolIf "isSlot" true, you will get multiple time slote list.Required tour timeslot should pass.
onlyChildboolIf "true", Only child inventory can book.Tour can book for child without adult.
contractIdintContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.
tourImagesarrayInformation about tours image.
tourIdintUnique identifier of the tour.
imagePathstringImage url of tour's.
imageCaptionNamestringImage caption name.
isFrontImageintThis image will use for front.
isBannerImageintThis image will use as banner.
isBannerRotateImageintThis image will use as rotate image.
tourReviewarrayAbout tour review.
idint
tourIdintUnique identifier of the tour.
reviewIdintTour review id.
reviewTitlestringReview title.
reviewContentstringReview content of tours.
visitMonthstringVisited month.
ratingintReview rationg.
imagePathstringImage url of tour's.
guestNamestringTour visited guest name.

Option Static Data

The following sections describes the Option Static Data request and response format

Request URL

This URL is for fetching Option Static Data


JSON Request Format:


TagTypeDescriptionOptionality
tourIdintUnique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.Mandatory
contractIdintContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.Mandatory

JSON Response Format:


Parent Tag TagChild TagTypeDescription
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path. (Note: If required)
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for available tour static option searches.
touroptionarrayTour options.
tourIdintUnique identifier of the tour.
tourOptionIdintUnique identifier of the tour options.
optionNamestringTours option name.
childAgestringAs per child policy.
infantAgestringAs per child policy.
optionDescriptionstringA short information about tours option.
cancellationPolicystringCancellation policy of the tours option.
cancellationPolicyDescriptionstringCancellation policy description of the tours option.
childPolicyDescriptionstringChild cancellation policy name of the tours option.
xmlcodestringXML code.
xmloptioncodestringXML option code.
countryIdintTour's country id.
cityIdintTour's city id.
minPaxintMinimum number of passangers.
cityIdintTour's city id.
maxPaxintMaximum number of passangers.
durationstringTime duration of tours.
timeZonestringTours time zone.
operationdaysarrayAvailiblity of tour on days.
tourIdintUnique identifier of the tour.
tourOptionIdintUnique identifier of the tour options.
mondayint
tuesdayint
wednesdayint
thursdayint
fridayint
saturdayint
sundayint
specialdatesarrayTour available on dates or festivals.
transfertimearray
tourIdintUnique identifier of the tour.
tourOptionIdintUnique identifier of the tour options.
transferTypestringAvailable transferId for tour. Available transfer types.
transferTimestring
durationstringTime duration of tours.

Tour Price

The following sections describes the Tour Price request and response format

Request URL

This URL is for fetching Tour Price data


JSON Request Format:


TagTypeDescriptionOptionality
countryIdintTour's country id, You will get countryId from {{BaseURL}}/api/Tour/countries API.Mandatory
cityIdintTour's city id, You will get cityId from {{BaseURL}}/api/Tour/cities API.Mandatory
travelDatestringTour travel date Formats.Mandatory

JSON Response Format:


Parent TagTagTypeDescriptionNote:
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path.If required.
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for tour price.
tourIdintUnique identifier of the tour.
contractIdintContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.
amountdecimalTour amount.
discountdecimalDiscount for tour.
sortOrderint

Tour Options

The following sections describes the Tour Options request and response format

Request URL

This URL is for fetching Tour Options data


JSON Request Format:


TagTypeDescriptionOptionality
tourIdintUnique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.Mandatory
contractIdintContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.Mandatory
travelDatestringTour travel date Formats.Mandatory
noOfAdultintNumber of adult.Mandatory
noOfChildintNumber of child.
noOfInfantintTotal number of adult and child.

JSON Response Format:


Parent TagTagTypeDescriptionNote:
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path.If required.
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for available tour option.
tourIdintUnique identifier of the tour.
tourOptionIdintUnique identifier of the tour options.
transferIdintAvailable transferId and transferName for tour. Available transfer types.
transferNamestring
adultPricedecimalPrice per adult, as per transferType.
childPricedecimalPrice per child, as per transferType.
infantPricedecimalTotal price.
withoutDiscountAmountdecimalAmount without discount.
finalAmountdecimalTotal amount as per booking. (adult + child)
startTimestringStart time of tour.
departureTimestringDeparture time of tours.
disableChildboolIf disable child is allow.
disableInfantboolIf disable adult is allow.
allowTodaysBookingboolBooking allow for today.
cutOffint
isSlotboolIf "isSlot" true, you will get multiple time slote list.Required tour timeslot should pass.
isDefaultTransferintIf tour option have default transfer.
rateKeystring
inventoryIdintUnique inventory id.

Tour Timeslot

The following sections describes the Tour Timeslot request and response format

Request URL

This URL is for fetching Tour Timeslot data


JSON Request Format:


TagTypeDescriptionOptionality
tourIdintUnique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.Mandatory
tourOptionIdintUnique identifier of the tour options, You will get tourOptionId from {{BaseURL}}/api/Tour/touroption API.Mandatory
TravelDatestringTour travel date Formats.Mandatory
transferIdintThe transferId, Required as per tour requirement.
contractIdintContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.Mandatory

JSON Response Format:


Parent TagTagTypeDescriptionNote:
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path.If required.
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for available tour time slot.
tourOptionIdintUnique identifier of the tour options.
timeSlotIdintUnique identifier of the tour options time slot.
timeSlotstringAvailable time slot for tour.
availableintNumber of slot available.
adultPricedecimalPrice per adult, as per transferType.
childPricedecimalPrice per child, as per transferType.
isDynamicPriceboolIf the flag is False then you have to consider the price from the Option API.

Tour Availability

The following sections describes the Tour Availability request and response format

Request URL

This URL is for fetching Tour Availability data


JSON Request Format:


TagTypeDescriptionOptionality
tourIdintUnique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.Mandatory
tourOptionIdintUnique identifier of the tour options, You will get tourOptionId from {{BaseURL}}/api/Tour/touroption API.Mandatory
transferIdintThe transferId.Mandatory
TravelDatestringTour travel date Formats.Mandatory
adultintTotal number of adult.Mandatory
childintTotal number of child.
infantintTotal number of infant.
contractIdintContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.

JSON Response Format:


Parent TagTagTypeDescriptionNote:
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path.If required.
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for available tour.
statusintStatus code as per availiblity
messagestringYou will got the massages as tour availiblity.

"success": tour is available.

"This tour is available only for 12/12/2021": Tour is abailable for (Eg: 12/12/2021) specify date only, Please select other date.

"This tour is available only From 12/12/2021 To 31/12/2021": Tour is available between (Eg: 12/12/2021 To 31/12/2021), Please select other date.

"This tour is not available From 12/12/2021 To 31/12/2021": Tour is not available between (Eg: 12/12/2021 To 31/12/2021), Please select other date.

"Sorry, the tour is not available on the selected date. Kindly choose the other date": Tour is not abailable for selected date, Please select other date.

"Sorry The Tour is Not Operational on the Selected Date.":

"Selected transfer type not available": Selected transfer type is not available for selected tour.

"Sorry, Child are not allowed in TourOptionName": Children are not allowed for this tour option.

"Sorry, Infant are not allowed in TourOptionName": Infant are not allowed for this tour option.

"We regret to inform you the tickets are not available for this option": Tickets are not available for this tour.

"Sorry, the tour is not available on the selected date due to stop sell, Kindly choose the other date": Tour is not abailable due to stop selling.

"You cannot book this tour for 12/12/2021":
productTypeint

Tour Cancellation Policy

The following sections describes the Tour Availability request and response format

Request URL

This URL is for fetching Tour cancellation policy.


JSON Request Format:


TagTypeDescriptionOptionality
tourIdintUnique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.Mandatory
travelDatestringTour travel date. (Note: Date format is yyyy-MM-dd)Mandatory
startTimestringStart time of tour.Mandatory
currentDatestringYou should enter current date time (yyyy/MM/dd/HH/mm).Mandatory
contractIdintContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.Mandatory
tourOptionIdintUnique identifier of the tour options.Mandatory

JSON Response Format:


Parent TagTagTypeDescriptionNote:
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
currencystringYou will get currency name.
currencysymbolstringYou will get the currency symbol.
errormessagestringYou will get the error massage if error acour.
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for cancallation policys.
tourIdintUnique identifier of the tour.
optionIdintUnique identifier of the tour options.
fromDatestringRepresents FromDate.
Date format is: MM-DD-YYYY
Example: 12-18-2018
toDatestringRepresents ToDate.
Date format is: MM-DD-YYYY
Example: 12-18-2018
percentageintThis is indicate cancellation charges percentage.

Tour Booking

The following sections describes the Tour Booking request and response format

Request URL

This URL is for fetching Tour Booking data


JSON Request Format:


Parent TagTagTypeDescriptionOptionality
uniqueNointIdentifier of the booking (at the partner) made by the partner. Shall be unique for the contract, otherwise an error will be returned. (Note: Max 6 digit)Mandatory
TourDetailsarrayMandatory
serviceUniqueIdintService uniqueId must be unique for each tour booked under the same referance. If the referanceNo having only one tour then you can pass same uniqueId. (Note: Max 6 digit)Mandatory
tourIdintUnique identifier of the tour, You will get tourId from tourlist API.Mandatory
optionIdintUnique identifier of the tour options, You will get tourOptionId from touroption API.Mandatory
adultintTotal number of adult.Mandatory
childintTotal number of child.Mandatory
infantintTotal number of infant.Mandatory
tourDatestringTour booking date Formats.Mandatory
timeSlotIdintUnique identifier of the tour options time slot. (Note: If required)Mandatory
startTimestringStart timing of tour.Mandatory
transferIdintYou should enter the transferId as per requierment.Mandatory
pickupstringEnter pickup location. (If requier)Mandatory
adultRatedecimalTotal adult price.Mandatory
childRatedecimalTotal child price.Mandatory
serviceTotalstringTotal amount of service. (adultRate + childRate)Mandatory
passengersarrayPassanger details.Mandatory
serviceTypestringService type is tour.Mandatory
prefixstringMr./ Ms./ Mrs.Mandatory
firstNamestringFirst name of passanger.Mandatory
lastNamestringLast name of passanger.Mandatory
emailstringEmailId of passanger's, manager for contact purposes & transactional emails.Mandatory
mobilestringMobile number of the passanger's manager for contact purposes.Mandatory
nationalitystringPassanger's nationality.Mandatory
pickupstringPickup location of passanger. (If requier)Mandatory
messagestringShort information about the passanger.Mandatory
leadPassengerboolLead passanger name, who guid and lead the tours.Mandatory
adultRatedecimalPrice per adult, as per transferType. You will get tourRates from tourlist API.Mandatory
paxTypestringThe passanger is Adult, Chind or Infant.Mandatory
clientReferenceNostringYour referenceNo.Mandatory

JSON Response Format:


Parent TagTagTypeDescription
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path.
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult for available tour time slot.
refernceNostringRayna booking confirmation number.
statusstringRepresents booking status with details.
bookingIdintThe bookingId unique booking identifier.
downloadRequiredboolIf "downloadRequired" true, the tour must hit Ticket Details API. and you must hit the tour ticket detail API.
serviceUniqueIdstringService uniqueId must be unique for each tour. You can enter uniqueNo if book only one tour.
servicetypestringService type is tour.
confirmationNostringIdentifier of the booking (at the supplier) made by the supplier.

Tour Ticket

The following sections describes the Ticket request and response format

Request URL

This URL is for fetching Ticket data


JSON Request Format:


Parent TagTagTypeDescriptionOptionality
uniqueNointIdentifier of the booking (at the partner) made by the partner while booking (Booking uniqueNo).Mandatory
referenceNostringThe refernceNo unique booking identifier (you will get it from booking response).Mandatory
bookedOptionarrayMandatory
serviceUniqueIdstringService uniqueId must be unique for each tour (Booking serviceUniqueId).Mandatory
bookingIdintThe bookingId unique booking identifier (get from booking response).Mandatory

JSON Response Format:


Parent TagTagChild TagTypeDescription
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
resultarrayResult for tours tecket details.
bookingIdintThe bookingId unique booking identifier.
referenceNostringThe refernceNo unique booking identifier (you will get it from booking response).
BookingStatusstringYou will get the booking status.
ticketURLstringFrom ticket url you will download the ticket.
optionNamestringTour option name.
validitystringValidity of tours ticket download.
validityExtraDetailsstringSome more information about validity of booked tour.
printTypestringThis is identfy that barcode or QR cord.
slotstringTour slot timing, if tour have slot
pnrNumberstringSupplier confirmation number, You will get it from booking response.
ticketDetailsarray
barCodestringBarcode number.
typestringTour type.
noOfAdultintNumber of adult.
noOfchildintNumber of child.

Tour Cancellation

The following sections describes the Tour Cancellation request and response format

Request URL

This URL is for fetching Tour Cancellation data


JSON Request Format:


TagTypeDescriptionOptionality
bookingIdintThe bookingId unique booking identifier (get from booking response).Mandatory
referenceNostringThe refernceNo unique booking identifier (get from booking response).Mandatory
cancellationReasonstringReason for cancle the tour.Mandatory

JSON Response Format:


Parent TagTagTypeDescription
statuscodeintResponse status & custom error code.
errorstringFields with error description, shown if error occurs.
urlstringCDN path.
countintCount REST API to obtain the number of Informatica resources based on a search expression.
resultarrayResult of cancel tour.

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 hotel agent for at least 6 months.

Go-Test/Live Process

In order to start testing, please notify our support team via e-mail at [email protected]

      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.

Status & Error Code

NoStatus CodeDescription
1200OK
2400Bad Request
3401Unauthorized
4403Forbidden
5404Not Found
6500Internal Server Error
7503Service Unavailable
8429Too Many Requests (QPS Limit exceeds)

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. Before you go live you need to share pdf sample voucher after booking.

  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 : 16424= Bangkok. 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 Real Name for first name and last name. Do not use test name.
  • 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.

Documentation and Downloads


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.

AllCitieswithCountry

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

All Hotels By City Full (for live data mapping)

The AllHotelsByCityFull API has been designed to provide All hotels basic data with city wise.
The following sections describe the AllHotelsByCityFull 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:

Example :

Tag Description
CountRepresent total number of hotels
HotelListRepresents HotelList
HotelIdRepresents HotelId
HotelNameRepresents HotelName
DescriptionRepresents Description
LatitudeRepresent Latitude
LongitudeRepresent Longitude
AddressRepresent Address
RatingRepresent Rating
CountryIdRepresent CountryId
CountryNameRepresent Address
CityIdRepresent CityId
CityNameRepresent CityName
HotelFrontImageRepresent HotelFrontImage
IsRecomondedHotelRepresent IsRecomondedHotel
IsActiveRepresent status of hotel is active or not.
UpdatedDateRepresents UpdatedDate
format:
MM-DD-YYYY
Example: 08-12-2018

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. (1 to 12)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
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.
-For Essential information you need to hit CancellationPolicy/Multi API

AvailabilityWithCancellation

      The AvailabilityWithCancellation API has been designed to provide list of Hotels with cancellation policy. 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. (1 to 12)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
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
CancellationPolicyRepresents cancellation policy
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.
-For Essential information you need to hit CancellationPolicy/Multi API

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 API must hit once for one booking or you will get duplication error.The following section describes API request and response format. in case of isCombineRoom= true we are going to do one change in previous response we sending price = 0 in other rooms and in roomNo=1 we giving you total price , but in new response we divide price in each room Total price will not change.only price is divided inside room.

JSON Request Format:


Parent TagTag DescriptionOptionality
TokenTokenToken Mandatory
RequestSearch key
HotelOptionIdRepresents HotelOptionIdMandatory
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.
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
BookingStatusRepresents booking status with details
Vouchered : Confirmed
Confirmed : Confirmed
Completed : Travel done.
Cancelled : booking cancelled
On Request : On Request
Not Confirmed : Not Confirmed
Cancel Charge: cancel charges if any for booking
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.