API Reference
The pmsXchange API suite synchronizes Property Management Systems with SiteMinder for channel distribution and reservation management.
All functionalities marked with a red asterisk ( * ) are mandatory. The others are strongly recommended.
Rooms and Rates
REST/JSON - Retrieve room type and rate plan mappings to align your PMS inventory with SiteMinder's channel distribution configuration.
Supported Endpoint:
GET Room Rates *
Documentation: View API Specification →
Must be completed first, as it required for all other components.
PMS Rooms and Rates (Beta)
You can find the Open API yaml file for both the Rates and Restrictions to PMS and PMS Rooms and Rates API's here.
REST/JSON - Enables you to share your hotel's room rate mapping data with SiteMinder, so we know which specific room rates to update
Supported Messages:
PMS Room Rates
Documentation: View API Specification →
It is a prerequisite to certify PMS Rooms and Rates to access Rates and Restrictions to PMS.
Availability and Restrictions
SOAP/XML - Sync room inventory and booking restrictions from your PMS to SiteMinder for channel distribution.
Supported Updates:
Availability *
Stop Sell
Minimum Length of Stay (MinLOS)
Maximum Length of Stay (MaxLOS)
Close to Arrival (CTA)
Close to Departure (CTD)
Documentation: View API Specification →
Rates
SOAP/XML - Sync pricing from your PMS to SiteMinder for channel distribution.
Supported Pricing Models:
Per Day Pricing (PDP) - if your PMS stores one rate per room per night
Occupancy Based Pricing (OBP) - if your PMS stores different rates for different guest counts
Documentation: View API Specification →
Certify either PDP or OBP, choosing based on your PMS pricing structure.
Rates and Restrictions to PMS (Beta)
You can find the Open API yaml file for both the Rates and Restrictions to PMS and PMS Rooms and Rates API's here.
REST/JSON - Allows your PMS to receive rate and restriction updates from SiteMinder
Supported Method:
Push
Supported Updates:
Per Day Pricing (PDP) - if your PMS stores one rate per room per night
Occupancy Based Pricing (OBP) - if your PMS stores different rates for different guest counts
Stop Sell
Minimum Length of Stay (MinLOS)
Maximum Length of Stay (MaxLOS)
Close to Arrival (CTA)
Close to Departure (CTD)
Documentation: View API Specification →
It is a prerequisite to certify PMS Rooms and Rates to access Rates and Restrictions to PMS.
Reservations PUSH
SOAP/XML - Receive reservations from SiteMinder directly to your PMS in real-time.
Supported Messages:
Reservation (Initial Delivery) *
Reservation Multi-Rooms *
Reservation Modifications
Reservation Cancellations
Documentation: View API Specification →
Certify either Reservations PUSH (recommended) or Reservations PULL.
Reservations PULL
SOAP/XML - Retrieve reservations from SiteMinder by polling at regular 2-5 minute intervals.
Supported Messages:
Reservation (Initial Delivery) *
Reservation Multi-Rooms *
Reservation Modifications
Reservation Cancellations
Documentation: View API Specification →
Certify either Reservations PUSH (recommended) or Reservations PULL.
Reservations Upload
SOAP/XML - Sync PMS reservations back to SiteMinder Platform.
Supported Messages:
Walk-in Reservations *
Direct Booking Channel Reservations *
CRS/GDS/Wholesaler Reservations *
SiteMinder Modification/Cancellation *
Documentation: View API Specification →
It is a prerequisite to certify Reservations PUSH or Reservations PULL to access Reservation Upload.
Reservations Import
REST/JSON - Bulk import all active reservations during initial PMS integration setup.
Supported Endpoint:
GET Reservation Import
Documentation: View API Specification →
It is a prerequisite to certify Reservations Upload to access Reservation Import.
Payment Transaction Record
SOAP/XML - Retrieve payment transaction data from SiteMinder to your PMS.
Supported Transaction Types:
Reserve
Charge *
Refund *
Documentation: View API Specification →
It is a prerequisite to certify Reservations PUSH or Reservations PULL to access Payment Transaction Record.
Credit Card Tokenization
SOAP/XML - Securely handle credit card data through certified third-party proxy providers for PCI compliance.
Supported Method:
Push
Pull
Documentation: View API Specification →
It is a prerequisite to certify Reservations PUSH or Reservations PULL to access Credit Card Tokenization.
Last updated
Was this helpful?