Properties

Methods

get
Retrieve a list of connected properties

https://[environment].katanox.com/v1/properties
This will provide an array of properties that you have a current deal with, their rate plans that are available to you and pagination options.
Request
Response
Request
Headers
Authorization
required
string
Bearer <api key>
Response
200: OK
{
"data": {
"properties": [
{
"type": "",
"id": "J0GEJRY",
"name": "HOTEL DEMO",
"description": "",
"address_line_1": "Overhoeksplein 1",
"address_line_2": "",
"postcode": "1031 KS",
"city": "Amsterdam",
"country": "Netherlands",
"location": {
"latitude": 1,
"longitude": 0
},
"email": "[email protected]",
"currency": "EUR",
"star_rating": 5,
"number_of_units": 1,
"images": [],
"translations": [],
"units": [
{
"id": "A7FWAFA",
"property_id": "GESEGXB",
"name": "APP",
"description": "",
"images": [],
"translations": [],
"amenities": []
},
{
"id": "GSEG8SS",
"property_id": "9SEF8SF",
"name": "FAM",
"description": "",
"images": [],
"translations": [],
"amenities": []
}
],
"rate_plans": [
{
"id": "67SEIV7",
"property_id": "7VS6S8V",
"name": "CORP / APP / 2",
"description": "",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"translations": []
},
{
"id": "7VS8V7S",
"property_id": "JVSBV78",
"name": "CORP / APP / 4",
"description": "",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"translations": []
}
],
"facilities": []
},
{
"type": "",
"id": "VDS8S7D",
"name": "Hotel royal example",
"description": "",
"address_line_1": "Overhoeksplein 1",
"address_line_2": "",
"postcode": "1031 KS",
"city": "Amsterdam",
"country": "Netherlands",
"location": {
"latitude": 0,
"longitude": 0
},
"email": "[email protected]",
"currency": "EUR",
"star_rating": 5,
"number_of_units": 1,
"images": [],
"translations": [],
"units": [
{
"id": "VDSV9D8",
"property_id": "XBC6BXR",
"name": "Double",
"description": "Double room\n",
"images": [],
"translations": [],
"amenities": []
},
{
"id": "VDSV8S7",
"property_id": "VDS8SD7",
"name": "Single",
"description": "Single room\n",
"images": [],
"translations": [],
"amenities": []
}
],
"rate_plans": [
{
"id": "2H2BY5D",
"property_id": "HJ52BHD",
"name": "Rate plan dbl",
"description": "",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"translations": []
},
{
"id": "HKNT2JK",
"property_id": "BUBKJ2B",
"name": "Rate plan sgl",
"description": "",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"translations": []
}
],
"facilities": []
}
]
},
"links": {
"first": {
"method": "GET",
"url": "/v1/properties?include=[]&locale=nl&limit=2&page=0"
},
"last": {
"method": "GET",
"url": "/v1/properties?include=[]&locale=nl&limit=2&page=4"
},
"next": {
"method": "GET",
"url": "/v1/properties?include=[]&locale=nl&limit=2&page=2"
},
"previous": {
"method": "GET",
"url": "/v1/properties?include=[]&locale=nl&limit=2&page=0"
}
},
"meta": {
"total_pages": 5,
"total_properties": 10
}
}

get
Retrieve a specified property

https://[environment].katanox.com/v1/properties/:id
Request
Response
Request
Path Parameters
id
required
string
The id of the property to retrieve
Headers
Authorization
required
string
Bearer <api key>
Response
200: OK
{
"data": {
"property": [
{
"type": "Apartment",
"id": "J0GEJRY",
"name": "HOTEL DEMO",
"description": "",
"address_line_1": "Overhoeksplein 1",
"address_line_2": "",
"postcode": "1031 KS",
"city": "Amsterdam",
"country": "Netherlands",
"location": {
"latitude": 1,
"longitude": 0
},
"email": "[email protected]",
"currency": "EUR",
"star_rating": 5,
"number_of_units": 1,
"images": [],
"translations": [],
"units": [
{
"id": "A7FWAFA",
"property_id": "GESEGXB",
"name": "APP",
"description": "",
"images": [],
"translations": [],
"amenities": []
},
{
"id": "GSEG8SS",
"property_id": "9SEF8SF",
"name": "FAM",
"description": "",
"images": [],
"translations": [],
"amenities": []
},
{
"id": "FSF9EFS",
"property_id": "VSVVS73",
"name": "DBL",
"description": "",
"images": [],
"translations": [],
"amenities": []
}
],
"rate_plans": [
{
"id": "67SEIV7",
"property_id": "7VS6S8V",
"name": "CORP / APP / 2",
"description": "",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"translations": []
},
{
"id": "7VS8V7S",
"property_id": "JVSBV78",
"name": "CORP / APP / 4",
"description": "",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"translations": []
}
{
"id": "V8DV8A9",
"property_id": "VDVS89S",
"name": "RACK / FAM / TRP+",
"description": "",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"translations": []
}
],
"facilities": []
},
]
},
}

get
Retrieve a rate plan by ID

https://[environment].katanox.com/v1/properties/:property_id/rate-plans/:id
Request
Response
Request
Path Parameters
property_id
required
string
The id of the property
id
required
string
The id of the rate plan
Headers
Authorization
required
string
Bearer <api key>
Response
200: OK
{
"rate_plan": {
"id": "67SEIV7",
"property_id": "7VS6S8V",
"name": "",
"description": "",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"charge_type": "",
"amount": 0
}
}

get
Retrieve a list of available units

https://[environment].katanox.com/v1/properties/:property_id/units/:id
Request
Response
Request
Path Parameters
property_id
required
string
The id of the property
id
required
string
The id of the unit
Headers
Authorization
required
string
Bearer <api key>
Response
200: OK
{
"unit": {
"id": "FS8FS90",
"property_id": "8VSD8S9",
"name": "Intimate",
"description": "Designed over 11 square metres, the Intimate rooms feature a queen-size bed, an ensuite bathroom with rain shower, and air conditioning. The retro-chic style complemented by vintage furniture and design objects takes you back in time.",
"images": [
{
"tag": "Featured",
"url": "https://cdn.traveldata.io/katanox-inventory/hotels/8VSD8S9/rooms/FS8FS90/image-0-202101235323052415110.jpg",
"width": 1024,
"height": 733
},
{
"tag": "",
"url": "https://cdn.traveldata.io/katanox-inventory/hotels/8VSD8S9/rooms/FS8FS90/image-1-20210123T147586588459.jpg",
"width": 1024,
"height": 692
},
{
"tag": "",
"url": "https://cdn.traveldata.io/katanox-inventory/hotels/8VSD8S9/rooms/FS8FS90/image-0-20210123T145085328116.jpg",
"width": 540,
"height": 768
}
],
"translations": [],
"amenities": []
}
}