Introduction
The Your.Rentals API provides access to high quality holiday rentals inventory for Holiday Rentals websites, Sales Channels and Channel Managers and Sales Channels.
To integrate with our API, you need to have a holiday rentals website with online booking and API credentials.
To request access to this API, please contact api@your.rentals
Environments
We offer two API environments you can take advantage of. Each one requires its own access token.
The test environment, located on https://api-dev.your.rentals, is used for testing during integration phase. A set of demo listing data is available for testing. In the test environment, you can use test cards from DIBS to simulate payments.
The production environment, located on https://api.your.rentals, is the one to be used after going live. Here you operate with real data of our property managers.
Listings
Get all listings
curl "https://{{api_domain}}/v1/listings"
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
[
{
"id": 35514,
"active": true,
"referenceNumber": "Malmö - copy from pro - mandatory cleani",
"rentalType": "B&B",
"rentalBasis": "Entire house or apartment",
"entrance": "Common - with security",
"bookingType": "instant",
"maxGuest": 2,
"description": {
"EN": {
"headline": "9 bedrooms big windows for 9 people",
"summary": "A great headline will catch guests when they see your property in search results.",
"description": "Describe your property from all angles in English (interior, exterior, local area) and any services that are included.",
"autoTranslated": false
},
"HR": {
"headline": "9 bedrooms big windows for 9 people in HR",
"summary": "A great headline will catch guests when they see your property in search results. Highlight what makes your listing special so that it stands out to guests who want to stay in your area.. A great headline will catch guests when they see your property in search results.",
"description": "Describe your property from all angles in English (interior, exterior, local area) and any services that are included.",
"autoTranslated": false
}
},
"facilities": {
"livingDining": [
"Dining chairs",
"Armchair"
],
"outdoor": [
"Bicycles",
"Balcony"
],
"parking": "No parking",
"airConditioning": "Central air-conditioning",
"miscellaneous": [
"Hair dryer",
"Iron & ironing board"
],
"washingMachine": "Washing machine",
"heating": "Electric heating",
"kitchen": [
"Dish-washer",
"Electric oven"
],
"swimmingPool": "Private outdoor pool",
"internet": "No internet"
},
"rooms": {
"bedrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bedroom",
"beds": [
{
"name": "Bunk-bed",
"number": 2
},
{
"name": "Double bed",
"number": 3
}
],
"type": "Bedroom"
}
]
},
"bathrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bathroom 1",
"shower": "Separate shower",
"toilet": "No toilet",
"type": "En-suite bathroom",
"bath": "Jacuzzi"
}
]
},
"kitchens": {
"numbers": 1,
"rooms": [
{
"type": "Kitchenette"
}
]
},
"others": [
"Common area",
"Eating area"
]
},
"suitability": {
"pets": "Pets allowed",
"petsCount": "1",
"wheelchair": "Full access for wheelchairs",
"eventsOrParties": "Not allowed",
"petFee": 22,
"children": "Children welcome",
"smoking": "Smoking allowed",
"petFeeBasis": "Per stay"
},
"location": {
"rentalLicenseNumber": "1234567",
"address": "Kanalgatan 5C & 5B",
"addressDetails": "9th floor",
"city": "Malmo",
"region": "Skåne län",
"zip": "21140",
"country": "Sweden",
"latitude": 1.4,
"longitude": 2,
"countryISO": "SE",
"en": {
"country": "Sweden",
"number": "5C",
"address": "Kanalgatan 5C & 5B",
"region": "bb",
"city": "ax",
"street": "Kanalgatan"
}
},
"specialRates": {
"earlyBirdRule": {
"discount": 5,
"checkIn": 4
},
"seasonPriceRules": [],
"lastMinuteRule": {
"discount": 5,
"checkIn": 14
},
"ratesSameAllYearRound": true
},
"basicRates": {
"maximumStay": 7,
"checkInDays": [
0,
1,
2,
3,
4,
5,
6
],
"checkOutDays": [
0,
1,
2,
3,
4,
5,
6
],
"maximumGuests": 2,
"weekendNight": 185.28,
"basicNight": 185.28,
"minimumStay": 1
},
"created": 1467388212,
"lastModified": 1614853538,
"status": "listed",
"floorspace": 130,
"cancellationPolicy": {
"name": "Moderate",
"textList": [
{
"name": "Cancellation policy: You will receive a 50% refund when cancelling up to 14 days prior to check-in",
"value": "Cancellation policy: You will receive a 50% refund when cancelling up to 14 days prior to check-in"
}
]
},
"advanceNotice": 2,
"houseRules": "As this is a residential building, no loud music and late parties are allowed. We also ask that you take off your shoes when you enter the apartment to keep our lovely floors in a nice condition (fresh slippers are provided).",
"images": [
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/15631428019f-ab48-46c5-a20b-d95fa820c53e.jpg"
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563dc61cb08-2a50-4c47-8e06-9e6da0916085.jpg",
"labels": [
"BBQ / Grill",
"Bicycles"
]
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563f947c343-acab-4dac-a0ee-c2a5f0d44ef5.jpg",
"labels": [
"Bedroom1",
"Bathroom1"
]
}
],
"cleaning": {
"feeBasis": "optional",
"fee": 38
},
"securityDeposit": 189,
"extras": [
{
"name": "Airport shuttle",
"feeBasis": "Per unit",
"fee": 27.68
}
],
"salesChannelExcludedList": [
"RIRE"
],
"urls": {
"guestListingPage": "https://app.your.rentals/book/property/35514?scid=BOYR",
"guestBookingPage": "https://app.your.rentals/en/book/35514?scid=BOYR"
},
"instructions": {
"checkIn": "15:00",
"checkOut": "11:00"
},
"externalIds": []
}
]
Returns all data for all listings with pagination. Make sure to get all delta records after this request has finished running based upon the start timestamp.
Please note that all prices returned in this endpoint are in EUR.
Listings are sorted by id in the response. There are 200 listings per page.
https://{{api_domain}}/v1/listings/0 returns total number of listings in the response.
HTTP Request
https://{{api_domain}}/v1/listings
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| pageNumber | number | Page number for the current listings request, it's not a required parameter, keep it blank for the first page (default value is 0) |
Response Header
| Header | Description |
|---|---|
| Content-Type | application/json |
| Link | Link to the result's next page. Example <https://{{api_domain}}/v1/listings/2>; rel="next" |
Response Body
The API return an array of Listing detail on success with http status code 200.
Get listings by timestamp
Example request
curl "https://{{api_domain}}/v1/listings/delta/1513202590"
-H "Authorization: Bearer meowmeowmeow"
In case more than one page of 200 listings return. We will have a
Linkin the response header for the next result page. The format of the link will look like this<https://{{api_domain}}/v1/listings/delta/{timestamp}/2>;rel="next". Continue access this URL to fetch new pages.Example response:
[
{
"id": 35514,
"active": true,
"referenceNumber": "Malmö - copy from pro - mandatory cleani",
"rentalType": "B&B",
"rentalBasis": "Entire house or apartment",
"entrance": "Common - with security",
"bookingType": "instant",
"maxGuest": 2,
"description": {
"EN": {
"headline": "9 bedrooms big windows for 9 people",
"summary": "A great headline will catch guests when they see your property in search results.",
"description": "Describe your property from all angles in English (interior, exterior, local area) and any services that are included.",
"autoTranslated": false
},
"HR": {
"headline": "9 bedrooms big windows for 9 people in HR",
"summary": "A great headline will catch guests when they see your property in search results.",
"description": "Describe your property from all angles in English (interior, exterior, local area) and any services that are included.",
"autoTranslated": false
}
},
"facilities": {
"livingDining": [
"Dining chairs",
"Armchair"
],
"outdoor": [
"Bicycles",
"Balcony"
],
"parking": "No parking",
"airConditioning": "Central air-conditioning",
"miscellaneous": [
"Hair dryer",
"Iron & ironing board"
],
"washingMachine": "Washing machine",
"heating": "Electric heating",
"kitchen": [
"Dish-washer",
"Electric oven"
],
"swimmingPool": "Private outdoor pool",
"internet": "No internet"
},
"rooms": {
"bedrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bedroom",
"beds": [
{
"name": "Bunk-bed",
"number": 2
},
{
"name": "Double bed",
"number": 3
}
],
"type": "Bedroom"
}
]
},
"bathrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bathroom 1",
"shower": "Separate shower",
"toilet": "No toilet",
"type": "En-suite bathroom",
"bath": "Jacuzzi"
}
]
},
"kitchens": {
"numbers": 1,
"rooms": [
{
"type": "Kitchenette"
}
]
},
"others": [
"Common area",
"Eating area"
]
},
"suitability": {
"pets": "Pets allowed",
"petsCount": "1",
"wheelchair": "Full access for wheelchairs",
"eventsOrParties": "Not allowed",
"petFee": 22,
"children": "Children welcome",
"smoking": "Smoking allowed",
"petFeeBasis": "Per stay"
},
"location": {
"rentalLicenseNumber": "1234567",
"address": "Kanalgatan 5C & 5B",
"addressDetails": "9th floor",
"city": "Malmo",
"region": "Skåne län",
"zip": "21140",
"country": "Sweden",
"latitude": 1.4,
"longitude": 2,
"countryISO": "SE",
"en": {
"country": "Sweden",
"number": "5C",
"address": "Kanalgatan 5C & 5B",
"region": "bb",
"city": "ax",
"street": "Kanalgatan"
}
},
"specialRates": {
"earlyBirdRule": {
"discount": 5,
"checkIn": 4
},
"seasonPriceRules": [],
"lastMinuteRule": {
"discount": 5,
"checkIn": 14
},
"ratesSameAllYearRound": true
},
"basicRates": {
"maximumStay": 7,
"checkInDays": [
0,
1,
2,
3,
4,
5,
6
],
"checkOutDays": [
0,
1,
2,
3,
4,
5,
6
],
"maximumGuests": 2,
"weekendNight": 185.28,
"basicNight": 185.28,
"minimumStay": 1
},
"created": 1467388212,
"lastModified": 1614853538,
"status": "listed",
"floorspace": 130,
"cancellationPolicy": {
"name": "Moderate",
"textList": [
{
"name": "Cancellation policy: You will receive a 50% refund when cancelling up to 14 days prior to check-in",
"value": "Cancellation policy: You will receive a 50% refund when cancelling up to 14 days prior to check-in"
}
]
},
"advanceNotice": 2,
"houseRules": "As this is a residential building, no loud music and late parties are allowed. We also ask that you take off your shoes when you enter the apartment to keep our lovely floors in a nice condition (fresh slippers are provided).",
"images": [
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/15631428019f-ab48-46c5-a20b-d95fa820c53e.jpg"
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563dc61cb08-2a50-4c47-8e06-9e6da0916085.jpg",
"labels": [
"BBQ / Grill",
"Bicycles"
]
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563f947c343-acab-4dac-a0ee-c2a5f0d44ef5.jpg",
"labels": [
"Bedroom1",
"Bathroom1"
]
}
],
"cleaning": {
"feeBasis": "optional",
"fee": 38
},
"securityDeposit": 189,
"extras": [
{
"name": "Airport shuttle",
"feeBasis": "Per unit",
"fee": 27.68
}
],
"salesChannelExcludedList": [
"RIRE"
],
"urls": {
"guestListingPage": "https://app.your.rentals/book/property/35514?scid=BOYR",
"guestBookingPage": "https://app.your.rentals/en/book/35514?scid=BOYR"
},
"instructions": {
"checkIn": "15:00",
"checkOut": "11:00"
},
"externalIds": []
}
]
https://{{api_domain}}/v1/listings/delta/{timestamp}/{pageNumber?}
Returns paginated list of updates since specific date. One listing will have one entry in delta response
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| timestamp |
number | Unix timestamp. All changes since this date will be returned |
| pageNumber | number | Page number for the current listings request, it's not a required parameter, keep it blank for the first page (default value is 0) |
Response Header
| Header | Type | Description |
|---|---|---|
| Link | string | Link to the result's next page. Continue request to this URL for next pages. |
Response Body
The response body is an array of Listing with the content type of application/json and HTTP status of 200.
If no listing changed since the timestamp, this endpoint going to return a blank array.
Any unexpected behavior is going with HTTP status not 200.
Get listing detail
Example request
curl "https://{{api_domain}}/v1/listing/{listingId}"
-H "Authorization: Bearer meowmeowmeow"
Example response:
[
{
"id": 35514,
"active": true,
"referenceNumber": "Malmö - copy from pro - mandatory cleani",
"rentalType": "B&B",
"rentalBasis": "Entire house or apartment",
"entrance": "Common - with security",
"bookingType": "instant",
"maxGuest": 2,
"description": {
"EN": {
"headline": "9 bedrooms big windows for 9 people",
"summary": "A great headline will catch guests when they see your property in search results.",
"description": "Describe your property from all angles in English (interior, exterior, local area) and any services that are included.",
"autoTranslated": false
},
"HR": {
"headline": "9 bedrooms big windows for 9 people in HR",
"summary": "A great headline will catch guests when they see your property in search results.",
"description": "Describe your property from all angles in English (interior, exterior, local area) and any services that are included.",
"autoTranslated": false
}
},
"facilities": {
"livingDining": [
"Dining chairs",
"Armchair"
],
"outdoor": [
"Bicycles",
"Balcony"
],
"parking": "No parking",
"airConditioning": "Central air-conditioning",
"miscellaneous": [
"Hair dryer",
"Iron & ironing board"
],
"washingMachine": "Washing machine",
"heating": "Electric heating",
"kitchen": [
"Dish-washer",
"Electric oven"
],
"swimmingPool": "Private outdoor pool",
"internet": "No internet"
},
"rooms": {
"bedrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bedroom",
"beds": [
{
"name": "Bunk-bed",
"number": 2
},
{
"name": "Double bed",
"number": 3
}
],
"type": "Bedroom"
}
]
},
"bathrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bathroom 1",
"shower": "Separate shower",
"toilet": "No toilet",
"type": "En-suite bathroom",
"bath": "Jacuzzi"
}
]
},
"kitchens": {
"numbers": 1,
"rooms": [
{
"type": "Kitchenette"
}
]
},
"others": [
"Common area",
"Eating area"
]
},
"suitability": {
"pets": "Pets allowed",
"petsCount": "1",
"wheelchair": "Full access for wheelchairs",
"eventsOrParties": "Not allowed",
"petFee": 22,
"children": "Children welcome",
"smoking": "Smoking allowed",
"petFeeBasis": "Per stay"
},
"location": {
"rentalLicenseNumber": "1234567",
"address": "Kanalgatan 5C & 5B",
"addressDetails": "9th floor",
"city": "Malmo",
"region": "Skåne län",
"zip": "21140",
"country": "Sweden",
"latitude": 1.4,
"longitude": 2,
"countryISO": "SE",
"en": {
"country": "Sweden",
"number": "5C",
"address": "Kanalgatan 5C & 5B",
"region": "bb",
"city": "ax",
"street": "Kanalgatan"
}
},
"specialRates": {
"earlyBirdRule": {
"discount": 5,
"checkIn": 4
},
"seasonPriceRules": [],
"lastMinuteRule": {
"discount": 5,
"checkIn": 14
},
"ratesSameAllYearRound": true
},
"basicRates": {
"maximumStay": 7,
"checkInDays": [
0,
1,
2,
3,
4,
5,
6
],
"checkOutDays": [
0,
1,
2,
3,
4,
5,
6
],
"maximumGuests": 2,
"weekendNight": 185.28,
"basicNight": 185.28,
"minimumStay": 1
},
"created": 1467388212,
"lastModified": 1614853538,
"status": "listed",
"floorspace": 130,
"cancellationPolicy": {
"name": "Moderate",
"textList": [
{
"name": "Cancellation policy: You will receive a 50% refund when cancelling up to 14 days prior to check-in",
"value": "Cancellation policy: You will receive a 50% refund when cancelling up to 14 days prior to check-in"
}
]
},
"advanceNotice": 2,
"houseRules": "As this is a residential building, no loud music and late parties are allowed. We also ask that you take off your shoes when you enter the apartment to keep our lovely floors in a nice condition (fresh slippers are provided).",
"images": [
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/15631428019f-ab48-46c5-a20b-d95fa820c53e.jpg"
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563dc61cb08-2a50-4c47-8e06-9e6da0916085.jpg",
"labels": [
"BBQ / Grill",
"Bicycles"
]
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563f947c343-acab-4dac-a0ee-c2a5f0d44ef5.jpg",
"labels": [
"Bedroom1",
"Bathroom1"
]
}
],
"cleaning": {
"feeBasis": "optional",
"fee": 38
},
"securityDeposit": 189,
"extras": [
{
"name": "Airport shuttle",
"feeBasis": "Per unit",
"fee": 27.68
},
{
"name": "Baby cot",
"fee": 0
},
{
"name": "Bed linen",
"feeBasis": "Per stay",
"fee": 18.47
}
],
"salesChannelExcludedList": [
"RIRE"
],
"urls": {
"guestListingPage": "https://app.your.rentals/book/property/35514?scid=BOYR",
"guestBookingPage": "https://app.your.rentals/en/book/35514?scid=BOYR"
},
"instructions": {
"checkIn": "15:00",
"checkOut": "11:00"
},
"externalIds": []
}
]
HTTP Request
https://{{api_domain}}/v1/listing/{listingId}
Return the listing detail of the provided id
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | id of the listing that need to get detail |
Response Body
The response body is an array of Listing with HTTP status of 200.
Update listing reference
curl --location --request PATCH 'https://{{api_domain}}/v1/listing/{listingId}/reference' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer meowmeowmeow' \
--data-raw '{
"reference": "1234",
"url": "https://saleschannel.com/1234"
}'
Allows saving the consumer's listing reference after import.
HTTP Request
https://{{api_domain}}/v1/listing/{listingId}/reference
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | Your.Rentals listingId |
Request Body
| Parameter | Type | Description |
|---|---|---|
| reference |
string | Consumer's listing reference |
| url | string | Consumer's listing page URL. Example https://www.saleschannel.com/p1234567 |
| status | enum | The listing on channel's status. Possible values building, incomplete, active, inactive |
| scUrl | string | The URL to access the listing on saleChannels, use for Channel Manager only |
| scReference | string | Consumer's listing reference, use for Channel Manager only |
| salesChannel | string | 4 characters channel code, use for Channel Manager only |
Response Header
| Header | Description |
|---|---|
| Content-Type | application/json |
Response Body
HTTP status code 200 on success call.
Update listings references
curl --location --request PATCH 'http://{{api_domain}}/v1/listing/references' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer meowmeowmeow' \
--data-raw '{
"references": [
{
"listingId": 35514,
"reference": "1234",
"url": "https://saleschannel.com/1234"
},
{
"listingId": 35515,
"reference": "5678",
"url": "https://saleschannel.com/5678"
}
]
}'
Allows saving the consumer's multiple listing reference at the same time
HTTP Request
https://{{api_domain}}/v1/listing/references
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Body
| Parameter | Type | Description |
|---|---|---|
| salesChannel | string | 4 characters channel code, use for Channel Manager only |
| references |
array | Array of listing references with the bellow information. |
| references.reference |
string | Consumer's listing reference |
| references.url | string | Consumer's listing page URL. Example https://www.saleschannel.com/p1234567 |
| references.status | enum | The listing on channel's status. Possible values building, incomplete, active, inactive |
| references.scUrl | string | The URL to access the listing on saleChannels, use for Channel Manager only |
| references.scReference | string | Consumer's listing reference, use for Channel Manager only |
| references.salesChannel | string | 4 characters channel code, use for Channel Manager only |
Response Header
| Header | Description |
|---|---|
| Content-Type | application/json |
Response Body
HTTP status code 200 on success call.
Availability
Get full availability
curl "https://{{api_domain}}/v1/availability"
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
[
{
"listingId": 1563,
"availability": {
"2018-10-30": {
"available": true,
"checkInDay": true,
"checkOutDay": true,
"minStay": 3,
"maxStay": 89
},
"2018-10-31": {
"available": false,
"checkInDay": false,
"checkOutDay": false,
"minStay": 3,
"maxStay": 89
},
.........
"2020-10-30": {
"available": true,
"checkInDay": true,
"checkOutDay": true,
"minStay": 3,
"maxStay": 89
}
}
},
{
"listingId": 2564,
"availability": {
"2018-10-30": {
"available": true,
"checkInDay": true,
"checkOutDay": true,
"minStay": 2,
"maxStay": 9
},
"2018-10-31": {
"available": false,
"checkInDay": false,
"checkOutDay": false,
"minStay": 2,
"maxStay": 9
},
.........
"2020-10-30": {
"available": true,
"checkInDay": true,
"checkOutDay": true,
"minStay": 2,
"maxStay": 9
}
}
}
]
Returns availability for all properties since today and for two year ahead.
HTTP Request
https://{{api_domain}}/v1/availability/{pageNumber?}
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| pageNumber | number | Page number for the current availability request, it's not a required parameter, keep it blank for the first page (default value is 0) |
Response Header
| Header | Description |
|---|---|
| Content-Type | application/json |
| Link | Link to the result's next page. Example <https://{{api_domain}}/v1/availability/2>; rel="next" |
Response Body
Returns an array of objects with the following fields.
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | Listing id |
| availability[date] |
object | The object of date, availability data with date format in YYYY-MM-DD. See Availability for more information. |
Get availability by timestamp
curl "https://{{api_domain}}/v1/availability/delta/{timestamp}/{pageNumber?}"
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
[
{
"listingId": 1563,
"availability": {
"2018-10-30": {
"available": true,
"checkInDay": true,
"checkOutDay": true,
"minStay": 3,
"maxStay": 89
},
"2018-10-31": {
"available": false,
"checkInDay": false,
"checkOutDay": false,
"minStay": 3,
"maxStay": 89
},
.........
"2020-10-30": {
"available": true,
"checkInDay": true,
"checkOutDay": true,
"minStay": 3,
"maxStay": 89
}
}
},
{
"listingId": 2564,
"availability": {
"2018-10-30": {
"available": true,
"checkInDay": true,
"checkOutDay": true,
"minStay": 2,
"maxStay": 9
},
"2018-10-31": {
"available": false,
"checkInDay": false,
"checkOutDay": false,
"minStay": 2,
"maxStay": 9
},
.........
"2020-10-30": {
"available": true,
"checkInDay": true,
"checkOutDay": true,
"minStay": 2,
"maxStay": 9
}
}
}
]
Returns availability updates since specified timestamp. The result is pagination using Link in the response header.
HTTP Request
https://{{api_domain}}/v1/availability/delta/timestamp
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| timestamp |
number | Unix timestamp. All changes since this date will be returned |
| pageNumber | number | Page number for the current availability request, it's not a required parameter, leave it blank for the first page (default value is 0) |
Response Header
| Header | Description |
|---|---|
| Content-Type | application/json |
| Link | Link to the result's next page. Example <https://{{api_domain}}/v1/availability/delta/{timestamp}/2>; rel="next" |
Response Body
Returns an array of objects with the following fields.
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | Listing id |
| availability[date] |
object | The object of date, availability data with date format in YYYY-MM-DD. See Availability for more information. |
Get availability for listing
curl "https://{{api_domain}}/v1/availability/listing/{listingId}"
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"list": [
{
"listingId": 4631,
"availability": {
"2018-11-27": {
"available": false,
"checkInDay": false,
"checkOutDay": false,
"minStay": 4,
"maxStay": 60
},
.....
"2019-11-28": {
"available": false,
"checkInDay": false,
"checkOutDay": false,
"minStay": 4,
"maxStay": 60
}
}
}
]
}
Returns availability of a specific listing
HTTP Request
https://{{api_domain}}/v1/availability/listing/{listingId}
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | Your.Rentals listingId |
Response Body
Returns an object with the following fields.
| Parameter | Type | Description |
|---|---|---|
| list.[].listingId |
number | Listing id |
| list.[].availability[date] |
object | The object of date, availability data with date format in YYYY-MM-DD. See Availability for more information. |
Get available listings in a period
curl "https://{{api_domain}}/v1/availability/listings/{fromDate}/{toDate}"
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
[
{
"id": 1563,
"active": true,
"referenceNumber": "Malmö - copy from pro - mandatory cleani",
"rentalType": "Apartment",
"rentalBasis": "Entire house or apartment",
"entrance": "Common - with security",
"bookingType": "instant",
"maxGuest": 2,
"description": {
"EN": {
"headline": "Perfect 3 bedroom apartment for Malmö city break - Great views.",
"summary": "Spacious 3 bedroom apartment with modern furniture in the center of Malmö near Gustav Adolfs Torg.",
"description": "Rental basis: Entire house or apartment\nNumber of bedrooms: 3",
"autoTranslated": false
},
"DA": {
"headline": "Perfekt 3 værelses lejlighed til Malmös byferie - Fantastisk udsigt! ",
"summary": "Spacious 3 værelses lejlighed med moderne møbler i centrum af Malmø nær Gustav Adolfs Torg.",
"description": "Udlejningsgrundlag: Hele hus eller lejlighed\nAntal soveværelser: 3",
"autoTranslated": true
},
},
"facilities": {
"livingDining": [
"Dining chairs",
"Armchair",
"DVD player",
"Dining table",
"Stereo system",
"TV",
"Sofa"
],
"outdoor": [
"Bicycles"
],
"parking": "Parking lot/garage (paid)",
"airConditioning": "No air-conditioning",
"miscellaneous": [
"Hair dryer",
"Iron & ironing board",
"Elevator in building"
],
"washingMachine": "Washing machine",
"heating": "Central heating",
"kitchen": [
"Dish-washer",
"Electric oven",
"Electric stove / cooktop",
"Freezer",
"Fridge",
"Microwave"
],
"swimmingPool": "No swimming pool",
"internet": "Wireless internet (WIFI)"
},
"rooms": {
"bedrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bedroom 1",
"beds": [
{
"name": "King-sized bed",
"number": 1
}
],
"type": "Bedroom"
},
]
},
"bathrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bathroom 1",
"shower": "Shower over bath",
"toilet": "Toilet",
"type": "Full bathroom",
"bath": "Standard bath"
},
]
},
"kitchens": {
"numbers": 1,
"rooms": [
{
"type": "Separate kitchen"
}
]
},
"others": [
"Living room",
"Dining room",
"Hall"
]
},
"suitability": {
"pets": "No pets allowed",
"wheelchair": "Full access for wheelchairs",
"eventsOrParties": "Not allowed",
"children": "Great for children",
"smoking": "No smoking"
},
"location": {
"address": "Kanalgatan 5C",
"addressDetails": "8th floor",
"city": "Malmö",
"region": "Skåne län",
"zip": "211 40",
"country": "Sweden",
"latitude": 55.6017,
"longitude": 13.00,
"countryISO": "SE",
"en": {
"number": "5C",
"country": "Sweden",
"address": "Kanalgatan 5C",
"region": "Skåne län",
"street": "Kanalgatan"
}
},
"created": 1467388212,
"lastModified": 1540798852,
"floorspace": 126,
"cancellationPolicy": {
"name": "Strict",
"textList": [
{
"name": "Cancellation policy: You will receive a 50% refund when cancelling up to 30 days prior to check-in",
"value": "Cancellation policy: You will receive a 50% refund when cancelling up to 30 days prior to check-in"
}
]
},
"advanceNotice": 3,
"houseRules": "As this is a residential building, no loud music and late parties are allowed. ",
"images": [
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/15631428019f-ab48-46c5-a20b-d95fa820c53e.jpg"
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563dc61cb08-2a50-4c47-8e06-9e6da0916085.jpg"
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/156385f066b5-0c04-4b29-a4ba-6bd4adbaa21b.jpg"
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/15632c9152e5-686c-4896-ba59-e6f06ff6a32d.jpg"
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/15636c777519-1408-4a6d-9691-899f06e5194d.jpg"
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563495f4afc-9f1c-4b51-9426-2993527a5003.jpg"
},
],
"cleaning": {
"feeBasis": "mandatory",
"fee": 200
},
"securityDeposit": 2500,
"extras": [
{
"name": "Baby cot",
"fee": 0
},
{
"name": "Bed linen",
"feeBasis": "Per person / stay",
"fee": 50
},
{
"name": "Internet",
"fee": 0
},
{
"name": "Airport shuttle",
"feeBasis": "Per unit",
"fee": 200
}
],
"localTax": {
"name": "Local tax",
"feeBasis": "% of Rental Amount",
"fee": 5
},
"taxes": [
{
"name": "Tourism fee",
"feeBasis": "Per day",
"fee": 2
}
],
"urls": {
"guestListingPage": "https://app.your.rentals/book/property/1563?scid=BOYR",
"guestBookingPage": "https://app.your.rentals/en/book/1563?scid=BOYR"
},
"instructions": {
"checkIn": "15:00",
"checkOut": "11:00"
},
"externalIds": []
}
]
Returns available listings of the caller (PM or collaborator) in a given period.
HTTP Request
https://{{api_domain}}/v1/availability/listings/{fromDate}/{toDate}
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| fromDate |
string | Start date of the period to look for available listings (YYYY-MM-DD) |
| toDate |
string | End date of the period to look for available listings (YYYY-MM-DD) |
Response Body
The API return an array of Listing detail on success with http status code 200.
Rates
Get rates
curl "https://{{api_domain}}/v1/rates/{pageNumber?}"
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
[
{
"listingId": 1563,
"rate": {
"2018-11-01": 115,
"2018-11-02": 150,
...
"2020-10-30": 169.42,
"2020-10-31": 169.42
},
"longerStay": {
"7": 5,
"14": 10,
"21": 15,
"28": 20
},
"lastMinute": {
"7": 10
},
"earlyBird": {
"360": 10
},
"additionalGuests": {
"amount": 2,
"price": 56.47
}
},
{
"listingId": 2275,
"rate": {
"2018-11-01": 150,
"2018-11-02": 90,
...
"2020-10-30": 202,
"2020-10-31": 202
},
"cleaning": {
"feeBasis": "optional",
"fee": 100
},
"securityDeposit": 200,
"extras": [
{
"name": "Airport shuttle",
"feeBasis": "Per unit",
"fee": 40
},
{
"name": "Baby cot",
"fee": 0
}
],
"taxes": [
{
"name": "Tourism fee",
"feeBasis": "Per adult / day",
"fee": 1
}
],
"localTax": {
"name": "Local tax",
"feeBasis": "Per person / day",
"fee": 2
}
},
...
{
"listingId": 2276,
"rate": {
"2018-11-01": 200,
"2018-11-02": 200,
...
"2020-10-30": 200,
"2020-10-31": 200
},
"longerStay": {
"7": 5,
"14": 0,
"21": 10,
"28": 0
},
"longerStayExclusionPeriods": [
{
"startDate": "2018-04-01",
"endDate": "2018-04-30"
}
],
"additionalGuests": {
"amount": 2,
"price": 20
},
"cleaning": {
"feeBasis": "included",
"fee": 0
},
"securityDeposit": 200,
"extras": [
{
"name": "Airport shuttle",
"feeBasis": "Per person",
"fee": 10
},
...
{
"name": "Umbrella",
"feeBasis": "Per person / night",
"fee": 2
}
],
"taxes": [
{
"name": "City tax",
"feeBasis": "Per adult / day",
"fee": 1
},
{
"name": "Destination fee",
"feeBasis": "Per adult / stay",
"fee": 2
},
...
{
"name": "VAT (Value Added Tax)",
"feeBasis": "Per person / day",
"fee": 3
}
],
"localTax": {
"name": "Local tax",
"feeBasis": "Per person / stay",
"fee": 5
}
}
]
Returns rates and rates rules for one year upfront.
Please note that all prices returned in this endpoint are in EUR.
Rates are sorted by listing id in the response. There are 200 rates per page.
HTTP Request
https://{{api_domain}}/v1/rates
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| pageNumber | number | Page number for the current listings request, it's not a required parameter, keep it blank for the first page (default value is 0) |
Response Header
| Header | Description |
|---|---|
| Link | Link to the result's next page. Example <https://{{api_domain}}/v1/rates/2>; rel="next" |
Response Body
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | Listing id |
| rate[date] |
number | Price per the given night |
| longerStay[minimumDays] |
number | Discount percentage value when staying more than minimumDays |
| longerStayExclusionPeriods[startDate] |
number | Discount percentage value when staying more than minimumDays exclusion periods from startDate |
| longerStayExclusionPeriods[endDate] |
number | Discount percentage value when staying more than minimumDays exclusion periods to enDate |
| lastMinute[days] |
number | Discount percentage value if booking is made less than [days] before check-in |
| earlyBird[days] |
number | Discount percentage value if booking is made more than [days] before check-in |
| additionalGuests |
object | Information to additional guests. See Additional Guests |
| cleaning.feeBasis |
enum | Whether a guest needs to pay for cleaning. Possible values included, mandatory, optional |
| cleaning.fee |
number | Price for cleaning in listings currency |
| securityDeposit |
number | The amount the Guest is liable for in case of damages in EUR |
| extras |
array | Extra fee or information to the listing. See Extra |
| localTax.name | string | Name of the local tax |
| localTax.feeBasis | string | Tax basis. See Tax basis |
| localTax.fee | number | Tax information |
| taxes | array | Information to the tax. See Tax |
Get rates by timestamp
Example request
curl "https://{{api_domain}}/v1/rates/delta/{timestamp}"
-H "Authorization: Bearer meowmeowmeow"
In case more than one page of 200 rates return. We will have a
Linkin the response header for the next result page. The format of the link will look like this<https://{{api_domain}}/v1/rates/delta/1543302590/2>;rel="next". Continue access this URL to fetch new pages.Example response:
[
{
"listingId": 1563,
"rate": {
"2018-11-01": 115,
"2018-11-02": 150,
...
"2020-10-30": 169.42,
"2020-10-31": 169.42
},
"longerStay": {
"7": 5,
"14": 10,
"21": 15,
"28": 20
},
"lastMinute": {
"7": 10
},
"earlyBird": {
"360": 10
},
"additionalGuests": {
"amount": 2,
"price": 56.47
}
},
{
"listingId": 2275,
"rate": {
"2018-11-01": 150,
"2018-11-02": 90,
...
"2020-10-30": 202,
"2020-10-31": 202
},
"cleaning": {
"feeBasis": "optional",
"fee": 100
},
"securityDeposit": 200,
"extras": [
{
"name": "Airport shuttle",
"feeBasis": "Per unit",
"fee": 40
},
{
"name": "Baby cot",
"fee": 0
}
],
"taxes": [
{
"name": "Tourism fee",
"feeBasis": "Per adult / day",
"fee": 1
}
],
"localTax": {
"name": "Local tax",
"feeBasis": "Per person / day",
"fee": 2
}
},
...
{
"listingId": 2276,
"rate": {
"2018-11-01": 200,
"2018-11-02": 200,
...
"2020-10-30": 200,
"2020-10-31": 200
},
"longerStay": {
"7": 5,
"14": 0,
"21": 10,
"28": 0
},
"longerStayExclusionPeriods": [
{
"startDate": "2018-04-01",
"endDate": "2018-04-30"
}
],
"additionalGuests": {
"amount": 2,
"price": 20
},
"cleaning": {
"feeBasis": "included",
"fee": 0
},
"securityDeposit": 200,
"extras": [
{
"name": "Airport shuttle",
"feeBasis": "Per person",
"fee": 10
},
...
{
"name": "Umbrella",
"feeBasis": "Per person / night",
"fee": 2
}
],
"taxes": [
{
"name": "City tax",
"feeBasis": "Per adult / day",
"fee": 1
},
{
"name": "Destination fee",
"feeBasis": "Per adult / stay",
"fee": 2
},
...
{
"name": "VAT (Value Added Tax)",
"feeBasis": "Per person / day",
"fee": 3
}
],
"localTax": {
"name": "Local tax",
"feeBasis": "Per person / stay",
"fee": 5
}
}
]
Returns paginated list of updates since specific date. One rate will have one entry in delta response
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Body Request
| Parameter | Type | Description |
|---|---|---|
| timestamp |
number | Unix timestamp. All changes since this date will be returned |
Response Header
| Header | Type | Description |
|---|---|---|
| Link | Link to the result's next page. Example <https://{{api_domain}}/v1/rates/delta/1543302590/2>; rel="next" |
Response Body
The response body is an array of Rate with the content type of application/json and HTTP status of 200.
If no rate changed since the timestamp, this endpoint going to return a blank array.
Any unexpected behavior is going with HTTP status not 200.
Get listing rate
Example request
curl "https://{{api_domain}}/v1/rates/listing/{listingId}"
-H "Authorization: Bearer meowmeowmeow"
Example response:
[
{
"listingId": 1563,
"rate": {
"2018-11-01": 115,
"2018-11-02": 150,
...
"2020-10-30": 169.42,
"2020-10-31": 169.42
},
"longerStay": {
"7": 5,
"14": 10,
"21": 15,
"28": 20
},
"lastMinute": {
"7": 10
},
"earlyBird": {
"360": 10
},
"additionalGuests": {
"amount": 2,
"price": 56.47
}
},
{
"listingId": 2275,
"rate": {
"2018-11-01": 150,
"2018-11-02": 90,
...
"2020-10-30": 202,
"2020-10-31": 202
},
"cleaning": {
"feeBasis": "optional",
"fee": 100
},
"securityDeposit": 200,
"extras": [
{
"name": "Airport shuttle",
"feeBasis": "Per unit",
"fee": 40
},
{
"name": "Baby cot",
"fee": 0
}
],
"taxes": [
{
"name": "Tourism fee",
"feeBasis": "Per adult / day",
"fee": 1
}
],
"localTax": {
"name": "Local tax",
"feeBasis": "Per person / day",
"fee": 2
}
},
...
{
"listingId": 2276,
"rate": {
"2018-11-01": 200,
"2018-11-02": 200,
...
"2020-10-30": 200,
"2020-10-31": 200
},
"longerStay": {
"7": 5,
"14": 0,
"21": 10,
"28": 0
},
"longerStayExclusionPeriods": [
{
"startDate": "2018-04-01",
"endDate": "2018-04-30"
}
],
"additionalGuests": {
"amount": 2,
"price": 20
},
"cleaning": {
"feeBasis": "included",
"fee": 0
},
"securityDeposit": 200,
"extras": [
{
"name": "Airport shuttle",
"feeBasis": "Per person",
"fee": 10
},
...
{
"name": "Umbrella",
"feeBasis": "Per person / night",
"fee": 2
}
],
"taxes": [
{
"name": "City tax",
"feeBasis": "Per adult / day",
"fee": 1
},
{
"name": "Destination fee",
"feeBasis": "Per adult / stay",
"fee": 2
},
...
{
"name": "VAT (Value Added Tax)",
"feeBasis": "Per person / day",
"fee": 3
}
],
"localTax": {
"name": "Local tax",
"feeBasis": "Per person / stay",
"fee": 5
}
}
]
Returns a specific listing rate information
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | id of the listing that need to get detail |
Response Body
The response body is an array of Rate with the content type of application/json and HTTP status of 200.
Any unexpected behavior is going with HTTP status not 200.
Bookings
Create Booking - Your.Rentals is Merchant of Record
curl -X POST \
https://{{api_domain}}/v1/booking \
-H 'Authorization: Bearer YOUR_TOKEN_HERE' \
-H 'Content-Type: application/json' \
-d '{
"listingId": "123",
"from": "2016-07-15",
"to": "2016-08-01",
"adults": "2",
"children": "2",
"childrenAges": [
0,
3
],
"guest": {
"firstName": "John",
"lastName": "Doe",
"email": "john@doe.com",
"phone": "+4930982905",
"address": "Genslerstraße 84, Berlin",
"billingAddress": "Genslerstraße 84, Berlin",
"country": "DE",
"language": "EN"
},
"creditCard": {
"name": "John R. Doe",
"number": "4711100000000001",
"cvc": "684",
"expiration": "06/24"
},
"salesChannel": "SACH",
"salesBrand": "SABR",
"ownReference": "abcdef",
"notes": "This is a test booking"
}'
Example response:
{
"bookingId": "HT8AG3",
"status": "confirmed",
"paymentStatus": "pending",
"confirmationUrl": "https://app.your.rentals/sc/Travelopo/ref/HT8AG3/1kmAnqDPQqvNE5BWJKDN",
"paymentUrl": "https://app.your.rentals/en/pay/Travelopo/ref/HT8AG3/1kmAnqDPQqvNE5BWJKDN",
"instalments": [
{
"amount": 7.23,
"dueDate": "2018-11-03",
"status": "init",
"id": 1,
"currency": "EUR",
"paymentReference": "VACEUH18AG31"
},
{
"amount": 21.68,
"dueDate": "2019-09-04",
"status": "init",
"id": 2,
"currency": "EUR",
"paymentReference": "VACEU1HT8AG32"
}
],
"paymentInstructions": {
"bankCode": "20-36-47",
"bankAccountCountry": "GB",
"accountName": "WorldPay AP Limited",
"iban": "GB41 BARC 2222 4748 5307 22",
"branchAddress": "London",
"checkDigits": 0,
"bankName": "Barclays Bank PLC",
"accountNumber": "1234356",
"bankAccountCurrency": "EUR",
"swift": "TESTGB11"
}
}
https://{{api_domain}}/v1/booking
Creates booking once booking details and payment have been confirmed by sales channel.
In case no credit card is provided or payment with the provided card fails, the booking will be created in pendingPayment state. URL of the page, where the guest can pay for the booking, will be returned. The guest can pay the booking until the timestamp returned in expiresAt.
Header Request
| Key | Value | Type | Description |
|---|---|---|---|
| Authorization |
Bearer YOUR_TOKEN | string | Provided access token to authorise request |
Request Body
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | ID of the listing to create the booking for |
| from |
string | Arrival date (YYYY-MM-DD) |
| to |
string | Departure date (YYYY-MM-DD) |
| adults |
number | Number of adults |
| children | number | Number of children |
| childrenAges | array | Ages of children, from age 0 to age 12 |
| guest |
object | See guest for more information |
| creditCard | object | See Creditcard for more information |
| salesChannel | string | Sales Channel ID through which booking was made (for channel managers only) |
| salesBrand | string | If sales channel has multiple brands to present correct brand to user |
| ownReference | string | Your custom reference for the booking |
| notes | string | Additional custom booking information |
| ip | string | Customer IP Address |
Response Body
| Parameter | Type | Description |
|---|---|---|
| bookingId |
string | ID of the booking created |
| status |
string | The current status of the booking confirmed, pendingPayment, pendingConfirm |
| paymentStatus |
string | Current payment status of the booking success, pending, failure |
| confirmationUrl |
string | Confirmation URL https://app.your.rentals/... |
| paymentUrl |
string | URL of the booking's payment webpage when booking is not successfully paid. Guest can enter payment information into this page to complete the payment process https://app.your.rentals/... |
| instalments |
object | See instalments for more information |
| paymentInstructions |
object | See creditcard for more information |
| expiresAt | string | The expiraiton datetime for pending bookings to receive payment. UTC / YYYY-MM-DD HH:mm:ss |
Create Booking - Sales Channel is Merchant of Record
curl -X POST \
https://{{api_domain}}/v1/booking \
-H 'Authorization: Bearer YOUR_TOKEN_HERE' \
-H 'Content-Type: application/json' \
-d '{
"listingId": "123",
"from": "2016-07-15",
"to": "2016-08-01",
"adults": "2",
"children": "2",
"childrenAges": [
0,
3
],
"guest": {
"firstName": "John",
"lastName": "Doe",
"email": "john@doe.com",
"phone": "+4930982905",
"address": "Genslerstraße 84, Berlin",
"billingAddress": "Genslerstraße 84, Berlin",
"country": "DE",
"language": "EN"
},
"salesChannel": "SACH",
"salesBrand": "SABR",
"ownReference": "abcdef",
"notes": "This is a test booking"
}'
Example response:
json { "bookingId": "N6CV97", "status": "pendingPayment", "paymentStatus": "pending", "paymentUrl": "https://app.your.rentals/en/pay/TheSalesbrand/ref/N6CV97/RE21436LVxz5b5AyY3kQ", "expiresAt": "2018-10-31 06:37:29" }
https://{{api_domain}}/v1/booking
Allows Sales Channel who collects payment (Merchant of Record) to create a confirmed booking and returns payment information. Only Sales Channels that have been approved to act as Merchant of Record can use this resource.
Header Request
| Key | Value | Type | Description |
|---|---|---|---|
| Authorization |
Bearer YOUR_TOKEN | string | Provided access token to authorise request |
Request Body
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | ID of the listing to create the booking for |
| from |
string | Arrival date (YYYY-MM-DD) |
| to |
string | Departure date (YYYY-MM-DD) |
| adults |
number | Number of adults, must be a positive number |
| children | number | Number of children |
| childrenAges | array | Ages of children, from age 0 to age 12 |
| guest |
object | See guest for more information |
| salesChannel | string | sales channel through which booking was made (for channel managers only) |
| salesBrand | string | if sales channel has multiple brands to present correct brand to user |
| ownReference | string | Your custom reference for the booking |
| notes | string | Additional custom booking information |
| ip | string | Customer IP Address |
Response Body
| Parameter | Type | Description |
|---|---|---|
| bookingId |
string | ID of the booking created |
| status |
string | The current status of the booking |
| paymentStatus |
string | Current payment status of the booking |
| paymentUrl |
string | URL of the booking's payment webpage |
| expiresAt | string | The expiration datetime for pending bookings to receive payment in UTC. Date format is YYYY-MM-DD HH:mm:ss |
Pay Booking
curl -X POST \
https://{{api_domain}}/v1/booking/HT8AG3/pay \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJWQUNBIn0.MzI3fdWkmMnvo2Tux6uf6HsGDORn5UB24wr9hme6Ijg' \
-H 'Content-Type: application/json' \
-d '{
"creditCard": {
"number": "4242424242424242",
"expiration": "06/24",
"cvc": "684"
}
}'
Example response:
{
"bookingId": "HT8AG3",
"status": "confirmed",
"paymentStatus": "success"
}
https://{{api_domain}}/v1/booking/{bookingId}/pay
This method is used to send a new credit card (a new payment) for a booking if previous payment was failed
Header Request
| Key | Value | Type | Description |
|---|---|---|---|
| Authorization |
Bearer YOUR_TOKEN | string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| bookingId |
string | Your.Rentals bookingId |
Request Body
| Parameter | Type | Description |
|---|---|---|
| creditCard |
object | See creditcard for more information |
Cancel Booking
curl -X POST \
http://{{api_domain}}/v1/booking/guest/cancel \
-H 'Authorization: Bearer YOUR_TOKEN_HERE' \
-H 'Content-Type: application/json' \
-d '{
"bookingId": "N6CV97",
"reason": "Unable to travel",
"message": "I do not wish to stay at the property anymore"
}'
Example response:
{
"id": "BY39WM",
"status": "cancelledByGuest",
"cancelledAt": "2018-10-31T06:58:44.911Z",
"cancelledReason": "Unable to travel",
"cancelledMessage": "I do not wish to stay at the property anymore",
"paymentStatus": "paid",
"instalments": [
{
"amount": 1000,
"paymentProvider": "stripe",
"dueDate": "2018-04-13",
"name": "balance",
"paidAt": "2018-04-13T11:16:37.208Z",
"id": 1,
"paymentTransaction": "ch_1CGPsWFRiAY5qh5ixGtpA4ez",
"status": "paid",
"refundedAmount": 500,
"refundedAt": "2018-10-31T06:58:46.359Z"
}
]
}
https://{{api_domain}}/v1/booking/{cancelledBy}/cancel
Allow Sales Channel or Channel Manager to cancel a booking (either Guest or Property Manager requested).
If Cancel booking fails, an error message will be returned. Example:
{ "message": "Booking state is not valid for this request" }
Header Request
| Key | Value | Type | Description |
|---|---|---|---|
| Authorization |
Bearer YOUR_TOKEN | string | Provided access token to authorise request |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| cancelledBy |
string | Actor for the booking cancellation, possible value guest, pm |
Request Body
| Parameter | Type | Description |
|---|---|---|
| bookingId |
string | Your.Rental booking reference number of Sales channel booking reference number (ownReference in Create booking request) |
| reason |
string | The reason to cancel booking |
| message |
string | Message that guest or property manager would like to send to the other |
| salesChannel | string | Sales channel through which booking was made |
Response Body
| Parameter | Type | Description |
|---|---|---|
| id |
string | Booking id |
| status |
string | Cancelled by guest or pm. Example: cancelledByGuest, cancelledByPm, pendingCancellation |
| cancelledAt |
string | Cancelled by guest or pm. |
| cancelledReason |
string | Reason of cancellation |
| cancelledMessage |
string | The message is sent to guest or pm |
| paymentStatus |
enum | The status of payment, possible values success, failure, partialPaid, pending, cancelled, paid, refunded |
| instalments |
object | The payment detail. See instalments for more information |
Get booking details
curl -X GET \
https://{{api_domain}}/v1/booking/HT8AG3/TRAV \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1igo3fuckyourselfnR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJWQUNBIn0.MzI3fdWkmMnvo2Tux6uf6HsGDORn5UB24wr9hme6Ijg' \
-H 'Content-Type: application/json' \
Example response:
{
"id": "HT8AG3",
"status": "confirmed",
"salesChannel": "TRAV",
"salesBrand": "TRVL",
"guest": {
"firstName": "John",
"lastName": "Doe",
"country": "vn",
"phone": "+84123334567",
"language": "en",
"id": "5174bb1ef277333331dc9c44f36ac6e",
"email": "guest@gmail.com"
},
"checkIn": {
"date": "2019-11-03",
"time": "10:00"
},
"checkOut": {
"date": "2019-11-04",
"time": "05:00"
},
"adults": 1,
"propertyAddress": {
"zip": "94111",
"country": "United States",
"rentalLicenseNumber": "33",
"address": "1 California St",
"city": "San Francisco",
"latitude": 37.7932571,
"placeId": "ChIJ5YfkX2GAhYARCU9BDiOTKRM",
"en": {
"number": "1",
"country": "United States",
"address": "1 California St",
"region": "California",
"city": "San Francisco",
"street": "California Street"
},
"number": "1",
"countryISO": "US",
"street": "California Street",
"region": "California",
"longitude": -122.3972152
},
"propertyManagerName": "Frank",
"instructions": {
"closestAirportsList": [
{
"name": "San Francisco Intl",
"country": "United States",
"iata": "SFO",
"distance": 19444,
"city": "San Francisco"
},
{
"name": "San Carlos Airport",
"country": "United States",
"iata": "SQL",
"distance": 33837,
"city": "San Carlos"
},
{
"name": "Palo Alto Airport of Santa Clara County",
"country": "United States",
"iata": "PAO",
"distance": 44490,
"city": "Palo Alto"
},
{
"name": "Hayward Executive Airport",
"country": "United States",
"iata": "HWD",
"distance": 28505,
"city": "Hayward"
},
{
"name": "NAS Alameda",
"country": "United States",
"iata": "NGZ",
"distance": 6970,
"city": "Alameda"
},
{
"name": "Livermore Municipal",
"country": "United States",
"iata": "LVK",
"distance": 90411,
"city": "Livermore"
}
],
"checkinContact": "Declan",
"collectionPoint": "Key code entrance",
"checkIn": "10:00",
"checkOut": "05:00",
"phone": {
"country": "VN",
"number": 12345678,
"code": 84
}
},
"payment": {
"currency": "EUR",
"rental": 34.01,
"cleaning": 0,
"discount": 0,
"amount": 34.01,
"paymentDate": "2018-10-31T07:22:41.650Z",
"extrasAndServices": []
},
"instalments": [
{
"paymentCardType": "Visa",
"amount": 7.23,
"paymentProvider": "stripe",
"dueDate": "2018-11-03",
"name": "deposit",
"paidAt": "2018-10-31T07:22:41.649Z",
"id": 1,
"paymentTransaction": "ch_1DRE2GFRidY5qh5ic1MUiWFv",
"status": "paid",
"paymentReference": "VACEUHT8AG31"
},
{
"paymentCardType": "Visa",
"amount": 21.68,
"paymentProvider": "stripe",
"dueDate": "2019-09-04",
"name": "balance",
"paidAt": "2018-10-31T07:22:41.650Z",
"id": 2,
"paymentTransaction": "ch_1DRE2GFRidY5qh5iTkI0yS3u",
"status": "paid",
"paymentReference": "VACEUHT8AG32"
}
],
"cancellationPolicy": {
"name": "Flexible",
"listText": [
"50% refund up to 7 days prior to arrival, except fees.",
"Cleaning fees, taxes and extras are always refunded if the guest did not check-in.",
"Our 5% service fee is non-refundable."
],
"refund": {
"dayPeriod": 7,
"percentage": 50
}
},
"paymentStatus": "paid"
}
https://{{api_domain}}/v1/booking/{bookingId}/{SalesChannelID}
This is used to retrieve booking details which may be used to communicate to the guest via emails or vouchers.
Header Request
| Key | Value | Type | Description |
|---|---|---|---|
| Authorization |
Bearer YOUR_TOKEN | string | Provided access token to authorise request |
Response Body
| Parameter | Type | Description |
|---|---|---|
| id |
string | Booking Id |
| status |
enum | Status of booking. Possible values expired, declined, pendingPayment, pendingConfirm, inProgress, coolOff, completed, disputeByPm, disputeByGuest, cancelled, cancelledByGuest, cancelledByPm, cancelledByYR, pendingCancellation |
| salesChannel |
string | Sale Channel |
| salesBrand |
string | Sale Brand |
| guest |
object | See guest for more information |
| checkIn.date |
date | Checkin date, date format YYYY-MM-DD |
| checkIn.time |
time | Checkin time, format HH:mm |
| checkOut.date |
date | Checkout date, format YYYY-MM-DD |
| checkOut.time |
time | Checkout time, format HH:mm |
| adults |
number | The number of adults |
| propertyAddress |
object | See listing's location information |
| propertyManagerName |
string | The name of property manager |
| instructions |
object | See listing's instructions information |
| payment |
object | See listing's payment information |
| instalments |
object | See instalments information |
| cancellationPolicy |
object | Cancellation policy used when guest cancels. See Cancellation policy |
Get Quote
curl -X POST \
https://api-dev.your.rentals/v1/quote \
-H 'Authorization: Bearer YOUR_TOKEN_HERE' \
-H 'Content-Type: application/json' \
-d '{
"listingId": "32544",
"from": "2021-06-25",
"to": "2021-07-02",
"adults": "1",
"children": "1",
"salesChannel": "ABCD"
}'
Response: 200
{
"rentalRate": 7546,
"discount": 0,
"bookingType": "instant",
"cancellation": "Cancellation policy up to 7 days: You will receive a full refund when you cancel up to 7 days before check-in",
"taxes": [{
"name": "Tourism fee",
"fee": 98
}],
"cleaningFeeBasis": "mandatory",
"cleaning": 650,
"securityDeposit": 800,
"guestPaymentInstallments": [{
"name": "Installment 1",
"amount": 8196,
"dueDate": "2021-06-18"
}],
"cancellationPolicyName": "Free7"
}
Response: 200
{
"available": false,
"reasons": [
"Dates not available"
]
}
https://{{api_domain}}/v1/quote
Live request that return exact final price and availability status for a property.
Please note:
- If there is a discount, it is included in rentalRate already (so rentalRate = rental_amount_before_discount - discount)
- Cleaning is NOT included in rentalRate yet.
- Total amount will be rentalRate + cleaning only if cleaningFeeBasis is mandatory.
- localTax or other taxes are always mandatory, paid upon check in. They should not be added into total amount in any case.
- Adults and children are counted number of persons, and used as a parameter when calculating rentalRate
- All prices are in EUR
Header Request
| Key | Value | Type | Description |
|---|---|---|---|
| Authorization |
Bearer YOUR_TOKEN | string | Provided access token to authorise request |
Request Body
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | ID of the listing to query |
| from |
string | Arrival date (format YYYY-MM-DD) |
| to |
string | Depature date (format YYYY-MM-DD) |
| adults |
number | Number of adults |
| children | number | Number of children |
| childrenAges | array | Ages of children, from age 0 to age 12 |
| salesChannel | string | Sales Channel ID through which booking was made (for channel managers only) |
| salesBrand | string | If sales channel has multiple brands to present correct brand to user |
| customerCountry | string | Customer's Two-letter ISO country code |
| customerLanguage | string | Customer's language code in ISO 639-1 format |
Response Body
| Parameter | Type | Description |
|---|---|---|
| rentalRate |
number | Final rental rate with discounts applied |
| discount | number | Amount that has been discounted from rentalRate |
| localTax | number | Mandatory fee of localTax the guest will have to pay upon check-in |
| cleaning | number | cleaning fee the guest will have to pay upon booking if cleaningFeeBasis is mandatory |
| securityDeposit | number | The amount the Guest is liable for in case of damages in listings currency |
| bookingType | enum | Whether a booking for this listing will be confirmed instantly or within 24 hours (instant or onRequest) |
| cancellation | string | Cancellation terms for booking |
| available | boolean | Returns false if the property is unavailable |
| taxes | array | Mandatory fee of taxes the guest will have to pay upon check-in |
| cleaningFeeBasis | enum | Whether cleaning fee is mandatory, optional or included in rental rates already (mandatory, included, optional) |
| guestPaymentInstallments | array | Due date and amount of guest installments |
| cancellationPolicyName | enum | Cancellation code of the quote (Flexible, Moderate, Strict, SuperFlexible, NonRefundable, Free7, Free14, Free30) |
Data definition
Listing
| Parameter | Type | Description |
|---|---|---|
| id |
number | Listing id |
| active |
boolean | Is listing published. Example true |
| lastModified |
number | Unix timestamp of listings last modification. Example 946684800 |
| created |
number | Unix timestanp of listing creation. Example 1455187074 |
| rentalType |
enum | Listings rental type. Possible values Apartment, B&B, Boat, Bungalow, Cabin, Castle, Chalet, Condo, Farmhouse, Guest room, Holiday house, Holiday park, House, Lodge, Mobile home, Villa |
| rentalBasis |
enum | Listings rental basis. Possible values Room with own facilities, Room with shared facilities, Entire house or apartment |
| entrance |
enum | Listings entrance type. Possible values Private, Common - without security, Common - with security |
| floorsBuilding | number | Number of floors in the building of listing |
| floorsProperty | number | Number of the floor listing is on |
| floorspace |
number | Listings floorspace in square meters |
| grounds |
number | Listings total ground area in square meters |
| maxGuest |
number | Maximum amount of guests who can stay in the listing |
| additionalGuests | object | See Additional Guest for more information |
| pmDetails | object | Contact details for the Property manager. You need to be approved to be provided these data. See PM Detail for more information |
| location |
object | The listing location information |
| images |
array | Listing images url (at least one image is present) |
| description[lang] |
object | The object listing descriptions, key by the language supported. See more Listing Description |
| facilities | object | See Facility |
| rooms |
object | See Listing Rooms |
| suitability |
object | See Suitability |
| extrasAndServices.cleaning.feeBasis | enum | Whether a guest needs to pay for cleaning. Possible values included, mandatory, optional |
| extrasAndServices.cleaning.fee | number | Price for cleaning in listings currency |
| extrasAndServices.securityDeposit | number | the amount the Guest is liable for in case of damages in listings currency |
| extrasAndServices.extras | array | Extra fee or information to the listing. See Extra |
| extrasAndServices.taxes | array | Array of taxes applied to the property. See Tax |
| localTax.name | string | Name of the local tax |
| localTax.feeBasis | string | Tax basis. Possible values Tax basis |
| localTax.fee | number | Tax amount |
| bookingType |
enum | whether a booking for this listing will be confirmed instantly or within 24 hours. Possible values instant, onRequest |
| salesChannelExcludedList | array | List of sales channels the listing is not to be distributed to (applicable to channel managers only). sales channel ID is 4 characters length, example AIRB, AWAY, TRIP |
| cancellationPolicy |
object | Cancellation policy used when guest cancels. See Cancellation policy |
| advanceNotice |
number | Minimum number of days prior to check-in when it's possible to book the listing |
| scReferences | array | Sales channel information. See SCReference |
| houseRules | string | The house rules |
| instructions | object | The property checkin/checkout detail instruction |
| referenceNumber | string | Listing name |
Listing Instructions
| Parameter | Type | Description |
|---|---|---|
| checkIn |
string | The property checkin time, time format is HH:mm |
| checkOut |
string | The property checkout time, time format is HH:mm |
| checkinContact |
string | Name of the people that should be contact on checking in or checking out. |
| collectionPoint |
string | The instruction where to get the key to access the property |
| phone.code |
string | The phone code of the checking contact person's country. |
| phone.number |
string | The phone number of the checking contact person |
| phone.country |
string | The Two-letter ISO country code of the checking contact person |
| checkinInstructions | string | The detail instruction when guest checking in |
| collectionLocation.country | string | The country of the key collection location. If the key collection location is not at the property. There will be collectionLocation information available to let guest know where to collect the key. |
| collectionLocation.countryISO | string | The Two-letter ISO country code of the key collection location. |
| collectionLocation.address | string | Detail address of the key collection location. |
| collectionLocation.city | string | city of the key collection location. |
| collectionLocation.region | string | region of the key collection location. |
| collectionLocation.latitude | string | Latitude of the key collection location. |
| collectionLocation.longitude | string | Longitude of the key collection location. |
Tax basis
Possible values % of Rental Amount, Per adult / day,Per adult / stay,Per adult / week,Per day,Per person / day,Per person / stay,Per person / week, Per stay, Per week
Listing description
{
"headline": "Perfect 3 bedroom apartment for Malmö city break",
"summary": "Spacious 3 bedroom apartment with modern furniture.",
"description": "Rental basis: Entire house or apartment",
"autoTranslated": false
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| headline | string | Listing headline | true |
| summary | string | Listing summary | true |
| description | string | Listing description | true |
| autoTranslated | Boolean | If the description is auto translated or entered by the listing owner | true |
Additional guest
{
"amount": 2,
"price": 56.47
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| amount | number | Maximum of extra guests who can stay in the listing | true |
| price | number | Nightly rate per extra guest | true |
PM Detail
{
"firstName": "John",
"lastName": "Doe",
"country": "SE",
"email": "john@example.com",
"phone": "+4612345678",
"address": "Djurgårdsvägen 68",
"city": "Stockholm",
"postalCode": "115 21",
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| firstName | string | The first name of the Property manager | true |
| lastName | string | The last name of the Property manager | |
| country | string | Two-letter ISO country code representing the country of the PM. Example VN, SG |
|
| string | The Property manager email address | ||
| phone | string | The Property manager phone number | |
| address | string | The Property manager address | |
| city | string | The Property manager city | |
| postalCode | string | The Property manager postalcode |
Location
{
"rentalLicenseNumber": "12343",
"address": "Čedanj 10",
"addressDetails": "Address 2",
"city": "Brod na Kupi",
"region": "Primorje-Gorski Kotar County",
"zip": "51301",
"country": "Croatia",
"latitude": 45.461,
"longitude": 14.8533,
"countryISO": "HR",
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| rentalLicenseNumber | string | Registration numbers for properties that is required by law in some regions | true |
| address | string | ||
| addressDetails | string | Details about listings address (apartment number etc.) | |
| city | string | true | |
| region | string | true | |
| zip | string | true | |
| country | string | true | |
| latitude | string | true | |
| longitude | string | true | |
| countryISO | string | true |
Listing images
{
...
"images": [
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/15631428019f-ab48-46c5-a20b-d95fa820c53e.jpg"
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563dc61cb08-2a50-4c47-8e06-9e6da0916085.jpg",
"labels": [
"BBQ / Grill",
"Bicycles"
]
},
{
"url": "https://s3-ap-southeast-1.amazonaws.com/dev.images.your.rentals/user/b8b0fd87-3d49-4d4a-942c-8d7c75840593/listing/1563f947c343-acab-4dac-a0ee-c2a5f0d44ef5.jpg",
"labels": [
"Bedroom1",
"Bathroom1"
]
}
]
...
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| url | string | Listing image HTTP url (at least one image is present) | true |
| labels | array | List of pre-defined labels defining images. Possible values for outdoor images BBQ / Grill, Bicycles, Children's play equipment, Facilities nearby, Garden, Outdoor furniture, Property exterior, Patio, Surroundings, Tennis court, Town, View, Terrace, Swimming pool, Sunbed, Property building, Parking, Facade/entrance, Fishing, Lake, Neighbourhood, Natural landspace, Boat, Beach, Balcony Possible values for indoor images Bedroom1, Bathroom1, Dining room, Bedroom3, Eating area, Floor plan, Hall, Kitchen1, Library, Lounge, Pantry, Sauna, Shower, Study, TV and multimedia, Work studio |
Listing facility
{
...
"facilities": {
"livingDining": [
"Dining chairs",
"Armchair",
"DVD player",
"Dining table",
"Stereo system",
"TV",
"Sofa",
"CD-player",
"Children highchair",
"Computer",
"Radio",
"Satellite / Cable TV",
"Games console",
"Laptop",
"Seating area",
"Telephone",
"Video games"
],
"outdoor": [
"Bicycles",
"Balcony",
"Garden",
"Boat",
"Sunbed",
"Tennis court",
"Outdoor furniture",
"Children's play equipment",
"BBQ / Grill",
"Fishing",
"Patio",
"Terrace"
],
"parking": "No parking",
"airConditioning": "Central air-conditioning",
"miscellaneous": [
"Hair dryer",
"Iron & ironing board",
"Elevator in building",
"Alarm-clock",
"Fan",
"Linen (free)",
"Towels (free)",
"Bath rope",
"Mosquito net",
"Gym / fitness equipment",
"Book collection",
"Indoor fireplace",
"Safe deposit box",
"Bidet",
"Hot tub / whirlpool",
"Private hot tub",
"Spa bath",
"Free toiletries",
"Slippers",
"Private sauna",
"Clothes dryer",
"Wardrobe/closet",
"Clothes rack",
"Bicycle rental",
"Shuttle service",
"Airport shuttle",
"Public transport tickets",
"Car rental",
"View - city",
"View - mountain",
"View - pool",
"View - river",
"View - nature",
"View - garden",
"View - lake",
"View - ocean",
"View - water"
],
"washingMachine": "Washing machine",
"heating": "Electric heating",
"kitchen": [
"Dish-washer",
"Electric oven",
"Electric stove / cooktop",
"Freezer",
"Fridge",
"Microwave",
"Coffee machine",
"Electric kettle",
"Kitchenware",
"Gas oven",
"Gas stove / cooktop",
"Toaster",
"Wood fired oven"
],
"swimmingPool": "Private outdoor pool",
"guestSafety": [
"Smoke detector",
"Professional cleaning",
"Property disinfected between stays",
"Police emergency contact",
"Medical emergency contact",
"Outdoor lighting",
"Hand sanitizer",
"First aid kit",
"Fire extinguisher",
"Enhanced cleaning practices",
"Fire emergency contact",
"Emergency exit route",
"Contactless check-in/out",
"Bedding & towels washed above 60°C",
"Carbon monoxide detector"
],
"internet": "No internet"
}
...
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| kitchen | array | List of pre-defined facilities in listing's kitchen. Possible values Coffee machine Dish-washer Electric kettle Electric oven Electric stove / cooktop Freezer Fridge Gas oven Gas stove / cooktop Kitchenware Microwave Toaster Wood fired oven |
|
| livingDining | array | List of pre-defined facilities in listing's living / dining area. Possible values Armchair, CD-player, Children highchair, Computer, Dining chairs, Dining table, DVD player, Games console, Laptop, Radio, Satellite / Cable TV, Seating area, Sofa, Stereo system, Telephone, TV, Video games |
|
| outdoor | array | List of pre-defined outdoor facilities. Possible values Balcony, BBQ / Grill, Bicycles, Boat, Children's play equipment, Fishing, Garden, Outdoor furniture, Patio, Sunbed, Tennis court, Terrace |
|
| miscellaneous | array | List of pre-defined miscellaneous facilities. Possible values Hair dryer, Iron & ironing board, Elevator in building, Alarm-clock, Fan, Linen (free), Towels (free), Bath rope, Mosquito net, Gym / fitness equipment, Book collection, Indoor fireplace, Safe deposit box, Bidet, Hot tub / whirlpool, Private hot tub, Spa bath, Free toiletries, Slippers, Private sauna, Clothes dryer, Wardrobe/closet, Clothes rack, Bicycle rental, Shuttle service, Airport shuttle, Public transport tickets, Car rental, View - city, View - mountain, View - pool, View - river, View - nature, View - garden, View - lake, View - ocean, View - water |
|
| airConditioning | enum | Air-conditioning type. Possible values Central air-conditioning, No air-conditioning, Partial air-conditioning |
|
| heating | enum | Listing's heating type. Possible values Central heating, Electric heating, Gas heating, No heating, Stove or fireplace |
|
| internet | enum | Listing's internet type. Possible values No internet, Wired internet, Wireless internet (WIFI) |
|
| parking | enum | Listing's parking possibility. Possible values Covered parking on site, No parking, Parking lot/garage (free), Parking lot/garage (paid), Parking on street (free), Parking on street (paid), Uncovered parking on site |
|
| swimmingPool | enum | Listing's pool type. Possible values No swimming pool, Private indoor pool, Private outdoor pool, Shared indoor pool, Shared outdoor pool |
|
| washingMachine | enum | Whether listing has a washing machine. Possible values No washing machine, Shared washing machine, Washing machine |
|
| guestSafety | enum | A list of listing's guest safety equipments. Possible values Smoke detector, Professional cleaning, Property disinfected between stays, Police emergency contact, Medical emergency contact, Outdoor lighting, Hand sanitizer, First aid kit, Fire extinguisher, Enhanced cleaning practices, Fire emergency contact, Emergency exit route, Contactless check-in/out, Bedding & towels washed above 60°C, Carbon monoxide detector |
Listing rooms
{
"bedrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bedroom 1",
"beds": [
{
"name": "King-sized bed",
"number": 1
}
],
"type": "Bedroom"
},
]
},
"bathrooms": {
"numbers": 1,
"rooms": [
{
"name": "Bathroom 1",
"shower": "Shower over bath",
"toilet": "Toilet",
"type": "Full bathroom",
"bath": "Standard bath"
},
]
},
"kitchens": {
"numbers": 1,
"rooms": [
{
"type": "Separate kitchen"
}
]
},
"others": [
"Living room",
"Dining room",
"Hall"
]
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| bedrooms.numbers | number | Number of listing's bedroom | |
| bedrooms.rooms | array | Array of bedroom with details. See bedroom | |
| bathrooms.numbers | number | Number of listing's bathroom | |
| bathrooms.rooms | array | Array of bathroom with details. See bathroom | |
| kitchens.numbers | number | Number of listing's kitchen | |
| kitchens.rooms | array | Array of kitchen with details. See kitchen | |
| others | array | Array of strings contain the other rooms in the listing. Possible array item values Common area, Dining room, Drying room, Eating area, Fitness room, Games room, Hall, Laundry, Library, Living room, Lounge, Office, Pantry, rumpusRoom, Sauna, Studio, Study, TV room, Work studio |
Bedroom
{
"name": "Bedroom 1",
"beds": [
{
"name": "King-sized bed",
"number": 1
}
],
"type": "Bedroom"
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| name | string | Name of the bedroom | |
| beds | array | Array of the bed details in the listing | |
| type | enum | Type of the room. Possible values Bedroom, Living room, Other room |
Bed detail
{
"name": "King-sized bed",
"number": 1
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| name | string | bed (enum) - Bed type. Possible value Bunk-bed, Double bed, King-sized bed, Queen-sized bed, Single bed (adult), Single bed (child), Sofa-bed (double), Sofa-bed (single) |
|
| number | number | Number of bed |
Bathroom
{
"name": "Bathroom 1",
"shower": "Shower over bath",
"toilet": "Toilet",
"type": "Full bathroom",
"bath": "Standard bath"
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| name | string | Name of the bathroom | |
| shower | enum | Shower type. Possible values Shower over bath, Separate shower, No shower |
|
| toilet | enum | Toilet type. Possible values No toilet, Toilet |
|
| type | enum | Bathroom type. Possible values En-suite bathroom, Full bathroom, WC |
|
| bath | enum | Bath type. Possible values Standard bath, No bath, Jacuzzi, Whirlpool |
Kitchen
{
"type": "Separate kitchen"
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | enum | List of pre-defined kitchens. Possible values Kitchenette, Open plan kitchen, Outdoor kitchen, Separate kitchen |
Suitability
{
"pets": "Pets allowed",
"wheelchair": "Full access for wheelchairs",
"eventsOrParties": "Not allowed",
"children": "Great for children",
"smoking": "No smoking",
"petsCount": 1,
"petFee": 5,
"petFeeBasis": "Per stay"
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| pets | enum | Policy on pets staying in the listing. Possible values No pets allowed, Pets allowed, Pets considered |
|
| wheelchair | enum | Wheel chair access type in the listing. Possible values Full access for wheelchairs, No access for wheelchairs, Some access for wheelchairs |
true |
| eventsOrParties | enum | Policy on events or parties allowed in the listing. Possible values Allowed, Not allowed |
true |
| children | enum | Listings policy on staying with children. Possible values Children welcome, Great for children, Not suitable for children |
true |
| smoking | enum | Listings policy on smoking. Possible values No smoking, Smoking allowed, Smoking outside |
true |
| petsCount | number | How many pets can stay in the listing | |
| petFee | number | Fee for bringing a pet | |
| petFeeBasis | enum | Basis of the fee. Possible values Per day, Per week, Per stay, Per pet / day, Per pet / stay, Per pet / week |
Cancellation policy
{
"name": "Strict",
"textList": [
{
"name": "Cancellation policy: You will receive a 50% refund when cancelling up to 30 days prior to check-in",
"value": "Cancellation policy: You will receive a 50% refund when cancelling up to 30 days prior to check-in"
}
]
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| name | enum | Policy type. Possible values Flexible, Moderate, Strict, SuperStrict |
true |
| textList.name | enum | Policy text | true |
| textList.value | enum | Policy text value | true |
Listing extra
{
"name": "Bed linen",
"feeBasis": "Per person / stay",
"fee": 50
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| name | enum | Extra type. Possible values Airport shuttle, Baby cot, Barbecue, Bed linen, Bike rental, Boat berth, Car rental, High chair, Internet, Kitchen linen, Laundry service, Linen package (bed linen + towel), Pet, Sunbed, Towel, Transfer, Umbrella |
|
| feeBasis | enum | Extra fee basis. Possible values Per day, Per night, Per person, Per person / night, Per person / stay, Per person / week, Per pet / day, Per pet / stay, Per pet / week, Per stay, Per unit, Per week |
|
| fee | number | Extras price in listings currency |
Sales channel reference
{
"scId": "BOOK",
"scAccountReference": "12345",
"scListingReference": "BOOK1234567",
"scListingUrl": "https://www.booking.com/BOOK1234567"
}
| Parameter | Type | Description | Required |
|---|---|---|---|
| scId | string | Sales channel id (sales channel code) | |
| scAccountReference | string | ||
| scListingReference | string | Property reference number on Sales channel side | |
| scListingUrl | string | URL of the listing on Sales channel's website |
Availability Format
"2018-10-30": {
"available": true,
"checkInDay": true,
"checkOutDay": true,
"minStay": 3,
"maxStay": 180
}
| Parameter | Type | Description |
|---|---|---|
| available |
boolean | Whether listing is available to book on that day |
| checkInDay |
boolean | Whether a guest can arrive on that day |
| minStay |
number | Minimum number of days for the guest to book if he checks in on that day |
| maxStay |
number | Maximum number of days for the guest to book if he checks in on that day |
| checkOutDay |
boolean | Whether a guest can departure on that day |
Guest
{
"firstName": "John",
"lastName": "Doe",
"email": "john@doe.com",
"phone": "+4930982905",
"address": "Genslerstraße 84, Berlin",
"billingAddress": "Genslerstraße 84, Berlin",
"country": "DE",
"language": "EN"
}
| Parameter | Type | Description |
|---|---|---|
| firstName |
string | |
| lastName |
string | |
| email |
string | |
| phone |
string | Phone number in E.164 format |
| address | string | |
| billingAddress | string | Deprecated |
| country | string | Customer's Country in ISO 3166-1 alpha-2 format |
| language | string | Customer's language code in ISO 639-1 format |
creditCard
{
"number": "4711100000000001",
"cvc": "684",
"expiration": "06/24"
}
| Parameter | Type | Description |
|---|---|---|
| number |
string | |
| cvc |
string | |
| expiration |
string | |
| name | string | Cardholder name |
| billingAddressDetails | object | See billingAddressDetails for more information |
Billing Address Details
{
"country": "IE",
"address1": "34 Cove Street",
"address2": "Elmpark",
"city": "Dublin",
"stateOrRegion": "Leinster",
"postalCode": "EIRWIQ"
}
| Parameter | Type | Description |
|---|---|---|
| country |
string | Billing Address Country in ISO 3166-1 alpha-2 format |
| address1 |
string | |
| address2 | string | |
| city | string | |
| stateOrRegion | object | |
| postalCode | object |
Additional Guests
{
"amount": 2,
"price": 56.94
}
| Parameter | Type | Description |
|---|---|---|
| amount |
number | Maximum of extra guests who can stay in the listing |
| price |
number | Nightly rate per extra guest |
Tax names
Possible values Destination fee, Tourism fee,Tax,Local tax,Goods and services tax,Government tax,City tax,VAT (Value Added Tax), Resort fee
Tax
{
"name": "Tourism fee",
"feeBasis": true,
"fee": 2
}
| Parameter | Type | Description |
|---|---|---|
| name |
enum | Name of the tax. See Tax names |
| feeBasis |
enum | Tax basis. Possible values Tax basis |
| fee |
number | Tax price in EUR if it is fixed amount |
Rate
| Parameter | Type | Description |
|---|---|---|
| listingId |
number | Listing id |
| rate[date] |
number | Price per the given night |
| longerStay[minimumDays] |
number | Discount percentage value when staying more than minimumDays |
| longerStayExclusionPeriods[startDate] |
number | Discount percentage value when staying more than minimumDays exclusion periods from startDate |
| longerStayExclusionPeriods[endDate] |
number | Discount percentage value when staying more than minimumDays exclusion periods to enDate |
| lastMinute[days] |
number | Discount percentage value if booking is made less than [days] before check-in |
| earlyBird[days] |
number | Discount percentage value if booking is made more than [days] before check-in |
| additionalGuests |
object | Information to additional guests. See Additional Guests |
| cleaning.feeBasis |
enum | Whether a guest needs to pay for cleaning. Possible values included, mandatory, optional |
| cleaning.fee |
number | Price for cleaning in listings currency |
| securityDeposit |
number | The amount the Guest is liable for in case of damages in EUR |
| extras |
array | Extra fee or information to the listing. See Extra |
| localTax.name | string | Name of the local tax |
| localTax.feeBasis | string | Tax basis. See Tax basis |
| localTax.fee | number | Tax information |
| taxes | array | Information to the tax. See Tax |
Optional Extras
{
"towel": {
"text": "Towel",
"feeBasis": [
"Per night",
"Per person / night",
"Per person / stay",
"Per person / week",
"Per stay",
"Per unit",
"Per week"
]
},
"bikeRental": {
"text": "Bike rental",
"feeBasis": [
"Per day",
"Per stay",
"Per unit",
"Per week"
]
},
...
"umbrella": {
"text": "Umbrella",
"feeBasis": [
"Per night",
"Per person / night",
"Per person / stay",
"Per person / week",
"Per stay",
"Per unit",
"Per week"
]
}
}
| Parameter | Type | Description |
|---|---|---|
| towel.text |
string | Information to optional extra name, Value Towel |
| towel.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per person / night, Per person / stay, Per person / week, Per stay, Per unit, Per week |
| bikeRental.text |
string | Information to optional extra name, Value Bike rental |
| bikeRental.feeBasis |
array | Information to optional extra fee basis, Possible values Per day, Per stay, Per unit, Per week |
| kitchenLinen.text |
string | Information to optional extra name, Value Kitchen linen |
| kitchenLinen.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per person / night, Per person / stay, Per person / week, Per stay, Per unit, Per week |
| carRental.text |
string | Information to optional extra name, Value Car rental |
| carRental.feeBasis |
array | Information to optional extra fee basis, Possible values Per day, Per stay, Per week |
| internet.text |
string | Information to optional extra name, Value Internet |
| internet.feeBasis |
array | Information to optional extra fee basis, Possible values Per day, Per stay, Per week |
| bedLinen.text |
string | Information to optional extra name, Value Bed linen |
| bedLinen.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per person / night, Per person / stay, Per person / week, Per stay, Per week |
| airportShuttle.text |
string | Information to optional extra name, Value Airport shuttle |
| airportShuttle.feeBasis |
array | Information to optional extra fee basis, Possible values Per person, Per stay, Per unit |
| linenPackageBedLinenTowel.text |
string | Information to optional extra name, Value Linen package (bed linen + towel) |
| linenPackageBedLinenTowel.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per person / night, Per person / stay, Per person / week, Per stay, Per unit, Per week |
| sunbed.text |
string | Information to optional extra name, Value Sunbed |
| sunbed.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per person / night, Per person / stay, Per person / week, Per stay, Per unit, Per week |
| babyCot.text |
string | Information to optional extra name, Value Baby cot |
| babyCot.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per person / night, Per person / stay, Per person / week, Per stay, Per unit, Per week |
| pet.text |
string | Information to optional extra name, Value Pet |
| pet.feeBasis |
array | Information to optional extra fee basis, Possible values Per day, Per stay, Per week, Per pet / stay, Per pet / day, Per pet / week |
| transfer.text |
string | Information to optional extra name, Value Transfer |
| transfer.feeBasis |
array | Information to optional extra fee basis, Possible values Per person, Per stay, Per unit |
| highChair.text |
string | Information to optional extra name, Value High chair |
| highChair.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per stay, Per week |
| laundryService.text |
string | Information to optional extra name, Value Laundry service |
| laundryService.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per person / night, Per person / stay, Per person / week, Per stay, Per unit, Per week |
| barbecue.text |
string | Information to optional extra name, Value Barbecue |
| barbecue.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per stay, Per week |
| boatBerth.text |
string | Information to optional extra name, Value Boat berth |
| boatBerth.feeBasis |
array | Information to optional extra fee basis, Possible values Per day, Per stay, Per week |
| umbrella.text |
string | Information to optional extra name, Value Umbrella |
| umbrella.feeBasis |
array | Information to optional extra fee basis, Possible values Per night, Per person / night, Per person / stay, Per person / week, Per stay, Per unit, Per week |
Dictionaries
Get dictionaries data
curl "https://{{api_domain}}/v1/dictionary"
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"countries": [
"Andorra",
"United Arab Emirates",
"Antigua and Barbuda",
...
"Montenegro",
"Republic of Macedonia"
],
"languages": {
"spokenLanguages": [
"Danish",
"German",
"English",
...
"Hungarian",
"Turkish"
],
"descriptionLanguages": [
"Danish",
"German",
"English",
...
"Swedish",
"Finnish"
]
},
"listings": {
"pets": [
"No pets allowed",
"Pets considered",
"Pets allowed"
],
"rentalType": [
"Cabin",
"Holiday park",
"Holiday house",
...
"Apartment",
"Villa"
],
...
"children": [
"Great for children",
"Children welcome",
"Not suitable for children"
]
},
"rooms": {
"bathroomBath": [
"Standard bath",
"No bath",
"Jacuzzi",
"Whirlpool"
],
"bathroomShower": [
"Shower over bath",
"Separate shower",
"No shower"
],
...
"otherRooms": [
"Drying room",
"Hall",
"Laundry",
...
"Eating area",
"Library"
]
},
"photos": {
"photosOutside": [
"Natural landspace",
"Neighbourhood",
"Surroundings",
...
"Property building",
"Swimming pool"
],
"photosInside": [
"Bathroom",
"Bedroom",
"Kitchen",
...
"Eating area",
"Library"
],
"photoLabelTypes": [
"Inside",
"Outside"
]
},
"optionalExtras": {
"towel": {
"text": "Towel",
"feeBasis": [
"Per night",
"Per person / night",
"Per person / stay",
"Per person / week",
"Per stay",
"Per unit",
"Per week"
]
},
"bikeRental": {
"text": "Bike rental",
"feeBasis": [
"Per day",
"Per stay",
"Per unit",
"Per week"
]
},
...
"umbrella": {
"text": "Umbrella",
"feeBasis": [
"Per night",
"Per person / night",
"Per person / stay",
"Per person / week",
"Per stay",
"Per unit",
"Per week"
]
}
},
"facilities": {
"miscellaneous": [
"Clothes dryer",
"View - lake",
"View - city",
...
"View - mountain",
"Alarm-clock"
],
"swimmingPool": [
"Shared indoor pool",
"Private outdoor pool",
"Shared outdoor pool",
"No swimming pool",
"Private indoor pool"
],
...
"washingMachine": [
"No washing machine",
"Washing machine",
"Shared washing machine"
]
},
"taxes": [
"Per person / stay",
"% of Rental Amount",
"Per adult / day",
"Per week",
"Per day",
"Per adult / week",
"Per person / week",
"Per person / day",
"Per stay",
"Per adult / stay"
],
"taxNames": [
"Destination fee",
"Tourism fee",
"Tax",
"Local tax",
"Goods and services tax",
"Government tax",
"City tax",
"VAT (Value Added Tax)",
"Resort fee"
]
}
Returns JSON object containing predefined values that are used in our listing data models.
HTTP Request
https://{{api_domain}}/v1/dictionary
Header Request
| Header | Type | Description |
|---|---|---|
| Authorization |
string | Provided access token to authorise request |
Response Header
| Header | Description |
|---|---|
| Content-Type | application/json |
Response Body
| Parameter | Type | Description |
|---|---|---|
| countries |
array | List of the countries, See countries |
| languages.spokenLanguages |
array | Spoken Languages, Possible values Danish, German, English, Spanish, French, Italian, Dutch, Norwegian, Portuguese, Russian, Swedish, Finnish, Hindi, Latvian, Punjabi, Czech, Ukrainian, Croatian, Lithuanian, Polish, Sign Language, Greek, Estonian, Hungarian, Turkish |
| languages.descriptionLanguages |
array | Description Languages, Possible values Danish, German, English, Spanish, French, Italian, Dutch, Norwegian, Portuguese, Russian, Swedish, Finnish |
| listings.pets |
array | Require to the pet, Possible values No pets allowed, Pets considere, Pets allowed |
| listings.rentalType |
array | Information to rental type, Possible values Cabin, Holiday park, Holiday house, Mobile home, Castle, Farmhouse, Boat, Chalet, House, B&B, Lodge, Guest room, Condo, Bungalow, Apartment, Villa |
| listings.entrance |
array | Information about entrance, Possible values Common - with security, Common - without security, Private |
| listings.smoking |
array | Information about smoking, Possible values No smoking, Smoking allowed, Smoking outside |
| listings.longTermRentals |
array | Information to long term rentals, Possible values Long-term rentals considered, Long-term rentals welcome, No long-term rentals |
| listings.wheelchairAccess |
array | Information to wheel chair access, Possible values Full access for wheelchairs, Some access for wheelchairs, No access for wheelchairs |
| listings.rentalBasis |
array | Information to rental basis, Possible values Entire house or apartment, Room with own facilities, Room with shared facilities |
| listings.children |
array | Information to children, Possible values Great for children, Children welcome, Not suitable for children |
| rooms.bathroomBath |
array | Information to bathroom bath, Possible values Standard bath, No bath, Jacuzzi, Whirlpool |
| rooms.bathroomShower |
array | Information to bathroom shower, Possible values Shower over bath, Separate shower, No shower |
| rooms.bathroomToilet |
array | Information to bathroom toilet, Possible values No toilet, Toilet |
| rooms.bathroomType |
array | Information to bathroom type, Possible values En-suite bathroom, Full bathroom, WC |
| rooms.bedroomBeds |
array | Information to bedroom beds, Possible values Single bed (child), Double bed, Sofa-bed (double), Single bed (adult), Sofa-bed (single), Bunk-bed, King-sized bed, Queen-sized bed |
| rooms.bedroomType |
array | Information to bedroom type, Possible values Other room, Living room, Bedroom |
| rooms.kitchenType |
array | Information to kitchen type, See kitchen type |
| rooms.otherRooms |
array | Information to other rooms, Possible values Drying room, Hall, Laundry, Work studio, Common area, Sauna, Fitness room, Studio, Study, Living room, Lounge, TV room, Rumpus room, Pantry, Games room, Office, Dining room, Eating area, Library |
| photos.photosOutside |
array | Information to photos outside, Possible values Natural landspace, Neighbourhood, Surroundings, Parking, Property exterior, Town, View, Beach, Facade/entrance, Facilities nearby, Lake, Property building, Swimming pool |
| photos.photosInside |
array | Information to photos inside, Possible values Bathroom, Bedroom, Kitchen, Drying room, Hall, Laundry, Work studio, Common area, Sauna, Fitness room, Studio, Study, Living room, Lounge, TV room, Rumpus room, Pantry, Games room, Office, Dining room, Eating area, Library |
| photos.photoLabelTypes |
array | Information to photo label types, Possible values Inside, Outside |
| optionalExtras |
object | Information to optional extras, See optional extras |
| facilities.miscellaneous |
array | Information to miscellaneous of the facilities, Possible values Clothes dryer, View - lake, View - city, Iron & ironing board, Bath rope, View - pool, View - water, Free toiletries, Safe deposit box, Indoor fireplace, View - nature, Spa bath, Fan, Private hot tub, Car rental, Hair dryer, Book collection, View - garden, Bicycle rental, Private sauna, Wardrobe/closet, Public transport tickets, Linen (free), Elevator in building, Gym / fitness equipment, Clothes rack, Slippers, Airport shuttle, Mosquito net, Towels (free), Bidet, Hot tub / whirlpool, View - ocean, View - river, Shuttle service, View - mountain, Alarm-clock |
| facilities.swimmingPool |
array | Information to swimming pool of the facilities, Possible values Shared indoor pool, Private outdoor pool, Shared outdoor pool, No swimming pool, Private indoor pool |
| facilities.kitchen |
array | Information to kitchen of the facilities, Possible values Gas stove / cooktop, Coffee machine, Electric stove / cooktop, Electric oven, Wood fired oven, Freezer, Microwave, Electric kettle, Dish-washer, Gas oven, Toaster, Fridge, Kitchenware |
| facilities.livingDining |
array | Information to living dining of the facilities, Possible values TV, Children highchair, Telephone, Video games, Games console, CD-player, Computer, Dining chairs, Laptop, DVD player, Sofa, Dining table, Stereo system, Satellite / Cable TV, Radio, Armchair, Seating area |
| facilities.parking |
array | Information to parking of the facilities, Possible values Parking on street (free), Uncovered parking on site, No parking, Parking lot/garage (free), Parking on street (paid), Parking lot/garage (paid), Covered parking on site |
| facilities.heating |
array | Information to outdoor of the facilities, Possible values Central heating, Electric heating, Stove or fireplace, No heating, Gas heating |
| facilities.outdoor |
array | Information to parking of the facilities, Possible values BBQ / Grill, Children's play equipment, Boat, Balcony, Garden, Outdoor furniture, Patio, Terrace, Bicycles, Sunbed, Fishing, Tennis court |
| facilities.internet |
array | Information to parking of the facilities, Possible values Wireless internet (WIFI), No internet, Wired internet |
| facilities.airConditioning |
array | Information to parking of the facilities, Possible values No air-conditioning, Partial air-conditioning, Central air-conditioning |
| facilities.washingMachine |
array | Information to parking of the facilities, Possible values No washing machine, Washing machine, Shared washing machine |
| taxNames |
array | Information to tax name, Possible values Destination fee, Tourism fee, Tax, Local tax, Goods and services tax, Government tax, City tax, VAT (Value Added Tax), Resort fee |
| taxes |
array | Information to taxes, Possible values Per person / stay, % of Rental Amount, Per adult / day, Per week, Per day, Per adult / week, Per person / week, Per person / day, Per stay, Per adult / stay |