API docs by Redocly

Distributor API. (0.0.6-SNAPSHOT)

Download OpenAPI specification:

Provides an API endpoints to access data on RoomDB.
More detailed information can be found in project README file

01. List of Properties

API endpoints to list of properties based on search parameters

Api to get search properties based on geocode, optional filtered ids, optional ratings

Authorizations:
bearerAuth
Request Body schema: application/json
required
latitude
required
string

latitude

longitude
required
string

longitude

radius
integer <int32> >= 0

radius

distributorType
Array of strings

distributor type

propertyTypeIds
Array of integers <int32> unique [ items <int32 > ]
hotelFacilitiesFiltered
Array of integers <int32> unique [ items <int32 > ]
pageNumber
integer <int32>
pageSize
integer <int32>

page size

checkInDate
string

checkIn Date

checkOutDate
string

checkOut Date

ratings
Array of strings

ratings

Array of objects (SortRequest)

Responses

Request samples

Content type
application/json
{
  • "latitude": "41.04984",
  • "longitude": "8.94651",
  • "radius": 20,
  • "distributorType": "[A/B/C]",
  • "propertyTypeIds": [
    ],
  • "hotelFacilitiesFiltered": [
    ],
  • "pageNumber": 0,
  • "pageSize": 10,
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "ratings": "[noRating/1/2/3/4/5]",
  • "sortRequests": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get search properties based on geocode, optional filtered ids, optional ratings Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
required
latitude
required
string

latitude

longitude
required
string

longitude

radius
integer <int32> >= 0

radius

distributorType
Array of strings

distributor type

propertyTypeIds
Array of integers <int32> unique [ items <int32 > ]
hotelFacilitiesFiltered
Array of integers <int32> unique [ items <int32 > ]
pageNumber
integer <int32>
pageSize
integer <int32>

page size

checkInDate
string

checkIn Date

checkOutDate
string

checkOut Date

ratings
Array of strings

ratings

Responses

Request samples

Content type
application/json
{
  • "latitude": "41.04984",
  • "longitude": "8.94651",
  • "radius": 20,
  • "distributorType": "[A/B/C]",
  • "propertyTypeIds": [
    ],
  • "hotelFacilitiesFiltered": [
    ],
  • "pageNumber": 0,
  • "pageSize": 10,
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "ratings": "[noRating/1/2/3/4/5]"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get search properties based on geocode, optional listId and optional filtered facility ids Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
required
latitude
required
string

latitude

longitude
required
string

longitude

radius
integer <int32> >= 0

radius

distributorType
Array of strings

distributor type

listId
integer <int32>

listId

hotelFacilitiesFiltered
Array of integers <int32> unique [ items <int32 > ]
pageNumber
integer <int32>
pageSize
integer <int32>

page size

checkInDate
string

checkIn Date

checkOutDate
string

checkOut Date

ratings
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "latitude": "41.04984",
  • "longitude": "8.94651",
  • "radius": 20,
  • "distributorType": "[A/B/C]",
  • "listId": 1,
  • "hotelFacilitiesFiltered": [
    ],
  • "pageNumber": 0,
  • "pageSize": 10,
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "ratings": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get search properties based on listId and optional filtered facility ids Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
required
listId
required
integer <int32> >= 0

listId

latitude
string

latitude

longitude
string

longitude

radius
integer <int32> >= 0

radius

distributorType
Array of strings

distributor type

propertyTypeIds
Array of integers <int32> unique [ items <int32 > ]
hotelFacilitiesFiltered
Array of integers <int32> unique [ items <int32 > ]
pageNumber
integer <int32>
pageSize
integer <int32>

page size

checkInDate
string

checkIn Date

checkOutDate
string

checkOut Date

ratings
Array of strings

ratings

Responses

Request samples

Content type
application/json
{
  • "listId": 1,
  • "latitude": "41.04984",
  • "longitude": "8.94651",
  • "radius": 20,
  • "distributorType": "[A/B/C]",
  • "propertyTypeIds": [
    ],
  • "hotelFacilitiesFiltered": [
    ],
  • "pageNumber": 0,
  • "pageSize": 10,
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "ratings": "[noRating/1/2/3/4/5]"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get search properties based on listId and optional filtered facility ids

Authorizations:
bearerAuth
Request Body schema: application/json
required
listId
required
integer <int32> >= 0

listId

latitude
string

latitude

longitude
string

longitude

radius
integer <int32> >= 0

radius

distributorType
Array of strings

distributor type

propertyTypeIds
Array of integers <int32> unique [ items <int32 > ]
hotelFacilitiesFiltered
Array of integers <int32> unique [ items <int32 > ]
pageNumber
integer <int32>
pageSize
integer <int32>

page size

checkInDate
string

checkIn Date

checkOutDate
string

checkOut Date

ratings
Array of strings

ratings

Array of objects (SortRequest)

Responses

Request samples

Content type
application/json
{
  • "listId": 1,
  • "latitude": "41.04984",
  • "longitude": "8.94651",
  • "radius": 20,
  • "distributorType": "[A/B/C]",
  • "propertyTypeIds": [
    ],
  • "hotelFacilitiesFiltered": [
    ],
  • "pageNumber": 0,
  • "pageSize": 10,
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "ratings": "[noRating/1/2/3/4/5]",
  • "sortRequests": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get List of Property by ids

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyIds
required
Array of integers <int32> unique [ items <int32 > ]

Property Ids

Responses

Request samples

Content type
application/json
{
  • "propertyIds": [
    ]
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get all filters count based on geocode

Authorizations:
bearerAuth
Request Body schema: application/json
required
latitude
required
string

latitude

longitude
required
string

longitude

radius
integer <int32> >= 0

radius

distributorType
Array of strings

distributor type

ratings
Array of strings

ratings

propertyTypeIds
Array of integers <int32> unique [ items <int32 > ]
hotelFacilitiesFiltered
Array of integers <int32> unique [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "latitude": "41.04984",
  • "longitude": "8.94651",
  • "radius": 20,
  • "distributorType": "[A/B/C]",
  • "ratings": "[noRating/1/2/3/4/5]",
  • "propertyTypeIds": [
    ],
  • "hotelFacilitiesFiltered": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get all filters count based on listId

Authorizations:
bearerAuth
Request Body schema: application/json
required
listId
required
integer <int32>

listId

latitude
string

latitude

longitude
string

longitude

radius
integer <int32> >= 0

radius

distributorType
Array of strings

distributor type

ratings
Array of strings

ratings

hotelFacilitiesFiltered
Array of integers <int32> unique [ items <int32 > ]
propertyTypeIds
Array of integers <int32> unique [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "listId": 2,
  • "latitude": "41.04984",
  • "longitude": "8.94651",
  • "radius": 20,
  • "distributorType": "[A/B/C]",
  • "ratings": "[noRating/1/2/3/4/5]",
  • "hotelFacilitiesFiltered": [
    ],
  • "propertyTypeIds": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get properties by geolocation and optional radius. Deprecated

Authorizations:
bearerAuth
query Parameters
latitude
required
number <double> [ -90 .. 90 ]

Latitude of property. Required.

longitude
required
number <double> [ -180 .. 180 ]

Longitude of property. Required.

radius
integer <int32> >= 1

Search radius in kilometers. Default to 20 km. Optional.

page
integer <int32> >= 0
Default: 0

Page number in paginated request. Default is 0.

size
integer <int32> [ 1 .. 1000 ]
Default: 10

Size of the page in paginated request. Default is 10.

distributorType
Array of arrays
Items Enum: "A" "B" "C"

Type A: Properties that can be booked immediately (instant booking) and real-time inventory is stored in our database.

Type B: Properties that can be booked immediately (instant booking) but inventory must be fetched from third-party databases.

Type C: Properties that can be booked on request only.

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "number": 0,
  • "size": 0,
  • "totalElements": 0,
  • "pageable": {
    },
  • "last": true,
  • "totalPages": 0,
  • "sort": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "empty": true
}

Api to get all property ids connected to a channel

Authorizations:
bearerAuth
path Parameters
channelId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get all filters count based on geocode Deprecated

Authorizations:
bearerAuth
query Parameters
latitude
required
number <double> [ -90 .. 90 ]

Latitude of property. Required.

longitude
required
number <double> [ -180 .. 180 ]

Longitude of property. Required.

radius
integer <int32> >= 1
Default: 20

Search radius in kilometers. Default to 20 km. Optional.

distributorType
Array of strings
Example: distributorType=[A/B/C]

distributor type

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get all filters count based on listId Deprecated

Authorizations:
bearerAuth
path Parameters
listId
required
integer <int32>
query Parameters
distributorType
Array of strings
Example: distributorType=[A/B/C]

distributor type

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get Properties count

Authorizations:
bearerAuth
query Parameters
allPropertiesCount
boolean
Default: false

By default this will return only count of properties with not null distributor types, for count of all properties pass flag as true

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Api to get Properties count for given listId

Authorizations:
bearerAuth
path Parameters
listId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

02. Properties

API endpoints to access Property basic information.

Get property data by id.

If supplier has role to read all properties than this endpoint will return any property in a system.
If supplier has no role to read all properties, result will return property only if it belongs to supplier.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get property data by id with media with isMain flag as true.

If supplier has role to read all properties than this endpoint will return any property in a system.
If supplier has no role to read all properties, result will return property only if it belongs to supplier.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get property data with facility data by id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1000000

RoomDB internal Property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

getSpecificPropertyFieldsForAISiteMap

Authorizations:
bearerAuth
path Parameters
fileName
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get property data with property info and google reviews by property id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get property info by property id.

If supplier has role to read all properties than this endpoint will return any property in a system.
If supplier has no role to read all properties, result will return property only if it belongs to supplier.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get property identifiers by property id.

It will return array of the identifiers if supplier has access to the property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get property facility data by propertyId.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1000000

RoomDB internal Property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get property facility data by propertyId and identifierSourceId.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1000000

RoomDB internal Property Id. Required.

identifierSourceId
required
integer <int32> >= 1

RoomDB Identifier Source Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

getSpecificPropertyFieldsForAI

Authorizations:
bearerAuth
path Parameters
fileName
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get property data by CultSwitch id.

If supplier has role to read all properties than this endpoint will return any property in a system.
If supplier has no role to read all properties, result will return property only if it belongs to supplier.

Authorizations:
bearerAuth
path Parameters
id
required
string [ 1 .. 255 ] characters

CultSwitch id - property id that is used in CultSwitch. Also known as ObjectId. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all logo(s), by property id.

All fields of the logo entity will be included in result.
There could be more than one logo.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

04. Property Filters

API endpoints to access Property Filters supported as of now,

These filterIds should be used in List of Properties Search end point

Get All Property Facility Filter.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Property Facility Filter by id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

Property Facility Filter ID. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

05. Sellable Units

API endpoints to get sellable units such as rooms, meals, extras.

Get sellable unit data by id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

RoomDB internal Sellable Unit Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get sellable unit by supplier unit id (deprecated: please use by-property-and-supplier-unit endpoint. Deprecated

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

Supplier unit id - unit (room, meal, etc.) id that is used on supplier side. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all sellable unit types.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all available sellable unit payment types.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get pagination of all sellable units, by property id

All fields of the sellable unit entity will be included in result.

Authorizations:
bearerAuth
query Parameters
page
integer <int32> >= 0
Default: 0

Page number in paginated request. Default is 0.

size
integer <int32> >= 1
Default: 10

Size of the page in paginated request. Default is 10.

propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get pagination of all sellable units, by property id and Sellable Unit type code

All fields of the sellable unit entity will be included in result.

Authorizations:
bearerAuth
query Parameters
page
integer <int32> >= 0
Default: 0

Page number in paginated request. Default is 0.

size
integer <int32> >= 1
Default: 10

Size of the page in paginated request. Default is 10.

propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

type
required
string [ 1 .. 255 ] characters

Sellable Unit type code. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get pagination of all sellable units, by property id and extra

All fields of the sellable unit entity will be included in result.

Authorizations:
bearerAuth
query Parameters
page
integer <int32> >= 0
Default: 0

Page number in paginated request. Default is 0.

size
integer <int32> >= 1
Default: 10

Size of the page in paginated request. Default is 10.

propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

isExtra
required
boolean

Get extra or not extra Sellable Units. Required.

language
string
Default: "en"

language, Default is 'en'.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get sellable unit identifiers by sellable unit id.

It will return array of the identifiers if supplier has access to the sellable unit

Authorizations:
bearerAuth
path Parameters
sellableUnitId
required
integer <int32> >= 1

RoomDB internal sellable unit Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all 'extra' sellable units, by property id.

All fields of the sellable unit entity will be included in result.
If you need to access to all sellable units related to a property, using "paging" endpoint is strongly recommended.Also result of this endpoint will include additional information for each sellable unit. Additional fields are: capacities, logos and media

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all 'extra' sellable units, by property id paginated.

All fields of the sellable unit entity will be included in result.
Also result of this endpoint will include additional information for each sellable unit. Additional fields are: capacities, logos and media

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

query Parameters
page
integer <int32> >= 0
Default: 0

Page number in paginated request. Default is 0.

size
integer <int32> >= 1
Default: 10

Size of the page in paginated request. Default is 10.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

getSpecificSellableUnitFieldsForAI

Authorizations:
bearerAuth
path Parameters
fileName
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get sellable unit capacity data.

Authorizations:
bearerAuth
path Parameters
sellableUnitId
required
integer <int32> >= 1

RoomDB internal Sellable Unit Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all sellable units, by property id.

All fields of the sellable unit entity will be included in result.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all sellable units, by property id and by specific sellable unit type.

All fields of the sellable unit entity will be included in result.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

type
required
string [ 1 .. 255 ] characters

Sellable Unit type code. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get sellable unit by property id and supplier unit id.

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32>
supplierUnitId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all sellable units, by property id and by specifying is extra or not.

All fields of the sellable unit entity will be included in result.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

isExtra
required
boolean

Get extra or not extra Sellable Units. Required.

query Parameters
language
string
Default: "en"

language, Default is 'en'.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get sellable unit data by External System Id.

Two params are needed: External System Abbreviation and External System Id.

Authorizations:
bearerAuth
path Parameters
source
required
string [ 1 .. 255 ] characters

External System Abbreviation - abbreviation that is used in RoomDb to identify External system. In models known as IdentifierSource - abbreviation. Required.

id
required
string [ 1 .. 255 ] characters

External System Id - identifier that is used in External system. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

06. Room Filters

API endpoints to access Room Filters

Get All Room Facility Meta.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Room Facility Meta by id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

Room Facility Meta ID. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Room Facility Meta by facility id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

Room Facility Meta Facility ID. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

07.01. Products for Type A (Instant Booking, real time) properties

API endpoints to get products related data for Type A properties.

Get List of Products.

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

checkInDate
required
string

arrivalDate

checkOutDate
required
string

departureDate

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

language
string
Default: "en"

Language.

promoCode
string

Promo Code.

object (CreateReservationGuestCount)

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "language": "en",
  • "promoCode": "promo123",
  • "totalGuestCounts": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

07.02. Products for Type B (Instant Booking) properties

API endpoints to get products related data for Type B properties.

Get Rates for Nuitee properties

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyId
required
string

PropertyId.

checkInDate
required
string

arrivalDate

checkOutDate
required
string

departureDate

Array of objects (NuiteeRatesRoomsRequest)
currency
string
nationality
string
language
string
refundableRatesOnly
boolean

Responses

Request samples

Content type
application/json
{
  • "propertyId": "1000000",
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "rooms": [
    ],
  • "currency": "string",
  • "nationality": "string",
  • "language": "string",
  • "refundableRatesOnly": true
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Min Rates for Nuitee properties

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyIds
Array of integers <int32> [ items <int32 > ]
checkIn
required
string

arrivalDate

checkOut
required
string

departureDate

Responses

Request samples

Content type
application/json
{
  • "propertyIds": [
    ],
  • "checkIn": "2024-08-18",
  • "checkOut": "2024-08-19"
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Products for EHotel properties Deprecated

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32>

RoomDb Property Id

noOfRooms
required
string

Number of Rooms

noOfPersons
required
string

Number of Persons per room

checkInDate
required
string <date>

Check In Date in yyyy-MM-dd format

checkOutDate
required
string <date>

Check Out Date in yyyy-MM-dd format

isProduction
boolean
Default: true

Is Production, Default value true

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Products for EHotel properties

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32>

RoomDb Property Id

noOfRooms
required
string

Number of Rooms

noOfPersons
required
string

Number of Persons per room

checkInDate
required
string <date>

Check In Date in yyyy-MM-dd format

checkOutDate
required
string <date>

Check Out Date in yyyy-MM-dd format

isProduction
boolean
Default: true

Is Production, Default value true

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Products cache data for EHotel properties, this api may not return latest up to data

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32>

RoomDb Property Id

startDate
required
string <date>

Start Date in yyyy-MM-dd format

endDate
required
string <date>

End Date in yyyy-MM-dd format

noOfRooms
required
integer <int32>

Number Of Rooms

noOfPersons
required
integer <int32>

Number Of Persons

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Min Rates for EHotel properties

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyIds
Array of integers <int32> [ items <int32 > ]
checkIn
required
string

arrivalDate

checkOut
required
string

departureDate

Responses

Request samples

Content type
application/json
{
  • "propertyIds": [
    ],
  • "checkIn": "2024-08-18",
  • "checkOut": "2024-08-19"
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

08. Media

API endpoints to get media such as photos and logos.

Get media data by id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

RoomDB internal media Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media, by property id with various filters

All fields of the media entity will be included in result.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

query Parameters
sellableUnitId
integer <int32> >= 0

SellableUnitId.

sortBy
string
Default: "sortOrder"

Field name that should be used for sorting in paginated request. Default is 'sortOrder'.

sortDesc
boolean
Default: false

Is descending sort should be applied in sorting in paginated request. Default is 'false'.

mediaTypeId
string
Example: mediaTypeId=1

mediaTypeId

isMain
string
Example: isMain=false

isMain

isLogo
string
Example: isLogo=false

isLogo

isScreenshot
string
Example: isScreenshot=false

isScreenshot

isUnassigned
string
Example: isUnassigned=false

isUnassigned

isMemo
string
Example: isMemo=false

isMemo

isFullBackgroundImage
string
Example: isFullBackgroundImage=false

isFullBackgroundImage

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media, by property id paginated with various filters

All fields of the media entity will be included in result.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

query Parameters
sellableUnitId
integer <int32> >= 0

SellableUnitId.

page
integer <int32> >= 0
Default: 0

Page number in paginated request.

size
integer <int32> [ 1 .. 100 ]
Default: 10

Size of the page in paginated request.

sortBy
string
Default: "sortOrder"

Field name that should be used for sorting in paginated request. Default is 'sortOrder'.

sortDesc
boolean
Default: false

Is descending sort should be applied in sorting in paginated request. Default is 'false'.

mediaTypeId
string
Example: mediaTypeId=1

mediaTypeId

isMain
string
Example: isMain=false

isMain

isLogo
string
Example: isLogo=false

isLogo

isScreenshot
string
Example: isScreenshot=false

isScreenshot

isUnassigned
string
Example: isUnassigned=false

isUnassigned

isMemo
string
Example: isMemo=false

isMemo

isFullBackgroundImage
string
Example: isFullBackgroundImage=false

isFullBackgroundImage

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all Predefined Tags.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media types.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media attribute types.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media attribute types for provided media type.

Authorizations:
bearerAuth
path Parameters
mediaTypeId
required
integer <int32> >= 1

RoomDB internal media type Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of media attributes for media.

Authorizations:
bearerAuth
path Parameters
mediaId
required
integer <int32> >= 1

RoomDB internal media Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all License types.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get First media with lowest sort order, by CultSwitch property id.

All fields of the media entity will be included in result.
This api returns first media with lowest sort order. If no media exist with sort order, it will return any one media. If no media exist for property, empty array will be returned

Authorizations:
bearerAuth
path Parameters
cultSwitchPropertyId
required
string

Cultswitch property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media by sellable unit id.

All fields of the media entity will be included in result.

Authorizations:
bearerAuth
path Parameters
sellableUnitId
required
string >= 1
Example: 12

Room DB internal sellable unit id.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media, by property id.

All fields of the media entity will be included in result.
If you need to access to all medias related to a property, using "paging" endpoint is strongly recommended.If the caller has sufficient privileges, this endpoint will return all media in the system related to the property ID.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media, by property id paginated

All fields of the media entity will be included in result.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

query Parameters
page
integer <int32> >= 0
Default: 0

Page number in paginated request.

size
integer <int32> >= 1
Default: 10

Size of the page in paginated request.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media, by property id and isMain flag in sorted order.

All fields of the media entity will be included in result.
If you need access to all medias related to a property, using "paging" endpoint is strongly recommended.If the caller has sufficient privileges, this endpoint will return all media in the system related to the property ID.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

query Parameters
isMain
required
boolean

Value for isMain

includeScreenshot
string
Example: includeScreenshot=false

Include screenshot in the list

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media, by CultSwitch property id.

All fields of the media entity will be included in result.
If you need access to all medias related to a property, using "paging" endpoint is strongly recommended.If the caller has sufficient privileges, this endpoint will return all media in the system related to the property ID.

Authorizations:
bearerAuth
path Parameters
cultSwitchPropertyId
required
string

Cultswitch property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media, by Cultswitch property id paginated

All fields of the media entity will be included in result.

Authorizations:
bearerAuth
path Parameters
cultSwitchPropertyId
required
string

Cultswitch property Id. Required.

query Parameters
page
integer <int32> >= 0
Default: 0

Page number in paginated request.

size
integer <int32> [ 1 .. 100 ]
Default: 10

Size of the page in paginated request.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all media, by CultSwitch property id and isMain flag in sorted order.

All fields of the media entity will be included in result.
If you need access to all medias related to a property, using "paging" endpoint is strongly recommended.If the caller has sufficient privileges, this endpoint will return all media in the system related to the property ID.

Authorizations:
bearerAuth
path Parameters
cultSwitchPropertyId
required
string

Cultswitch property Id. Required.

query Parameters
isMain
required
boolean

Value for isMain

includeScreenshot
string
Example: includeScreenshot=false

Include screenshot in the list

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

09. Calendar

API endpoints to get availabilities by property id

downloadRoomJson

path Parameters
fileName
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

getPropertyCalendarForCultBookingChannel

path Parameters
fileName
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

getProductCalendarJson

path Parameters
fileName
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

getCalendarBySource

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32> >= 1

RoomDB PropertyId. Required.

startDate
string <date>

Start date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

endDate
string <date>

End date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

availabilityGtThan
integer <int32> >= 0

Availability filter number. Records with availability grater than provided number will be included in result. Optional.

closedForSale
boolean

Include in result closed for sale records. Optional.

channelId
integer <int32> >= 1

Channel identifier. Optional.

productId
Array of integers <int32> [ items <int32 > ]

CSV list of Product identifiers. Optional.

roomId
Array of integers <int32> [ items <int32 > ]

CSV list of Room identifiers. Optional.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get product properties with default restrictions

This API fetches record based on default restrictions :
availability greater than zero Or
closedForSale is true Or
closedToArrival is true Or
closedToDeparture is true Or
minLos is greater than one

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32> >= 1

RoomDB PropertyId. Required.

startDate
string <date>

Start date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

endDate
string <date>

End date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

channelId
integer <int32> >= 1

Channel identifier. Required.

productId
Array of integers <int32> [ items <int32 > ]

CSV list of Product identifiers. Optional.

roomId
Array of integers <int32> [ items <int32 > ]

CSV list of Room identifiers. Optional.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getCalendarBySourceCultbooking

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32> >= 1

RoomDB PropertyId. Required.

startDate
string <date>

Start date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

endDate
string <date>

End date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

availabilityGtThan
integer <int32> >= 0

Availability filter number. Records with availability grater than provided number will be included in result. Optional.

closedForSale
boolean

Include in result closed for sale records. Optional.

channelId
integer <int32> >= 1

Channel identifier. Optional.

productId
Array of integers <int32> [ items <int32 > ]

CSV list of Product identifiers. Optional.

roomId
Array of integers <int32> [ items <int32 > ]

CSV list of Room identifiers. Optional.

Responses

Response samples

Content type
application/json
{
  • "prices": {
    },
  • "closeDepartureParams": {
    },
  • "closeArrivalParams": {
    },
  • "closeSaleParams": {
    },
  • "currency": [
    ],
  • "symbol": [
    ],
  • "min_stays": {
    },
  • "min_stays_only": {
    },
  • "MinLos": {
    },
  • "Cheapest": {
    }
}

getCalendarIBEBySource

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32> >= 1

RoomDB PropertyId. Required.

startDate
string <date>

Start date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

endDate
string <date>

End date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

10.01. Reservations for Type A (Instant Booking, real time) properties

API endpoints for Reservations for Type A properties.

Create a pending reservation (Phase 1 booking).

Authorizations:
bearerAuth
header Parameters
pci-token
string
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

arrival
required
string

arrivalDate

departure
required
string

departureDate

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

language
string
Default: "en"

Language.

required
Array of objects (CreateReservationRoomRate)
required
object (CreateReservationGuestCount)
comments
Array of strings
required
object (CreateReservationBooker)
Array of objects (CreateReservationGuest)
object (CreateReservationOtaDetails)
object (CreateReservationCreditCardDetails)
isCreditCardBooking
boolean

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "arrival": "2024-08-18",
  • "departure": "2024-08-19",
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "language": "en",
  • "roomRates": [
    ],
  • "totalGuestCounts": {
    },
  • "comments": [
    ],
  • "booker": {
    },
  • "guests": [
    ],
  • "otaDetails": {
    },
  • "ccData": {
    },
  • "isCreditCardBooking": true
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Confirm a pending reservation (Phase 2 booking).

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

reservationId
required
string

Reservation Id.

language
string
Default: "en"

Language.

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "reservationId": "14253cds3bc244e",
  • "language": "en"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Update CC Data for a reservation.

Authorizations:
bearerAuth
header Parameters
pci-token
string
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

reservationId
required
string

Reservation Id.

object (CreateReservationCreditCardDetails)

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "reservationId": "14253cds3bc244e",
  • "ccData": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Reservation Information by Booking Id. Deprecated

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32>
bookingId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Reservation Information by Booking Id.

Authorizations:
bearerAuth
query Parameters
distributorId
required
integer <int32>
distributorCode
required
string
bookingId
integer <int32>
propertyId
integer <int32>
channelBookingId
string
start
string
end
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

10.02. Reservations for Type B (Instant Booking) properties

API endpoints for Reservations for Type B properties.

Create a pending reservation (Phase 1 booking).

Authorizations:
bearerAuth
Request Body schema: application/json
required
offerId
required
string
usePaymentSdk
boolean

Responses

Request samples

Content type
application/json
{
  • "offerId": "string",
  • "usePaymentSdk": true
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Confirm a pending reservation (Phase 2 booking).

Authorizations:
bearerAuth
Request Body schema: application/json
required
prebookId
required
string
object (NuiteeConfirmBookingHolderRequest)
Array of objects (NuiteeConfirmBookingGuestsRequest)
object (NuiteeConfirmBookingPaymentRequest)

Responses

Request samples

Content type
application/json
{
  • "prebookId": "string",
  • "holder": {
    },
  • "guests": [
    ],
  • "payment": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

EHotel Reservation Deprecated

Authorizations:
bearerAuth
path Parameters
sellableUnitId
required
integer <int32>
supplierUnitId
required
string
roomTypeCode
required
string
availabilityId
required
integer <int32>
Request Body schema: application/json
required
checkInDate
required
string

arrivalDate

checkOutDate
required
string

departureDate

object (EHotelGuestDetailsRequest)
Array of objects (EHotelGuestDetailsRequest)
object (EHotelCompanyDetailsRequest)
cardToken
required
string

Card Token.

isProduction
required
boolean

Is Production.

specialRequests
Array of strings

Responses

Request samples

Content type
application/json
{
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "bookerDetails": {
    },
  • "guestDetails": [
    ],
  • "companyDetails": {
    },
  • "cardToken": "2357894646598718498",
  • "isProduction": true,
  • "specialRequests": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

EHotel Reservation V2

Authorizations:
bearerAuth
path Parameters
supplierUnitId
required
string
roomTypeCode
required
string
availabilityId
required
integer <int32>
noOfRooms
required
integer <int32>
noOfPersonsPerRoom
required
integer <int32>
Request Body schema: application/json
required
checkInDate
required
string

arrivalDate

checkOutDate
required
string

departureDate

object (EHotelGuestDetailsRequest)
Array of objects (EHotelGuestDetailsRequest)
object (EHotelCompanyDetailsRequest)
cardToken
required
string

Card Token.

isProduction
required
boolean

Is Production.

specialRequests
Array of strings

Responses

Request samples

Content type
application/json
{
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "bookerDetails": {
    },
  • "guestDetails": [
    ],
  • "companyDetails": {
    },
  • "cardToken": "2357894646598718498",
  • "isProduction": true,
  • "specialRequests": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get booking data by bookingId.

Authorizations:
bearerAuth
query Parameters
bookingId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get EHotel Reservation Data By Id

Authorizations:
bearerAuth
query Parameters
reservationId
required
string

Reservation Id

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

11.01. Cancellations for Type A (Instant Booking, real time) properties

API endpoints for Cancellations for Type A properties.

Cancel Reservation by Booking Id.

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

reservationId
required
string

Reservation Id.

bookerReservationId
required
string

Booker Reservation Id.

language
string
Default: "en"

Language.

cancellationReasonLanguage
string
Default: "en"

Cancellation Reason Language.

cancellationReason
string

Cancellation Reason.

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "reservationId": "14253cds3bc244e",
  • "bookerReservationId": "14253cds3bc244e",
  • "language": "en",
  • "cancellationReasonLanguage": "en",
  • "cancellationReason": "Not Interested anymore"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Cancellation Policy by Booking Id.

Authorizations:
bearerAuth
query Parameters
bookingId
required
integer <int32>

BookingId. Required.

language
required
string

language. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

11.02. Cancellations for Type B (Instant Booking) properties

API endpoints for Cancellations for Type B properties.

Cancel Booking

Authorizations:
bearerAuth
Request Body schema: application/json
required
bookingId
required
string
reason
string

Responses

Request samples

Content type
application/json
{
  • "bookingId": "string",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

EHotel Cancellations

Authorizations:
bearerAuth
query Parameters
supplierUnitId
required
string

Supplier Unit Id

reservationId
required
string

Reservation Id

reservationPin
required
string

Reservation Pin

isProduction
boolean
Default: true

Is Production, Default value true

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

12. Authentication

API endpoints to get token

Common call and get token base on clientId and clientSecret.

API endpoint to generate new token.

query Parameters
distributorId
required
string
distributorSecret
required
string

Responses

Response samples

Content type
application/json
{
  • "tokenType": "string",
  • "expiresIn": 0,
  • "accessToken": "string",
  • "executionTime": 0
}

Refresh token.

This API can be used by authorized users to get new token.
Potentially could be used to avoid token expire, just need to refresh before expiration time.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "tokenType": "string",
  • "expiresIn": 0,
  • "accessToken": "string",
  • "executionTime": 0
}

Get distributor information. For distributor.

This API can be used to get all information about distributor account.
This endpoint available only for distributors, administrators should use other endpoint and provide distributor name parameter.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": {},
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get distributor information. For admin

This API can be used to get all information about distributor account.
This endpoint available only for admin, distributor should use other endpoint.

Authorizations:
bearerAuth
path Parameters
name
required
string [ 1 .. 255 ] characters

Distributor name. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {},
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Helper method to get encoded password for a provided password

query Parameters
password
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

13. Health and Safety

API endpoints to health check.

Helper method to check application availability.

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

14.01. Lists > Continents

API endpoints to access Continents.

Get list of all continents.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get continent data by Alpha-2 code.

Authorizations:
bearerAuth
path Parameters
code
required
string = 2 characters

Two letters continent code (ISO 3166 Alpha-2). Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

14.02. Lists > Countries

API endpoints to access country names and codes.

Get list of all countries with ISO 3166 Alpha-2 code.

If you need other codes please use endpoint with codeFormat parameter.
Language code parameter used for name and full name language.

Authorizations:
bearerAuth
query Parameters
langCode
string = 2 characters
Default: "en"

Two letters language code (ISO 639-1). Optional. Default language is english.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get country data by id. Name, full name and codes will be included.

Authorizations:
bearerAuth
path Parameters
countryId
required
integer <int32> >= 1

RoomDB internal country Id. Required.

query Parameters
langCode
string = 2 characters
Default: "en"

Two letters language code (ISO 639-1). Optional. Default language is english.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get country data by Alpha-2 code. Name, full name and codes will be included.

Authorizations:
bearerAuth
path Parameters
code
required
string = 2 characters

Two letters country code (ISO 3166 Alpha-2). Required.

query Parameters
langCode
string = 2 characters
Default: "en"

Two letters language code (ISO 639-1). Optional. Default language is english.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of countries with specified code(s).

Valid values for codeFormat are:
- "all" to include ISO 3166 Alpha-2, Alpha-2 and Numeric code
- "alpha2" to include ISO 3166 Alpha-2 code
- "alpha3" to include ISO 3166 Alpha-3 code
- "numeric" to include ISO 3166 Numeric code

Language code parameter used for name and full name language.

Authorizations:
bearerAuth
path Parameters
codeFormat
required
string
Enum: "ALL" "ALPHA2" "ALPHA3" "NUMERIC"
query Parameters
langCode
string = 2 characters
Default: "en"

Two letters language code (ISO 639-1). Optional. Default language is english.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

14.03. Lists > States

API endpoints to access States, districts or any other country subdivisions.

Get list of all States.

All fields of the State entity will be included in result.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get state data by id.

Authorizations:
bearerAuth
path Parameters
stateId
required
integer <int32> >= 1

RoomDB internal state Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all states for country. Country code should be in ISO 3166 Alpha-2 format.

Authorizations:
bearerAuth
path Parameters
countryCode
required
string = 2 characters

Two letters country code (ISO 3166 Alpha-2). Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get state data by its code (ISO 3166-2).

Authorizations:
bearerAuth
path Parameters
code
required
string [ 2 .. 8 ] characters

State code (ISO 3166-2). Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

14.04. Lists > Currencies

API endpoints to access Currency information.

Get list of all currencies.

All fields of the Currency entity will be included in result.

Authorizations:
bearerAuth
query Parameters
langCode
string = 2 characters

Two letters language code (ISO 639-1). Optional. Default language is english.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get currency data by id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

RoomDB internal currency Id. Required.

query Parameters
langCode
string = 2 characters

Two letters language code (ISO 639-1). Optional. Default language is english.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get currency data by ISO 4217 numeric code.

Authorizations:
bearerAuth
path Parameters
code
required
integer <int32> [ 1 .. 999 ]

Numeric currency code (ISO 4217). Required.

query Parameters
langCode
string = 2 characters

Two letters language code (ISO 639-1). Optional. Default language is english.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get currency data by ISO 4217 three-letter code.

Authorizations:
bearerAuth
path Parameters
code
required
string = 3 characters

Three letters currency code (ISO 4217). Required.

query Parameters
langCode
string = 2 characters

Two letters language code (ISO 639-1). Optional. Default language is english.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

14.05. Lists > Room Types

API endpoints to access Room Type information.

Get list of all room types.

All fields of the Room Type entity will be included in result.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Room Type data by id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

RoomDB internal room type Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

15.01. Types > Property types

API endpoints to access Property Types.

Get list of all property types.

All fields of the Property Type entity will be included in result.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get property type data by id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

RoomDB internal property type Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get property type data by code value.

Authorizations:
bearerAuth
path Parameters
code
required
string [ 1 .. 4 ] characters

Code (OTA, Booking, CultSwitch) for specific Property Type. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

15.02. Types > Meal types

API endpoints to access meal types

Get list of all meal types.

All fields of the Meal Type entity will be included in result.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get meal type by id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

RoomDB internal meal type Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

16. CultBooking APIs

API endpoints to get data from CultBooking end points.

Update Session Token by token

Authorizations:
bearerAuth
path Parameters
token
required
string

Token. Required.

Request Body schema: application/json
required
sessionData
string
userIp
string
userHostName
string
userMacAddress
string
userOs
string
userPhysicalLocation
string

Responses

Request samples

Content type
application/json
{
  • "sessionData": "string",
  • "userIp": "string",
  • "userHostName": "string",
  • "userMacAddress": "string",
  • "userOs": "string",
  • "userPhysicalLocation": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Queue Entries by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32>

Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Update Queue Entries By Id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Id. Required.

Request Body schema: application/json
required
emailData
string
ewsEmailId
string
sentAt
string

Responses

Request samples

Content type
application/json
{
  • "emailData": "string",
  • "ewsEmailId": "string",
  • "sentAt": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Add Session Token

Authorizations:
bearerAuth
Request Body schema: application/json
required
sessionData
string
userIp
string
userHostName
string
userMacAddress
string
userOs
string
userPhysicalLocation
string

Responses

Request samples

Content type
application/json
{
  • "sessionData": "string",
  • "userIp": "string",
  • "userHostName": "string",
  • "userMacAddress": "string",
  • "userOs": "string",
  • "userPhysicalLocation": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Add Reservation Logs

Authorizations:
bearerAuth
Request Body schema: application/json
required
reservationId
string
logMessage
string
hostName
string

Responses

Request samples

Content type
application/json
{
  • "reservationId": "string",
  • "logMessage": "string",
  • "hostName": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Add Queue Log

Authorizations:
bearerAuth
Request Body schema: application/json
required
queueEntryId
integer <int64>
type
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "queueEntryId": 0,
  • "type": 0
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Add Ews Emails

Authorizations:
bearerAuth
Request Body schema: application/json
required
ewsEmailId
string

ewsEmail id

reservationId
string

reservation id

provider
string

provider

Responses

Request samples

Content type
application/json
{
  • "ewsEmailId": "5f008c72c61bb04",
  • "reservationId": "123456",
  • "provider": "ews1"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Add Booking Cancel Policies

Authorizations:
bearerAuth
Request Body schema: application/json
required
offsetDropTime
string
offsetTimeUnit
string
offsetUnitMultiplier
string
basisType
string
nights
integer <int32>
percentOrAmount
integer <int32>
isPercent
boolean
csCancelPolicyId
integer <int32>
cultBookingBookingId
string
cultSwitchBookingId
string
oldCancellationPolicyId
string

Responses

Request samples

Content type
application/json
{
  • "offsetDropTime": "string",
  • "offsetTimeUnit": "string",
  • "offsetUnitMultiplier": "string",
  • "basisType": "string",
  • "nights": 0,
  • "percentOrAmount": 0,
  • "isPercent": true,
  • "csCancelPolicyId": 0,
  • "cultBookingBookingId": "string",
  • "cultSwitchBookingId": "string",
  • "oldCancellationPolicyId": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Set Token validity as false

Authorizations:
bearerAuth
path Parameters
token
required
string

Token. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Terms and Conditions for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Session Token by token

Authorizations:
bearerAuth
path Parameters
token
required
string

Session Token. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Reservations by CultSwitchBookingId

Authorizations:
bearerAuth
path Parameters
cultSwitchBookingId
required
string

CultSwitchBookingId. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Reservations by CultBookingBookingId

Authorizations:
bearerAuth
path Parameters
cultBookingBookingId
required
string

CultBookingBookingId Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Reservation by Confirmation Time Less Than or Equal To Requested Time And By Email Checked

Authorizations:
bearerAuth
query Parameters
page
integer <int32> >= 0
Default: 0

Page number in paginated request. Default is 0.

size
integer <int32> [ 1 .. 1000 ]
Default: 10

Size of the page in paginated request. Default is 10.

sortDesc
boolean
Default: true

Is descending sort should be applied in sorting in paginated request(sort on id). Default is 'true'.

confirmationTime
required
string

Confirmation Time Less Than or Equal To Requested Time

emailChecked
boolean
Default: true

Email Checked, default value is true

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Privacy Policy for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Price Comparison Widget for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Payment Gateways for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Payment Gateways for property and payment provider

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

paymentProvider
required
string
Enum: "MOLLIE" "STRIPE"

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Number Format for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Guest by CultBookingBookingId

Authorizations:
bearerAuth
path Parameters
cultBookingBookingId
required
string

CultBookingBookingId. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Guest Email template for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Fully Booked Template for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Ews Email by reservation id

Authorizations:
bearerAuth
path Parameters
reservationId
required
string

Reservation Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Currency Setting for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

query Parameters
langCode
string
Default: "en"

Language Code, Default value en

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Communication Credit Card template for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Color Customisations for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Cancellation Email template for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Cancellation Email template using propertyId and language code

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

languageCode
required
string = 2 characters

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Booking Cancel Policies By Id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32>

Booking Cancel Policies. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get All Settings for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get All Settings for a listId

Authorizations:
bearerAuth
path Parameters
listId
required
integer <int32>

List Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Additional Features for property

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Calendar

API endpoints to get availabilities by property id - [Deprecated]

getCalendarBySource_1 Deprecated

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32> >= 1

Identifier of the property that is used in External system. Required.

startDate
string <date>

Start date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

endDate
string <date>

End date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

availabilityGtThan
integer <int32> >= 0

Availability filter number. Records with availability grater than provided number will be included in result. Optional.

closedForSale
boolean

Include in result closed for sale records. Optional.

channelId
integer <int32> >= 1

Channel identifier. Optional.

productId
Array of integers <int32> [ items <int32 > ]

CSV list of Product identifiers. Optional.

roomId
Array of integers <int32> [ items <int32 > ]

CSV list of Room identifiers. Optional.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get product properties with default restrictions Deprecated

This API fetches record based on default restrictions :
availability greater than zero Or
closedForSale is true Or
closedToArrival is true Or
closedToDeparture is true Or
minLos is greater than one

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32> >= 1

Identifier of the property that is used in External system. Required.

startDate
string <date>

Start date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

endDate
string <date>

End date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

channelId
integer <int32> >= 1

Channel identifier. Required.

productId
Array of integers <int32> [ items <int32 > ]

CSV list of Product identifiers. Optional.

roomId
Array of integers <int32> [ items <int32 > ]

CSV list of Room identifiers. Optional.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getCalendarBySourceCultbooking_1 Deprecated

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32> >= 1

Identifier of the property that is used in External system. Required.

startDate
string <date>

Start date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

endDate
string <date>

End date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

availabilityGtThan
integer <int32> >= 0

Availability filter number. Records with availability grater than provided number will be included in result. Optional.

closedForSale
boolean

Include in result closed for sale records. Optional.

channelId
integer <int32> >= 1

Channel identifier. Optional.

productId
Array of integers <int32> [ items <int32 > ]

CSV list of Product identifiers. Optional.

roomId
Array of integers <int32> [ items <int32 > ]

CSV list of Room identifiers. Optional.

Responses

Response samples

Content type
application/json
{
  • "prices": {
    },
  • "closeDepartureParams": {
    },
  • "closeArrivalParams": {
    },
  • "closeSaleParams": {
    },
  • "currency": [
    ],
  • "symbol": [
    ],
  • "min_stays": {
    },
  • "min_stays_only": {
    },
  • "MinLos": {
    },
  • "Cheapest": {
    }
}

getCalendarIBEBySource_1 Deprecated

Authorizations:
bearerAuth
query Parameters
propertyId
required
integer <int32> >= 1

Identifier of the property that is used in External system. Required.

startDate
string <date>

Start date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

endDate
string <date>

End date to filter calendar data. In 'yyyy-MM-dd' format. Optional.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CultSwitch APIs

API endpoints to get data from CultSwitch end points - [Deprecated]

Check Get List of Products XML. Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

checkInDate
required
string

arrivalDate

checkOutDate
required
string

departureDate

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

language
string
Default: "en"

Language.

promoCode
string

Promo Code.

object (CreateReservationGuestCount)

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "checkInDate": "2024-08-18",
  • "checkOutDate": "2024-08-19",
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "language": "en",
  • "promoCode": "promo123",
  • "totalGuestCounts": {
    }
}

Get Product Ids for given list of roomIds. Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
required
channel_id
integer <int32>
object_id
integer <int32>
room_ids
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "channel_id": 0,
  • "object_id": 0,
  • "room_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Check Create a pending reservation (Phase 1 booking) XML. Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

arrival
required
string

arrivalDate

departure
required
string

departureDate

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

language
string
Default: "en"

Language.

required
Array of objects (CreateReservationRoomRate)
required
object (CreateReservationGuestCount)
comments
Array of strings
required
object (CreateReservationBooker)
Array of objects (CreateReservationGuest)
object (CreateReservationOtaDetails)
object (CreateReservationCreditCardDetails)
isCreditCardBooking
boolean

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "arrival": "2024-08-18",
  • "departure": "2024-08-19",
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "language": "en",
  • "roomRates": [
    ],
  • "totalGuestCounts": {
    },
  • "comments": [
    ],
  • "booker": {
    },
  • "guests": [
    ],
  • "otaDetails": {
    },
  • "ccData": {
    },
  • "isCreditCardBooking": true
}

Check Confirm a pending reservation (Phase 2 booking) XML. Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

reservationId
required
string

Reservation Id.

language
string
Default: "en"

Language.

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "reservationId": "14253cds3bc244e",
  • "language": "en"
}

Check CC Update XML. Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

reservationId
required
string

Reservation Id.

object (CreateReservationCreditCardDetails)

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "reservationId": "14253cds3bc244e",
  • "ccData": {
    }
}

Check Cancel Reservation XML by Booking Id. Deprecated

Authorizations:
bearerAuth
Request Body schema: application/json
required
propertyId
required
integer <int32>

Property Id.

distributorId
required
string

Distributor Id.

distributorCode
required
string

Distributor Code.

reservationId
required
string

Reservation Id.

bookerReservationId
required
string

Booker Reservation Id.

language
string
Default: "en"

Language.

cancellationReasonLanguage
string
Default: "en"

Cancellation Reason Language.

cancellationReason
string

Cancellation Reason.

Responses

Request samples

Content type
application/json
{
  • "propertyId": 1000003,
  • "distributorId": "58078",
  • "distributorCode": "14253cds3bc244e",
  • "reservationId": "14253cds3bc244e",
  • "bookerReservationId": "14253cds3bc244e",
  • "language": "en",
  • "cancellationReasonLanguage": "en",
  • "cancellationReason": "Not Interested anymore"
}

Get Element and categories information. Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get Distribution information by id. Deprecated

Authorizations:
bearerAuth
query Parameters
distributorId
required
integer <int32>

DistributorId. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Products

API endpoints to get rate plans, packages and promotions - [Deprecated]

Get product data by id. Deprecated

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

RoomDB internal product Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get product identifiers by product id. Deprecated

It will return array of the identifiers if supplier has access to the product

Authorizations:
bearerAuth
path Parameters
productId
required
integer <int32> >= 1

RoomDB internal product Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all products, by property id. Deprecated

All fields of the Product entity will be included in result.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get products data by External System Id. Deprecated

Two params are needed: External System Abbreviation and External System Id.

Authorizations:
bearerAuth
path Parameters
source
required
string [ 1 .. 255 ] characters

External System Abbreviation - abbreviation that is used in RoomDb to identify External system. In models known as IdentifierSource - abbreviation. Required.

id
required
string [ 1 .. 255 ] characters

External System Id - identifier that is used in External system. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Rate Plans (Products) for type A Properties

API endpoints to access Rate Plans (Products) for the product.

Get rate plan data by id. Deprecated

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32> >= 1

RoomDB internal rate plan Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get rooms with rate plans, by property id. Deprecated

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get rooms with rate plans and promotion, by property id. Deprecated

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get rate plan data by supplier unit id. Deprecated

Authorizations:
bearerAuth
path Parameters
supplierUnitId
required
string

Rate plan Supplier Unit Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get list of all rate plans, by property id paginated. Deprecated

All fields of the Rate Plan entity will be included in result.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

query Parameters
page
integer <int32> >= 0
Default: 0

Page number in paginated request.

size
integer <int32> [ 1 .. 1000 ]
Default: 10

Size of the page in paginated request.

sortBy
string
Default: "id"

Field name that should be used for sorting in paginated request. Default is 'id'.

sortDesc
boolean
Default: true

Is descending sort should be applied in sorting in paginated request. Default is 'true'.

search
string

Search on id, supplierUnitId, name.

excludeExpiredProducts
boolean

excludeExpiredProducts

language
string
Default: "en"

language, Default is 'en'.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get rooms with rate plans, by property id and channel id. Deprecated

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

channelId
required
integer <int32>

Channel Id. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

getSpecificRatePlanFieldsForAI Deprecated

Authorizations:
bearerAuth
path Parameters
fileName
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get list of all rate plans, by property id. Deprecated

All fields of the Rate Plan entity will be included in result.

Authorizations:
bearerAuth
path Parameters
propertyId
required
integer <int32> >= 1000000

RoomDB internal property Id. Required.

query Parameters
language
string
Default: "en"

language, Default is 'en'.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Suppliers

API endpoints to get token - [Deprecated]

Common call and get token base on clientId and clientSecret. Deprecated

API endpoint to generate new token.

query Parameters
supplierId
required
string
supplierSecret
required
string

Responses

Response samples

Content type
application/json
{
  • "tokenType": "string",
  • "expiresIn": 0,
  • "accessToken": "string",
  • "executionTime": 0
}

Refresh token. Deprecated

This API can be used by authorized users to get new token.
Potentially could be used to avoid token expire, just need to refresh before expiration time.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "tokenType": "string",
  • "expiresIn": 0,
  • "accessToken": "string",
  • "executionTime": 0
}

Get supplier information. For supplier. Deprecated

This API can be used to get all information about supplier account.
This endpoint available only for suppliers, administrators should use other endpoint and provide supplier name parameter.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": {},
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Get supplier information. For admin Deprecated

This API can be used to get all information about supplier account.
This endpoint available only for admin, supplier should use other endpoint.

Authorizations:
bearerAuth
path Parameters
name
required
string [ 1 .. 255 ] characters

Supplier name. Required.

Responses

Response samples

Content type
application/json
{
  • "result": {},
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}

Helper method to get encoded password for a provided password Deprecated

query Parameters
password
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "status": "string",
  • "message": "string",
  • "executionTime": 0
}