API Documentation

Overview

This documentation is for OTA partners who want to connect directly with Rentlio PMS through our standardized OTA Channel API.

With this integration, your platform can:

  • Sync hotel information, rooms, and rate plans
  • Receive real-time availability and pricing updates
  • Push reservations, modifications, and cancellations back to Rentlio

We’ve designed this API to be straightforward and predictable, so you can focus on building a reliable connection with minimal overhead.

To get started, head over to Getting Started.

If you get stuck or need support, reach out to our team at integrations@rentl.io.

Getting Started

Overview

The Generic OTA Channel enables third-party OTAs to connect with Rentlio PMS via a simple, standardized API.

By implementing a predefined set of endpoints, your platform can seamlessly exchange room, rate, availability, and reservation data with Rentlio.

How It Works

This integration supports two-way communication:

  • Rentlio pulls static data (property information, unit types/rooms, and rate plans) and pushes availability and rate updates
  • OTA sends reservation events back to Rentlio, which include new bookings, modifications, and cancellations

Authentication

To ensure secure communication between the OTA and Rentlio, each connected channel will be assigned a unique otaClientID and otaClientSecret. Rentlio will generate and provide these credentials to the OTA during the setup process.

Rentlio to OTA - Basic Authentication (Optional)

If username and password are provided, Rentlio uses HTTP Basic Auth when making requests to your API.

This authentication method is applied specifically when Rentlio:

  • Pulls static data from your system
    • Hotel (property) information
    • Unit types (rooms)
    • Rate plans
  • Pushes availability, rate amounts, and restrictions to your API

Example:

{base64_encoded_username_password} is a Base64-encoded string of username:password.

curl -X GET "yourBaseUrl/hotel/12345" -H "Authorization: Basic {base64_encoded_username_password}"

OTA to Rentlio - Basic Authentication (Required for reservation push)

When sending reservation-related events (new bookings, modifications, cancellations) to Rentlio, your API requests must include Basic Auth.

Example:

curl -X POST "https://app.rentl.io/api/generic/12345/reservation" \
  -H "Authorization: Basic {base64_encoded_otaClientID_otaClientSecret}" \
  -H "Content-Type: application/json" \
  -d '{}'

{base64_encoded_otaClientID_otaClientSecret} is a Base64-encoded string of otaClientID:otaClientSecret.

  • otaClientID: Unique string assigned during setup
  • otaClientSecret: Pre-shared secret (hash-validated)

Rentlio will validate these headers to ensure the request is coming from a trusted partner.

Test Environment/Sandbox Info

Rentlio will provide you with test account credentials, including a test property with activated Channel Manager. This allows you to implement, validate, and fine-tune your API responses without affecting production data.

To set up your test environment, please provide the following information:

  • Name of your channel
  • Logo (image file)
  • Base URL of your API
  • Username and password (if you use Basic Auth)

To request access, reach out to our team at integrations@rentl.io, we’ll get you set up quickly.

Certification Process

Overview

Before your OTA integration can go live and become available to Rentlio users, you’ll need to complete a certification process to ensure everything is working as expected.

We’re here to support you through each step!

Certification Steps

Here’s what the process looks like:

  1. Implement all required API endpoints
    1. Your endpoints must follow the expected response structure defined in this documentation
  2. Validate static data synchronization
    1. Rentlio will call your endpoints for hotel, rooms, and rates to verify data is returned correctly
  3. Test availability and price updates
    1. We'll push rate and availability data to you to confirm proper handling
  4. Send reservation events to Rentlio
    1. You'll need to simulate a new reservation, a modification, and a cancellation
    2. These requests must include correct authentication headers (otaClientID and otaClientSecret)
  5. Final review and approval
    1. Once testing is complete and all criteria are met, we'll mark your channel as certified
    2. You will then be switched to "live" status and made available to the Rentlio user base

Requesting Certification

When your integration is ready for testing, please email us at integrations@rentl.io.

API Overview

There are 2 types of APIs:

Rentlio to OTA APIs

APIs need to be developed on OTA side. Rentlio will call these APIs:

  • to fetch hotel info (check if entered OTA hotel id is correct)
  • to fetch rooms and rates for hotel
  • to send availability, rate amounts and restrictions updates to OTA

OTA to Rentlio APIs

Rentlio Reservation APIs (implemented on Rentlio side) - OTA channel calls these APIs to push reservations (create, update, cancel)

Rentlio to OTA APIs

OTA APIs called from Rentlio.

It is essential for the OTA channel to implement these APIs to meet system requirements.

Base URL

All of these APIs have OTA base URL inside API path. If OTA base URL is https://app.mojnoviota.com then API paths will look like:

GET https://app.mojnoviota.com/hotel/{hotelId}  (Get Hotel Info API)
GET https://app.mojnoviota.com/hotel/{hotelId}/rooms (Get Rooms)
GET https://app.mojnoviota.com/hotel/{hotelId}/rates (Get Rates)
POST https://app.mojnoviota.com/hotel/{hotelId}/pricing_and_availability (Update Rates And Availability)

For these APIs authentication is optional.

Update Rates And Availability

POST/hotel/{hotelId}/pricing_and_availability

This API will send rooms and rates data (availability, rate amounts, restrictions). Rentlio uses this API to send room and rates data (availability, rate amounts, restrictions) updates to OTA side

Headers
  • Authorization (optional)
    string

    Basic Authentication
