Search Home Contracting API New! Content API Room type and rate plan management Rates & Availability API Reservations API Photo API New! Promotions API Market insights API Messaging API New! Missed reservations API Guest Review API Opportunities API Reporting API Property scores API Licences API New! Online Check-in API New! Services API reference

Home

About the Connectivity APIs Authentication Curl Requests Glossary

Changelog

Changelog Q1 and Q2 2021

Migration guides

Migrating to new(er) versions

Getting started

Tutorial: Create a test property Prologue – Hello, World! Step 1 – Create property Step 2 – Retrieve property details Step 3 – Create room type Step 4 – Create rate plan Step 5 – Create product Step 6 – Push availability Step 7 – Checks Epilogue – Whats next?

Understanding the Contracting API

Contracting API management

Managing contracts

Use cases and best practices

Use cases and best pactrices

Trouble shooting guide

List of possible error codes and solutions

Content API overview Property statuses Licence requirements per region Supporting calls

Managing rooms & rates

Section overview Create room Create multi-bedroom setup Modify room amenities Modify room photos Deactivate room Activate room Creating and updating rate plans Rename rate Deactivate rate Activate rate Create product Modify product Delete product

Managing properties

Section overview Create property Create independent property Modify property name Modify property contact details Modify property photos Modify property facilities Modify property policies Setting up children policies and child rates (pricing) Implementing or disabling CVC collection Preparing a property to be open bookable Retrieve property details Retrieve property attributes Retrieve regional licence requirements Retrieve house rules Set house rules Specify property mealplans Property Profile API Key Collection API Key Collection API: Generic Calls Key Collection API: Per-Property Calls Key Collection API: Methods Descriptions Key Collection API: External References Key Collection API: Manage photos

API endpoints

/ota/OTA_HotelDescriptiveContentNotif /ota/OTA_HotelDescriptiveInfo /ota/OTA_HotelInvNotif /ota/OTA_HotelProductNotif /ota/OTA_HotelRatePlanNotif /ota/OTA_HotelSearch /ota/OTA_HotelSummaryNotif

Understanding the Photo API

Photo API management

Managing photos Managing panoramic (360) photos Managing photo galleries Self-assessment tutorial

Understanding the Licences API

Licences API management

Managing licences

Rates & Availability API overview Pricing models

B.XML endpoints

Create/update inventory, rates, restrictions Create/update rates (Derived pricing) Self-assessment tutorial (Derived pricing)

OTA endpoints

Create/update inventory, restrictions Create/update rates

CSV endpoints

Create/update rates (LOS pricing)

Reservations API overview Reservations API best practices

B.XML endpoints

Retrieve new/modified/cancelled reservations Retrieve reservations summary

OTA endpoints

Retrieve/confirm new reservations Retrieve confirm modified/cancelled reservations

Managing missed reservations

Understanding the check-in API

Check-in request API management

Managing check-in requests

Promotions API overview Create/update a promotion Retrieve promotion details Retrieve promotion channels Self-assessment tutorial FAQ

Understanding room types and rate plans

Implementation use cases

Room types

Managing room types

Rate plans

Managing rate plans

Roomrates

Managing roomrates

Understanding the Messaging API

Implementation use cases and best practices

Implementations use cases and best practices

Messaging API management

Managing messages Managing conversations Managing tags Searching messages Uploading and downloading attachments

Guest Review API overview

Sample requests

Retrieve reviews Reply to a review Retrieve property scores Self-assessment tutorial Access reviews iframe

Using the Opportunities API

Opportunities API management

Retrieving opportunities Implementing or dismissing opportunities

Overview Misconduct Categories

Managing property scores

Managing area demand data

Overview Code Groups (Added 2017-08-08) Country Codes/Names Country Codes/Currency Codes Credit Card Names/OTA codes Currency Codes/Names Get Legal Entities Get Property Commission Rate IDs/Names Room Names City Tax Categories Room IDs/Names Room Rate Availability Room/Rate IDs/Names/Policies

Overview

Booking.com codes

BCBI (Breakfast Item) BCBT (Breakfast Type) BCCP (Cancellation and prepaymeny Policies) BCIO (Check-In/Out Times) BCJT (Job Titles) BCL (Language) BCPT (Payment Type) BCRT (Room Type)

OTA codes

ACC (Attraction Category Code) CHG (Charge Type) CUI (Main Cuisine Code) ERR (Error Codes) FTT (Fee Tax Type) HAC (Hotel Amenity) ITT (Image Tag Type) MPT (Meal Plan Type) OTC (Option Type) PCT (Property Class Type) PTT (Phone Technology Type) RMA (Room Amenity Type) TRP (Transportation Code) UIT (Unique ID Type)

OTA objects

AcceptedPayment AcceptedPayments AdditionalDetail AdditionalDetails Address Addresses AffiliationInfo Ambiance Ambiances Amenities Amenity AreaInfo Attraction Attractions Attribute Award Awards Base BasicPropertyInfo BookingRule BookingRules CancellationGracePeriod CancelPenalties CancelPenalty CancelPolicy CategoryCodes Charge Comment Comments Commission CommissionPayableAmount CompanyName Condition Conditions ContactInfo ContactInfos Criteria Criterion CuisineCode CuisineCodes Customer Departure DepositPayments Description

GuestRoom RatePlan Related endpoints

