Booking API JSON

Interface Specifications

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 1 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Change History

Version Date Changes

1.1 20 Apr 2017 Each static content request of the ContentAPI has been
redesigned, including the URL path. (Check Static Data via
API for more information).

Following ContentAPI request has been removed:

GetCountry, Get Hotels in Country, Get Hotels in Province,
and Get Hotels in Location.
1.2 05 September Searches by multiple hotel Establishments ID’s (Optional).
2017
The maximum number of Hotel codes that can be sent
per availability search is 500.

The Hotel Codes should belong to the same Province ID,

otherwise the response would only provide contracts
corresponding to the Province ID of the First Hotel Code
in the list.
Cancellation policies on the Availability response
(Optional). You must request from the API team for its
activation.
ESTABLISHMENTINFO - Extra establishment’s information
for the Availability response (Optional). You must request
from the API team for its activation.
1.3 26 January 2018 Moved Money definition to new Common API Types
section. Added new TaxBreakdown class. Extended
Money class with TaxBreakdown attribute. Added
GetTaxBreakdown to requests.
1.4 27 September New “Extras” functionality. You must request from the
2018 API team for its activation.

Now it’s possible to request the response zipper: GZIP

compression. Added header:
Accept-Encoding: application/gzip
Test Service URL is updated to https://pp.api.yalago.com
The ExpiryDateUTC tag will only appear if request is done
via JSON format. This tag will not be listed if request is
sent via XML format.
Updated the Board Type 6 description. From Self-Catering
to Self Catering.
PACKAGE FLAG (Optional) in the response. You must
request from API team for its activation. “IsPackagePrice”
tag is sent in responses to determine if a rate is Packaged
or not.
“GetpackagePrice” updated with “GetPackagePrice” in
the API Availability, Details and Booking confirmation
requests
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 2 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 “Quantity Availability”: -1 is described in the Comment
section of Availability and Details responses
1.5 01 August 2019 Added new Accommodation Type 26 – Aparthotel in the
Accommodation Type table
04 February 2020 Added “GetLocalCharges” tag on requests

Added LOCALCHARGESAMOUNT definition to Common

API Types section
Added ‘GetErrataCategory’ tag on Details, Create Booking
and Get Booking Requests

Added ‘ErrataCategory’ tag on Details, Create Booking

and Get Booking Responses
Added “GetBoardBasis” tag on Availability, Details, Create
Booking and Get Booking Requests

Added ‘BoardBasis’ class on Availability, Details, Create

Booking and Get Booking Responses
Added samples of XML Requests and Responses for Each
API calls
1.6 28 July 2020 Added Booking Search method under the Booking API
Function Calls

This new function will allow searching for list of bookings

made in aspecified date range. You can search up to 30
days.
Separate XML and JSON documentation of Booking API
Updated Comments for Local Charges Currency under
Common API Types
Updated Voucher requirement on Certification Process –
BookingRef and AffiliateRef to be displayed in the
Voucher

Removed ProviderRef, ProviderName

Updated Test API service endpoint to Client Integrtion -
https://apici.yalago.com . This is to ensure high
availability of Yalago service end point for client
integration on a less downtime as well as continuous
development and integration.
Added ‘CurrencyCode’ tag on Availability, Details, and
Booking Confirmation Requests

The CurrencyCode will depend on the currencies that are

set up in each client’s accounts.

Please contact your Sales Manager to know the list of

currencies supported on your account
Added ‘Currencies’ on Tables section

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 3 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Contents
Change History.................................................................................................................................. 2
Account Setup................................................................................................................................... 6
API Overview .................................................................................................................................... 6
Setup Process ................................................................................................................................ 6
Booking API Function Calls ................................................................................................................ 7
Best Practices ................................................................................................................................ 7
Common API Types ....................................................................................................................... 8
Get Availability ............................................................................................................................. 9
Example Requests ................................................................................................................... 13
Example Responses ................................................................................................................. 15
Get Details .................................................................................................................................. 28
Example Request..................................................................................................................... 33
Example Response .................................................................................................................. 34
Create Booking............................................................................................................................ 42
Example Request..................................................................................................................... 48
Example Response .................................................................................................................. 50
Get Booking ................................................................................................................................ 56
Get Cancellation Charges ............................................................................................................ 63
Cancel Booking............................................................................................................................ 65
Booking Search ........................................................................................................................... 66
Example Request..................................................................................................................... 67
Example Response .................................................................................................................. 68
Extras .............................................................................................................................................. 69
Types of Extras ............................................................................................................................ 69
Activation and Extras options ..................................................................................................... 69
Extra Categories .......................................................................................................................... 70
Fields........................................................................................................................................... 71
Tables ............................................................................................................................................. 72
Accommodation Types................................................................................................................ 72
Board Types ................................................................................................................................ 72
Booking Statuses......................................................................................................................... 72
Cancellation Statuses .................................................................................................................. 72
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 4 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Card Types .................................................................................................................................. 73
Rating Types ............................................................................................................................... 73
Culture Types .............................................................................................................................. 73
Languages ................................................................................................................................... 73
Currencies ................................................................................................................................... 73
Source Market Codes .................................................................................................................. 74
Certification Process ....................................................................................................................... 75
Workflow .................................................................................................................................... 75
1.- Availability ............................................................................................................................. 75
2.- Details .................................................................................................................................... 76
3.- Confirmation & Voucher ........................................................................................................ 76
Voucher................................................................................................................................... 76
4. Static Content ......................................................................................................................... 77

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 5 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Account Setup
On beginning your integration, a Yalago affiliate account will be created for you, with access to rates
in your chosen currency (ies).

For each affiliate account created, you will be given an API key to access the Yalago staging service to
begin development.

When development and certification have been completed, you may receive a new API key to access
the production environment.

API Overview
Service Address

Production Service: https://api.yalago.com

Client Integration Service: https://apici.yalago.com

Authentication

Requests are authenticated by sending the affiliate account API key in the http request headers
collection.

Example Http Request

POST https://api.yalago.com/hotels/availability/Get HTTP/1.1

X-Api-Key: ec428138-1e30-4fa2-a608-ae856149e30a
Content-Type: application/json; charset=utf-8
Accept-Encoding: application/gzip
Host:api.yalago.com
Content-Length: 296
Expect: 100-continue
Connection: Keep-Alive

Setup Process