Request body
  • roomId
    string

    Internal Room ID on OTA side
  • date
    string

    Use YYYY-MM-DD format for a single date of YYYY-MM-DD:YYYY-MM-DD for a date range. Dates are always inclusive. Dates must be within 2 years from today
  • availability (optional)
    integer

    availability for specific Room ID and specific Dates
  • rates (optional)
    array

    rates amounts for specific Room ID, Rate ID and specific Dates
  • rates@rateId
    string

    internal Rate Id on OTA side
  • rates@restrictions
    object

    restrictions for specific Room ID, Rate ID and specific Dates
  • rates@restrictions@minStay
    integer

    minimum length of stay (based on stay-through) for specific Room ID, Rate ID and specific Dates
  • rates@restrictions@maxStay
    integer

    maximum length of stay (based on stay-through) for specific Room ID, Rate ID and specific Dates
  • rates@restrictions@minStayArrival
    integer

    minimum lengths of stay (based on arrival date) for specific Room ID, Rate ID and specific Dates
  • rates@restrictions@maxStayArrival
    integer

    maximum lengths of stay (based on arrival date) for specific Room ID, Rate ID and specific Dates
  • rates@restrictions@minAdvanceReservation
    integer

    minimum advanced booking window restriction for specific Room ID, Rate ID and specific Dates
  • rates@restrictions@maxAdvanceReservation
    integer

    maximum advanced booking window restriction for specific Room ID, Rate ID and specific Dates
  • rates@restrictions@noCheckIn
    boolean

    closed-to-arrival restriction. (prevents check-in for specific Room ID, Rate ID and specific Dates)
  • rates@restrictions@noCheckOut
    boolean

    Closed-to-departure restriction. (prevents check-out for specific Room ID, Rate ID and specific Dates)
  • rates@restrictions@closed
    boolean

    stop sell for specific Room ID, Rate ID and specific Dates
  • rates@price
    float

    price for specific Room ID, Rate ID and specific Dates
  • rates@occupancyPrices
    array

    occupancy prices for specific Room ID, Rate ID and specific Dates (occupancy based pricing)
  • rates@occupancyPrices@occupancy
    integer

    occupancy for occupancy based pricing
  • rates@occupancyPrices@price
    float

    price for occupancy based pricing

API responses from OTA side

  • 200 : Successful operation
  • 400: Invalid ID supplied
  • 404: Hotel not found
Response body
  • status
    string

    Status of update. OK for successful update
  • message
    string

    Update message

CURL example

curl -X POST "otaBaseURL/hotel/123/pricing_and_availability" \
  -H "Authorization: Basic <your-auth-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "rooms": [
      {
        "roomId": "152",
        "date": "2025-10-01:2025-10-20",
        "availability": 10,
        "rates": [
          {
            "rateId": "94",
            "restrictions": {
              "noCheckOut": true
            },
            "price": 200.00
          }
        ]
      }
    ]
  }'
URI Parameters
HideShow
hotelId
string (required) 

Unique identifier for hotel on OTA side

Request  Example 1
HideShow

For Hotel with ID 123 send availability 10, rate price 200.00 and set a closed-to-departure restriction for Room ID 152, Rate ID 94 from 1.10.2025 - 20.10.2025

Headers
Content-Type: application/json
Authorization: Basic <your-auth-token>
Body
[
  {
    "roomId": "152",
    "date": "2025-10-01:2025-10-20",
    "availability": 10,
    "rates": [
      {
        "rateId": "94",
        "restrictions": {
          "noCheckOut": true
        },
        "price": 200
      }
    ]
  }
]
Schema
[                                        // Array of objects
  {                                      // Object
    "roomId": "string",                  // ID of the room
    "date": "string",                    // Date in format "YYYY-MM-DD" or "YYYY-MM-DD:YYYY-MM-DD"
    "availability": "integer",           // Number of available units (optional)
    "rates": [                           // Array of objects
      {                                  // Object
        "rateId": "string",              // ID of the rate
        "restrictions": {                // Object
          "minStay": "integer",              // Minimum stay in nights
          "maxStay": "integer",              // Maximum stay in nights
          "minStayArrival": "integer",       // Minimum stay if arriving that day
          "maxStayArrival": "integer",       // Maximum stay if arriving that day
          "minAdvanceReservation": "integer",// Minimum days in advance to book
          "maxAdvanceReservation": "integer",// Maximum days in advance to book
          "noCheckIn": "boolean",            // true if check-in not allowed
          "noCheckOut": "boolean",           // true if check-out not allowed
          "closed": "boolean"                // true if closed for booking
        },
        "price": "float",              // Price for the rate
        "occupancyPrices": [          // Object
          {
            "occupancy": "integer",   // Occupancy level (e.g. 1, 2, 3...)
            "price": "float"          // Price for this occupancy level
          }
        ]
      }
    ]
  }
]
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "message": "Successful operation"
}
Schema
{
  "status": "string",
  "message": "string"
}
Request  Example 2
HideShow

For Hotel with ID 123 set availability to 5 for Room ID 152, Rate ID 94 from 1.10.2025 - 20.10.2025

Headers
Content-Type: application/json
Authorization: Basic <your-auth-token>
Body
[
  {
    "roomId": "152",
    "date": "2025-10-01:2025-10-20",
    "availability": 5
  }
]
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "message": "Successful operation"
}
Request  Example 3
HideShow

