API objects

Hotel

Field Type Description Mandatory
hotel_id integer or string The advertiser's unique hotel identifier true
room_types Array of RoomType arrays Two dimensional array containing the room combinations for this hotel true

RoomType

Field Type Description Mandatory
<RoomType> RoomTypeOffer Object containing the offer for one specific room. The name of the object represents the room description* true

* In case of alternative accomodations, the room description should be in the following format: "Accomodation Type - #Bedrooms - #Bathrooms - #Guests - #Unitsize" (e.g. "Villa - 2BR - 1BA - sleeps4 - 64m2")


RoomTypeOffer

Field Type Description Mandatory
booking_fee number Additional booking fees the users need to pay the advertiser. Please consider this fee as an average fee per day for the whole stay. true
breakfast_included boolean Specifies if breakfast is included true
currency string Specifies the currency of prices, taxes and fee true
discounts Discounts array List of Discounts applicable on the price false
final_rate number

The final rate the user has to pay (discounts excluded). Please consider this rate as an average rate per day for the whole stay.

 true
free_cancellation boolean Specifies if the user can cancel the booking without any charges true
free_cancellation_deadline string Date determined from which a cancellation penalty is applied and the rate becomes not freely refundable. The cancellation deadline must be provided in the following specific format e.g.:
2024-05-25T16:00:00+00:00		 false
hotel_fee number Additional fees the users need to pay the hotel. Please consider this fee as an average fee per day for the whole stay. true
rate_type string

Specifies if the rate is mobile exclusive or a reward rate. If omitted, the rate will be considered as DEFAULT. Must be one of the following values:

  • "DEFAULT"
  • "REWARD"
  • "MOBILE"
 false
local_tax number City taxes. Please consider this fee as an average fee per day for the whole stay. true
meal_code string

Specifies the board types. Must be one of the following values:

  • "RO" - Room only
  • "BB" - Bed and breakfast
  • "HB" - Half board
  • "FB" - Full board
  • "AI" - All inclusive
 true
mobileURL string The deep link redirecting to the mobile landing page - in case of multiple room request, the same link needs to be provided for each room within the same rate combination false
net_rate number Net rate without any taxes. Please consider this rate as an average rate per day for the whole stay. true
payment_type string

Specifies the payment type. Must be one of the following values:

  • "prepaid" – Payment is collected pre-arrival by the OTA or the hotel
  • "postpaid" – Payment is collected at check-out by the hotel
  • "installment" – Payment is collected by OTA in several installments (widely used in Latin America, for example)
 true
resort_fee number Locale-specific resort fees. Please consider this fee as an average fee per day for the whole stay. true
room_amenities string array Array of short strings describing room-specific amenities, e.g. "Free Wifi" false
room_code string Specifies the room code of the advertised room true
service_charge number Additional fees the user has to pay, e.g. for a transfer to hotel. Please consider this fee as an average fee per day for the whole stay. true
url string The deep link redirecting to the landing page - in case of multiple room request, the same link needs to be provided for each room within the same rate combination true
vat number VAT. Please consider this fee as an average fee per day for the whole stay. true
shared_room boolean Specifies if the rate is a shared room / dormitory. false

Discounts

Field Type Description Mandatory
marketing_text string Description of the discount false
final_rate number Positive value (absolute) of the discount which will be applied to the final_rate of the RoomTypeOffer object.
Please consider this rate as an average rate per day for the whole stay. 		true
hotel_fee number Positive value (absolute) of the discount which will be applied to the hotel_fee of the RoomTypeOffer object.
Please consider this fee as an average fee per day for the whole stay. 		true
booking_fee number Positive value (absolute) of the discount which will be applied to the booking_fee of the RoomTypeOffer object.
Please consider this fee as an average fee per day for the whole stay. 		true
local_tax number Positive value (absolute) of the discount which will be applied to the local_tax of the RoomTypeOffer object.
Please consider this fee as an average fee per day for the whole stay. 		true
net_rate number Positive value (absolute) of the discount which will be applied to the net_rate of the RoomTypeOffer object.
Please consider this rate as an average rate per day for the whole stay. 		true
resort_fee number Positive value (absolute) of the discount which will be applied to the resort_fee of the RoomTypeOffer object.
Please consider this fee as an average fee per day for the whole stay. 		true
vat number Positive value (absolute) of the discount which will be applied to the vat of the RoomTypeOffer object.
Please consider this fee as an average fee per day for the whole stay. 		true
service_charge number Positive value (absolute) of the discount which will be applied to the service_charge of the RoomTypeOffer object.
Please consider this fee as an average fee per day for the whole stay. 		true