API Reference

The SiteConnect API suite consists of four key API types:

Rooms and Rates

Active Rooms Requirement: Only rooms and rates that are active in the booking channel must be returned in the response. This ensures that hoteliers can manage these rooms effectively within SiteMinder.

Room Type: Each room type must have a unique RoomTypeCode and RoomDescription @Name.

Rate Plan: Each rate plan must have a unique RatePlanCode and RatePlanDescription @Name.

Room Type + Rate Plan Combinations: Each RoomStay in the response represents a unique combination of a room type and a rate plan. This combination is identified using the RoomDescription @Name and RatePlanDescription @Name fields. Ensuring that each combination is unique is essential for accurate mapping within SiteMinder.

Mapping Interface: For seamless integration the RoomDescription @Name and RatePlanDescription @Name provided must be clear and concise. These descriptions appear in dropdown menus within the SiteMinder platform, enabling users to efficiently link their SiteMinder room rates to those in the booking channel.

Additional Flags

  • Use NO_AVAILABILITY and/or NO_RATES flags to restrict availability and/or rate updates from being sent from SiteConnect to the connected booking channel.

  • If a Room Rate is intended only for reservation delivery and not for availability, rates, or restriction updates, use the NO_UPDATE flag. This ensures the Room Rate is mapped solely for reservation delivery purposes.

Availability and Restrictions

Each Availability and Restrictions message contains a single AvailStatusMessages element which indicates the hotel to update using the AvailStatusMessages / HotelCode attribute. The AvailStatusMessages / AvailStatusMessage elements will contain the updates to process over a date range. There can be several AvailStatusMessage updates per request; however, each request will be limited to one hotel and one room type.

  • Availability *

  • Stop Sell *

  • Minimum Stay on Arrival

  • Maximum Stay on Arrival

  • Minimum Stay Through

  • Maximum Stay Through

  • Close to Arrival (CTA)

  • Close to Departure (CTD)

Response Behaviour for Stop Sells: If the partner's system does not support stop sells, it is required that the system interpret a RestrictionStatus of "Close" as equivalent to zero availability. This ensures consistency in how availability is communicated between SiteConnect and the booking channel, preventing errors when managing inventory. This behaviour is allowed only if the booking channel supports one rate plan per room type.

Minimum Stay and Maximum Stay: Can be defined as either a "Stay on Arrival" (based on the arrival date) or a "Stay Through" (covering the entire stay). SiteConnect sends Minimum Stay and Maximum Stay using the MinMaxMessageType attribute, with the following values:

  • For "Stay on Arrival": SetMinLOS or SetMaxLOS

  • For "Stay Through": SetForwardMinStay or SetForwardMaxStay

To enable Min/Max Stay Through, the booking channel must also support Min/Max Stay On Arrival.

The Min/Max Stay Through option is managed at the property level. Once certified, each property can choose between configuring Stay On Arrival or Stay Through as their preferred setting.

SiteConnect will send the Availability and Restrictions message first. Only after this message has received a successful response from the booking channel, the Rates message will be sent.

Rates

Each Rate message contains a single RateAmountMessages element which indicates the hotel to update using the RateAmountMessages / HotelCode attribute. The RateAmountMessages / RateAmountMessage elements will contain the updates to process over a date range. There can be several RateAmountMessage updates per request, however, each request will be limited to one hotel and one room type.

SiteConnect supports two pricing models, Per Day Pricing (PDP) and Occupancy Based Pricing (OBP). Both are a channel level feature, the pricing model configured will apply to all properties connected to the booking channel.

Per Day Pricing

PDP refers to a pricing model where rates are set for each individual day. Under this model, the rate for a room type is determined on a daily basis, allowing for different prices on different days. The Rate API updates for PDP will specify rates for each date within the defined range, allowing for precise daily rate management. The below functionalities are supported:

  • Rates *

  • Included Occupancy

  • Single Guest Discount

  • Extra Adult Rate

  • Extra Child Rate

  • Inclusions

Occupancy Based Pricing