For Hotel with ID 123 send rate price 255.00 and set minimum and maximum lengths of stay (based on stay-through) for Room ID 152, Rate ID 94 from 1.10.2025 - 20.10.2025

Headers
Content-Type: application/json
Authorization: Basic <your-auth-token>
Body
[
  {
    "roomId": "152",
    "date": "2025-10-01:2025-10-20",
    "rates": [
      {
        "rateId": "94",
        "restrictions": {
          "minStay": 2,
          "maxStay": 20
        },
        "price": 255
      }
    ]
  }
]
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "message": "Successful operation"
}
Request  Example 4
HideShow

For Hotel with ID 123 send occupancy rate prices for 1 guest 100.00 for 2 guests 150.00 for Room ID 152 and 153, Rate ID 96 on date 1.10.2025

Headers
Content-Type: application/json
Authorization: Basic <your-auth-token>
Body
[
  {
    "roomId": "152",
    "date": "2025-10-01",
    "rates": [
      {
        "rateId": "96",
        "price": 150,
        "occupancyPrices": [
          {
            "occupancy": 1,
            "price": 100
          },
          {
            "occupancy": 2,
            "price": 150
          }
        ]
      }
    ]
  },
  {
    "roomId": "153",
    "date": "2025-10-01",
    "rates": [
      {
        "rateId": "96",
        "price": 150,
        "occupancyPrices": [
          {
            "occupancy": 1,
            "price": 100
          },
          {
            "occupancy": 2,
            "price": 150
          }
        ]
      }
    ]
  }
]
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "message": "Successful operation"
}
Response  400
HideShow

Invalid ID supplied

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Invalid ID supplied"
}
Schema
{
  "status": "string",
  "message": "string"
}
Response  404
HideShow

Hotel not found

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Hotel not found"
}

Get Hotel Info

GET/hotel/{hotelId}

This API returns hotel info from OTA side based on requested hotel id. Rentlio will use this API to fetch hotel info from OTA side

Headers
  • Authorization (optional)
    string

    Basic Authentication

API responses from OTA side

  • 200 : Successful operation
  • 400: Invalid ID supplied
  • 404: Hotel not found
Response Body
  • hotelId
    string

    unique identifier of hotel on OTA side
  • name
    string

    Hotel name
  • address
    string

    Hotel address
  • zipCode
    string

    Hotel zip code
  • city
    string

    Hotel city

CURL example

curl -X GET "otaBaseURL/hotel/123" -H "Authorization: Basic <your-auth-token>"
URI Parameters
HideShow
hotelId
string (required) 

unique identifier for hotel on OTA side

Request
HideShow

Fetches hotel info for hotel with ID 123

Headers
Authorization: Basic <your-auth-token>
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "hotelId": "123",
  "name": "Test Hotel",
  "address": "Test address 1",
  "zipCode": "10000",
  "city": "Test city"
}
Schema
{                      
  "hotelId": "string", // Unique identifier of hotel on OTA side
  "name": "string",    // Hotel name
  "address": "string", // Hotel address
  "zipCode": "string", // Hotel zip code
  "city": "string"     // Hotel city
}
Response  400
HideShow

Invalid ID supplied

Response  404
HideShow

Hotel not found

Get Rooms

GET/hotel/{hotelId}/rooms{?page}

This API will return all hotel room types on OTA side. Rentlio will use this API to fetch room types list from OTA side.

Headers
  • Authorization (optional)
    string

    Basic Authentication

API responses from OTA side

  • 200 : Successful operation
  • 400: Invalid ID supplied
  • 404: Hotel not found
Response Body
  • rooms
    array

    Rooms array
  • rooms@id
    string

    OTA Room id
  • rooms@name
    string

    OTA Room name
  • total
    integer

    Total rooms number (together with perPage can be used for pagination)
  • perPage
    integer

    Number of rooms returned per page

CURL example

curl -X GET "otaBaseURL/hotel/123/rooms?page=1" -H "Authorization: Basic <your-auth-token>"
URI Parameters
HideShow
hotelId
string (required) 

unique identifier for hotel on OTA side

page
number (optional) Default: 1

Page to return, defaults to 1 (pagination)

Request
HideShow

Fetches rooms for hotel with ID 123 on page 1 (fetches first page with 3 rooms, 4th room is on second page)

Headers
Authorization: Basic <your-auth-token>
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "rooms": [
    {
      "id": "111",
      "name": "Test room"
    },
    {
      "id": "222",
      "name": "Test room 2"
    },
    {
      "id": "333",
      "name": "Test room 3"
    }
  ],
  "total": 4,
  "perPage": 3
}
Schema
{
  "rooms": [             // Array of room objects
    {
      "id": "string",    // OTA Room ID
      "name": "string"   // OTA Room name
    }
  ],
  "total": "integer",    // Total rooms number 
  "perPage": "integer"   // Number of rooms returned per page
}
Response  400
HideShow

Invalid ID supplied

Response  404
HideShow

Hotel not found

Get Rates

GET/hotel/{hotelId}/rates{?page}

This API will return all rates for hotel on OTA side. Rentlio will use this API to fetch rates list from OTA side

Headers
  • Authorization (optional)
    string

    Basic Authentication

API responses from OTA side

  • 200 : Successful operation
  • 400: Invalid ID supplied
  • 404: Hotel not found