Live Environment

 Prior to starting this process you must successfully pass the Acceptance Test.
 Provide your xml support the IP/IPs from which you are planning to access the live server (a
maximum of 255 IPs can be provided. The IPs must be static, NOT dynamic.

Test Environment

 Provide your xml support the IP/IPs from which you are planning to access the live server (a
maximum of 255 IPs can be provided. The IPs must be static, NOT dynamic.
 Yalago will configure the system to grant you to access from the provided IPs.

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 6 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Use the credentials provided by your API Agent. These credentials may be the same for the live
environment. You will not have access to the live environment until you have successfully passed the
Acceptance Test/Certification Process.

Booking API Function Calls

The booking process has three steps. It is mandatory to go through each of the steps to confirm a
reservation:

Availability

Details

CreateBooking

Best Practices
To confirm a booking you should send the following requests (this is the optimal workflow and we
expect to send like this):

1.- Availability

2.- Details

3.- Booking

There are some inappropriate workflows that we won’t accept. Below some examples:

Example 1

1.- Availability

2.- Details

3.- Availability (same as n.1)

4.- Details (same as n.2)

5.- Booking

Example 2

1.- Availability

2.- Availability (same as n.1)

3.- Availability (same as n.1)

4.- Details

5.- Booking
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 7 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Common API Types

Object Field Type Comments

MONEY Amount Decimal The amount (inclusive of tax if
applicable)
Currency String The three-letter currency code

TaxBreakdown TAXBREAKDOWN Tax breakdown of rate provided if

GetTaxBreakdown = True and
applicable – not required on
requests

TAXBREAKDOWN Amount Decimal The amount exclusive of any tax

VAT Decimal The VAT part of the total Amount

LOCALCHARGESAMOUNT Amount Decimal The amount (inclusive of tax if

applicable)
Currency String The three-letter currency code

Local charges will follow local

currency of the destination

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 8 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Get Availability
ENDPOINT POST https://apici.yalago.com/hotels/availability/get
Note: Dates and Times (Cancellation policies) are all in UK time, so GMT when the UK is in winter,
and BST in the UK’s summer.

Request Fields

Object Field Type Required Comments

AVAILABILITYREQUEST CheckInDate Date Y Arrival date (yyyy-
mm-dd)
CheckOutDate Date Y Departure date (yyyy-
mm-dd)
ProvinceId Integer Y Yalago ProvinceID
element
LocationId Integer N Narrows the search
to a smaller location
with the province
Culture String Y The language to
return text field in if
available. (Default
"en-GB"). If the
information is not
available in the
requested language,
the information will
be returned in English
Rooms List of Y A collection of room
occupancy details
ROOMOCCUPANCY
GetPackagePrice Boolean N Attribute to include
or exclude package
rates.

True: Package rates

are included

False: Package rates

are excluded
IsFlightPlus Boolean N Attribute to include
or exclude flight
rates.

True: Flight rates are

included

False: Flight rates are

excluded
SourceMarket String N Customer’s market
region
GetTaxBreakdown Boolean N Will include
additional tax
breakdown
information on
net/gross rates as
required
GetLocalCharges Bookean N Will include the Local
charges tags in the
responses

Local charges are

payable at the hotel
and exclusive of the
room rate

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 9 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 GetBoardBasis Boolean N Attribute to include
or exclude Board
Basis
True: Board Basis are
included
False: Board Basis are
excluded

Board Basis provides

the services included
and excluded in the
chosen Meal Plan
CurrencyCode String N The three-letter
currency code

Depends on the
Currency that is set
up in Client’s account

Please refer to
Currencies in Tables
for the list of codes
ROOMOCCUPANCY Adults Integer Y The number of adults
(18 and over) in the
room
ChildAges List of Integer Y The age of each child
and infant (under 18)
in the room

ESTABLISHMENTIDS EstablishmentId Integer N Yalago establishment

code (mandatory if
the ProvinceID and
LocationID are not
used).

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 10 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Response Fields

Object Field Type Comments

AVAILABILITYRESPONSE Establishments List of A collection of available
hotels
ESTABLISHMENT

ESTABLISHMENT EstablishmentId Integer Yalago establishment

code
AcceptedCardTypes List of String A collection of codes
indicating the card types
accepted by the hotel.
Note, this is only relevant
for pay direct rates (See
card types)
Rooms List of ROOM A collection of available
rooms
ROOM Code String The booking code for this
room
Description String Description

QuantityAvailable Integer The number of rooms of

this type that are
available for booking

“QuantityAvailable”: -1
the room rate is from a
3rd party Supplier, where
exact # of available
rooms is not provided
Boards List of BOARD Room description

BOARD Type Integer The board type (See

board types table)
Code String The board code of the
requested room
Description String Board description

GrossCost MONEY The recommended selling

price to the end
customer, including
affiliate commission
NetCost MONEY The cost to the affiliate,
excluding commission
NonRefundable Boolean Indicates that the cost of
this room is non-
refundable
IsPayAtHotel Boolean Whether the Gross Cost is
to be paid directly to the
hotel by the end
customer
IsBindingPrice Boolean Indicates that the gross
cost is a fixed selling price
IsOnRequest Boolean Indicates whether the
result has actual
inventory or would be on
request
RequestedRoomIndex Integer The zero-based index of
the corresponding room
in the request
BookingConditions String Details of booking
conditions for this result
SpecialOfferText String Details of any special
offers included in this
result.
**IsPackagePrice Boolean Indicates that the room is
Package Rate or not

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 11 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 LocalChargesAmount LOCALCHARGESAM Local Charges of rate
provided if
OUNT GetLocalCharges = True
and applicable – not
required on requests
BoardBasis List of INCLUSIONS Inclusive and Exclusive
services of the board
and EXCLUSIONS basis;

if request has
GetBoardBasis=true,
Board inclusions and
exclusions are provided
INCLUSIONS InclusionId Integer Inclusions ID from
GetBoardTypeInclusions
Inclusive service of the
board basis
ReplacementText String Additional information of
the Board Basis
EXCLUSIONS InclusionId Integer Inclusions ID from
GetBoardTypeInclusions
Exclusive service of the
board basis
ReplacementText String Additional information of
the Board Basis
SupplierBoardTypeId Integer Board Type ID from
GetSupplierBoardTypes

**EXTRA ExtraID Integer Internal identifier of the

extra service
Title String Name of service

ExtraTypeId Integer Internal identifier of the

type of service provided
RequiresFlightDetails Boolean If value = TRUE, is needed
to specify the flight
details on the
confirmation request
IsMandatory Boolean If TRUE, is needed to
include the extra service
to book the room
IsOpaque Boolean If TRUE, the price of the
extra should not be
revealed to the end
customer – it needs to be
bundled with the room
price.
Options EXTRAOPTIONS
**EXTRAOPTIONS OptionId Integer Internal identifier of the
different extra options
(speed boat, plane….)
Title String Name of the extra service
option
AgentText String Description of the service
provided
CustomerText String Notes to customers for
Extras arrangements after
booking
i.e. Transfer arrangement
and processes at the
airport
NetCost MONEY The cost of the extra
service, excluding the
commission
GrossCost MONEY The recommended selling
price to the end
customer, including
affiliate commission

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 12 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 **CANCELLATIONPOLICY CancellationCharges List of
CANCELLATIONCH
ARGE
**CANCELLATIONCHARGE Charge MONEY The cost of cancelling the
booking
ExpiryDate Date Indicates how long this
cancellation charge
response is valid for.
ExpiryDateUTC Date Indicates how long this
cancellation charge
response is valid for
(Universal Time).
**ESTABLISHMENTINFO LocationId Integer Used for location-level
availability searches
LocationName String Destination location
name
Rating Integer Numeric rating of the
hotel
RatingTypeId Integer See rating types table

AccomodationType String Type of Establishment

(Hotel,
Apartment,Camping…)

**Optional (activation needed).

Example Requests

Example JSON Request by Province and Location

{
"CheckInDate": "2018-09-26",
"CheckOutDate": "2018-10-03",
"ProvinceId": 74304,
"LocationId": 250012,
"EstablishmentId": 0,
"Rooms": [
{
"Adults": 2,
"ChildAges": [1,7]
}
],
"SourceMarket": “GB”,
"Culture": "en-gb",
"GetPackagePrice": true,
"GetTaxBreakdown": true,
"GetBoardBasis": false,
"GetLocalCharges": true,
"CurrencyCode": "USD"
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 13 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Example JSON Request by Hotel Id
{
"CheckInDate": "2018-09-26",
"CheckOutDate": "2018-10-03",
"EstablishmentId": 278073,
"EstablishmentIds": [],
"SourceMarket": "GB",
"Rooms": [
{
"Adults": 2,
"ChildAges": [1, 7]
},
{
"Adults": 2,
"ChildAges": []
}
],
"Culture": "en-gb",
"GetPackagePrice": true,
"GetTaxBreakdown": true,
"GetLocalCharges": true,
"GetBoardBasis": false,
"CurrencyCode": "USD"
}

Example JSON Request by Hotel List

{
"CheckInDate": "2018-07-08",
"CheckOutDate": "2018-07-09",
"EstablishmentIds": [
858947,
2452820,
858953
],
"Rooms": [
{
"Adults": 2,
"ChildAges": []
},
{
"Adults": 1,
"ChildAges": [1, 7]
}
],
"SourceMarket": “GB”,
"Culture": "en-GB",
"GetPackagePrice": true,
"GetTaxBreakdown": true,
"GetLocalCharges": true,
"GetBoardBasis": false,
"CurrencyCode": "USD"
}
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 14 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Example Responses

JSON Response with EXTRAS

{
"Establishments": [
{
"EstablishmentId": 1490812,
"Rooms": [
{
"Code": "CGISBzQwMjE2NzcaBzExMjg5ODg=",
"Description": "Beach Villa",
"QuantityAvailable": 999,
"Boards": [
{
"Type": 4,
"Code": "CgE0",
"Description": "Full Board",
"NetCost": {
"Amount": 1999.17,
"Currency": "USD"
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
{
"Charge": {
"Amount": 1999.17,
"Currency": "USD"
},
"ExpiryDate": "2019-12-25T23:59:59",
"ExpiryDateUTC": "2019-12-25T23:59:59Z"
},
{
"Charge": {
"Amount": 999.59,
"Currency": "USD"
},
"ExpiryDate": "2019-12-21T23:59:59",
"ExpiryDateUTC": "2019-12-21T23:59:59Z"
},
{
"Charge": {
"Amount": 0.0,
"Currency": "USD"
},
"ExpiryDate": "2019-12-17T23:59:59",
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 15 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "ExpiryDateUTC": "2019-12-17T23:59:59Z"
}
]
},
"BookingConditions": null,
"SpecialOfferText": "",
"Extras": [
{
"ExtraId": "16",
"Title": "Return Transfer",
"ExtraTypeId": "2",
"RequiresFlightDetails": true,
"IsMandatory": true,
"IsOpaque": false,
"Options": [
{
"OptionId": "18",
"Title": "Combined Return Speedboat Transfer",
"CustomerText": "On Arrival:\nOnce you have arrived at Male International Airport and
you have collected your luggage, then please exit the Arrivals Hall and immediately locate the airport
representative or desk with the name of the hotel you have booked. Please identify yourself to the
respective hotel's airport representative by showing a copy of your booking voucher. Since you have
booked a speedboat transfer, your repersentative will escort you to the correct boat for your transfer.
In the unlikely event you should have any difficulty in locating the airport repersentative or if your
flight has arrived late - please call the Diethelm Travel helpline where an English speaking
representative will help you. (If calling from a mobile, the international dialling code must be dialled. If
calling from a land line there is no need.)\n\nOn Departure:\nThe pick up stated on your booking is
only an estimated time and will be confirmed to you by reception on the evening prior to departure
day. Confirmation will be either by way of a phone call to your hotel room or a message left with the
hotel staff and delivered to your room. In the unlikely event there is any confusion or
misunderstanding - please call the Diethelm Travel helpline where an English speaking representative
will help you. (If calling from a mobile, the international dialling code must be dialled. If calling from a
land line there is no need.) \n\nTelephone Number: 24 hrs: Shareek Rasheed +960 7407606\nMobile:
24 hrs: Howard Brohier +960 7991106",
"NetCost": {
"Amount": 1288.66,
"Currency": "USD"
},
"GrossCost": {
"Amount": 0.0,
"Currency": "USD"
}
}
],
"IsBindingPrice": false
}
],
"PresaleOfferBookableDate": null,
"IsEstimatedContract": false,
"IsPackagePrice": false
},
{
"Type": 5,
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 16 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Code": "CgIyMg==",
"Description": "All Inclusive",
"NetCost": {
"Amount": 2467.73,
"Currency": "USD"
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
{
"Charge": {
"Amount": 2467.73,
"Currency": "USD"
},
"ExpiryDate": "2019-12-25T23:59:59",
"ExpiryDateUTC": "2019-12-25T23:59:59Z"
},
{
"Charge": {
"Amount": 1233.87,
"Currency": "USD"
},
"ExpiryDate": "2019-12-21T23:59:59",
"ExpiryDateUTC": "2019-12-21T23:59:59Z"
},
{
"Charge": {
"Amount": 0.0,
"Currency": "USD"
},
"ExpiryDate": "2019-12-17T23:59:59",
"ExpiryDateUTC": "2019-12-17T23:59:59Z"
}
]
},
"BookingConditions": null,
"SpecialOfferText": "",
"Extras": [
{
"ExtraId": "16",
"Title": "Return Transfer",
"ExtraTypeId": "2",
"RequiresFlightDetails": true,
"IsMandatory": true,
"IsOpaque": false,
"Options": [
{
"OptionId": "18",
"Title": "Combined Return Speedboat Transfer",
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 17 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "CustomerText": "On Arrival:\nOnce you have arrived at Male International Airport and
you have collected your luggage, then please exit the Arrivals Hall and immediately locate the airport
representative or desk with the name of the hotel you have booked. Please identify yourself to the
respective hotel's airport representative by showing a copy of your booking voucher. Since you have
booked a speedboat transfer, your repersentative will escort you to the correct boat for your transfer.
In the unlikely event you should have any difficulty in locating the airport repersentative or if your
flight has arrived late - please call the Diethelm Travel helpline where an English speaking
representative will help you. (If calling from a mobile, the international dialling code must be dialled. If
calling from a land line there is no need.)\n\nOn Departure:\nThe pick up stated on your booking is
only an estimated time and will be confirmed to you by reception on the evening prior to departure
day. Confirmation will be either by way of a phone call to your hotel room or a message left with the
hotel staff and delivered to your room. In the unlikely event there is any confusion or
misunderstanding - please call the Diethelm Travel helpline where an English speaking representative
will help you. (If calling from a mobile, the international dialling code must be dialled. If calling from a
land line there is no need.) \n\nTelephone Number: 24 hrs: Shareek Rasheed +960 7407606\nMobile:
24 hrs: Howard Brohier +960 7991106",
"NetCost": {
"Amount": 1288.66,
"Currency": "USD"
},
"GrossCost": {
"Amount": 0.0,
"Currency": "USD"
}
}
],
"IsBindingPrice": false
}
],
"IsPackagePrice": false
}
]
},
{
"Code": "CGISBzQwMjE2NzcaBzExNTAzMjQ=",
"Description": "Garden Room",
"QuantityAvailable": 999,
"Boards": [
{
"Type": 4,
"Code": "CgE0",
"Description": "Full Board",
"NetCost": {
"Amount": 1718.04,
"Currency": "USD"
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 18 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 {
"Charge": {
"Amount": 1718.04,
"Currency": "USD"
},
"ExpiryDate": "2019-12-25T23:59:59",
"ExpiryDateUTC": "2019-12-25T23:59:59Z"
},
{
"Charge": {
"Amount": 859.02,
"Currency": "USD"
},
"ExpiryDate": "2019-12-21T23:59:59",
"ExpiryDateUTC": "2019-12-21T23:59:59Z"
},
{
"Charge": {
"Amount": 0.0,
"Currency": "USD"
},
"ExpiryDate": "2019-12-17T23:59:59",
"ExpiryDateUTC": "2019-12-17T23:59:59Z"
}
]
},
"BookingConditions": null,
"SpecialOfferText": "",
"Extras": [
{
"ExtraId": "16",
"Title": "Return Transfer",
"ExtraTypeId": "2",
"RequiresFlightDetails": true,
"IsMandatory": true,
"IsOpaque": false,
"Options": [
{
"OptionId": "18",
"Title": "Combined Return Speedboat Transfer",
"CustomerText": "On Arrival:\nOnce you have arrived at Male International Airport and
you have collected your luggage, then please exit the Arrivals Hall and immediately locate the airport
representative or desk with the name of the hotel you have booked. Please identify yourself to the
respective hotel's airport representative by showing a copy of your booking voucher. Since you have
booked a speedboat transfer, your repersentative will escort you to the correct boat for your transfer.
In the unlikely event you should have any difficulty in locating the airport repersentative or if your
flight has arrived late - please call the Diethelm Travel helpline where an English speaking
representative will help you. (If calling from a mobile, the international dialling code must be dialled. If
calling from a land line there is no need.)\n\nOn Departure:\nThe pick up stated on your booking is
only an estimated time and will be confirmed to you by reception on the evening prior to departure
day. Confirmation will be either by way of a phone call to your hotel room or a message left with the
hotel staff and delivered to your room. In the unlikely event there is any confusion or
misunderstanding - please call the Diethelm Travel helpline where an English speaking representative
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 19 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 will help you. (If calling from a mobile, the international dialling code must be dialled. If calling from a
land line there is no need.) \n\nTelephone Number: 24 hrs: Shareek Rasheed +960 7407606\nMobile:
24 hrs: Howard Brohier +960 7991106",
"NetCost": {
"Amount": 1288.66,
"Currency": "USD"
},
"GrossCost": {
"Amount": 0.0,
"Currency": "USD"
}
}
],
"IsBindingPrice": false
}
],
"PresaleOfferBookableDate": null,
"IsEstimatedContract": false,
"IsPackagePrice": false
},
{
"Type": 5,
"Code": "CgIyMg==",
"Description": "All Inclusive",
"NetCost": {
"Amount": 2186.6,
"Currency": "USD"
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
{
"Charge": {
"Amount": 2186.6,
"Currency": "USD"
},
"ExpiryDate": "2019-12-25T23:59:59",
"ExpiryDateUTC": "2019-12-25T23:59:59Z"
},
{
"Charge": {
"Amount": 1093.3,
"Currency": "USD"
},
"ExpiryDate": "2019-12-21T23:59:59",
"ExpiryDateUTC": "2019-12-21T23:59:59Z"
},
{
"Charge": {
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 20 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Amount": 0.0,
"Currency": "USD"
},
"ExpiryDate": "2019-12-17T23:59:59",
"ExpiryDateUTC": "2019-12-17T23:59:59Z"
}
]
},
"BookingConditions": null,
"SpecialOfferText": "",
"Extras": [
{
"ExtraId": "16",
"Title": "Return Transfer",
"ExtraTypeId": "2",
"RequiresFlightDetails": true,
"IsMandatory": true,
"IsOpaque": false,
"Options": [
{
"OptionId": "18",
"Title": "Combined Return Speedboat Transfer",
"CustomerText": "On Arrival:\nOnce you have arrived at Male International Airport and
you have collected your luggage, then please exit the Arrivals Hall and immediately locate the airport
representative or desk with the name of the hotel you have booked. Please identify yourself to the
respective hotel's airport representative by showing a copy of your booking voucher. Since you have
booked a speedboat transfer, your repersentative will escort you to the correct boat for your transfer.
In the unlikely event you should have any difficulty in locating the airport repersentative or if your
flight has arrived late - please call the Diethelm Travel helpline where an English speaking
representative will help you. (If calling from a mobile, the international dialling code must be dialled. If
calling from a land line there is no need.)\n\nOn Departure:\nThe pick up stated on your booking is
only an estimated time and will be confirmed to you by reception on the evening prior to departure
day. Confirmation will be either by way of a phone call to your hotel room or a message left with the
hotel staff and delivered to your room. In the unlikely event there is any confusion or
misunderstanding - please call the Diethelm Travel helpline where an English speaking representative
will help you. (If calling from a mobile, the international dialling code must be dialled. If calling from a
land line there is no need.) \n\nTelephone Number: 24 hrs: Shareek Rasheed +960 7407606\nMobile:
24 hrs: Howard Brohier +960 7991106",
"NetCost": {
"Amount": 1288.66,
"Currency": "USD"
},
"GrossCost": {
"Amount": 0.0,
"Currency": "USD"
}
}
],
"IsBindingPrice": false
}
],
"IsPackagePrice": false
}
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 21 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 ]
}
],
"EstablishmentInfo": {
"EstablishmentName": "Meeru Island Resort Hotel",
"LocationId": 249675,
"LocationName": "North Male Atoll",
"Rating": 4,
"RatingTypeId": 1,
"AccomodationType": "Hotel",
"CountryCode": "MV"
}
}
],
"Messages": []
}

