AccommodationApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| calculatePropertyPrice | POST /accommodation/properties/{id}/calculate-price | Calculate price for a booking |
| cancelMyBooking | POST /accommodation/my/bookings/{id}/cancel | Cancel booking (requires auth) |
| checkPropertyAvailability | POST /accommodation/properties/{id}/check-availability | Check availability for a date range |
| createPropertyBooking | POST /accommodation/properties/{id}/book | Create a booking (requires auth) |
| createPropertyReview | POST /accommodation/properties/{id}/reviews | Submit property review (requires auth) |
| getBookingCancellationInfo | GET /accommodation/my/bookings/{id}/cancellation-info | Get cancellation info/preview (requires auth) |
| getMyBooking | GET /accommodation/my/bookings/{id} | Get booking details (requires auth) |
| getProperty | GET /accommodation/properties/{id} | Get property details by ID |
| getPropertyBySlug | GET /accommodation/properties/slug/{slug} | Get property by slug |
| getPropertyReviews | GET /accommodation/properties/{id}/reviews | Get property reviews |
| getSimilarProperties | GET /accommodation/properties/{id}/similar | Get similar properties |
| listAmenities | GET /accommodation/amenities | List amenities |
| listCancellationPolicies | GET /accommodation/cancellation-policies | List cancellation policies |
| listMyBookings | GET /accommodation/my/bookings | List user’s bookings (requires auth) |
| listProperties | GET /accommodation/properties | List properties with filters |
| listPropertyReportReasons | GET /accommodation/property-report-reasons | Get property report reasons |
| listPropertyTypes | GET /accommodation/property-types | List property types |
| reportProperty | POST /accommodation/properties/{id}/report | Report a property (requires auth) |
calculatePropertyPrice
PriceCalculationResponse calculatePropertyPrice(id, CalculatePriceRequest)
Calculate price for a booking
Calculates the total price for a booking including nightly rates, fees, taxes, and any applicable discounts.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Property ID | [default to null] |
| CalculatePriceRequest | CalculatePriceRequest | Price calculation request |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
cancelMyBooking
BookingOrderResponse cancelMyBooking(id, CancelBookingRequest)
Cancel booking (requires auth)
Cancels a booking belonging to the authenticated user. Refund amount is calculated based on the property’s cancellation policy.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Booking ID | [default to null] |
| CancelBookingRequest | CancelBookingRequest | Cancellation request |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
checkPropertyAvailability
AvailabilityCheckResponse checkPropertyAvailability(id, CheckAvailabilityRequest)
Check availability for a date range
Checks if the property is available for booking during the specified dates.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Property ID | [default to null] |
| CheckAvailabilityRequest | CheckAvailabilityRequest | Availability check request |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
createPropertyBooking
BookingOrderResponse createPropertyBooking(id, CreateBookingRequest)
Create a booking (requires auth)
Creates a new booking for a property. The booking may be instant or require host approval depending on the property settings.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Property ID | [default to null] |
| CreateBookingRequest | CreateBookingRequest | Booking request details |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
createPropertyReview
PropertyReviewResponse createPropertyReview(id, CreatePropertyReviewRequest)
Submit property review (requires auth)
Submits a review for a property. The user must have a completed booking for the property to submit a review.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Property ID | [default to null] |
| CreatePropertyReviewRequest | CreatePropertyReviewRequest | Review details |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
getBookingCancellationInfo
CancellationInfoResponse getBookingCancellationInfo(id)
Get cancellation info/preview (requires auth)
Retrieves cancellation information including the calculated refund amount before actually cancelling a booking.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Booking ID | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getMyBooking
BookingOrderResponse getMyBooking(id)
Get booking details (requires auth)
Retrieves detailed information about a specific booking belonging to the authenticated user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Booking ID | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getProperty
PropertyResponse getProperty(id)
Get property details by ID
Retrieves complete details for a specific property including amenities, pricing, location, and availability information.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Property ID | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getPropertyBySlug
PropertyResponse getPropertyBySlug(slug)
Get property by slug
Retrieves property details using the URL-friendly slug identifier.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| slug | String | Property slug | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getPropertyReviews
PaginatedResponse_PropertyReviewResponse getPropertyReviews(id, page, per_page)
Get property reviews
Retrieves a paginated list of reviews for a specific property.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Property ID | [default to null] |
| page | Long | Page number (default: 1) | [optional] [default to null] |
| per_page | Long | Items per page (default: 10) | [optional] [default to null] |
Return type
PaginatedResponse_PropertyReviewResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getSimilarProperties
List getSimilarProperties(id, limit)
Get similar properties
Retrieves properties similar to the specified property based on location, type, and price range.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Property ID | [default to null] |
| limit | Long | Maximum number of results (default: 6) | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listAmenities
List listAmenities()
List amenities
Retrieves all available amenities that properties can have.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listCancellationPolicies
List listCancellationPolicies()
List cancellation policies
Retrieves all available cancellation policies with their refund rules.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listMyBookings
PaginatedResponse_BookingOrderResponse listMyBookings(status, page, per_page)
List user’s bookings (requires auth)
Retrieves a paginated list of the authenticated user’s bookings.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| status | String | Filter by status: upcoming, current, past, cancelled | [optional] [default to null] |
| page | Long | Page number (default: 1) | [optional] [default to null] |
| per_page | Long | Items per page (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_BookingOrderResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listProperties
PaginatedResponse_PropertyListResponse listProperties(latitude, longitude, radius_km, property_type_ids, amenity_ids, min_price, max_price, min_guests, check_in_date, check_out_date, min_bedrooms, min_bathrooms, instant_booking_only, page, per_page, sort_by, sort_order)
List properties with filters
Retrieves a paginated list of properties matching the specified filters. Supports filtering by location, price range, amenities, and availability.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| latitude | Double | Latitude coordinate for geo-filtering | [optional] [default to null] |
| longitude | Double | Longitude coordinate for geo-filtering | [optional] [default to null] |
| radius_km | Double | Search radius in kilometers | [optional] [default to null] |
| property_type_ids | String | Comma-separated property type IDs | [optional] [default to null] |
| amenity_ids | String | Comma-separated amenity IDs | [optional] [default to null] |
| min_price | Double | Minimum price per night | [optional] [default to null] |
| max_price | Double | Maximum price per night | [optional] [default to null] |
| min_guests | Integer | Minimum number of guests | [optional] [default to null] |
| check_in_date | String | Check-in date (YYYY-MM-DD format) | [optional] [default to null] |
| check_out_date | String | Check-out date (YYYY-MM-DD format) | [optional] [default to null] |
| min_bedrooms | Integer | Minimum number of bedrooms | [optional] [default to null] |
| min_bathrooms | Integer | Minimum number of bathrooms | [optional] [default to null] |
| instant_booking_only | Boolean | Only show properties with instant booking enabled | [optional] [default to null] |
| page | Long | Page number (default: 1) | [optional] [default to null] |
| per_page | Long | Items per page (default: 20, max: 100) | [optional] [default to null] |
| sort_by | String | Sort field: price, rating, distance, created_at, name | [optional] [default to null] |
| sort_order | String | Sort order: asc, desc | [optional] [default to null] |
Return type
PaginatedResponse_PropertyListResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listPropertyReportReasons
List listPropertyReportReasons()
Get property report reasons
Retrieves all available reasons for reporting a property.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listPropertyTypes
List listPropertyTypes()
List property types
Retrieves all available property types (e.g., Apartment, House, Villa).
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
reportProperty
PropertyReportResponse reportProperty(id, CreatePropertyReportRequest)
Report a property (requires auth)
Reports a property for violating platform guidelines.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Property ID | [default to null] |
| CreatePropertyReportRequest | CreatePropertyReportRequest | Report details |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8