Response Body
  • rates
    array

    Rates array
  • rates@id
    string

    Rate id
  • rates@name
    string

    Rate name
  • total
    integer

    Total rates number (together with perPage can be used for pagination)
  • perPage
    integer

    Number of rates returned per page

CURL example

curl -X GET "otaBaseURL/hotel/123/rates?page=1" -H "Authorization: Basic <your-auth-token>"
URI Parameters
HideShow
hotelId
string (required) 

Unique identifier for hotel on OTA side

page
number (optional) Default: 1

Page to return, defaults to 1 (pagination)

Request
HideShow

Fetches rates for hotel with ID 123 on page 1 (fetches first page with 3 rates, 4th rate is on second page)

Headers
Authorization: Basic <your-auth-token>
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "rates": [
    {
      "id": "11",
      "name": "Test rate"
    },
    {
      "id": "22",
      "name": "Test rate 2"
    },
    {
      "id": "33",
      "name": "Test rate 3"
    }
  ],
  "total": 4,
  "perPage": 3
}
Schema
{
  "rates": [            // Array of Rate objects
    {
      "id": "string",   // OTA Rate ID
      "name": "string", // OTA Rate name
    }
  ],
  "total": "integer",   // Total rates number
  "perPage": "integer"  // Number of rates returned per page
}
Response  400
HideShow

Invalid ID supplied

Response  404
HideShow

Hotel not found

OTA to Rentlio APIs

Rentlio APIs called from OTA

These APIs are implemented on Rentlio side. OTA channel calls these APIs to push reservations to Rentlio.

Reservation

POST/api/generic/{hotelId}/reservation

Rentlio API used by OTA to push new reservations to Rentlio

All reservation endpoints require Basic Authentication.

POST https://app.rentl.io/api/generic/{hotelId}/reservation
Headers
  • Authorization*
    string

    Basic Authentication
Request Body

CURL example

curl -X POST "https://app.rentl.io/api/generic/h123456/reservation" \
  -H "Authorization: Basic <your-auth-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "bookingId": "booking123",
    "ucid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "note": "Guest is arriving late",
    "stay": [
      {
        "stayId": "stay456",
        "adults": 2,
        "children": 1,
        "childrenAges": [8],
        "arrivalDate": "2025-04-15",
        "departureDate": "2025-04-16",
        "commission": 10.50,
        "bookedAt": "2025-03-01T14:30:00",
        "note": "Prefers high floor",
        "guests": [
          {
            "name": "John Doe",
            "email": "john@example.com",
            "phone": "+385123456789",
            "address": "Main Street 123",
            "city": "Zagreb",
            "postalCode": "10000",
            "countryCode": "HR",
            "document": {
              "type": 14,
              "number": "ABCD1234"
            }
          }
        ],
        "prices": [
          {
            "accommodation": {
              "price": 100.00,
              "rateId": "rt456789"
            },
            "services": [],
            "meals": [],
            "fees": [],
            "date": "2025-04-15",
            "roomId": "r789012"
          }
        ]
      }
    ],
    "booker": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "+385123456789",
      "isCompany": false
    }
  }'
URI Parameters
HideShow
hotelId
string (required) 

OTA hotel ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Basic <your-auth-token>
Body
{
  "bookingId": "booking123",
  "ucid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "note": "Guest is arriving late",
  "stay": [
    {
      "stayId": "stay456",
      "adults": 2,
      "children": 1,
      "childrenAges": [
        8
      ],
      "arrivalDate": "2025-04-15",
      "departureDate": "2025-04-16",
      "commission": 10.5,
      "bookedAt": "2025-03-01T14:30:00",
      "note": "Prefers high floor",
      "guests": [
        {
          "name": "John Doe",
          "email": "john@example.com",
          "phone": "+385123456789",
          "address": "Main Street 123",
          "city": "Zagreb",
          "postalCode": "10000",
          "countryCode": "HR",
          "document": {
            "type": 14,
            "number": "ABCD1234"
          }
        }
      ],
      "prices": [
        {
          "accommodation": {
            "price": 100,
            "rateId": "rt456789"
          },
          "services": [],
          "meals": [],
          "fees": [],
          "date": "2025-04-15",
          "roomId": "r789012"
        }
      ]
    }
  ],
  "booker": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+385123456789",
    "isCompany": false
  }
}
Schema
{
  "bookingId": "string",          // Unique booking ID on OTA side
  "ucid": "string",               // Unique correlation ID (UUIDv4)
  "note": "string",               // General reservation note
  "stay": ["object"],             // Array of Stay Objects
  "booker": "object",             // Booker object
  "creditCard": "object"          // Credit card object
}
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "message": "Successful operation"
}
Response  400
HideShow

Invalid ID supplied

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Invalid ID supplied"
}
Response  401
HideShow

Unauthorized

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Unauthorized"
}
Response  404
HideShow

Hotel not found

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Hotel not found"
}

PUT/api/generic/{hotelId}/reservation

Rentlio API used by OTA to push reservations updates to Rentlio

All reservation endpoints require Basic Authentication.

PUT https://app.rentl.io/api/generic/{hotelId}/reservation
Headers
  • Authorization*
    string

    Basic Authentication
Request Body

CURL example

