v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Reservations

Create Reservation

Create a reservation (Direct Booking) in Hostex.

post/reservations

Request body

property_idinteger required

The id of the property for the reservation.

custom_channel_idinteger required

The id of the custom channel through which the reservation is booked. See Query Custom Channel for retrieving custom channels.

check_in_datestring date required

The check-in date for the reservation in YYYY-MM-DD format.

check_out_datestring date required

The check-out date for the reservation in YYYY-MM-DD format.

number_of_guestsinteger

The total number of guests included in the reservation.

guest_namestring required

The name of the primary guest.

emailstring

The email address of the primary guest.

mobilestring

The mobile phone number of the primary guest.

currencystring required

The currency code for the reservation amounts. See Supported Currencies for more information.

rate_amountinteger required

The total rate amount for the reservation.

commission_amountinteger required

The commission amount for the reservation.

received_amountinteger required

The total amount received for the reservation.

income_method_idinteger required

The identifier for the income method used for the reservation payment. See Query Income methods for retrieving all income methods.

remarksstring

Any additional remarks related to the reservation.

Response

The request has been successfully submitted.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}