API Object: Reservation

In this section, you will gain a clearer understanding of the main objects of a reservation and their key components, ensuring that all necessary information is captured.

While screenshots from the SIHOT UI are provided for context, this page focuses first on API structure and usage.
For UI-based examples, see the Visual Reference (SIHOT) section.


Types of Reservations

SIHOT supports three main reservation structures in the API:

  • Simple Reservation: A reservation with one room.
  • Multi-Room Reservation: A reservation that includes two or more rooms.
  • Group Reservation: A reservation that includes multiple elements organized by room types and/or dates of stay. Each element within the group is assigned a unique sequential number, known as subno.
NOTE

In all reservation types, the rooming list may override information from the reservation data, such as:
  • Room categories
  • Packages
  • Dates of stay

For visual examples of these, see the Visual Reference (SIHOT) section.

Elements of a Reservation

Reservations in SIHOT consist of three main elements:

  • RESERVATION: General information about the reservation
  • ROOM: Room-specific data
  • PERSON: Individual guest details

When working with reservation data, it’s important to understand each element correctly in order to retrieve the right information for your specific integration needs.


RESERVATION

The data within the RESERVATION element reflects the information shown on the main reservation page in SIHOT, offering general details about the overall reservation. However, this data can be overwritten for specific rooms or individual entries within the reservation.

TIP

Use RESERVATION-OBJID as your primary identifier. The same resno may be reused across multiple sub-reservations or after a room move.
Attribute Description Combobox Type / Values Additional Remarks
RESERVATION-OBJID Unique reservation identifier The same resno can have different OBJIDs - in case of group reservations or after a room move
CENTRAL-RESERVATION-ID HQ-level reservation ID
resno Reservation number in SIHOT
subno Sub-reservation number each subno has a different RESERVATION-OBJID
restype Reservation status/type Main restype available are: 1=Confirmed, 2=Not guaranteed, S=Cancelled, E=Error, K=Allotment
optiontodate Date until which the reservation is optional
noofnights Total room nights Might differ by ROOM or PERSON
arrival Arrival date Might differ by ROOM or PERSON
departure Departure date Might differ by ROOM or PERSON
gdsresnumber Unique identifier assigned to travel agents, booking agencies, or other entities within a Global Distribution System. Varies by client A GDS search is recommended when the goal is to access the guest's reservation, as this is often the only number that the final guest has access to.
category Room category This value can be different from ratecategory in case of an upgrade. Might also differ by ROOM or PERSON
ratecategory Booked room category Might differ by ROOM or PERSON
marketsegment Market segment Combobox: MA
forecastrategross Gross rate for the reservation
forecastratenet Net rate without taxes
noofpax / noofchildren / noofadults Total number of persons / children / adults
paymentinstructions Payment instructions 0=Own, 1=Orderer, 2=Group
ORDERER Client who made the reservation, typically a guest but can also be a Company or other entity
TRAVELAGENCY This field usually indicates that a Travel Agency, an OTA or a Company is intermediating the reservation
TRAVELPOINT This field indicates if there is a third intermediator for the reservation
RESERVATIONPACKAGES Booked packages for the reservation May be overridden by PERSON

ROOM

The ROOM element represents individual room data within a reservation.

Attribute Description Combobox Type / Values Additional Remarks
ROOMINGLIST-OBJID Rooming list identifier
ROOM-OBJID Allocated room identifier
category Category of assigned room Combobox: 19
datefrom / dateto Room-specific arrival/departure May differ per guest
noofpax / children / adults Occupancy for the room
noofnights Nights for this room
room Room number

PERSON

The PERSON element contains personal details of individuals occupying each room.

Attribute Description Combobox Type / Values Additional Remarks
PERSON-OBJID Unique identifier of the person This number remains the same even if the actual guest profile is changed
persontype Person classification (e.g., adult/child) Combobox: PG
name1 / name2 Last name / First name
sex Gender (based on title) 0=Unknown, 1=Male, 2=Female
title Title 2 Combobox type: 16 used for formal, academic, professional and religious titles
address Title Combobox: 18 used for common titles (Mr, Ms, etc.)
country ISO2 country code Combobox: 11
subcountry / subsubcountry Region / District Mapping required
marketsegment Market segment Combobox: MA
salutation Salutation for letters Combobox: 17
ratecategory Booked room category Combobox: 19
datefrom / dateto Guest-specific stay dates
arrivaltime / departuretime Guest arrival/departure time
vip / vip2 VIP level tags Combobox: 13 / vi
personStatus Guest check-in status RESERVED / ASSIGNED / CHECKEDIN / CHECKEDOUT
qrcode QR code for self-check-in
hasprecheckin / hasprecheckout Flags for pre-checkin/out 0 = No, 1 = Yes
GUEST-OBJID Unique identifier of the guest If assigned, indicates that there is a guest profile assigned

PERSONPACKAGE and Services

Attribute Description
service Services and packages assigned to the guest
datefrom / dateto Service/package date range
quantity Quantity of service/package
priceperunit Unit price
totalprice Total per night per unit
AMENITIES Room-level extras (e.g. bathrobe, fruit basket)

Visual Reference (SIHOT)


Simple Reservation



Multi-Room Reservation



Group Reservation



Room Element in SIHOT



Person Element in SIHOT