curl -X PUT "https://app.rentl.io/api/generic/h123456/reservation" \
  -H "Authorization: Basic <your-auth-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "bookingId": "booking123",
    "ucid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "note": "Guest is arriving late",
    "stay": [
      {
        "stayId": "stay456",
        "adults": 2,
        "children": 1,
        "childrenAges": [8],
        "arrivalDate": "2025-04-15",
        "departureDate": "2025-04-16",
        "commission": 10.50,
        "bookedAt": "2025-03-01T14:30:00",
        "note": "Prefers high floor",
        "guests": [
          {
            "name": "John Doe",
            "email": "john@example.com",
            "phone": "+385123456789",
            "address": "Main Street 123",
            "city": "Zagreb",
            "postalCode": "10000",
            "countryCode": "HR",
            "document": {
              "type": 14,
              "number": "ABCD1234"
            }
          }
        ],
        "prices": [
          {
            "accommodation": {
              "price": 100.00,
              "rateId": "rt456789"
            },
            "services": [],
            "meals": [],
            "fees": [],
            "date": "2025-04-15",
            "roomId": "r789012"
          }
        ]
      }
    ],
    "booker": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "+385123456789",
      "isCompany": false
    }
  }'
URI Parameters
HideShow
hotelId
string (required) 

OTA hotel ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Basic <your-auth-token>
Body
{
  "bookingId": "booking123",
  "ucid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "note": "Guest is arriving late",
  "stay": [
    {
      "stayId": "stay456",
      "adults": 2,
      "children": 1,
      "childrenAges": [
        8
      ],
      "arrivalDate": "2025-04-15",
      "departureDate": "2025-04-16",
      "commission": 10.5,
      "bookedAt": "2025-03-01T14:30:00",
      "note": "Prefers high floor",
      "guests": [
        {
          "name": "John Doe",
          "email": "john@example.com",
          "phone": "+385123456789",
          "address": "Main Street 123",
          "city": "Zagreb",
          "postalCode": "10000",
          "countryCode": "HR",
          "document": {
            "type": 14,
            "number": "ABCD1234"
          }
        }
      ],
      "prices": [
        {
          "accommodation": {
            "price": 100,
            "rateId": "rt456789"
          },
          "services": [],
          "meals": [],
          "fees": [],
          "date": "2025-04-15",
          "roomId": "r789012"
        }
      ]
    }
  ],
  "booker": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+385123456789",
    "isCompany": false
  }
}
Schema
{
  "bookingId": "string",          // Unique booking ID on OTA side
  "ucid": "string",               // Unique correlation ID (UUIDv4)
  "note": "string",               // General reservation note
  "stay": ["object"],             // Array of Stay Objects
  "booker": "object",             // Booker object
  "creditCard": "object"          // Credit card object
}
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "message": "Successful operation"
}
Response  400
HideShow

Invalid ID supplied

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Invalid ID supplied"
}
Response  401
HideShow

Unauthorized

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Unauthorized"
}
Response  404
HideShow

Hotel not found

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Hotel not found"
}

Cancel reservation

PUT/api/generic/{hotelId}/reservation/cancel

Rentlio API used by OTA to push reservations cancellations to Rentlio

All reservation endpoints require Basic Authentication.

PUT https://app.rentl.io/api/generic/{hotelId}/reservation/cancel
Headers
  • Authorization*
    string

    Basic Authentication
Request Body

CURL example

curl -X PUT "https://app.rentl.io/api/generic/h123456/reservation/cancel" \
  -H "Authorization: Basic <your-auth-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "bookingId": "booking123",
    "ucid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "reason": "Guest request due to unexpected circumstances",
    "booker": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }'
URI Parameters
HideShow
hotelId
string (required) 

OTA hotel ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Basic <your-auth-token>
Body
{
  "bookingId": "booking123",
  "ucid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "reason": "Guest request due to unexpected circumstances",
  "booker": {
    "name": "John Doe",
    "email": "john@example.com"
  }
}
Schema
{
  "bookingId": "string",  // Internal booking ID from the OTA side
  "ucid": "string",       // Unique correlation ID (UUIDv4) for tracking/debugging
  "reason": "string",     // Reason for cancellation
  "booker": {             // Object
    "name": "string",     // Name of the person who made the reservation
    "email": "string"     // Email of the booker
  }
}
Response  200
HideShow

Successful operation

Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "message": "Successful operation"
}
Response  400
HideShow

Invalid ID supplied

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Invalid ID supplied"
}
Response  401
HideShow

Unauthorized

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Unauthorized"
}
Response  404
HideShow

Hotel not found

Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "message": "Hotel not found"
}

Reservation Data Models

This section describes the data models used for managing reservations.

CreateUpdateReservationRequest

Schema

{
  "bookingId": "string",          // Unique booking ID on OTA side
  "ucid": "string",               // Unique correlation ID (UUIDv4)
  "note": "string",               // General reservation note
  "stay": ["object"],             // Array of Stay Objects
  "booker": "object",             // Booker object
  "creditCard": "object"          // Credit card object
}
Properties
  • bookingId
    string

    Internal booking ID on OTA side
  • ucid
    string

    Unique correlation ID UUIDv4 (for debugging)
  • note
    string

    Booking note
  • stay
    array

    Array of Stay objects
  • booker
    object

    Booker information
  • creditCard
    object

    Credit card information

Example