JSON Response with Local Charges and Tax Breakdown

{
"Establishments": [
{
"EstablishmentId": 6264715,
"Rooms": [
{
"Code": "CGISBzYyNjQ3MTYaBzExNjYwMTY=",
"Description": "Rover Room",
"QuantityAvailable": 999,
"Boards": [
{
"Type": 4,
"Code": "CgE0",
"Description": "Full Board",
"NetCost": {
"Amount": 587.88,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 559.89,
"Vat": 27.99
}
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
{
"Charge": {
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 22 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Amount": 195.96,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 186.63,
"Vat": 9.33
}
},
"ExpiryDate": "2019-12-25T23:59:59",
"ExpiryDateUTC": "2019-12-25T23:59:59Z"
},
{
"Charge": {
"Amount": 0.0,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 0.0,
"Vat": 0.0
}
},
"ExpiryDate": "2019-12-17T23:59:59",
"ExpiryDateUTC": "2019-12-17T23:59:59Z"
}
]
},
"BookingConditions": null,
"SpecialOfferText": "",
"IsPackagePrice": true,
"LocalChargesAmount": {
"Amount": 60.0,
"Currency": "AED"
}
},
{
"Type": 1,
"Code": "CgEx",
"Description": "Room Only",
"NetCost": {
"Amount": 245.01,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 233.34,
"Vat": 11.67
}
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
{
"Charge": {
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 23 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Amount": 81.67,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 77.78,
"Vat": 3.89
}
},
"ExpiryDate": "2019-12-25T23:59:59",
"ExpiryDateUTC": "2019-12-25T23:59:59Z"
},
{
"Charge": {
"Amount": 0.0,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 0.0,
"Vat": 0.0
}
},
"ExpiryDate": "2019-12-17T23:59:59",
"ExpiryDateUTC": "2019-12-17T23:59:59Z"
}
]
},
"BookingConditions": null,
"SpecialOfferText": "",
"IsPackagePrice": true,
"LocalChargesAmount": {
"Amount": 60.0,
"Currency": "AED"
}
},
{
"Type": 2,
"Code": "CgEy",
"Description": "Bed And Breakfast",
"NetCost": {
"Amount": 315.6,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 300.57,
"Vat": 15.03
}
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
{
"Charge": {
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 24 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Amount": 105.2,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 100.19,
"Vat": 5.01
}
},
"ExpiryDate": "2019-12-25T23:59:59",
"ExpiryDateUTC": "2019-12-25T23:59:59Z"
},
{
"Charge": {
"Amount": 0.0,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 0.0,
"Vat": 0.0
}
},
"ExpiryDate": "2019-12-17T23:59:59",
"ExpiryDateUTC": "2019-12-17T23:59:59Z"
}
]
},
"BookingConditions": null,
"SpecialOfferText": "",
"IsPackagePrice": true,
"LocalChargesAmount": {
"Amount": 60.0,
"Currency": "AED"
}
},
{
"Type": 3,
"Code": "CgEz",
"Description": "Half Board",
"NetCost": {
"Amount": 451.74,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 430.23,
"Vat": 21.51
}
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
{
"Charge": {
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 25 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Amount": 150.58,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 143.41,
"Vat": 7.17
}
},
"ExpiryDate": "2019-12-25T23:59:59",
"ExpiryDateUTC": "2019-12-25T23:59:59Z"
},
{
"Charge": {
"Amount": 0.0,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 0.0,
"Vat": 0.0
}
},
"ExpiryDate": "2019-12-17T23:59:59",
"ExpiryDateUTC": "2019-12-17T23:59:59Z"
}
]
},
"BookingConditions": null,
"SpecialOfferText": "",
"IsPackagePrice": true,
"LocalChargesAmount": {
"Amount": 60.0,
"Currency": "AED"
}
}
]
},
{
"Code": "CPQSEgYxNjUzMzQaDDAsMDIjQkIjTEIjMA==",
"Description": "Double/Twin (2 Pers)",
"QuantityAvailable": -1,
"Boards": [
{
"Type": 2,
"Code": "CgJCQhAB",
"Description": "Bed And Breakfast",
"NetCost": {
"Amount": 278.29,
"Currency": "GBP"
},
"NonRefundable": true,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"BookingConditions": null,
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 26 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "SpecialOfferText": null,
"IsPackagePrice": false,
"LocalChargesAmount": {
"Amount": 60.0,
"Currency": "AED"
}
}
]
},
{
"Code": "CPQSEgYxNjUzMzQaDDAsMDIjUk8jTEIjMA==",
"Description": "Double/Twin (2 Pers)",
"QuantityAvailable": -1,
"Boards": [
{
"Type": 1,
"Code": "CgJSTxAB",
"Description": "Room Only",
"NetCost": {
"Amount": 215.88,
"Currency": "GBP"
},
"NonRefundable": true,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"BookingConditions": null,
"SpecialOfferText": null,
"IsPackagePrice": false,
"LocalChargesAmount": {
"Amount": 60.0,
"Currency": "AED"
}
}
]
}
],
"EstablishmentInfo": {
"EstablishmentName": "Rove City Center",
"LocationId": 253015,
"LocationName": "Deira",
"Rating": 3,
"RatingTypeId": 1,
"AccomodationType": "Hotel",
"CountryCode": "AE"
}
}
],
"Messages": []
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 27 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Get Details
ENDPOINT POST https://apici.yalago.com/hotels/details/get
Note: Dates and Times (Cancellation policies) are all in UK time, so GMT when the UK is in winter,
and BST in the UK’s summer.

Request Fields

Object Field Type Required Comments

DETAILSREQUEST CheckInDate Date Y Arrival date (yyyy-mm-dd)

CheckOutDate Date Y Departure date (yyyy-mm-

dd)
EstablishmentId Integer Y The id of the requested hotel

Culture String Y The language to return text

field in if available (Default
"en-GB")
Rooms List of Y A collection of room
occupancy details
ROOMOCCUPANCY
GetPackagePrice Boolean N Attribute to include or
exclude package rates.

True: Package rates are

included

False: Package rates are

excluded
IsFlightPlus Boolean N Attribute to include or
exclude flight rates.

True: Flight rates are

included

False: Flight rates are

excluded
SourceMarket String N Customer’s market region

GetLocalCharges Bookean N Will include the Local

charges tags in the
responses

Local charges are payable at

the hotel and exclusive of
the room rate
GetErrataCategory Boolean N Attribute to include or
exclude Errata Categories
True: Errata Categories are
included
False: Errata Categories are
excluded

Errata Categories are the

classification of the Key
information provided by the
Hotel
GetTaxBreakdown Boolean N Will include additional tax
breakdown information on
net/gross rates as required
GetBoardBasis Boolean N Attribute to include or
exclude Board Basis
True: Board Basis are
included
False: Board Basis are
excluded

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 28 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Board Basis provides the
services included and
excluded in the chosen Meal
Plan
CurrencyCode String N The three-letter currency
code

Depends on the Currency

that is set up in Client’s
account

Please refer to Currencies in

Tables for the list of codes
ROOMOCCUPANCY Adults Integer Y The number adults in the
room (18 and over)
ChildAges List of Integer Y The age of each child and
infant in the room (under
18)

RoomCode String Y The booking code of the

requested room
BoardCode String Y The booking code of the
requested board
**Extras EXTRASELECTION
**EXTRASELECTION ExtraId Integer Internal identifier of the
extra service
OptionId Integer Internal identifier of the
different extra options
(speed boat, plane …)

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 29 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Response Fields

Object Field Type Comments

DETAILSRESPONSE Establishment ESTABLISHMENT The requested hotel
details
InfoItems List of INFOITEM A collection of
important
information texts
ESTABLISHMENT EstablishmentId Integer
AcceptedCardTypes List of String A collection of codes
indicating the card
types accepted by the
hotel, for pay direct
rates (See card types)
Rooms List of ROOM A collection of
available rooms
ROOM Code String The booking code for
this room
Description String Description

QuantityAvailable Integer The number of rooms

of this type that are
available for booking

“QuantityAvailable”:
-1 the room rate is
from a 3rd party
Supplier, where exact
# of available rooms is
not provided
Boards List of BOARD Room description

BOARD Type Integer The board type (See

board types)
Code String The booking code for
this board
Description String Board description

GrossCost MONEY The recommended

selling price to the
end customer,
including affiliate
commission
NetCost MONEY The cost to the
affiliate, excluding
commission
NonRefundable Boolean Indicates that the cost
of this room is non-
refundable
IsPayAtHotel Boolean Whether the Gross
Cost is to be paid
directly to the hotel
by the end customer
IsBindingPrice Boolean Indicates that the
gross cost is a fixed
selling price
IsOnRequest Boolean Indicates whether the
result has actual
inventory or would be
on request
RequestedRoomIndex Integer The zero-based index
of the corresponding
room in the request
CancellationPolicy CANCELLATIONPOLICY Cancellation charge
information
BookingConditions String Details of
establishment
remarks for this result

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 30 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 SpecialOfferText String Details of any special
offers included in this
result.
IsPackagePrice Boolean Indicates whether the
room is Package Rate
or not

LOCALCHARGES Amount LOCALCHARGESAMOUNT The amount (inclusive

of tax if applicable)
Title String The heading of the
Local Charge
Description String Description of the
Local Charges
IsPerBooking Boolean Indicates whether the
local charge is applied
per booking or per
room

BoardBasis List of INCLUSIONS and Inclusive and

Exclusive services of
EXCLUSIONS the board basis;

if request has
GetBoardBasis=true,
Board inclusions and
exclusions are
provided
SupplierBoardTypeId Integer Board Type ID from
GetSupplierBoardTyp
es
INCLUSIONS InclusionId Integer Inclusions ID from
GetBoardTypeInclusio
ns

Inclusive service of
the board basis
ReplacementText String Additional
information of the
Board Basis
EXCLUSIONS InclusionId Integer Inclusions ID from
GetBoardTypeInclusio
ns

Exclusive service of
the board basis
ReplacementText String Additional
information of the
Board Basis

**Extras EXTRA List of extra services

CANCELLATIONPOLICY CancellationCharges List of

