PMS -> SM

Share room type and rate plan configurations from your PMS with the SiteMinder Platform.

This is a beta specification and subject to change. Reach out to our Ecosystem Team if you wish to develop to this API.

API: pmsXchange · Operation: Rooms and Rates · Direction: PMS → SM · Method: Pull (SM-initiated)

What is Rooms and Rates (PMS -> SM)?

Rooms and Rates (PMS -> SM) is a retrieval method where SiteMinder requests a list of configured room types and rate plans directly from the Property Management System (PMS). This integration allows the PMS to share its room and rate mapping configuration with SiteMinder, including important metadata about rate setup types and data limitations, ensuring accurate distribution setup and synchronization across all connected channels.

To implement Rooms and Rates (PMS -> SM), the PMS must certify for Rooms and Rates (SM -> PMS).

Considerations

• Direction of Integration: Unlike the standard Rooms and Rates (SM -> PMS) endpoint where the PMS pulls from SiteMinder, this endpoint is called by SiteMinder to retrieve configuration from the PMS.
• Required Fields: All fields in the RoomRateMapping object are required: id, roomTypeCode, ratePlanCode, roomTypeName, ratePlanName, includedAdultOccupancy, maxAdultOccupancy, minRate, currencyCode and rateSetup.
• Rate Setup: The rateSetup object has 2 fields

  • type - This indicates how the rate is configured in the PMS and can be 1 of 2 values.

    • Derived: Rate is calculated from another rate (base rate). Derived rates should include NO_RATES in unsupportedData.
    • Manual: Rate is manually managed and can receive updates.
  • parentRatePlanCode - The rate plan code the of the base rate this rate is derived from.

    • If the rate is a Derived rate then parentRatePlanCode is required.
• Data Limitations: Use the unsupportedData array to communicate limitations:

  • NO_RATES: No rate updates should be pushed to this room rate
  • NO_UPDATES: No updates of any kind should be pushed to this room rate

Authentication Requirements: The REST components of the pmsXchange API only support PMS-level authentication, which means using the same credentials across all properties. If you’re currently using hotel-level authentication (credentials per property), we recommend switching to PMS-level to ensure compatibility with the REST endpoints.

Message Exchange Flow

The following diagram illustrates the asynchronous message flow:

Retrieve room rate mappings for a hotel

get

Returns the current room rate mapping configuration for the specified hotel

Authorizations

AuthorizationstringRequired

Path parameters

hotelCodestringRequired

Hotel identifier code

pmsCodestringRequired

PMSX partner code

Header parameters

X-SM-TRACE-TOKENstringRequired

The unique identifier of the request (UUID), this traceToken is logged with this request.

Example: 8bf21e96-e6c7-4bf9-a377-a5763e053538

Responses

200

PMS RoomRate Mapping Response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Access Denied

application/json

404

Not Found

application/json

429

Too Many Requests

500

Internal server error

application/json

503

Service Unavailable

application/json

get/pmses/{pmsCode}/hotels/{hotelCode}/room-rates/v1

GET /pmses/{pmsCode}/hotels/{hotelCode}/room-rates/v1 HTTP/1.1
Host: pmsx-partner.com
Authorization: Basic username:password
X-SM-TRACE-TOKEN: 8bf21e96-e6c7-4bf9-a377-a5763e053538
Accept: */*

[
  {
    "id": "8bf21e96-e6c7-4bf9-a377-a5763e053538",
    "roomTypeCode": "ABC",
    "ratePlanCode": "CBA",
    "roomTypeName": "Single Room",
    "ratePlanName": "Best Available Rate",
    "includedAdultOccupancy": 2,
    "maxAdultOccupancy": 4,
    "minRate": 99,
    "currencyCode": "USD",
    "rateSetup": {
      "type": "Derived",
      "parentRatePlanCode": "BAR"
    },
    "unsupportedData": [
      {
        "code": "NO_RATES"
      }
    ]
  }
]

Common Questions

What is the difference between Rooms and Rates (PMS -> SM) and Rooms and Rates (SM -> PMS) endpoint?

The direction of the API call is different:

• Rooms and Rates (SM -> PMS): PMS calls SiteMinder to retrieve room and rate configuration
• Rooms and Rates (PMS -> SM): SiteMinder calls the PMS to retrieve room and rate configuration

Rooms and Rates (PMS -> SM) also includes additional metadata like rateSetupType and unsupportedData to communicate rate configuration and limitations.

When should I use NO_RATES vs NO_UPDATES in unsupportedData?

Use these codes to communicate data limitations:

• NO_RATES: Use for derived rates or when only restrictions should be updated, but not pricing
• NO_UPDATES: Use when the room rate should not receive any updates (restrictions or rates)

For derived rates, set rateSetupType to "Derived" and include NO_RATES in unsupportedData.

How often will SiteMinder call this endpoint?

SiteMinder calls this endpoint during:

• Initial hotel setup and configuration
• On-demand when mapping issues are detected
• Periodic synchronization to detect configuration changes

This is not a real-time polling endpoint. The PMS should return the current configuration state when called.

Still have questions?

Use the Ask button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues.

If you need more support, visit Integration Support.