Reservation with 1 stay from 15.04.2025 - 16.04.2025
{
  "bookingId": "booking1234",
  "ucid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "note": "Guest is arriving late",
  "stay": [
    {
      "stayId": "stay4567",
      "adults": 2,
      "children": 1,
      "childrenAges": [8],
      "arrivalDate": "2025-04-15",
      "departureDate": "2025-04-16",
      "commission": 10.50,
      "bookedAt": "2025-03-01T14:30:00",
      "note": "Prefers high floor",
      "guests": [
        {
          "name": "John Doe",
          "email": "john@example.com",
          "phone": "+385123456789"
        }
      ],
      "prices": [
        {
          "accommodation": {
            "price": 100.00,
            "rateId": "rt456789"
          },
          "services": [],
          "meals": [],
          "fees": [],
          "date": "2025-04-15",
          "roomId": "r789012"
        }
      ]
    }
  ],
  "booker": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+385123456789",
    "isCompany": true,
    "vatId": "1234"
  }
}

Example 2

Reservation with 2 stays, first stay from 15.04.2025 - 16.04.2025, second from 15.04.2025 - 18.04.2025, with services, meals, fees
{
    "bookingId": "booking1234",
    "ucid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "note": "Guest is arriving late",
    "stay": [
        {
            "stayId": "stay4567",
            "adults": 2,
            "children": 1,
            "childrenAges": [
                8
            ],
            "arrivalDate": "2025-04-15",
            "departureDate": "2025-04-16",
            "commission": 10.50,
            "bookedAt": "2025-03-01T14:30:00",
            "note": "Prefers high floor",
            "guests": [
                {
                    "name": "John Doe",
                    "email": "john@example.com",
                    "phone": "+385123456789"
                }
            ],
            "prices": [
                {
                    "accommodation": {
                        "price": 100.00,
                        "rateId": "rt456789"
                    },
                    "services": [],
                    "meals": [],
                    "fees": [],
                    "date": "2025-04-15",
                    "roomId": "r789012"
                }
            ]
        },
        {
            "stayId": "stay45678",
            "adults": 2,
            "children": 1,
            "childrenAges": [
                8
            ],
            "arrivalDate": "2025-04-15",
            "departureDate": "2025-04-18",
            "commission": 10.50,
            "bookedAt": "2025-03-01T14:30:00",
            "note": "Prefers high floor",
            "guests": [
                {
                    "name": "Jane Smith",
                    "email": "jane@example.com",
                    "phone": "+385987654321",
                    "address": "Secondary Street 456",
                    "city": "Split",
                    "postalCode": "21000",
                    "countryCode": "HR",
                    "document": {
                        "type": 18,
                        "number": "XYZ9876"
                    }
                }
            ],
            "prices": [
                {
                    "accommodation": {
                        "price": 100.00,
                        "rateId": "rt456789"
                    },
                    "services": [
                        {
                            "name": "Wi-Fi",
                            "price": 0.00,
                            "quantity": 1,
                            "includedInAccommodation": true
                        },
                        {
                            "name": "Parking",
                            "price": 10.00,
                            "quantity": 1,
                            "includedInAccommodation": false
                        }
                    ],
                    "meals": [
                        {
                            "name": "Breakfast",
                            "price": 15.00,
                            "quantity": 3,
                            "includedInAccommodation": false
                        }
                    ],
                    "fees": [
                        {
                            "name": "City Tax",
                            "price": 2.00,
                            "quantity": 3,
                            "includedInAccommodation": false
                        }
                    ],
                    "date": "2025-04-15",
                    "roomId": "r789012"
                },
                {
                    "accommodation": {
                        "price": 100.00,
                        "rateId": "rt456789"
                    },
                    "services": [
                        {
                            "name": "Wi-Fi",
                            "price": 0.00,
                            "quantity": 1,
                            "includedInAccommodation": true
                        },
                        {
                            "name": "Parking",
                            "price": 10.00,
                            "quantity": 1,
                            "includedInAccommodation": false
                        }
                    ],
                    "meals": [
                        {
                            "name": "Breakfast",
                            "price": 15.00,
                            "quantity": 3,
                            "includedInAccommodation": false
                        }
                    ],
                    "fees": [
                        {
                            "name": "City Tax",
                            "price": 2.00,
                            "quantity": 3,
                            "includedInAccommodation": false
                        }
                    ],
                    "date": "2025-04-16",
                    "roomId": "r789012"
                },
                {
                    "accommodation": {
                        "price": 100.00,
                        "rateId": "rt456789"
                    },
                    "services": [
                        {
                            "name": "Wi-Fi",
                            "price": 0.00,
                            "quantity": 1,
                            "includedInAccommodation": true
                        },
                        {
                            "name": "Parking",
                            "price": 10.00,
                            "quantity": 1,
                            "includedInAccommodation": false
                        }
                    ],
                    "meals": [
                        {
                            "name": "Breakfast",
                            "price": 15.00,
                            "quantity": 3,
                            "includedInAccommodation": false
                        }
                    ],
                    "fees": [
                        {
                            "name": "City Tax",
                            "price": 2.00,
                            "quantity": 3,
                            "includedInAccommodation": false
                        }
                    ],
                    "date": "2025-04-17",
                    "roomId": "r789012"
                }
            ]
        }
    ],
    "booker": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+385123456789",
        "address": "Main Street 123",
        "city": "Zagreb",
        "postalCode": "10000",
        "note": "Repeat customer",
        "countryCode": "HR",
        "isCompany": false,
        "document": {
            "type": 14,
            "number": "ABCD1234"
        }
    },
    "creditCard": {
        "cardNumber": "4111111111111111", // Visa test number
        "cardHolder": "John Doe",
        "cardExpiryMonth": "08",
        "cardExpiryYear": "2026",
        "cvv": "123"
    }
}

