Rates and Restrictions to PMS (Beta)

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

This Open API specification defines the API that you would need to build to receive rate and restriction updates from SiteMinder.

This is an example of the message flow for a rates update. Due to the high volume of updates. It's important that the PMS receives the updates and places them on a queue for processing offline. Rather than processing the updates in realtime and blocking further updates from PMSX application.

Each message will be for a specific room rate code combination and will include a list of all updated dates. The maximum number of dates per message will be 760, but this does depend on the update period the hotel has configured.

There are 2 different rate endpoints. One to receive per day pricing, the other to receive occupancy based rates. You will have to specify which rate configuration your pms supports and build the appropriate endpoint. You do not need to implement both rate endpoints.

We will handle any required rate conversion between per day pricing and occupancy based pricing. So if your PMS supports occupancy based rates, we will use the room rate configuration data in Platform to build out the full occupancy based rate when the rate in Platform is per day priced. This is the same for conversion in the other direction, ie between per day pricing and occupancy based pricing.

For the restrictions message, if your pms does not support that restriction type we will not send that data.

Hotel Room Rate Update (Per day rate)

post

Endpoint to receive and process hotel room rate rates

Authorizations

basicAuth

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

Body

application/json

invTypeCodestringRequired

Inventory type code

Example: ABC

ratePlanCodestringRequired

Rate plan code

Example: CBA

currencyCodestringRequired

Three-letter currency code

Example: USDPattern: ^[A-Z]{3}$

Responses

200

Rates Update received

application/json

400

Bad request

application/json

429

Too Many Requests

500

Internal server error

application/json

post

/pmses/{pmsCode}/hotels/{hotelCode}/rates

HTTPcURLJavaScriptPython

POST /pmses/{pmsCode}/hotels/{hotelCode}/rates HTTP/1.1
Host: pmsx-partner.com
Authorization: Basic username:password
X-SM-TRACE-TOKEN: 8bf21e96-e6c7-4bf9-a377-a5763e053538
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "invTypeCode": "ABC",
  "ratePlanCode": "CBA",
  "currencyCode": "USD",
  "rates": [
    {
      "date": "2025-01-01",
      "rate": {
        "amountAfterTax": 355.5,
        "numberOfAdults": 2
      },
      "extraAdultAmount": {
        "amountAfterTax": 65.5
      },
      "extraChildAmount": {
        "amountAfterTax": 65.5
      }
    }
  ]
}

{
  "result": "Success"
}

Hotel Room Rate Update (Occupancy based rates)

post

Endpoint to receive and process hotel room rate rates

Authorizations

basicAuth

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

Body

application/json

invTypeCodestringRequired

Inventory type code

Example: ABC

ratePlanCodestringRequired

Rate plan code

Example: CBA

currencyCodestringRequired

Three-letter currency code

Example: USDPattern: ^[A-Z]{3}$

Responses

200

Rates Update received

400

Bad request

application/json

429

Too Many Requests

500

Internal server error

application/json

post

/pmses/{pmsCode}/hotels/{hotelCode}/occupancy-based-rates

HTTPcURLJavaScriptPython

POST /pmses/{pmsCode}/hotels/{hotelCode}/occupancy-based-rates HTTP/1.1
Host: pmsx-partner.com
Authorization: Basic username:password
X-SM-TRACE-TOKEN: 8bf21e96-e6c7-4bf9-a377-a5763e053538
Content-Type: application/json
Accept: */*
Content-Length: 348

{
  "invTypeCode": "ABC",
  "ratePlanCode": "CBA",
  "currencyCode": "USD",
  "occupancyBasedRates": [
    {
      "date": "2025-01-01",
      "occupancyBasedRates": [
        {
          "amountAfterTax": 300,
          "numberOfAdults": 1
        },
        {
          "amountAfterTax": 355.5,
          "numberOfAdults": 2
        },
        {
          "amountAfterTax": 425,
          "numberOfAdults": 3
        },
        {
          "amountAfterTax": 492.5,
          "numberOfAdults": 4
        }
      ],
      "extraChildAmount": {
        "amountAfterTax": 65.5
      }
    }
  ]
}

No content

Hotel Room Rate Update (Restrictions)

post

Endpoint to receive and process hotel room rate restrictions

Authorizations

basicAuth

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

Body

application/json

invTypeCodestringRequired

Inventory type code

Example: ABC

ratePlanCodestringRequired

Rate plan code

Example: CBA

Responses

200

Restrictions Update received

400

Bad Request

application/json

429

Too Many Requests

500

Internal server error

application/json

post

/pmses/{pmsCode}/hotels/{hotelCode}/restrictions

HTTPcURLJavaScriptPython

POST /pmses/{pmsCode}/hotels/{hotelCode}/restrictions HTTP/1.1
Host: pmsx-partner.com
Authorization: Basic username:password
X-SM-TRACE-TOKEN: 8bf21e96-e6c7-4bf9-a377-a5763e053538
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "invTypeCode": "ABC",
  "ratePlanCode": "CBA",
  "restrictions": [
    {
      "date": "2025-01-01",
      "minLOS": 2,
      "maxLOS": 7,
      "close": false,
      "closeToArrival": false,
      "closeToDeparture": false
    }
  ]
}

No content