CANCELLATIONCHARGE
CANCELLATIONCHARGE Charge MONEY The cost of cancelling
the booking
ExpiryDate Date Indicates how long
this cancellation
charge response is
valid for.
ExpiryDateUTC Date Indicates how long
this cancellation
charge response is
valid for (Universal
Time).
** Infoitems List of INFOITEM List of Infoitems

ERRATACATEGORY Id Integer If GetErratacatogory

= true from the
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 31 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 request,
ErrataCategory id is
provided

See
GetErrataCategory to
get Errata details.
INFOITEM Title String The heading of the
info item

If GetErratacatogory
= false from the
request, only InfoItem
details is provided
Definition String The body text of the
info item

MONEY Amount Decimal The amount

Currency String The three-letter

currency code (ISO
4217)
**EXTRA ExtraID Integer Internal identifier of
the extra service
Title String Name of service

ExtraTypeId Integer Internal identifier of

the type of service
provided
RequiresFlightDetails Boolean If value = TRUE, is
needed to specify the
flight details on the
confirmation request
IsMandatory Boolean If TRUE, is needed to
include the extra
service to book the
room
IsOpaque Boolean If TRUE, the price of
the extra should not
be revealed to the
end customer – it
needs to be bundled
with the room price.
Options EXTRAOPTIONS
**EXTRAOPTIONS OptionId Integer Internal identifier of
the different extra
options (speed boat,
plane….)
Title String Name of the extra
service option
AgentText String Description of the
service provided
CustomerText String
NetCost MONEY The cost of the extra
service, excluding the
commission
GrossCost MONEY The recommended
selling price to the
end customer,
including affiliate
commission
**ESTABLISHMENTINFO LocationID Integer Used for location-
level availability
searches
LocationName Destination location
name
Rating Numeric rating of the
hotel

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 32 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 RatingTypeId See rating types table

AccomodationType Type of Establishment

(Hotel,
Apartment,Camping…
)
CountryCode String Country code of the
Establishment

Example Request

JSON Details Request

{
"CheckInDate": "2018-10-04T00:00:00Z",
"CheckOutDate": "2018-10-11T00:00:00Z",
"EstablishmentId": 192146,
"Rooms": [
{
"Adults": 2,
"ChildAges": [],
"RoomCode": "CGISBzQ3MDU2NDkaBzEwODc0MjI=",
"BoardCode": "CgE1",
"Extras": [
{
"ExtraId": "40",
"OptionId": "69"
}
]
}
],
"Culture": "en-gb",
"GetPackagePrice": true,
"SourceMarket": "GB",
"GetTaxBreakdown": true,
"GetLocalCharges": true,
" GetErrataCategory": false,
"GetBoardBasis": true,
"CurrencyCode": "USD"
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 33 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Example Response

JSON Details Response with Extras

{
"Establishment": {
"EstablishmentId": 1490812,
"Rooms": [
{
"Code": "CGISBzQwMjE2NzcaBzExMjg5ODg=",
"Description": "Beach Villa",
"QuantityAvailable": 999,
"Boards": [
{
"Type": 4,
"Code": "CgE0",
"Description": "Full Board",
"NetCost": {
"Amount": 1686.8,
"Currency": "USD"
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
{
"Charge": {
"Amount": 1686.8,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 1686.8,
"Vat": 0.0
}
},
"ExpiryDate": "2019-12-25T23:59:59",
"ExpiryDateUTC": "2019-12-25T23:59:59Z"
},
{
"Charge": {
"Amount": 843.4,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 843.4,
"Vat": 0.0
}
},
"ExpiryDate": "2019-12-21T23:59:59",
"ExpiryDateUTC": "2019-12-21T23:59:59Z"
},
{
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 34 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Charge": {
"Amount": 0.0,
"Currency": "USD",
"TaxBreakDown": {
"Amount": 0.0,
"Vat": 0.0
}
},
"ExpiryDate": "2019-12-17T23:59:59",
"ExpiryDateUTC": "2019-12-17T23:59:59Z"
}
]
},
"BookingConditions": "",
"SpecialOfferText": "",
"Extras": [
{
"ExtraId": "16",
"Title": "Return Transfer",
"ExtraTypeId": "2",
"RequiresFlightDetails": true,
"IsMandatory": true,
"IsOpaque": false,
"Options": [
{
"OptionId": "18",
"Title": "Combined Return Speedboat Transfer",
"CustomerText": "On Arrival:\nOnce you have arrived at Male International Airport and you
have collected your luggage, then please exit the Arrivals Hall and immediately locate the airport
representative or desk with the name of the hotel you have booked. Please identify yourself to the
respective hotel's airport representative by showing a copy of your booking voucher. Since you have
booked a speedboat transfer, your repersentative will escort you to the correct boat for your transfer.
In the unlikely event you should have any difficulty in locating the airport repersentative or if your
flight has arrived late - please call the Diethelm Travel helpline where an English speaking
representative will help you. (If calling from a mobile, the international dialling code must be dialled. If
calling from a land line there is no need.)\n\nOn Departure:\nThe pick up stated on your booking is
only an estimated time and will be confirmed to you by reception on the evening prior to departure
day. Confirmation will be either by way of a phone call to your hotel room or a message left with the
hotel staff and delivered to your room. In the unlikely event there is any confusion or
misunderstanding - please call the Diethelm Travel helpline where an English speaking representative
will help you. (If calling from a mobile, the international dialling code must be dialled. If calling from a
land line there is no need.) \n\nTelephone Number: 24 hrs: Shareek Rasheed +960 7407606\nMobile:
24 hrs: Howard Brohier +960 7991106",
"NetCost": {
"Amount": 1030.93,
"Currency": "USD"
},
"GrossCost": {
"Amount": 0.0,
"Currency": "USD"
}
}
],
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 35 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "IsBindingPrice": false
}
],
"IsPackagePrice": false,
"LocalCharges": []
}
]
}
],
"EstablishmentInfo": {
"EstablishmentName": "Meeru Island Resort Hotel",
"LocationId": 249675,
"LocationName": "North Male Atoll",
"Rating": 4,
"RatingTypeId": 1,
"AccomodationType": "Hotel",
"CountryCode": "MV"
}
},
"InfoItems": [
{
"Title": "Notice",
"Description": "Meeru accommodates children in the Garden Rooms and Beach Villas. \r\nAdults
only (age 18 years and older) are accommodated in the Jacuzzi Beach Villas, Water Front Villas and
Jacuzzi Water Villas. \r\nAdults only facilities are for guests of 18 years and older."
},
{
"Title": "Notice",
"Description": "Transfers are compulsory and will be added to the hotel booking manually. Return
by speed boat transfers US$ 157.89 per adult, US$78.95 per child 2 - 14yrs & infants below 1yr.
Complimentary. Above rates are valid from 01 November 2019 to 31 October 2020. Upon exiting the
customs area, guests enter the Arrival Hall, then proceed to the nearby Crown & Champa Resorts’
booth, #59, here an airport representative will be able to assist with the next steps of the journey.
Guests usually wait no longer than an hour at the Airport before a scheduled speedboat transfer
departs to Meeru. In rare instances, such as international flight arrival is delays or a baggage claims,
guests will need a special form and in this case boat departure time maybe extended.\r\nThe last
speedboat departure from Meeru to the airport is scheduled no later \r\nthan 1900hrs.\r\nThe last
speedboat departure from the airport to Meeru is scheduled no later \r\nthan 0200hrs. \r\nGuests
who cannot connect with the 0200hrs speedboat departure from the airport to Meeru, may choose to
overnight at Champa Central Hotel, Male', or remain at the airport. \r\n\r\n\r\nTo book transfers,
please access the manage my booking facility on our web-site, using your booking reference number
and name. You will then be able to raise a CSR (Customer Support Request), advising us of the
transfers you require."
},
{
"Title": "Notice",
"Description": "Unless stated in the room description, your hotel booking will NOT include a
speedboat, seaplane or domestic flight transfer from Male to your hotel. Pre booked resort transfers
are a mandatory requirement for entry into the Maldives and MUST be booked prior to travel. If you
have not selected a transfer already, please return to the transfer option page to add these to your
booking. If you do not wish to book these transfers then you must make arrangements directly with
the resort prior to travel. Please note, seaplane transfers only operate in daylight hours between 6am

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 36 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 and 5pm. If your international flight arrives or departs between 3pm and 9am, where available, please
choose the domestic flight option, or contact us to discuss your transfer options."
},
{
"Title": "Notice",
"Description": "Please note that recent immigration requirements in the Maldives stipulate that
non machine readable passports will no longer be accepted on arrival at Male International Airport. As
such please be aware that all customers travelling to the Maldives MUST ensure that they are
travelling on a biometric passport in order to board their flight. Most UK passports issued since 2006
will be biometric, however please check this is the case before booking."
},
{
"Title": "Notice",
"Description": "Please note that clients travelling for wedding purposes and booking a room type
with \"Honeymooners\" remark in the room title will need to provide a valid marriage certificate (not
more than 12 months old)."
}
]
}