OBP is a pricing model where rates vary based on the number of occupants in the room. Under this model, the rate changes depending on the number of guests staying in the room. The Rate updates for OBP will include rates for various occupancy levels, providing detailed pricing based on the number of guests. The below functionalities are supported:

  • Rates *

  • Included Occupancy *

  • Maximum Occupancy *

  • Single Guest Discount *

  • Extra Adult Rate *

  • Extra Child Rate

  • Inclusions

Default Included Occupancy: If no Included Occupancy value is set by the property, the SiteMinder assumes a default included occupancy of 2 guests.

Uniform Rates for Undefined Settings: If the property has not set values for Included Occupancy, Single Guest Discount, or Extra Adult Rate, the SiteMinder will apply the same rate for all occupancy levels.

Migrate from PDP to OBP

Existing partners transitioning from Per Day Pricing to Occupancy Based Pricing:

Maximum Occupancy Requirement: Your channel must provide the Maximum Occupancy for each room and rate code combination via OTA_HotelAvailRS for all connected properties. This data is required for an initial setup of the Maximum Occupancy values in our system.

Mixed Rate Messages During Transition: During the transition period, rate messages will be received in both OBP and non-OBP formats until all rates are converted to the OBP model. A Success response is expected after each PDP or OBP message update.

Reservations

Communication interface that enables booking channels to send reservation, modification, and cancellation notifications directly to hotels connected through SiteMinder's Platform.

  • Reservation (Initial Delivery) *

  • Reservation Multi-Room

  • Reservation Modifications

  • Reservation Cancellations

Reservation IDs: UniqueID ID must be unique among all properties connected at all time. If a reservation is received with an ID already used, it will be ignored regardless if it arrives for a different hotel.

Reservation Confirmation and Response Handling: SiteConnect does not have the authority to allow or deny reservations. The OTA_HotelResNotifRS response simply confirms whether SiteConnect has successfully received the reservation delivery message or notification request, indicating Success or Error. It is important to note that SiteConnect only acknowledges receipt of the reservation message and does not influence the booking process on your end.

Reservation Modifications and Cancellations: SiteConnect uses specific reservation status fields to differentiate between types of reservation actions. Modifications are identified using the 'Modify' @ResStatus, while cancellations are marked with 'Cancel' @ResStatus. For both actions, the full reservation data must be provided, including the original reservation details and the timestamp reflecting when the modification or cancellation was made. This ensures that the booking system processes changes and cancellations accurately and consistently across all properties.

Virtual Credit Cards (VCC): If a booking channel supports Virtual Credit Cards (VCC), it is essential to ensure that VCC details are updated in accordance with any reservation modifications or cancellations. This is critical for maintaining accurate payment information and ensuring that charges align with the updated booking details, especially in cases where reservations are amended or canceled after the initial transaction.

In the event of a cancellation, the TPA_Extensions section must either be removed entirely, or the VCCCurrentBalance should be set to 0.00. Alternatively, the VCCCurrentBalance can be updated to reflect the amount permitted by the cancellation policy, indicating how much the hotel can still charge from the VCC for the canceled reservation.

Reservation Notification Emails: SiteConnect can optionally send reservation notification emails to SiteMinder hotels based on key data provided in the OTA_HotelResNotifRQ. If your channel cannot send reservation emails directly to hotels, notify the Integration Analyst during the SiteConnect development process. This feature is not enabled by default and must be requested for activation.

Region-Dependent Reservation Delivery: SiteConnect operates in two regions: APAC (Asia Pacific) and EMEA (Europe, Africa, Middle East & Americas). Your customers may belong to either region, and you must ensure that reservations are directed to the correct SiteConnect instance. While these regions are typically assigned based on geography, exceptions can be made upon request for support or routing reasons.

The hotel or SiteMinder Support can specify the region (APAC or EMEA & Americas) where the property is set up, ensuring that you push reservations to the appropriate endpoint.

All functionalities marked with a red asterisk ( * ) are mandatory. The others are strongly recommended.

Rooms and Rates
Availability and Restrictions
Rates
Reservations

Last updated