Descriptions DescriptiveText DetailDescription DietaryOption DietaryOptions Email Emails Error Errors FacilityInfo Feature Features Fee FeePolicies FeePolicy Fees Floor Floors Guarantee GuaranteeAccepted GuaranteePayment GuaranteePaymentPolicy GuaranteesAccepted GuestCount GuestCounts GuestInformation GuestRoom GuestRoomInfo GuestRooms HotelCategory HotelCrossRef HotelCrossRefs HotelDescriptiveContent HotelDescriptiveContents HotelDescriptiveInfo HotelDescriptiveInfos HotelInfo HotelProduct HotelProducts HotelRef HotelResModifies HotelResModify HotelReservation HotelReservationID HotelReservationIDs HotelReservations HotelSummaryMessage HotelSummaryMessages HotelierMessage ImageFormat ImageItem ImageItems ImageTag ImageTags InternetFeePolicy InventoryCrossRef InventoryCrossRefs InvoiceDetails Item Items JourneyTime Junction Language Languages Leg LicenseInfo LicenseInfos Line MealPlan Motorway MultimediaDescription MultimediaDescriptions Name Names NoShowPolicy OTA_HotelDescriptiveContentNotifRQ OTA_HotelDescriptiveContentNotifRS OTA_HotelDescriptiveInfoRQ OTA_HotelDescriptiveInfoRS OTA_HotelInvNotifRQ OTA_HotelInvNotifRS OTA_HotelProductNotifRQ OTA_HotelProductNotifRS OTA_HotelRatePlanNotifRQ OTA_HotelRatePlanNotifRS OTA_HotelResModifyNotifRQ OTA_HotelResModifyNotifRS OTA_HotelResNotifRQ OTA_HotelResNotifRS OTA_HotelSearchRQ OTA_HotelSearchRS OTA_HotelSummaryNotifRQ OTA_HotelSummaryNotifRS Occupancy OperationSchedule OperationSchedules OperationTime OperationTimes Option Options OwnershipManagementInfo OwnershipManagementInfos ParkingFeePolicy PaymentCard PersonName PetsPolicies PetsPolicy Phone Phones Policies Policy PolicyInfo Position PrepaymentPolicy PreventLikelyToBeCancelledBookings Price PricingType Profile ProfileInfo Profiles Properties Property PropertyManagedBy PropertyTaxInfo Rate RatePlan RateDescription RatePlanCrossRef RatePlans Rates RelativePosition RelativePositions ResGlobalInfo ReservationTime ResGuest ResGuestRPH ResGuestRPHs ResGuests Restaurant Restaurants Room RoomDescription RoomLocation RoomRate RoomRates RoomStay RoomStays RoomType RoomTypes Route SellableProduct SellableProducts SellMealsThroughBooking Service ServiceDetails ServiceExtraIdentificationInfo ServiceRPH ServiceRPHs Services SpecialRequest SpecialRequests StandardPhrase StandardPhrases Start SubRoom SubRooms TPA_Extensions TaxPolicies TaxPolicy Telephone Text TextItem TextItems TimeSpan Total TotalNumberOfFloors TransportType Transportation Transportations Type TypeOfResidence Types UniqueID ValueAddInclusions Warning Warnings

Future deprecation of HotelInvNotif photo functionality

Adding and modifying photos through OTA_HotelInvNotif entered the sunset phase as of September 16, 2020. This means that to keep managing photos you must switch to the Photo API before September 16, 2021, when this functionality is fully depecrated.

Description¶

Multiple parents

Description can be a child of:

GuestRoom
RatePlan

GuestRoom ¶

Fields¶

Field	Description	Type	Min/max	Notes
_GuestRoom/ `Description`	Description and images for room type.	object	1..1	-
_Description/ `Text`	Specifies an optional (more descriptive) name for the room type.	string	0..1	You can retrieve accepted room names per room type and language by using the room name endpoint. Default name is based on Room Type`[@RoomType]`.
_Description/ `Image`	The URL for a room photo. We'll download from this URL and upload to Booking.com servers.	string	0..1	Uploading photos is asynchronous. We recommend uploading at least 4 photos per room, with a size of at least 2048x1536 pixels, in landscape orientation.
_{Description/Image/} `@ImageTagID`	One or more comma-separated Image Tag Type Codes that specify what the photo shows.	CSV/ITT	0..1	Example: `1,5,116`

XML¶

<Description>
  <Image>http://pathtoimage/doublemer_room001.jpg</Image>
  <Text>Deluxe Double Room with Sea View</Text>
</Description>

RatePlan ¶

Fields¶

Field	Description	Type	Min/max	Notes
_RatePlan/ `Description`	-	object	1..1	-
_Description/ `@Name`	A custom name for the rate plan.	string	1..1	Rate plan names must be unique. Creating a rate plan with a duplicate name results in an error.

XML¶

<Description
  Name="1st night non-refundable Rate with Breakfast for 1 person"/>

Related endpoints¶

/ota/OTA_HotelInvNotif
/ota/OTA_HotelRatePlanNotif

Is this page helpful? Yes | No

Thanks for your feedback!

Description¶

GuestRoom¶

Fields¶

XML¶

RatePlan¶

Fields¶

XML¶

Related endpoints¶

GuestRoom ¶

RatePlan ¶