Provider Help Center

To help you offer your properties the best possible service, we’re always developing new APIs. You’ll need to be certified by us before you can use some of these APIs, while there are some that you can start using after you carry out a self-assessment.

 

Mandatory APIs that require certification

You must implement these APIs, and before you can do that you’ll need a certification from us. To obtain this, please contact us .

• Rates & Availability API – this helps properties set availability, rates and restrictions on our platform. To find out what’s required, take a look at this article.
• Reservations API – this helps you retrieve reservations and modifications made on our platform. To find out what’s required, take a look at this article.

 

Depending on your business model, the data you have about your properties and how involved you are in managing them, we encourage you to implement the full Content API.

If that’s not possible, you may be able to just implement the Room Rate Management section of it. Either way, you’ll need a certification from us before you can get started.

• Content API – this helps properties add and update content including photos, facilities information and policies. To find out more, take a look at the ‘Managing properties’ documentation.
• Room Rate Management – this lets properties add rates and rooms or units, as well as to combine these into products. To find out more, take a look at the ‘Managing rooms & rates’ documentation .

 

If we only require you to implement the Room Rate Management section, you can still choose to implement the full Content API if you wish. To do this, you’ll need a certification from us first. Please contact us  to obtain this.

 

Optional API elements that may require certification

You can also choose to implement these extra API elements tailored to your properties’ pricing models. If you want to do this, you may also need a certification from us depending on the element you choose. To obtain this, please contact us .

• Default pricing – this is our basic pricing model, which sends one price per day for each room and rate from your platform to ours. You’ll need a certification if this wasn’t covered in your initial Rates & Availability API certification. To find out more, take a look at the documentation.
• Single use pricing – this lets your properties offer a price for single occupancy of a room or unit they’re already displaying prices for. You don’t need a certification for this element, but please contact us before you implement it so we can make sure it’s right for you. To find out more, take a look at the documentation for BXML or the documentation for OTA.
• Length of stay pricing – this lets your properties offer prices tailored to various combinations of length of stay and occupancy. You’ll need a certification for this element. To find out more, take a look at the documentation.
• Occupancy Based Pricing – this lets your properties set prices for different room or unit occupancy up to the maximum occupancy. You don’t need a certification for this element, but please contact us before you implement it so we can make sure it’s right for you. To find out more, take a look at the documentation.
• Derived pricing – this lets your properties set the standard occupancy for a room and then add or deduct a fixed amount or percentage from the standard price depending on the actual occupancy. You don’t need a certification for this element. To find out more, take a look at the self-assessment tutorial.

 

Optional APIs that require self-assessment

We don’t currently require a certification before you use the APIs in this section, but we still recommend that you follow the relevant self-assessment tutorial before you get started.

 

If there isn’t a self-assessment tutorial available for the API you want to implement, we recommend that you  read through the API documentation instead. You’ll need to make sure you’re confident implementing the API on your test properties before you roll it out to live properties.

 

Whenever you implement a new API, we advise you to only offer it to a small beta group for the first few weeks. This will allow you to identify and resolve any issues before you roll the API out to all your properties.

 

• Promotions API – this helps your properties create and manage promotions they offer during a set period of time or to a specific group of travellers. To find out more, take a look at the self-assessment tutorial.

• Reporting API – this lets your properties report issues like an invalid credit card, check-out date or price changes, cancellations and guest misconduct. To find out more, take a look at the documentation.

• Photo API – this makes it easier for you and your properties to add and organise photos as a way of improving properties’ visibility. To find out more, take a look at the self-assessment tutorial.

• Opportunities API – this lets you identify various ways to help your properties generate more bookings. To find out more, take a look at the documentation.

• Guest Reviews API – this helps you and your properties to proactively manage the guest experience by retrieving and replying to reviews and scores. To find out more, take a look at the self-assessment tutorial.

• Property Score API – this lets you retrieve the quality of a property’s content and information on how to improve it. To find out more, take a look at the documentation.

• Licences API – this is a part of the Content API and Room Rate Management API. It lets you manage property licence information that may be required before the property can open for bookings. To find out more, take a look at the documentation.

• Mapping API – this lets you obtain your properties’ room or unit details from our platform, so that you can match these up with information on your platform. To find out more, take a look at the documentation .

If you’re ready to get started with our APIs, take a look at all the documentation.