Search Home Connections API New! Migrating Content API to modernised APIs Contracting API Content API Room type and rate plan management Room type, rate plan, policies and roomrate management New! Mobile rates management Rates & Availability API Flexible children rates Reservations API Reservations API Reservation Recovery API New! Photo API Promotions API Market insights API New! Messaging API Guest Review API Opportunities API Reporting API Property scores API Licences API New! Online Check-in API Services API reference

Home

About the Connectivity APIs Authentication Curl Requests Glossary

Changelog

Q3 and Q4 2023 Changelog archive

Deprecation policy

Deprecation and sunsetting Sunsetting HTTP 1.0 support

Migration guides

Migrating to new(er) versions

Tutorial: Create a test property

Introduction 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?

Tutorial: Create a test reservation

Introduction Step 1 – Create inventory, rates and restrictions for your test property Step 2 – Check the availability and select room(s) you want to book Step 3 – Provide required reservation details Step 4 – Specify your info and how do you want to pay Epilogue – Whats next?

Connections API Overview Managing Connections Troubleshooting Connections API

Introduction to modernised Content APIs Creating and managing property details Creating and managing contact details Troubleshooting modernised Content APIs

Understanding the Contracting API

Contracting API management

Managing contracts

Use cases and best practices

Use cases and best pactrices

Troubleshooting guide

List of possible error codes and solutions

Content API overview Property statuses Supporting calls

Managing room type content

Managing room amenities

Managing properties

Section overview Create property Modify property name Modify property contact details 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 Enable long stay bookings Retrieve property details Retrieve property attributes Retrieve house rules Set house rules Specify property mealplans

Related APIs

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

Trouble shooting guide

List of possible error codes and solutions

Understanding the Licences API

Licences API management

Managing licences

Rates & Availability API overview Before implementing a pricing type Configuring and retrieving pricing types Implementing pricing types

B.XML endpoints

Create or update inventory, rates, restrictions Create or update derived pricing rates Retrieve inventory and rate details

OTA endpoints

Create or update inventory, restrictions Create or update rates

CSV endpoints

Create or update LOS pricing rates

Tutorial & Troubleshooting

Self-assessment tutorial for derived pricing

Managing a children policy Managing flexible children rates

Reservations API overview OTA reservations process B.XML reservations process

Processing reservations using OTA

Retrieving new reservations Acknowledging new reservations Retrieving modified/cancelled reservations Acknowledging modified/cancelled reservations

Processing reservations using B.XML

Retrieving reservation summary

Using reservationssummary

Troubleshooting section

List of error codes and possible solutions

FAQ

Frequently asked questions about the Reservations API General information Testing the Reservations API Missing reservation messages Troubleshooting overbookings Handling payment related data

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

Reservation Recovery API overview Managing reservations recovery

Understanding the check-in API

Check-in request API management

Managing check-in requests Configuring check-in forms

Promotions API overview Managing promotions Retrieving promotion details Retrieving 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 room types and rate plans

Implementation use cases

Room types

Managing room types

Rate plans

Managing rate plans

Policy Management API

Policies API overview Managing policies Troubleshooting errors List of policy codes Cancellation Policies FAQs Implementation use cases

Roomrates

Managing roomrates

Managing mobile rates

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

Report reservation changes List misconduct categories Reporting API Self-assessment

Managing property scores

Analysing 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 Property Commission Room Names City Tax Categories

Overview

Booking.com codes

BCBI (Breakfast Item) BCBT (Breakfast Type) BCCP (Cancellation and Prepayment 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) 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

Fields XML Related endpoints

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 DescriptiveText DetailDescription DietaryOption DietaryOptions Email Emails Error Errors Error Codes FacilityInfo Feature Features Fee FeePolicies FeePolicy Fees Floor Floors Guarantee GuaranteeAccepted GuaranteePayment GuaranteePaymentPolicy GuaranteesAccepted GuestCount GuestCounts GuestInformation GuestRoom GuestRoomInfo GuestRooms HiddenAddress HotelCategory HotelCrossRef HotelCrossRefs HotelDescriptiveContent HotelDescriptiveContents HotelDescriptiveInfo HotelDescriptiveInfos HotelInfo HotelProduct HotelProducts HotelRef HotelResModifies HotelResModify HotelReservation HotelReservationID HotelReservationIDs HotelReservations HotelSummaryMessage HotelSummaryMessages InternetFeePolicy InventoryCrossRef InventoryCrossRefs InvoiceDetails Item Items JourneyTime Junction Language Languages Leg Line LongStayInfo MealPlan Motorway 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 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 TimeSpan Total TotalNumberOfFloors TransportType Transportation Transportations Type Types UniqueID ValueAddInclusions Warning Warnings

Award¶

You can set a star rating only for Hotel (non-Home) properties. For example, Hostel, Resort, Motel or Capsule Hotel among others and not Apartment or Villa and so on.

To verify whether your property belongs to a Hotel property, see the property class type table.

Exception for France and its territories

As an exception you can set star rating for Home properties that are located only in France and its territories (country codes FR, YT, GP, MQ, RE, and GF).

Fields¶

Field	Description	Type	Min/max	Notes
_Awards/ `Award`	Details of an award.	object	0..*	-
_Award/ `@Provider`	The type of award.	enum	0..1	Accepts: `Star rating`
_Award/ `@Rating`	The number of stars. Can be set only once at the time of creating a property. Once set, you cannot change this value.	int	0..1	Accepts: `0`–`5`. Some countries don't use star ratings.

XML¶

<Award
  Provider="Star rating"
  Rating="3" />

Related endpoints¶

/ota/OTA_HotelDescriptiveContentNotif

Is this page helpful? Yes | No

Thanks for your feedback!