Latest

Blog Detail Title

Short Content Here

by Author Name

Date Published

Developer

Revenue Management Integration Guide

Andrea Stubbe December 3, 2018

This guide explains how you can connect your revenue or rate management application (RMS) to apaleo. If you are new to apaleo APIs, head over to the quick-start guide , and learn how you can implement the apaleo connect flow.

Inventory and rates in apaleo

First, head over to our guides and get familiar with the way apaleo models inventory and rate plans, and what rate restrictions we support.

If you already have a test account set up, you can follow these guides to set up rates, and check the network traffic in your browser. The apaleo UI is using the same API as you will, and this is a great way to get familiar with the calls.

There is one concept in apaleo which is quite different from what you might now: Time slices. With this, we mean the time slot, for which a room is offered. Each hotel comes with two standard patterns, overnight and day-use. If you only want to manage rates for nights, be sure to filter all rate plans to be overnight. Then, you can think of 'one time slice' as being the same as 'one night'.

Rate plan APIs

Browse all apaleo APIs on https://api.apaleo.com/. For most revenue or rate management integrations, the Core APIs are the only ones needed. Switch between different modules using the dropdown in the top right corner.

swagger

 

First, you need to initialise your system, and let it know which rate plans exist on apaleo. You can do this in the Rate Plan APIs

GET /rateplan/v1/rate-plans

As it is not possible to change the rates of derived rate plans, set the filter to exclude those: isDerived=false. There are more filters, too, if you want to limit to specific properties or channels.

Next, you want to get and set some rates, right? Here you go:

GET /rateplan/v1/rate-plans/{id}/rates

This retrieves all rates in a given time interval. If the price is not set, it means no rates have been initialised for this 'time slice'. The rates also include the restrictions. To initialise or update rates and restrictions, call

PUT /rateplan/v1/rate-plans/{id}/rates
Attention: If you leave information out, it will be deleted. For example not setting the restrictions in the PUT call will simply remove them.

To be on the safe side, we recommend to always GET the rates, then manipulate the data you retrieved, and send it back with the PUT call.

rate-plan-apis

Getting training data

For step 2, before setting the rates, you might have some magic calculation in place. apaleo lets you access every single piece of data stored in it, and you can use it all for training for army of friendly and smart recommendation robots. Here are some suggestions:
All the reservations, with all their prices. And info on if they were cancelled, how many people stay there, if it was part of a multi-room booking, if services were included, how long in advance the booking was made - anything.

GET /booking/v1/reservations

Check current availability and pricing information, using the offer-index:

GET /booking/v1/offer-index

Or what channel managers do, and get real time updates on ARI (availability, rates, and inventory) data using the Distribution API.

Care to dig deeper? Access folio data, to check when the guest paid and how:

GET /finance/v1/folios/

This is where your expertise lies, though, and we are sure you know better than us, what data you want or need. Whatever idea you have - we're pretty sure, apaleo has an API for that. And if not, let us know on https://apaleo.github.com/apis.

Andrea Stubbe

Posted by

Andrea Stubbe
Andrea started coding as a kid, paused that for some years trying to find more interesting things, but then ended up doing that for a living. After working as a freelancer, researcher, teacher, and a normal employee in small and giant corporations, she fulfilled her childhood dream and co-founded a company a year ago. Being a fan of microservices since before she knew that term, she’s still contemplating how and if to use them in micro-sized companies.
Comments

RECENT ARTICLES

by Benjamin Schmid

10/10/2019

IBE Integration Guide

Let's talk Internet Booking Engines (IBEs). They work best when directly connected to the PMS, without any intermediaries that might get in the way with delays ...

by Andrea Stubbe

06/13/2019

Digital guest journey with apaleo

apaleo is building software for hotels, and our users are people that work at hotels. To create amazing guest experiences we need you, creators of guest facing ...

by Andrea Stubbe

05/02/2019

Push it! Webhooks in apaleo

The notification service allows you to build or set up apps which subscribe to certain events on apaleo (webhooks). When an event is triggered, we send an HTTP ...

WANT MORE AMAZING THINGS?

Subscribe to our a-list for all the fun:

  • Keep up to date with hotel trends
  • Understand what matters most to hotel clients
  • Sweet gifs and special offers

Get it in your inbox every Monday ;)

By entering your email you expressly consent to receive our newsletter every week and other material related to...