v1

latestSwagger 2.02026-07-141993129.2 KB

Bookings

Load a specific reservation from a booking.

With this request you can load one specific reservation done with one booking request.

get/api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}

Path parameters

confirmationIdstring required

The confirmation id for the booking the reservation was made.

reservationNumberinteger required

Specifies the reservation number for the reservation to load.

Query parameters

expand'None' | 'RoomRates'

Specifies the expand type.

exclude'None' | 'Customers'

Specifies the exclude type.

Headers

App-Idstring required

Application identifier

App-Keystring required

Application key.

Response

Returns the details of the reservation specified.

_warningsstring[]

Warnings that came up when your request was processed. Your request will still be processed successfull when you see such warnings in your response

addon_servicesstring[]

A list of addon service codes that are currently booked on the reservation. Services which are charged once per stay are only visible before and on the day they are booked for.

adultsinteger

The number of adults per room

arrival_datestring date-time

The arrival date of the guests

balancenumber double

The balance for all folios of this reservartion. It is calculated by all already charged room and service rates plus manual charges or charges from other systems like POS minus all payments. A negative balance indicates the reservation is overpaid, a positive balance that the guest owes the hotel money

cancellation_idstring

Given the reservation was cancelled, this field contains the cancellation id

channel_codestring

The code of the channel that was used when the booking has been created. It is also known as source. Possible values can be OTA, GDS or DIRECT, but it is configurable per hotel

checkin_timestring date-time

The real checkin time of the guests. It will be set after the checkin has been performed

checkout_timestring date-time

The real checkout time of the guests. It will be set after the checkout has been performed

commentstring

The comment for this reservation

confirmation_idstring

The confirmation id for the booking which the guest can use to check in on the kiosk, add the booking to the mobile app etc. It is used as identifier for all reservations done with the same booking request

createdstring date-time

Timestamp the reservation was created

currencystring

The currency all amounts of this reservation will be shown in

departure_datestring date-time

The departure date of the guests

external_idstring

The external id for this reservation is the unique identifier from the system that created the booking in hetras. It could be the id of an OTA like Expedia or booking.com or one of the GDS systems like Amadeus or Galileo

hotel_idinteger

The id of the hotel this reservation is valid for

labelsstring[]

A list of labels that are attached to the reservation.

market_codestring

The code of the market segment the rate plan for this reservation is linked to

The payment method for this reservation

reservation_numberinteger

The reservation number of the reservation

The current status of this reservation

roomsinteger

The number of rooms this reservation is valid for. After a multi-room booking is done there will be one reservation in hetras for this booking for all rooms. The hotel staff then will split this reservation into one reservation per room to be able to check in the guests

subchannel_codestring

The code of the subchannel that was used when the booking has been created. Possible values can be BOOKING, EXPEDIA or WALKIN, but it is configurable per hotel

updatedstring date-time

Timestamp of when the reservation was changed the last time