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 setupotaClientSecret: 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:
- Implement all required API endpoints
- Your endpoints must follow the expected response structure defined in this documentation
- Validate static data synchronization
- Rentlio will call your endpoints for hotel, rooms, and rates to verify data is returned correctly
- Test availability and price updates
- We'll push rate and availability data to you to confirm proper handling
- Send reservation events to Rentlio
- You'll need to simulate a new reservation, a modification, and a cancellation
- These requests must include correct authentication headers (
otaClientIDandotaClientSecret)
- Final review and approval
- Once testing is complete and all criteria are met, we'll mark your channel as certified
- 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 - OTA APIs called from Rentlio
- OTA to Rentlio APIs - Rentlio APIs called from OTA
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)
stringBasic Authentication
Request body
-
roomId
stringInternal Room ID on OTA side -
date
stringUse 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)
integeravailability for specific Room ID and specific Dates -
rates (optional)
arrayrates amounts for specific Room ID, Rate ID and specific Dates -
rates@
rateId stringinternal Rate Id on OTA side -
rates@
restrictions objectrestrictions for specific Room ID, Rate ID and specific Dates -
rates@
restrictions@ minStay integerminimum length of stay (based on stay-through) for specific Room ID, Rate ID and specific Dates -
rates@
restrictions@ maxStay integermaximum length of stay (based on stay-through) for specific Room ID, Rate ID and specific Dates -
rates@
restrictions@ minStayArrival integerminimum lengths of stay (based on arrival date) for specific Room ID, Rate ID and specific Dates -
rates@
restrictions@ maxStayArrival integermaximum lengths of stay (based on arrival date) for specific Room ID, Rate ID and specific Dates -
rates@
restrictions@ minAdvanceReservation integerminimum advanced booking window restriction for specific Room ID, Rate ID and specific Dates -
rates@
restrictions@ maxAdvanceReservation integermaximum advanced booking window restriction for specific Room ID, Rate ID and specific Dates -
rates@
restrictions@ noCheckIn booleanclosed-to-arrival restriction. (prevents check-in for specific Room ID, Rate ID and specific Dates) -
rates@
restrictions@ noCheckOut booleanClosed-to-departure restriction. (prevents check-out for specific Room ID, Rate ID and specific Dates) -
rates@
restrictions@ closed booleanstop sell for specific Room ID, Rate ID and specific Dates -
rates@
price floatprice for specific Room ID, Rate ID and specific Dates -
rates@
occupancyPrices arrayoccupancy prices for specific Room ID, Rate ID and specific Dates (occupancy based pricing) -
rates@
occupancyPrices@ occupancy integeroccupancy for occupancy based pricing -
rates@
occupancyPrices@ price floatprice for occupancy based pricing
API responses from OTA side
200: Successful operation400: Invalid ID supplied404: Hotel not found
Response body
-
status
stringStatus of update. OK for successful update -
message
stringUpdate 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
}
]
}
]
}'
- hotelId
string(required)Unique identifier for hotel on OTA side
Example 1For 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
}
]
}
]
}
]200Successful operation
Headers
Content-Type: application/jsonBody
{
"status": "OK",
"message": "Successful operation"
}Schema
{
"status": "string",
"message": "string"
}Example 2For 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
}
]200Successful operation
Headers
Content-Type: application/jsonBody
{
"status": "OK",
"message": "Successful operation"
}Example 3For 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
}
]
}
]200Successful operation
Headers
Content-Type: application/jsonBody
{
"status": "OK",
"message": "Successful operation"
}Example 4For 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
}
]
}
]
}
]200Successful operation
Headers
Content-Type: application/jsonBody
{
"status": "OK",
"message": "Successful operation"
}400Invalid ID supplied
Headers
Content-Type: application/jsonBody
{
"status": "ERROR",
"message": "Invalid ID supplied"
}Schema
{
"status": "string",
"message": "string"
}404Hotel not found
Headers
Content-Type: application/jsonBody
{
"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)
stringBasic Authentication
API responses from OTA side
200: Successful operation400: Invalid ID supplied404: Hotel not found
Response Body
-
hotelId
stringunique identifier of hotel on OTA side -
name
stringHotel name -
address
stringHotel address -
zipCode
stringHotel zip code -
city
stringHotel city
CURL example
curl -X GET "otaBaseURL/hotel/123" -H "Authorization: Basic <your-auth-token>"
- hotelId
string(required)unique identifier for hotel on OTA side
Fetches hotel info for hotel with ID 123
Headers
Authorization: Basic <your-auth-token>200Successful operation
Headers
Content-Type: application/jsonBody
{
"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
}400Invalid ID supplied
404Hotel 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)
stringBasic Authentication
API responses from OTA side
200: Successful operation400: Invalid ID supplied404: Hotel not found
Response Body
-
rooms
arrayRooms array -
rooms@
id stringOTA Room id -
rooms@
name stringOTA Room name -
total
integerTotal rooms number (together with perPage can be used for pagination) -
perPage
integerNumber of rooms returned per page
CURL example
curl -X GET "otaBaseURL/hotel/123/rooms?page=1" -H "Authorization: Basic <your-auth-token>"
- hotelId
string(required)unique identifier for hotel on OTA side
- page
number(optional) Default: 1Page to return, defaults to 1 (pagination)
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>200Successful operation
Headers
Content-Type: application/jsonBody
{
"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
}400Invalid ID supplied
404Hotel 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)
stringBasic Authentication
API responses from OTA side
200: Successful operation400: Invalid ID supplied404: Hotel not found
Response Body
-
rates
arrayRates array -
rates@
id stringRate id -
rates@
name stringRate name -
total
integerTotal rates number (together with perPage can be used for pagination) -
perPage
integerNumber of rates returned per page
CURL example
curl -X GET "otaBaseURL/hotel/123/rates?page=1" -H "Authorization: Basic <your-auth-token>"
- hotelId
string(required)Unique identifier for hotel on OTA side
- page
number(optional) Default: 1Page to return, defaults to 1 (pagination)
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>200Successful operation
Headers
Content-Type: application/jsonBody
{
"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
}400Invalid ID supplied
404Hotel 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*
stringBasic Authentication
Request Body
-
body*
objectReservation data (See CreateUpdateReservationRequest)
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
}
}'
- hotelId
string(required)OTA hotel ID
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
}200Successful operation
Headers
Content-Type: application/jsonBody
{
"status": "OK",
"message": "Successful operation"
}400Invalid ID supplied
Headers
Content-Type: application/jsonBody
{
"status": "ERROR",
"message": "Invalid ID supplied"
}401Unauthorized
Headers
Content-Type: application/jsonBody
{
"status": "ERROR",
"message": "Unauthorized"
}404Hotel not found
Headers
Content-Type: application/jsonBody
{
"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*
stringBasic Authentication
Request Body
-
body*
objectReservation data (See CreateUpdateReservationRequest)
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
}
}'
- hotelId
string(required)OTA hotel ID
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
}200Successful operation
Headers
Content-Type: application/jsonBody
{
"status": "OK",
"message": "Successful operation"
}400Invalid ID supplied
Headers
Content-Type: application/jsonBody
{
"status": "ERROR",
"message": "Invalid ID supplied"
}401Unauthorized
Headers
Content-Type: application/jsonBody
{
"status": "ERROR",
"message": "Unauthorized"
}404Hotel not found
Headers
Content-Type: application/jsonBody
{
"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*
stringBasic Authentication
Request Body
-
body*
objectCancellation data (See CancelGenericReservationRequest)
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"
}
}'
- hotelId
string(required)OTA hotel ID
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
}
}200Successful operation
Headers
Content-Type: application/jsonBody
{
"status": "OK",
"message": "Successful operation"
}400Invalid ID supplied
Headers
Content-Type: application/jsonBody
{
"status": "ERROR",
"message": "Invalid ID supplied"
}401Unauthorized
Headers
Content-Type: application/jsonBody
{
"status": "ERROR",
"message": "Unauthorized"
}404Hotel not found
Headers
Content-Type: application/jsonBody
{
"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
stringInternal booking ID on OTA side -
ucid
stringUnique correlation ID UUIDv4 (for debugging) -
note
stringBooking note -
stay
arrayArray of Stay objects -
booker
objectBooker information -
creditCard
objectCredit card information
Example
{
"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
{
"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
stringInternal stay ID on OTA side -
adults
integerNumber of adults -
children
integerNumber of children -
childrenAges
arrayArray of children's ages -
arrivalDate
stringArrival date (YYYY-MM-DD format) -
departureDate
stringDeparture date (YYYY-MM-DD format) -
commission
floatOTA commission nominal amount -
bookedAt
stringBooking timestamp (2006-01-02T15:04:05 UTC format) -
note
stringStay note -
guests
arrayArray of Guest objects -
prices
arrayArray 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
stringBooker's name -
email
stringBooker's email -
phone
stringBooker's phone -
address
stringBooker's address -
city
stringBooker's city -
postalCode
stringBooker's postal code -
note
stringAdditional notes about the booker -
countryCode
stringBooker's country code -
isCompany
booleanWhether the booker is a company -
vatId
stringVAT ID for companies -
document
objectDocument 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
stringGuest's name -
email
stringGuest's email -
phone
stringGuest's phone -
address
stringGuest's address -
city
stringGuest's city -
postalCode
stringGuest's postal code -
note
stringAdditional notes about the guest -
countryCode
stringGuest's country code -
document
objectDocument 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
integerDocument type (1-25) -
number
stringDocument number
Document Types
- Border crossing pass (foreign)
- Travel documents for refugees issued by RH
- Other
- Sailor's booklet (Croatian)
- Children's passport (foreign)
- Official passport (Croatian)
- Diplomatic passport (foreign)
- Travel document issued by RH
- Proof of passport retention
- Diplomatic personal ID card
- Health insurance card
- Travel document for stateless persons
- Children's passport (Croatian)
- Personal passport (Croatian)
- Joint passport (Croatian)
- Driver's licence (Croatian)
- Family passport (Croatian)
- Personal passport (foreign)
- Driver's licence (foreign)
- Personal ID card for foreigners issued by RH
- Diplomatic passport (Croatian)
- Document/proof of lost or stolen travel documents
- Personal ID card (foreign)
- Travel paper for foreigners (foreign)
- 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
objectAccommodation information including price and rateId -
services
arrayArray of service objects -
meals
arrayArray of meal objects -
fees
arrayArray of fee objects -
date
stringDate for this price entry (YYYY-MM-DD format) -
roomId
stringInternal Room ID on OTA side
Accommodation
-
price
numberPrice -
rateId
stringOTA Rate ID
Service/Meal/Fee
-
name
stringName of the service/meal/fee -
price
numberPrice -
quantity
integerQuantity -
includedInAccommodation
booleanWhether 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
stringCard number -
cardHolder
stringName on card -
cardExpiryMonth
stringMM format -
cardExpiryYear
stringYYYY format -
cvv
stringCard 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
stringInternal booking ID on OTA side -
ucid
stringUnique correlation ID UUIDv4 (for debugging) -
reason
stringCancellation reason -
booker
objectSimplified 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