JSON Response with Local Charges, Board Basis, GetErrataCategory and Tax Breakdown
{
"Establishment": {
"EstablishmentId": 111761,
"Rooms": [
{
"Code": "CGISBzMyNzk1MTUaBzEzMzcwODc=",
"Description": "Club Sea View Room",
"QuantityAvailable": 999,
"SupplierId": 98,
"SupplierName": "dnata Contract Hotels",
"IsDirectContract": true,
"Boards": [
{
"Type": 5,
"Code": "CgE1",
"Description": "All Inclusive",
"GrossCost": {
"Amount": 19671.12,
"Currency": "AED",
"TaxBreakDown": {
"Amount": 18734.4,
"Vat": 936.72
}
},
"NetCost": {
"Amount": 18214.0,
"Currency": "AED",
"TaxBreakDown": {
"Amount": 17346.67,

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 37 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Vat": 867.33
}
},
"NonRefundable": false,
"IsPayAtHotel": false,
"IsBindingPrice": false,
"IsOnRequest": false,
"RequestedRoomIndex": 0,
"CancellationPolicy": {
"CancellationCharges": [
{
"Charge": {
"Amount": 18214.0035,
"Currency": "AED",
"TaxBreakDown": {
"Amount": 17346.67,
"Vat": 867.3335
}
},
"ExpiryDate": "2019-11-14T23:59:59",
"ExpiryDateUTC": "2019-11-14T23:59:59Z"
},
{
"Charge": {
"Amount": 2602.005,
"Currency": "AED",
"TaxBreakDown": {
"Amount": 2478.1,
"Vat": 123.905
}
},
"ExpiryDate": "2019-11-06T23:59:59",
"ExpiryDateUTC": "2019-11-06T23:59:59Z"
}
]
},
"BookingConditions": "",
"SpecialOfferText": "",
"LongSpecialOfferText": "",
"PreOpaqueNetCost": null,
"GrossDiscount": null,
"LocalCharges": [
{
"Amount": {
"Amount": 50.0,
"Currency": "AED"
},
"Title": "Deposit",
"Description": "50.00 AED off booking value",
"IsPerBooking": true
},
{
"Amount": {
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 38 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Amount": 140.0,
"Currency": "AED"
},
"Title": "Tourism Tax",
"Description": "20.00 AED per room per night * 7 night(s)",
"IsPerBooking": false
}
],
"BoardBasis": {
"Inclusions": [],
"Exclusions": [],
"SupplierBoardTypeId": "0"
}
}
]
}
]
},
"InfoItems": [
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "“With bookings that include children, please note that the children may be
accommodated in the existing bedding and not in separate beds. An extra bed can often be provided
at an extra charge pre travel or locally if required.”"
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "With bookings that include children, please note that the children may be
accommodated in the existing bedding and not in separate beds. An extra bed can often be provided
at an extra charge pre travel or locally if required."
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "Check-in and check-out time:\r\nCheck in time is 15:00, check out time is 12:00. All
guests arriving before 15:00 will be accommodated as rooms become available. Baggage may be
checked in for those arriving early if rooms are unavailable."
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "DINE AROUND OPTION:\r\n•\tIn case guest would like to experience one of our
specialty restaurants (“Peacock” Chinese restaurant, “Ciao” Italian restaurant, or “Al Hadiqa” Lebanese
restaurant) Guest can select a tailor-made restaurant set menus or a credit amount of AED 100 per
person on a la carte order(exclusive of hotel bars), during the restaurant operating hours.
\r\n•\tExceeding this amount guests will be charged accordingly.\r\n•\tHalf or Full Board meals
cannot be taken in the Beach Bar, Beach Lawns or at special events.\r\n•\tShould the guest consume
from the above outlets or events, the hotel will charge the published selling price.\r\n•\tThe guest will
not be reimbursed for the un-consumed meal plan nor will the hotel reimburse the difference"
},
{
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 39 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "ErrataCategory": 0,
"Title": "Notice",
"Description": "RECREATION FACILITIES:\r\nFree of Charge for the hotel guest:\tSheraton Beach
and Sheraton Fitness Club, Pool and beach access including loungers. Subject to change without prior
notice.\r\nAt a charge:\tWater Sports: Lease of sports and any water sports equipment. \r\nArmonia
Spa: Massage, treatments and therapies"
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "CLUB ROOM BENEFITS:\r\n•\tWelcome drink upon arrival\r\n•\tBreakfast is served
in the Club Lounge only\r\n•\tHouse brand cocktails and light snacks/pastries/finger sandwiches
served every evening (17:30-20:00) in the Club Lounge(timing may change during Ramadan period and
religious holidays\r\n•\tCookies and Arabic sweets\r\n•\tTea, coffee, soft drinks served throughout
the day in our Club Lounge only until 23:00\r\n•\tShoe shine upon request\r\n•\tIce delivery to the
room upon request\r\n(Any of the above services are subject to change without prior notice)"
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "Mandatory Charges:\r\nTourism Dirham Fee is AED20 per bedroom per night,
payable at the Hotel by the guest upon check out"
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "Parking: Hotel offers complimentary self –parking and valet parking"
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "Check-in time is 15:00, check-out time is 12:00. All guests arriving before 15:00 will
be accommodated as rooms become available. Baggage may be checked-in for those arriving early if
rooms are unavailable."
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "Please note that religious holidays are usually ‘Dry Days’ where alcohol and
entertainment are prohibited.\r\nThe exact dates are subject to the sighting of the moon and
therefore the actual date is subject to change and may differ from the dates advised. \r\n\r\n2019
approximate dates as follows: \r\n01-Jan-19, 03-Apr-19, 05-May-19 until 04-Jun-19, 05 Jun-19 & 06-
Jun-19, 11 -Aug-19, 12-Aug-19, 01-Sep-19, 30-Nov-19, 10 Nov-19, 02-Dec-19.\r\n\r\nExact dates are
usually advised closer to the date, but may not be advised until customers arrive at their destination.
\r\n\r\nPlease also note that some excursions will not be available on religious days and also public
holidays, please enquire for details."
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "The Tourism Dirham Fee (TD Fee) will be applicable and paid upon checkout for
each bedroom allocated for the stay. This applies for all nights stayed. The fee per bedroom per night
is as follows; 5 star hotels & deluxe hotels apartments AED 20, 4 star hotels & superior hotel
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 40 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 apartments AED 15, 3 star hotels & standard hotel apartments AED 10. The TD Fee is not included in
the room rate."
},
{
"ErrataCategory": 0,
"Title": "Notice",
"Description": "Please note that religious holidays are usually ‘Dry Days’, on these days hotels &
restaurants refrain from serving alcoholic drinks and hosting live entertainment for 24 hours. The exact
dates are subject to the sighting of the moon and therefore the actual date is subject to change and
may differ from the dates advised. 2019 approximate dates as follows: 03-Apr-19, 04-Jun-19, 05-Jun-
19, 10-Aug-19, 11-Aug-19, 01-Sep-19 & 9-Nov-19. Please also note that some excursions will not be
available on religious days and also public holidays, kindly enquire for details."
}
]
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 41 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Create Booking
ENDPOINT POST https://apici.yalago.com/hotels/bookings/create

Request Fields

Object Field Type Requ Comments

ired
CREATEBOOKINGRE AffiliateRef String Y The affiliate's internal
unique reference for
QUEST the booking
CheckInDate Date Y Arrival date (yyyy-mm-
dd)
CheckOutDate Date Y Departure date (yyyy-
mm-dd)
EstablishmentId Integer Y The id of the requested
hotel
Culture String Y The language to return
text field in if available
(Default "en-GB")
Rooms List of Y A collection of room
occupancy details
BOOKINGROOM
ContactDetails CONTACTDETAILS Y An object containing
customer contact
information
PaymentMethod PAYMENTMETHOD N An object containing
payment details.
Required for pay-direct
rates
GetPackagePrice Boolean N Attribute to include or
exclude package rates.

True: Package rates are

included

False: Package rates are

excluded
IsFlightPlus Boolean N Attribute to include or
exclude flight rates.

True: Flight rates are

included

False: Flight rates are

excluded
SourceMarket String N Customer’s market
region
GetLocalCharges Bookean N Will include the Local
charges tags in the
responses

Local charges are

payable at the hotel
and exclusive of the
room rate
GetTaxBreakdown Boolean N Will include additional
tax breakdown
information on
net/gross rates as
required
GetErrataCategory Boolean N Attribute to include or
exclude Errata
Categories
True: Errata Categories
are included

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 42 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 False: Errata Categories
are excluded

Errata Categories are

the classification of the
Key information
provided by the Hotel
GetBoardBasis Boolean N Attribute to include or
exclude Board Basis
True: Board Basis are
included
False: Board Basis are
excluded

Board Basis provides

the services included
and excluded in the
chosen Meal Plan
CurrencyCode String N The three-letter
currency code

Depends on the
Currency that is set up
in Client’s account

Please refer to
Currencies in Tables for
the list of codes
**FlightDetails FLIGHTDETAIL N This field is
MANDATORY in the
information confirmation request If
Extras returned
‘RequiresFlightDetails=
true’ from Details
response
**FLIGHTDETAIL IsFlightOutbound Boolean N True: Exit transfer
schedule from location
(Maldives, Mauritius,
etc)

False: Entry transfer

schedule from location
(Maldives, Mauritius,
etc)
ArriveDate Date Y Arrival date of the flight
(yyyy-mm-ddThh-mm-
ss)
DepartDate Date Y Departure date of the
flight (yyyy-mm-ddThh-
mm-ss)
Number Integer Y Flight Number: 2 Letter
+ up to 6 Digit number
(AA123456)
From String N IATA Code & name of
city
To String N IATA Code & name of
city
BOOKINGROOM AffiliateRoomRef Y The affiliate's internal
unique reference for
the booking room
RoomCode String Y The booking code of the
requested room
BoardCode String Y The booking code of the
requested board
ExpectedCost MONEY N The expected gross cost
of the room.

Both ExpectedCost and

ExpectedNetCost to be

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 43 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 sent in the Booking
Request if the room is
IsBindingPrice = true
ExpectedNetCost MONEY Y The expected net cost
of the room. If room is
IsBindingPrice = false,
Booking request may be
sent with
‘ExpectedNetCost’ only

Both ExpectedCost and

ExpectedNetCost to be
sent in the Booking
Request if the room is
IsBindingPrice = true
Guests List of GUEST Y A collection of details
for each guest staying
in the room
SpecialRequests String N Any special
requirements for the
guests in this room
**Extras BOOKEDROOMEXT N List of extra services

RA
**BOOKEDROOMEX ExtraId Integer N Internal identifier of the
extra service.
TRA
OptionId Integer N Internal identifier of the
different extra options
(speed boat, plane…)
ExpectedNetCost MONEY N The cost of the extra
service, excluding
commission
ExpectedCost MONEY N The recommended
selling price to the end
customer, including
affiliate commission
CONTACTDETAILS Title String Y The contact's title

FirstName String Y The contact's first name

LastName String Y The contact's last name

DateOfBirth Date N The contact's date of

birth
(yyyy-mm-dd)
Address1 String N The 1st line of the
contact's address
Address2 String N The 2nd line of the
contact's address
Address3 String N The 3rd line of the
contact's address
Town String N The town of the
contact's address
County String N The county of the
contact's address
PostCode String N The contact's postal
code
Country String N The contact's country of
residence
EmailAddress String N The contact's email
address
HomeTel String N The contact's home
telephone number
MobileTel String N The contact's mobile
telephone number
WorkTel String N The contact's work
telephone number

PAYMENTMETHOD CardNumber String Y The long number on the

card
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 44 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 CardType String Y See card types

SecurityCode String Y The 3 digits on the back

of the card
IssueNumber String N Required for switch /
solo
StartMonth Integer N Required for switch /
solo
StartYear Integer N Required for switch /
solo
EndMonth Integer Y The card's expiry month
(01-12)
EndYear Integer Y The card's expiry year
(4 digit)

GUEST Title String Y The guest's title

FirstName String Y The guest's first name

LastName String Y The guest's last name

Age Integer Y For adults, this value

should be any integer
>= 18. For children and
infants, it should be
their age on the day of
check-out.

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 45 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Response Fields

Object Field Type Comments

CREATEBOOKING Bookings List of BOOKING A collection of the
Yalago bookings that
RESPONSE have been made – one
per currency

BOOKING BookingRef String The unique id of the

Yalago booking
Status Integer See booking statuses

Establishment ESTABLISHMENTDETAILS Details of the booked

establishment
Rooms List of BOOKEDROOM A collection of the
rooms that have been
booked
InfoItems List of INFOITEM A collection of
important information
texts
ErrorMessage String If the booking has
failed, gives details of
the error that occurred

ESTABLISHMENTDETAILS EstablishmentId Integer The id of the booked

establishment
Name String The name of the
establishment

BOOKEDROOM BookRoomId Integer The unique id of the

Yalago booking room
AffiliateRoomRef String The affiliate's internal
unique reference for
the booked room
Description String Description of the room
booked
Board String Description of the
board booked
RoomCode String The room code of the
requested room
BoardCode String The board code of the
requested room
ProviderRef String The hotel’s reference
for this booking.
ProviderName String The provider that this
booking is placed with.
Guests List of GUEST A collection of details
for each guest staying in
the room
GUEST Title String The guest's title

FirstName String The guest's first name

LastName String The guest's last name

Age Integer The guest's age on the

day of check-out

GrossCost MONEY The recommended

selling price to the end
customer, including
affiliate commission
NetCost MONEY The cost to the affiliate,
excluding commission
SpecialRequests String Any special requests
from the customer to
pass onto the hotel

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 46 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 NonRefundable Boolean Indicates that the cost
of this room is non-
refundable
IsBindingPrice Boolean If TRUE, indicates that
the gross cost is a fixed
selling price

LOCALCHARGES Amount LOCALCHARGESAMOUNT The amount (inclusive

of tax if applicable)
Title String The heading of the
Local Charge
Description String Description of the Local
Charges
IsPerBooking Boolean Indicates whether the
local charge is applied
per booking or per
room
BoardBasis List of INCLUSIONS and Inclusive and Exclusive
services of the board
EXCLUSIONS basis;

if request has
GetBoardBasis=true,
Board inclusions and
exclusions are provided
SupplierBoardTypeId Integer Board Type ID from
GetSupplierBoardTypes
INCLUSIONS InclusionId Integer Inclusions ID from
GetBoardTypeInclusions

Inclusive service of the

board basis
ReplacementText String Additional information
of the Board Basis
EXCLUSIONS InclusionId Integer Inclusions ID from
GetBoardTypeInclusions

Exclusive service of the

board basis
ReplacementText String Additional information
of the Board Basis

**Extras BOOKEDROOMEXTRA
**BOOKEDROOMEXTRA ExtraTypeId Integer Internal identifier of the
type of service provided
ExtraId Integer Internal identifier of the
extra service
ExtraTitle String Name of the service

OptionId Integer Internal identifier of the

different extra options
(speed boat, plane….)
OptionTitle String Name of the Extra
service option
GrossCost MONEY The recommended
selling price to the end
customer, including
affiliate commission
NetCost MONEY The cost of the extra
service, excluding
commissions

** Infoitems List of INFOITEM List of Infoitems

ERRATACATEGORY Id Integer If GetErratacatogory =

true from the request,

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 47 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 ErrataCategory id is
provided

See GetErrataCategory
to get Errata details.
INFOITEM Title String The heading of the info
item

If GetErratacatogory =
false from the request,
only InfoItem details is
provided
Definition String The body text of the
info item

Example Request
JSON Booking Confirmation Request

{
"AffiliateRef": "11102019-001",
"CheckInDate": "2019-11-05T00:00:00Z",
"CheckOutDate": "2019-11-09T00:00:00Z",
"EstablishmentId": 1490812,
"Rooms": [
{
"Guests": [
{
"Title": "Mr",
"FirstName": "Alvaro",
"LastName": "Yalago",
"Age": 45
},
{
"Title": "Mr",
"FirstName": "Alvaro",
"LastName": "Yalago Jr",
"Age": 18
}
],
"RoomCode": "CGISBzQwMjE2NzcaBzExMjg5ODg=",
"BoardCode": "CgE0",
"ExpectedNetCost": {
"Amount": 1713.94,
"Currency": "USD"
},
"AffiliateRoomRef": "room1",
"SpecialRequests": "non smoking room",
"Extras": [
{
"ExtraId": "16",
"OptionId": "18",
"ExpectedCost": {
"Amount": 0.0,
"Currency": "GBP"
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 48 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 },
"ExpectedNetCost": {
"Amount": 1010.1,
"Currency": "USD"
}
}
]
}
],
"Culture": "en-gb",
"ContactDetails": {
"Title": "Mr",
"FirstName": "Alvaro",
"LastName": "Yalago",
"Address1": "Test st",
"Address2": "Address City",
"County": "",
"PostCode": "12345",
"Country": "",
"EmailAddress": "[email protected]",
"WorkTel": ""
},
"GetPackagePrice": true,
"SourceMarket": "GB",
"FlightDetails": [
{
"IsFlightOutbound": true,
"ArriveDate": "2019-11-05T00:00:00Z",
"DepartDate": "2019-11-09T00:00:00Z",
"Number": "AAA123456",
"From": "DXB",
"To": "ALC"
},
{
"IsFlightOutbound": false,
"ArriveDate": "2019-11-05T00:00:00Z",
"DepartDate": "2019-11-09T00:00:00Z",
"Number": "BBB123456",
"From": "ALC",
"To": "DXB"
}
],
"GetTaxBreakdown": false,
"GetLocalCharges": false,
"GetErrataCategory": false,
"GetBoardBasis": false,
"CurrencyCode": "USD"
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 49 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Example Response
JSON Booking Confirmation Response

{
"BookingRef": "YAC/14212571",
"Status": 2,
"Establishment": {
"EstablishmentId": 1670743,
"Name": "Anantara Veli Resort And Spa",
"EstablishmentInfo": null
},
"Rooms": [
{
"BookRoomId": 1,
"AffiliateRoomRef": "YAL16102018Extras2-0",
"Description": "Deluxe Over Water Bungalow",
"Board": "Full Board",
"RoomCode": "CGISBzI5NTYyMzAaBTMyNjQ1",
"BoardCode": "CgE0EAE=",
"ProviderRef": "2149585",
"ProviderName": "Anantara Veli Resort And Spa",
"Guests": [
{
"Title": null,
"FirstName": "test",
"LastName": "one",
"Age": 18
},
{
"Title": null,
"FirstName": "test",
"LastName": "two",
"Age": 18
}
],
"GrossCost": null,
"NetCost": {
"Amount": 4187.26,
"Currency": "GBP"
},
"SpecialRequests": "",
"NonRefundable": true,
"Extras": [
{
"ExtraTypeId": "2",
"ExtraId": "9",
"ExtraTitle": "Transfers",
"OptionId": "16",
"OptionTitle": "Combined Return Speedboat Transfer",
"GrossCost": null,
"NetCost": {
"Amount": 303.56,
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 50 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Currency": "GBP"
}
},
{
"ExtraTypeId": "3",
"ExtraId": "15",
"ExtraTitle": "Disney Tickets",
"OptionId": "26",
"OptionTitle": "Tickets to Disney",
"GrossCost": null,
"NetCost": {
"Amount": 233.51,
"Currency": "GBP"
}
}
],
"IsBindingPrice": false
}
],
"InfoItems": [
{
"Title": "Notice",
"Description": "Baan Huraa, our Thai specialty restaurant on Anantara Veli Resort, will be
temporarily closed for upgrading works from 1 November to 23 December 2016. When it reopens in
time for the yearend festivities, the contemporary yet elegant interior of Baan Huraa will complement
the authentic Thai flavours by our culinary team beautifully. Baan Huraa, whose name means 'House
on a Reef', is not only one of our most popular restaurants, it is a special house that reflects our Thai
roots. We want this upgrade to be a celebration of excellence in what we offer our guests - both in our
food and in the indulgent environs. We look forward to welcoming Baan Huraa diners from 24
December 2016. In the meantime, we trust that the dining options at Anantara Dhigu Resort, Anantara
Veli Resort and Naladhu Maldives will continue to provide guests with varied choices and
temptations."
},
{
"Title": "Accommodation Information",
"Description": "Unless stated in the room description, your hotel booking will NOT include a
speedboat or seaplane transfer from Male to your hotel. We will contact you shortly after booking to
confirm cost of transfer and to confirm flight times if we do not have them."
},
{
"Title": "Notice",
"Description": "Transfers are a compulsory requirement for entry into The Maldives and must be
arranged prior to travel, except for hotels in the capital city of Male. \r\nUnless stated in the room
description, your hotel booking will NOT include a speedboat or seaplane transfer from Male to your
hotel. If you do not have transfers booked, you will incur extra costs and delays locally. \r\nPlease
contact us before departure to book transfers if you do not already have this arranged."
},
{
"Title": "Notice",
"Description": "<br/>\r\nPlease note that recent immigration requirements in the Maldives
stipulate that non machine readable passports will no longer be accepted on arrival at Male
International Airport. As such please be aware that all customers travelling to the Maldives MUST

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 51 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 ensure that they are travelling on a biometric passport in order to board their flight. Most UK
passports issued since 2006 will be biometric, however please check this is the case before booking."
},
{
"Title": "Notice",
"Description": "Please select a transfer from the Choose Extras section above, or call our sales team
if one is not available. If you do not wish to book your transfer with us then you must make
arrangements directly with the resort prior to travel. Seaplanes in Maldives only travel during daylight
hours. Domestic flights operate daytime and night time to a seasonal schedule. Luggage allowance on
Seaplanes and Domestic flights is 20KG of checked luggage per person and 5KG of hand luggage per
person only.\r\nPlease note that recent immigration requirements in the Maldives stipulate that non
machine readable passports will no longer be accepted on arrival at Male International Airport. As
such please be aware that all customers travelling to the Maldives MUST ensure that they are
travelling on a biometric passport in order to board their flight. Most UK passports issued since 2006
will be biometric, however please check this is the case before booking."
},
{
"Title": "Mandatory Extra Customer Note",
"Description": "Speedboat transfer"
},
{
"Title": "Mandatory Extra Customer Note",
"Description": "Disney Entry tickets"
}
],
"ErrorMessage": null,
"Errors": null,
"CheckInDate": "2018-10-30T00:00:00",
"CheckOutDate": "2018-11-06T00:00:00",
"AffilateRef": "YAL16102018Extras2",
"Bookings": [
{
"BookingIndex": 0,
"BookingRef": "YAC/14212571",
"Status": 2,
"Establishment": {
"EstablishmentId": 1670743,
"Name": "Anantara Veli Resort And Spa",
"EstablishmentInfo": null
},
"Rooms": [
{
"BookRoomId": 1,
"AffiliateRoomRef": "YAL16102018Extras2-0",
"Description": "Deluxe Over Water Bungalow",
"Board": "Full Board",
"RoomCode": "CGISBzI5NTYyMzAaBTMyNjQ1",
"BoardCode": "CgE0EAE=",
"ProviderRef": "2149585",
"ProviderName": "Anantara Veli Resort And Spa",
"Guests": [
{
"Title": null,
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 52 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "FirstName": "test",
"LastName": "one",
"Age": 18
},
{
"Title": null,
"FirstName": "test",
"LastName": "two",
"Age": 18
}
],
"GrossCost": null,
"NetCost": {
"Amount": 4187.26,
"Currency": "GBP"
},
"SpecialRequests": "",
"NonRefundable": true,
"Extras": [
{
"ExtraTypeId": "2",
"ExtraId": "9",
"ExtraTitle": "Transfers",
"OptionId": "16",
"OptionTitle": "Combined Return Speedboat Transfer",
"GrossCost": null,
"NetCost": {
"Amount": 303.56,
"Currency": "GBP"
}
},
{
"ExtraTypeId": "3",
"ExtraId": "15",
"ExtraTitle": "Disney Tickets",
"OptionId": "26",
"OptionTitle": "Tickets to Disney",
"GrossCost": null,
"NetCost": {
"Amount": 233.51,
"Currency": "GBP"
}
}
],
"IsBindingPrice": false
}
],
"InfoItems": [
{
"Title": "Notice",
"Description": "Baan Huraa, our Thai specialty restaurant on Anantara Veli Resort, will be
temporarily closed for upgrading works from 1 November to 23 December 2016. When it reopens in
time for the yearend festivities, the contemporary yet elegant interior of Baan Huraa will complement
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 53 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 the authentic Thai flavours by our culinary team beautifully. Baan Huraa, whose name means 'House
on a Reef', is not only one of our most popular restaurants, it is a special house that reflects our Thai
roots. We want this upgrade to be a celebration of excellence in what we offer our guests - both in our
food and in the indulgent environs. We look forward to welcoming Baan Huraa diners from 24
December 2016. In the meantime, we trust that the dining options at Anantara Dhigu Resort, Anantara
Veli Resort and Naladhu Maldives will continue to provide guests with varied choices and
temptations."
},
{
"Title": "Accommodation Information",
"Description": "Unless stated in the room description, your hotel booking will NOT include a
speedboat or seaplane transfer from Male to your hotel. We will contact you shortly after booking to
confirm cost of transfer and to confirm flight times if we do not have them."
},
{
"Title": "Notice",
"Description": "Transfers are a compulsory requirement for entry into The Maldives and must be
arranged prior to travel, except for hotels in the capital city of Male. \r\nUnless stated in the room
description, your hotel booking will NOT include a speedboat or seaplane transfer from Male to your
hotel. If you do not have transfers booked, you will incur extra costs and delays locally. \r\nPlease
contact us before departure to book transfers if you do not already have this arranged."
},
{
"Title": "Notice",
"Description": "<br/>\r\nPlease note that recent immigration requirements in the Maldives
stipulate that non machine readable passports will no longer be accepted on arrival at Male
International Airport. As such please be aware that all customers travelling to the Maldives MUST
ensure that they are travelling on a biometric passport in order to board their flight. Most UK
passports issued since 2006 will be biometric, however please check this is the case before booking."
},
{
"Title": "Notice",
"Description": "Please select a transfer from the Choose Extras section above, or call our sales
team if one is not available. If you do not wish to book your transfer with us then you must make
arrangements directly with the resort prior to travel. Seaplanes in Maldives only travel during daylight
hours. Domestic flights operate daytime and night time to a seasonal schedule. Luggage allowance on
Seaplanes and Domestic flights is 20KG of checked luggage per person and 5KG of hand luggage per
person only.\r\nPlease note that recent immigration requirements in the Maldives stipulate that non
machine readable passports will no longer be accepted on arrival at Male International Airport. As
such please be aware that all customers travelling to the Maldives MUST ensure that they are
travelling on a biometric passport in order to board their flight. Most UK passports issued since 2006
will be biometric, however please check this is the case before booking."
},
{
"Title": "Mandatory Extra Customer Note",
"Description": "Speedboat transfer"
},
{
"Title": "Mandatory Extra Customer Note",
"Description": "Disney Entry tickets"
}
],
"ErrorMessage": null,
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 54 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "CheckInDate": "2018-10-30T00:00:00",
"CheckOutDate": "2018-11-06T00:00:00",
"AffilateRef": "YAL16102018Extras2"
}
]
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 55 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Get Booking
ENDPOINT POST https://apici.yalago.com/hotels/bookings/getbooking

Request Fields

Object Field Type Required Comments

GETBOOKINGREQUEST BookingRef String Y The unique id of the Yalago
booking
GetTaxBreakdown Boolean N Will include additional tax
breakdown information on
net/gross rates as required
GetLocalCharges Bookean N Will include the Local charges
tags in the responses

Local charges are payable at

the hotel and exclusive of the
room rate
GetErrataCategory Boolean N Attribute to include or exclude
Errata Categories
True: Errata Categories are
included
False: Errata Categories are
excluded

Errata Categories are the

classification of the Key
information provided by the
Hotel
GetBoardBasis Boolean N Attribute to include or exclude
Board Basis
True: Board Basis are included
False: Board Basis are
excluded

Board Basis provides the

services included and
excluded in the chosen Meal
Plan

Example Request

{
"BookingRef": "YAC/14207525",
"GetTaxBreakdown": false,
"GetLocalCharges": false,
"GetErrataCategory": false,
"GetBoardBasis": false
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 56 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Response Fields

Object Field Type Comments

GETBOOKINGRESPONSE BookingRef String The unique id of the
Yalago booking
Status Integer See booking statuses

Establishment ESTABLISHMENTDETAILS Details of the booked

establishment
Rooms List of BOOKEDROOM A collection of the rooms
that have been booked
InfoItems List of INFOITEM A collection of important
information texts
CheckInDate Date Arrival date (yyyy-mm-dd)

CheckOutDate Date Departure date (yyyy-mm-

dd)
CancellationCharge MONEY The cost charged to the
affiliate for any cancelled
rooms
ContactDetails CONTACTDETAILS An object containing
customer contact
information

ESTABLISHMENTDETAILS EstablishmentId Integer The id of the booked

establishment
Name String The name of the
establishment

BOOKEDROOM If the whole booking has

been cancelled, then all
rooms will be returned,
otherwise just uncancelled
rooms.
BookRoomId Integer The unique id of the
Yalago booking room
AffiliateRoomRef String The affiliate's internal
unique reference for the
booked room
Description String Description of the room
booked
Board String Description of the board
booked
RoomCode String The room code of the
requested room
BoardCode String The board code of the
requested room
ProviderRef String The hotel’s reference for
this booking. To be passed
on to the customer.
ProviderName String The provider that this
booking is placed with. To
be passed on to the
customer.
Guests List of GUEST A collection of details for
each guest staying in the
room
GrossCost MONEY The recommended selling
price to the end customer,
including affiliate
commission
NetCost MONEY The cost to the affiliate,
excluding commission
SpecialRequests String Any special requests from
the customer to pass onto
the hotel

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 57 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 NonRefundable Boolean Indicates that the cost of
this room is non-
refundable
IsBindingPrice Boolean If TRUE, indicates that the
gross cost is a fixed selling
price
**Extras BOOKEDROOMEXTRA
**BOOKEDROOMEXTRA ExtraTypeId Integer Internal identifier of the
type of service provided
ExtraId Integer Internal identifier of the
extra service
ExtraTitle String Name of the service

OptionId Integer Internal identifier of the

different extra options
(speed boat, plane….)
OptionTitle String Name of the Extra service
option
GrossCost MONEY The recommended selling
price to the end customer,
including affiliate
commission
NetCost MONEY The cost of the extra
service, excluding
commissions

LOCALCHARGES Amount LOCALCHARGESAMOUNT The amount (inclusive of

tax if applicable)
Title String The heading of the Local
Charge
Description String Description of the Local
Charges
IsPerBooking Boolean Indicates whether the
local charge is applied per
booking or per room

BoardBasis List of INCLUSIONS and Inclusive and Exclusive

services of the board basis;
EXCLUSIONS
if request has
GetBoardBasis=true,
Board inclusions and
exclusions are provided
SupplierBoardTypeId Integer Board Type ID from
GetSupplierBoardTypes
INCLUSIONS InclusionId Integer Inclusions ID from
GetBoardTypeInclusions

Inclusive service of the

board basis
ReplacementText String Additional information of
the Board Basis
EXCLUSIONS InclusionId Integer Inclusions ID from
GetBoardTypeInclusions

Exclusive service of the

board basis
ReplacementText String Additional information of
the Board Basis

GUEST Title String The guest's title

FirstName String The guest's first name

LastName String The guest's last name

Age Integer The guest's age on the day

of check-out

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 58 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 MONEY Amount Decimal The amount

Currency String The three-letter currency

code

** Infoitems List of INFOITEM List of Infoitems

ERRATACATEGORY Id Integer If GetErratacatogory = true

from the request,
ErrataCategory id is
provided

See GetErrataCategory to
get Errata details.
INFOITEM Title String The heading of the info
item

If GetErratacatogory =
false from the request,
only InfoItem details is
provided
Definition String The body text of the info
item

CONTACTDETAILS Title String The contact's title

FirstName String The contact's first name

LastName String The contact's last name

DateOfBirth Date The contact's date of birth,

if known
(yyyy-mm-dd or null)
Address1 String The 1st line of the
contact's address
Address2 String The 2nd line of the
contact's address
Address3 String The 3rd line of the
contact's address
Town String The town of the contact's
address
County String The county of the
contact's address
PostCode String The contact's postal code

Country String The contact's country of

residence
EmailAddress String The contact's email
address
HomeTel String The contact's home
telephone number
MobileTel String The contact's mobile
telephone number
WorkTel String The contact's work
telephone number

Example Response

{
"BookingRef": "YAC/17157105",
"Status": 2,
"Establishment": {
"EstablishmentId": 1490806,
"Name": "Komandoo Island Resort Hotel",
"EstablishmentInfo": null
},
"Rooms": [
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 59 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 {
"BookRoomId": 1,
"AffiliateRoomRef": "room1",
"Description": "Jacuzzi Beach Villa",
"Board": "Full Board",
"RoomCode": "CGISBzQ2NDIzNDkaBzExNjk3NjY=",
"BoardCode": "CgE0",
"ProviderRef": "2715123",
"ProviderName": "Komandoo Island Resort Hotel",
"Guests": [
{
"Title": "xx",
"FirstName": "yyyy",
"LastName": "zzzz",
"Age": 30
},
{
"Title": "Mr",
"FirstName": "Guest",
"LastName": "Two",
"Age": 21
}
],
"GrossCost": null,
"NetCost": {
"Amount": 1038.0,
"Currency": "USD"
},
"SpecialRequests": "",
"NonRefundable": false,
"Extras": [
{
"ExtraTypeId": "2",
"ExtraId": "34",
"ExtraTitle": "Transfer",
"OptionId": "42",
"OptionTitle": "Return Seaplane Transfer",
"GrossCost": null,
"NetCost": {
"Amount": 780.0,
"Currency": "USD"
}
}
],
"IsBindingPrice": false,
"LocalCharges": []
}
],
"InfoItems": [
{
"Title": "Notice",
"Description": "Transfers are compulsory and will be added to the hotel booking manually. Return
by Seaplane Transfers. US$410.53 per adult. Above rate is valid from 01 May 2019 to 31 October 2019.
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 60 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Seaplane is available during daylight only and subject to weather conditions. Baggage allowance is
20kg per person. In extraordinary circumstances, luggage may be transported by boat or by a later
flight. In case of cancellation received one day or less prior to date of arrival a charge of US$205.26 per
adult will be collected from the guest upon arrival at Resort. The same rate applies for Rebooking after
No Show."
},
{
"Title": "Accommodation Information",
"Description": "Unless stated in the room description, your hotel booking will NOT include a
speedboat or seaplane transfer from Male to your hotel. We will contact you shortly after booking to
confirm cost of transfer and to confirm flight times if we do not have them."
},
{
"Title": "Notice",
"Description": "Unless stated in the room description, your hotel booking will NOT include a
speedboat, seaplane or domestic flight transfer from Male to your hotel. Pre booked resort transfers
are a mandatory requirement for entry into the Maldives and MUST be booked prior to travel. If you
have not selected a transfer already, please return to the transfer option page to add these to your
booking. If you do not wish to book these transfers then you must make arrangements directly with
the resort prior to travel. Please note, seaplane transfers only operate in daylight hours between 6am
and 5pm. If your international flight arrives or departs between 3pm and 9am, where available, please
choose the domestic flight option, or contact us to discuss your transfer options."
},
{
"Title": "Notice",
"Description": "Please note that recent immigration requirements in the Maldives stipulate that
non machine readable passports will no longer be accepted on arrival at Male International Airport. As
such please be aware that all customers travelling to the Maldives MUST ensure that they are
travelling on a biometric passport in order to board their flight. Most UK passports issued since 2006
will be biometric, however please check this is the case before booking."
},
{
"Title": "Notice",
"Description": "Please note that clients travelling for wedding purposes and booking a room type
with \"Honeymooners\" remark in the room title will need to provide a valid marriage certificate (not
more than 12 months old)."
},
{
"Title": "Mandatory Extra Customer Note",
"Description": "On Arrival:\nOnce you have arrived at Male International Airport and you have
collected your luggage, then please exit the Arrivals Hall and immediately locate the airport
representative or desk with the name of the hotel you have booked. Please identify yourself to the
respective hotel's airport representative by showing a copy of your booking voucher. Since you have
booked a Seaplane transfer, you will immediately proceed to the TMA Seaplane counter where you
need to check-in for your seaplane transfer. In the unlikely event you should have any difficulty in
locating the TMA desk or if your flight has arrived late - please call the Diethelm Travel helpline where
an English speaking representative will help you. (If calling from a mobile, the international dialling
code must be dialled. If calling from a land line there is no need.). Please note that carry-on baggage
allowance on the seaplane is 5kg and checked in baggage is 20kg. Excess charges are US$5.00 per kg (+
GST) and applicable on both outward and return journeys. Please note, infants do not receive any
baggage allowance.\n\nOn Departure:\nThe pick up stated on your booking is only an estimated time
and will be confirmed to you by reception on the evening prior to departure day. Confirmation will be
either by way of a phone call to your hotel room or a message left with the hotel staff and delivered to
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 61 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 your room. In the unlikely event there is any confusion or misunderstanding - please call the Diethelm
Travel helpline where an English speaking representative will help you. (If calling from a mobile, the
international dialling code must be dialled. If calling from a land line there is no need.) \n\nTelephone
Number: 24 hrs: Shareek Rasheed +960 7407606\nMobile: 24 hrs: Howard Brohier +960 7991106"
}
],
"CheckInDate": "2019-10-22T00:00:00Z",
"CheckOutDate": "2019-10-25T00:00:00Z",
"CancellationCharge": {
"Amount": 0.0,
"Currency": "USD"
},
"ContactDetails": {
"Title": "xx",
"FirstName": "yyyy",
"LastName": "zzzz",
"DateOfBirth": "",
"Address1": "",
"Address2": "",
"Address3": "",
"Town": "",
"County": "",
"PostCode": "",
"Country": "",
"EmailAddress": "",
"HomeTel": "",
"MobileTel": "",
"WorkTel": ""
}
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 62 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Get Cancellation Charges
ENDPOINT POST https://apici.yalago.com/hotels/bookings/getcancellationcharges

Request Fields

Object Field Type Required Comments

GETCANCELLATION BookingRef String Y The unique id of the Yalago
booking
CHARGESREQUEST
GetTaxBreakdown Boolean N Will include additional tax
breakdown information on
net/gross rates as required

Example Request

{
"BookingRef": "YAC/14207525",
" GetTaxBreakdown ": false
}

Response Fields

Object Field Type Comments

GETCANCELLATION IsCancellable Boolean Indicates if the booking can be
cancelled or not
CHARGESRESPONSE
Charge CANCELLATIONCHARGE Details of the cancellation
charge

CANCELLATIONCHARGE Charge MONEY The cost of cancelling the

booking
ExpiryDate Date Indicates how long this
cancellation charge response is
valid for
ExpiryDateUTC Date Indicates how long this
cancellation charge response is
valid for (Universal Time).
MONEY Amount Decimal The amount

Currency String The three-letter currency code

Example Response

{
"IsCancellable": true,
"Charge": {
"Charge": {
"Amount": 0.0,
"Currency": "EUR"
},
"ExpiryDate": "2018-09-15T03:57:42.7168273+1:00",
"ExpiryDateUTC": "2018-09-15T02:57:42.7168273Z”

},
"CancellationPolicyStatic": [
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 63 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 {
"CancellationCharges": [
{
"Charge": {
"Amount": 0.0,
"Currency": "EUR"
},
"ExpiryDate": "2018-09-24T22:59:59",
“ExpiryDateUTC”: "2018-09-24T22:59:59Z",
},
{
"Charge": {
"Amount": 586.99,
"Currency": "EUR"
},
"ExpiryDate": "2018-09-26T22:59:59",
“ExpiryDateUTC”: "2018-09-24T22:59:59Z",
}
],
"RoomName": "Family Room (Standard Family Room)"
}
]
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 64 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Cancel Booking
ENDPOINT POST https://apici.yalago.com/hotels/bookings/cancel

Request Fields

Object Field Type Required Comments

CANCELBOOKINGREQUEST BookingRef String Y The unique id of
the Yalago
booking
ExpectedCharge CANCELLATIONCHARGE Y Details of the
expected
cancellation
charge, see “Get
Cancellation
Charges”
CANCELLATIONCHARGE Charge MONEY Y The expected
cost of cancelling
the booking
MONEY Amount Decimal Y The amount

Currency String Y The three-letter

currency code

Example JSON Request

{
"BookingRef": "YAC/14809829",
"ExpectedCharge": {
"Charge": {
"Amount": 0.0,
"Currency": "USD"
}
}
}

Response Fields

Object Field Type Comments

CANCELBOOKINGRESPONSE BookingRef String The unique id of the Yalago booking

Status Integer See cancellation statuses

Messages String Any additional information

Example JSON Response

{
"BookingRef": "YAC/14809829",
"Status": 1,
"Messages": null
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 65 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Booking Search
This method can be used to get a list of Bookings.

ENDPOINT POST https://apici.yalago.com /hotels/bookings/search

Request Fields
Object Field Type Mandatory Comments

BookingsSearchRequest BookedOnDateFrom DateTime N A date time in ISO

8601 format (e.g
2017-02-
22T10:26:13Z)

*Atleast one date

range is required
for this call (
BookedOn or
CheckIn date
range)

*Date Range
should be 30 days
or less
BookedOnDateTo DateTime N A date time in ISO
8601 format (e.g
2017-02-
22T10:26:13Z)
CheckInDateFrom DateTime N A date time in ISO
8601 format (e.g
2017-02-
22T10:26:13Z)

*Atleast one date

range is required
for this call (
BookedOn or
CheckIn date
range)

*Date Range
should be 30 days
or less
CheckInDateTo DateTime N A date time in ISO
8601 format (e.g
2017-02-
22T10:26:13Z)
ProvinceId Integer N Yalago’s id for the
province
Status Integer N Current status of
Booking

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 66 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Response Fields

Object Field Type Comments

BookingsSearchResponse Bookings List of A list of Facilities

BOOKINGS

BOOKINGS SearchResult List of

SEARCHRESULT
Count Integer Count of Bookings

SEARCHRESULT BookingRef String The unique id of the Yalago

booking
AffiliateRef String The affiliate's internal unique
reference for the booking
Contact String Name of Contact Person or
Owner of the booking
Type String Type of booking – in Yalago’s
case, Accommodation
booking will be returned
Status Integer Current status of Booking

BookedOnDate DateTime A date time in ISO 8601

format (e.g 2017-02-
22T10:26:13Z)
CheckInDate DateTime A date time in ISO 8601
format (e.g 2017-02-
22T10:26:13Z)
CheckOutDate DateTime A date time in ISO 8601
format (e.g 2017-02-
22T10:26:13Z)
Province PROVINCE
INFO
NetAmount Decimal Cost of booking

Currency String The three-letter currency

code (ISO 4217)
MasterEstabId Integer Yalago establishment code

PROVINCE INFO ProvinceId Integer Yalago’s id for the Province

ProvinceName String The name of the Province

Example Request
JSON Booking Search Request
{
"BookedOnDateFrom": "2020-03-24T00:00:00",
"BookedOnDateTo": "2020-03-31T08:00:00",
"CheckInDateFrom": null,
"CheckInDateTo": null,
"ProvinceId": 0,
"Status": 2
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 67 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Example Response
JSON Booking Search Response
{
"Bookings": [
{
"BookingRef": "YAC/17200681",
"AffiliateRef": "cd8b24ec-d224-4bba-9de6-c583f6dd2ab2",
"Contact": "Mr userone Test",
"Type": "Accommodation",
"Status": 2,
"BookedOnDate": "2020-03-30T04:37:16.38",
"CheckInDate": "2020-04-02T00:00:00",
"CheckOutDate": "2020-04-03T00:00:00",
"Province": {
"ProvinceId": 54634,
"ProvinceName": "Dubai"
},
"NetAmount": 3513.94,
"Currency": "AED",
"MasterEstabId": 2041871
},
{
"BookingRef": "YAC/17200683",
"AffiliateRef": "ecebb35f-e375-4fc5-8ec2-4eecc3df29a4",
"Contact": "MR Test Codegen",
"Type": "Accommodation",
"Status": 2,
"BookedOnDate": "2020-03-30T04:56:53.597",
"CheckInDate": "2020-04-10T00:00:00",
"CheckOutDate": "2020-04-11T00:00:00",
"Province": {
"ProvinceId": 54634,
"ProvinceName": "Dubai"
},
"NetAmount": 7127.46,
"Currency": "AED",
"MasterEstabId": 2041871
}
],
"Count": 2
}

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 68 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Extras
Best leisure travels do not consist of only meticulously chosen destinations and luxurious
accommodations, but also getting all the fun and excitement of the experience has to offer without
the stress of needing to spend extra time to make the preparations.

Allowing customers to book additional services to make their vacations and travels more care free is
made possible by the Extras functionality that we have just added in our accommodation services.
We have a selection of services that can go with your hotel accommodation that will surely add
significance to your travel experience.

The variations services we can offer may range from customer’s smooth transfers, guided tours,
special occasion banquets, park passes and others that are supplemental of their hotel booking.

Types of Extras
Transfers

- Mainly transport services that comes along with the Hotel booking. This covers majority of
Maldives transfers, round trip hotel transfers and/or private transfer inside the city

Attractions

- This Extras includes, but not limited to, City Tours, Attraction passes, Group excursions,
Tours guide services, etc.

Hotel Supplements

- Mostly consisting of add-ons services the hotel offers for improved customer’s experience.
This may cover access to exclusive facilities, private banquets, guests’ special requests, etc.

Activation and Extras options

The first step to receive the product of extras is to ask for its activation to the API support team:
[email protected].

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 69 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Extra Categories

Mandatory Extras

- Extra option that requires to be booked along with the Room. A great sample are Maldives
accommodation that would require to be booked with Transfer option by Seaplane and
Seaboat. This is primarily indicated with ‘IsMandatory’ tag in the API responses.

Opaque Extras

- Price of Opaque Extras needs to be combined along with Room price. The cost of Opaque
extra should not be disclosed to end customers but should be provided as part of the
Booking cost. This category is indicated with ‘IsOpaque’ tag in the API responses

Dependent Extras

- There are Extras that cannot be booked independently, a dependent Extra requires a
prerequisite service to be booked. A good example is a Gala Dinner that can only be
reserved along with booking a Special Occasion Pass. This is indicated with ‘Requirements’
node, where the required pre-requisite Extra is also provided.

Extras that Require Flight Details

- These services may need flight details to be booked. Transfers are a good example, knowing
the customer’s date and time of arrival or departure would help smoother arrangement of
the transport service. This is indicated with ‘RequiresFlightDetails’ tag.
- If an Extra requires flight details, then from the Booking Confirmation request, client needs
to send additional tags to provide the Flight’s Departure and Arrival date and time.

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 70 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Fields

Once activated, the system will send the following information in all the steps of the booking
process, depending on the chosen configuration these will be returned in the availability, details or
all the steps of the process:

Extras ExtraId Integer Internal identifier of the

additional service
Title String Name of service

ExtraTypeId Integer Internal identifier of the type

of service provided
RequiresFlightDetails Boolean If value = TRUE, is needed to
specify the flight details on the
confirmation request
IsMandatory Boolean If TRUE, is needed to include
the extra service to book the
room
IsOpaque Boolean If TRUE, the price of the extra
should not be revealed to the
end customer – it needs to be
bundled with the room price.
Options EXTRAOPTIONS Refer to EXTRAOPTIONS table

IsBindingPrice
Extra Requirement REQUIREMENTS This tag will only appear if the
service depends on another
Extra/service
REQUIREMENTS ExtraId Integer The Extra Id tag of the service
pre-requisite in booking the
desired service/Extra
***EXTRAOPTIONS OptionId Integer Internal identifier of the
different extra options
Title String Name of the extra service
option
AgentText String Description of the service
provided
CustomerText String Notes to customers for Extras
arrangements after booking

i.e. Transfer arrangements and

processes at the airport
NetCost MONEY The cost of the additional
service provided by the hotel,
excluding the client
commission
GrossCost MONEY The recommended selling
price to the end customer,
including affiliate commission

Note: When choosing extras, sometimes it is possible to add 2 or more extras to the same booking,
but it is not possible to select two options of the same extra.

**Additional Extras information is detailed in Extras Documentation. Please refer to Extras for
complete Booking flow with Extra Functionality.

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 71 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Tables
Accommodation Types
1 Hotel
2 Apartment
3 Camping
5 Hostel
6 Rural Hotel
7 Rural House
8 Villa
9 Bungalow
10 Condominium
11 Bed and Breakfast
12 Cruise
13 Castle
14 Farmhouse
15 Guest House
16 Hotel Boat
17 Inn
18 Restaurant With Rooms
19 Townhouse
21 Campus
22 Cottage
23 Chalet
25 Holiday Village
26 Aparthotel

Board Types
1 Room Only
2 Bed and Breakfast
3 Half Board
4 Full Board
5 All Inclusive
6 Self Catering

Booking Statuses
2 Booked
3 Failed
4 Cancelled
5 OnRequest

Cancellation Statuses
1 Successful
2 Failed
3 Pending

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 72 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Card Types
VI Visa
MC MasterCard

Rating Types
1 Star Rating
2 Key Rating
3 Official AA Rating
4 Official Visit England Rating
5 Official Visit Wales Rating
6 Official Visit Scotland Rating
7 Self-Assessed Rating

Culture Types
en-GB English
ar-AE Arabic
de-DE German
es-ES Spanish
fr-FR French
it-IT Italian

Languages
en English
ar Arabic
de German
es Spanish
fr French
it Italian

Currencies
1 QAR
2 SGD
3 CAD
4 THB
5 CHF
6 EUR
7 AUD
8 HKD
9 OMR
10 JPY
11 AED
12 BHD
13 NZD
14 SAR
15 ZAR
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 73 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 16 MXN
17 DKK
18 GBP
19 PHP
20 CNY
21 MYR
22 INR
23 KWD
24 MAD
25 IDR
26 PLN
27 FJD
28 USD

Source Market Codes

The different Source Market codes are based on the two-letter code defined in ISO_3166-1_alpha-2

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 74 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 Certification Process
The purpose of the certification process is to ensure a correct XML integration; this means that at all
times an optimum use of the number of requests will be made. All basic information is displayed
both during the booking process and on voucher.

Workflow
The correct workflow is as follows:

Details
Availability Booking

Static
content

1.- Availability
It has to be minimized the number of requests to launch and try not to repeat the same availability
after launching the Details request.

If you are going to request by multi-occupancy it’s advisable to request all rooms in a single request.
Example:
{
"CheckInDate":"2017-06-05",
"CheckOutDate":"2017-06-15",
"ProvinceId":54633,
"LocationId":218214,
"EstablishmentId":0,
"Rooms":[
{
"Adults":2,
"ChildAges":[
]
},
{
Copyright © 2015 – Yalago
No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 75 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 "Adults":1,
"ChildAges":[
4,
2
]
}
],
"Culture":"en-GB"
}

There are specific contracts/rates for each market. If you are going to work with more than one
market, the source market code for which you want to receive rates must be included in the request.

2.- Details
Although cancellation policies are returned from this step, this call should not be abused in order to
recover all cancellation policies for all hotels received in the availability response. Only when the
client selects the hotel he wants, this call must be made.

BookingConditions and InfoItems show hotels key information (local city taxes, issues, key collection
...). In case of being returned, this information must be shown to the customer before, after the
confirmation and in the voucher.

3.- Confirmation & Voucher

It’s mandatory to inform all the passengers’ names. This will avoid problems to the customer upon
their arrival at the hotel.

If the hotel price has changed during the booking process, you will receive an error in confirmation
stating the new price. You can re-launch the confirmation with the updated price without having to
repeat the rest of the steps of the reservation.

Voucher
Below listed all the information that has to appear in the booking voucher:

1. It should display the BookingRef, AffiliateRef. These fields will facilitate the hotelier to find
the booking at their system.
2. Establishment address, name, phone, accommodation type and rating (1 star, 2 star…)
3. Check-in, check-out, number of rooms, room and board description.
4. InfoItems and BookingConditions must be shown in the voucher.
5. The lead pax of each of the rooms must be informed. In case there are children, their names
and ages must be shown.
6. Not to display booking price on voucher.

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 76 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.
 4. Static Content
Our static content displays basic information of establishments such as:

- Establishment name
- Establishment description
- Address, phone numbers
- Accommodation type + rating
- Images
- Facilities
- RoomTypes (in process)

All this information must be stored in your system and updated periodically. It’s recommended at
least once a week.

If the information is obtained through Amazon S3, this information is updated once a week, but if it
is obtained through the API, the information is in real time.

As part of the certification process, such information must be shown prior to the confirmation step.

Copyright © 2015 – Yalago

No part of this document may be reproduced in any way without the prior agreement and written permission of Yalago

Page 77 of 77
BUSINESS DOCUMENT This document is intended for business use and should be distributed to intended recipients only.