Stay

Schema

{
  "stayId": "string",             // Unique stay identifier
  "adults": "integer",            // Number of adults
  "children": "integer",          // Number of children
  "childrenAges": ["integer"],    // Array of children ages
  "arrivalDate": "string",        // Format: YYYY-MM-DD
  "departureDate": "string",      // Format: YYYY-MM-DD
  "commission": "float",          // OTA commission amount
  "bookedAt": "string",           // Format: 2006-01-02T15:04:05 UTC
  "note": "string",               // Optional note
  "guests": ["object"],           // Array of Guest objects
  "prices": ["object"]            // Array of Price objects
}
Properties
  • stayId
    string

    Internal stay ID on OTA side
  • adults
    integer

    Number of adults
  • children
    integer

    Number of children
  • childrenAges
    array

    Array of children's ages
  • arrivalDate
    string

    Arrival date (YYYY-MM-DD format)
  • departureDate
    string

    Departure date (YYYY-MM-DD format)
  • commission
    float

    OTA commission nominal amount
  • bookedAt
    string

    Booking timestamp (2006-01-02T15:04:05 UTC format)
  • note
    string

    Stay note
  • guests
    array

    Array of Guest objects
  • prices
    array

    Array of Price objects

Example

{
  "stayId": "stay45678",
  "adults": 2,
  "children": 1,
  "childrenAges": [8],
  "arrivalDate": "2025-04-15",
  "departureDate": "2025-04-18",
  "commission": 10.50,
  "bookedAt": "2025-03-01T14:30:00",
  "note": "Prefers high floor",
  "guests": [
    {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "+385123456789",
      "countryCode": "HR",
      "document": {
        "type": 14,
        "number": "ABCD1234"
      }
    }
  ],
  "prices": [
    {
      "accommodation": {
        "price": 100.00,
        "rateId": "rt456789"
      },
      "services": [],
      "meals": [],         
      "fees": [],
      "date": "2025-04-15",
      "roomId": "r789012"
    },
    {
      "accommodation": {
        "price": 100.00,
        "rateId": "rt456789"
      },
      "services": [],
      "meals": [],         
      "fees": [],
      "date": "2025-04-16",
      "roomId": "r789012"
    },
    {
      "accommodation": {
        "price": 110.00,
        "rateId": "rt456789"
      },
      "services": [],
      "meals": [],         
      "fees": [],
      "date": "2025-04-17",
      "roomId": "r789012"
    }
  ]
}

Booker

Schema

{
  "name": "string",             // Full name of the booker/guest
  "email": "string",            // Email address
  "phone": "string",            // Phone number
  "address": "string",          // Street address
  "city": "string",             // City name
  "postalCode": "string",       // Postal / ZIP code
  "note": "string",             // Optional note about the guest
  "countryCode": "string",      // ISO country code (e.g. HR, US)
  "isCompany": "boolean",       // true if booker is a company
  "vatId": "string",            // VAT ID (if company)
  "document": "object"          // Document object
}
Properties
  • name
    string

    Booker's name
  • email
    string

    Booker's email
  • phone
    string

    Booker's phone
  • address
    string

    Booker's address
  • city
    string

    Booker's city
  • postalCode
    string

    Booker's postal code
  • note
    string

    Additional notes about the booker
  • countryCode
    string

    Booker's country code
  • isCompany
    boolean

    Whether the booker is a company
  • vatId
    string

    VAT ID for companies
  • document
    object

    Document information

Example

{
  "name": "John Doe",
  "email": "john@example.com",
  "phone": "+385123456789",
  "address": "Main Street 123",
  "city": "Zagreb",
  "postalCode": "10000",
  "note": "Repeat customer",
  "countryCode": "HR",
  "isCompany": false,
  "document": {
    "type": 14,
    "number": "ABCD1234"
  }
}

Guests

Schema

{
  "name": "string",             // Guest's full name
  "email": "string",            // Guest's email address
  "phone": "string",            // Guest's phone number
  "address": "string",          // Street address
  "city": "string",             // City
  "postalCode": "string",       // ZIP / postal code
  "note": "string",             // Optional note about the guest
  "countryCode": "string",      // ISO 3166-1 alpha-2 country code (e.g. HR, US)
  "document": "object"          // Document object
}
Properties
  • name
    string

    Guest's name
  • email
    string

    Guest's email
  • phone
    string

    Guest's phone
  • address
    string

    Guest's address
  • city
    string

    Guest's city
  • postalCode
    string

    Guest's postal code
  • note
    string

    Additional notes about the guest
  • countryCode
    string

    Guest's country code
  • document
    object

    Document information

Example

{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "phone": "+385987654321",
  "address": "Secondary Street 456",
  "city": "Split",
  "postalCode": "21000",
  "countryCode": "HR",
  "document": {
    "type": 18,
    "number": "XYZ9876"
  }
}

Document

Schema

{
  "type": "integer",    // Document type (valid values: 1–25)
  "number": "string"    // Document number or identifier
}
Properties
  • type
    integer

    Document type (1-25)
  • number
    string

    Document number

