API Reference

The pmsXchange API suite consists of seven key API types:

Rooms and Rates

This API enables a Property Management System (PMS) to request a list of Room Rates and mapping codes from pmsXchange for a specific hotel.

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.

  • Availability *

  • Stop Sell

  • Minimum Stay on Arrival

  • Maximum Stay on Arrival

  • Close to Arrival (CTA)

  • Close to Departure (CTD)

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.

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

Per Day Pricing

PDP refers to a pricing model where base 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 *

  • 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 *

  • Extra Adult Rate

  • Extra Child Rate

  • Inclusions

Included Occupancy: Included Occupancy value must be set by the property in their SiteMinder Platform.

Maximum Occupancy: The maximum occupancy rates allowed is 5.

Reservations Delivery (Pull)

Allows the PMS to pull reservations, modifications and cancellations from SiteMinder Platform. These reservations are from the hotel's connected booking channels through SiteMinder's Platform.

  • Reservation (Initial Delivery) *

  • Reservation Multi-Rooms

  • Reservation Modifications

  • Reservation Cancellations

Reservations Upload

test

Reservations Import

test

Payment Transaction Record

A one-way API that allows a PMS to retrieve reservation payment transaction data. These payment transactions are payments taken against a reservation via SiteMinder's Pay product.

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

Last updated