Document Types

  1. Border crossing pass (foreign)
  2. Travel documents for refugees issued by RH
  3. Other
  4. Sailor's booklet (Croatian)
  5. Children's passport (foreign)
  6. Official passport (Croatian)
  7. Diplomatic passport (foreign)
  8. Travel document issued by RH
  9. Proof of passport retention
  10. Diplomatic personal ID card
  11. Health insurance card
  12. Travel document for stateless persons
  13. Children's passport (Croatian)
  14. Personal passport (Croatian)
  15. Joint passport (Croatian)
  16. Driver's licence (Croatian)
  17. Family passport (Croatian)
  18. Personal passport (foreign)
  19. Driver's licence (foreign)
  20. Personal ID card for foreigners issued by RH
  21. Diplomatic passport (Croatian)
  22. Document/proof of lost or stolen travel documents
  23. Personal ID card (foreign)
  24. Travel paper for foreigners (foreign)
  25. Personal ID card (Croatian)

Example

{
  "type": 14,
  "number": "ABCD1234"
}

Prices

Schema

{
  "accommodation": {       // Object
    "price": "float",      // Price for accommodation (base rate)
    "rateId": "string"     // Rate ID associated with this price
  },
  "services": [                             // Array of service objects
    {                                       // Object
      "name": "string",                     // Name of the additional service
      "price": "float",                     // Price per day for the service
      "quantity": "integer",                // Quantity of the service
      "includedInAccommodation": "boolean" // Whether this service is included in the base accommodation price
    }
  ],
  "meals": [                                // Array of meal objects
    {                                       // Object
      "name": "string",                     // Name of the meal (e.g. Breakfast)
      "price": "float",                     // Price per day for the meal
      "quantity": "integer",                // Quantity
      "includedInAccommodation": "boolean" // Whether the meal is included in accommodation
    }
  ],
  "fees": [                                 // Array of fee objects
    {                                       // Object
      "name": "string",                     // Name of the fee (e.g. Cleaning Fee)
      "price": "float",                     // Price of the fee
      "quantity": "integer",                // Quantity
      "includedInAccommodation": "boolean" // Whether the fee is included in the accommodation price
    }
  ],
  "date": "string",     // Date of the price entry (format: YYYY-MM-DD)
  "roomId": "string"    // Internal Room ID for which this pricing applies
}
Properties
  • accommodation
    object

    Accommodation information including price and rateId
  • services
    array

    Array of service objects
  • meals
    array

    Array of meal objects
  • fees
    array

    Array of fee objects
  • date
    string

    Date for this price entry (YYYY-MM-DD format)
  • roomId
    string

    Internal Room ID on OTA side
Accommodation
  • price
    number

    Price
  • rateId
    string

    OTA Rate ID
Service/Meal/Fee
  • name
    string

    Name of the service/meal/fee
  • price
    number

    Price
  • quantity
    integer

    Quantity
  • includedInAccommodation
    boolean

    Whether it's included in the accommodation price

Example

{
  "accommodation": {
    "price": 100.00,
    "rateId": "rt456789"
  },
  "services": [
    {
      "name": "Wi-Fi",
      "price": 0.00,
      "quantity": 1,
      "includedInAccommodation": true
    },
    {
      "name": "Parking",
      "price": 10.00,
      "quantity": 1,
      "includedInAccommodation": false
    }
  ],
  "meals": [
    {
      "name": "Breakfast",
      "price": 15.00,
      "quantity": 3,
      "includedInAccommodation": false
    }
  ],
  "fees": [
    {
      "name": "City Tax",
      "price": 2.00,
      "quantity": 3,
      "includedInAccommodation": false
    }
  ],
  "date": "2025-04-15",
  "roomId": "r789012"
}

Credit card

Schema

{
    "cardNumber": "string",         // Card number
    "cardHolder": "string",         // Name on card
    "cardExpiryMonth": "string",    // MM format
    "cardExpiryYear": "string",     // YYYY format
    "cvv": "string"                 // Card security code
  }
Properties
  • cardNumber
    string

    Card number
  • cardHolder
    string

    Name on card
  • cardExpiryMonth
    string

    MM format
  • cardExpiryYear
    string

    YYYY format
  • cvv
    string

    Card security code

Example

{
  "cardNumber": "4111111111111111",     // Visa test number
  "cardHolder": "John Doe",
  "cardExpiryMonth": "08",
  "cardExpiryYear": "2026",
  "cvv": "123"
}

CancelGenericReservationRequest

Schema

{
  "bookingId": "string",  // Internal booking ID from the OTA side
  "ucid": "string",       // Unique correlation ID (UUIDv4) for tracking/debugging
  "reason": "string",     // Reason for cancellation
  "booker": {             // Object
    "name": "string",     // Name of the person who made the reservation
    "email": "string"     // Email of the booker
  }
}
Properties
  • bookingId
    string

    Internal booking ID on OTA side
  • ucid
    string

    Unique correlation ID UUIDv4 (for debugging)
  • reason
    string

    Cancellation reason
  • booker
    object

    Simplified booker information (name and email)

Example

{
  "bookingId": "booking1234",
  "ucid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "reason": "Guest request due to unexpected circumstances",
  "booker": {
    "name": "John Doe",
    "email": "john@example.com"
  }
}

Changelog

Stay up to date with the latest changes to the Rentlio OTA Channel API. We’ll post updates here for all new features, improvements, and breaking changes.

April 10, 2025

Initial API Specification Released

  • Published v1 of the Rentlio OTA Channel API documentation