> For the complete documentation index, see [llms.txt](https://developer.siteminder.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.siteminder.com/pmsxchange-api/guides/api-overview.md).

# API Overview

Use this page to understand what each pmsXchange API operation does and what data it handles.

### Rooms and Rates <a href="#rooms-and-rates" id="rooms-and-rates"></a>

***

{% columns %}
{% column %}

#### SM -> PMS <a href="#sm-greater-than-pms" id="sm-greater-than-pms"></a>

`REST/JSON`&#x20;

Retrieve room type and rate plan mappings.

* GET Room Rates

View API Specification [→](/pmsxchange-api/reference/rooms-and-rates/sm-to-pms.md)
{% endcolumn %}

{% column %}

#### PMS -> SM <mark style="color:red;">(Beta)</mark> <a href="#pms-greater-than-sm-beta" id="pms-greater-than-sm-beta"></a>

`REST/JSON`&#x20;

Share room type and rate plan mappings.

* GET Room Rates

View API Specification [→](/pmsxchange-api/reference/rooms-and-rates/pms-to-sm.md)
{% endcolumn %}
{% endcolumns %}

***

### Availability <a href="#availability" id="availability"></a>

***

{% columns %}
{% column %}

#### PMS -> SM

`SOAP/XML`&#x20;

Sync room inventory from your PMS to SiteMinder for channel distribution.

* Availability

View API Specification [→](/pmsxchange-api/reference/availability.md)
{% endcolumn %}

{% column %}

{% endcolumn %}
{% endcolumns %}

***

### Restrictions <a href="#restrictions" id="restrictions"></a>

***

{% columns %}
{% column %}

#### PMS -> SM <a href="#pms-greater-than-sm" id="pms-greater-than-sm"></a>

`SOAP/XML`

Sync booking restrictions from your PMS to SiteMinder for channel distribution.

* Stop Sell
* Minimum Length of Stay (MinLOS)
* Maximum Length of Stay (MaxLOS)
* Close to Arrival (CTA)
* Close to Departure (CTD)

View API Specification [→](/pmsxchange-api/reference/restrictions/pms-to-sm.md)
{% endcolumn %}

{% column %}

#### SM -> PMS <a href="#sm-greater-than-pms-beta" id="sm-greater-than-pms-beta"></a>

`REST/JSON`&#x20;

Receive restriction updates pushed from SiteMinder directly to your PMS.

* Stop Sell
* Minimum Length of Stay (MinLOS)
* Maximum Length of Stay (MaxLOS)
* Close to Arrival (CTA)
* Close to Departure (CTD)

View API Specification [→](/pmsxchange-api/reference/restrictions/sm-to-pms.md)
{% endcolumn %}
{% endcolumns %}

***

### Rates <a href="#rates" id="rates"></a>

***

{% columns %}
{% column %}

#### PMS -> SM <a href="#pms-greater-than-sm-1" id="pms-greater-than-sm-1"></a>

`SOAP/XML`

Sync pricing from your PMS to SiteMinder for channel distribution.

* Per Day Pricing (PDP)
* Occupancy Based Pricing (OBP)

View API Specification [→](/pmsxchange-api/reference/rates/pms-to-sm.md)
{% endcolumn %}

{% column %}

#### SM -> PMS <a href="#sm-greater-than-pms-beta-1" id="sm-greater-than-pms-beta-1"></a>

`REST/JSON`

Receive rate updates pushed from SiteMinder directly to your PMS.

* Per Day Pricing (PDP)
* Occupancy Based Pricing (OBP)

View API Specification [→](/pmsxchange-api/reference/rates/sm-to-pms.md)
{% endcolumn %}
{% endcolumns %}

***

### Reservations <a href="#reservations" id="reservations"></a>

***

{% columns %}
{% column %}

#### Push (SM -> PMS) <a href="#push-sm-greater-than-pms" id="push-sm-greater-than-pms"></a>

`SOAP/XML`

Receive reservations from SiteMinder directly to your PMS in real time.

* Reservation (Initial Delivery)
* Reservation Multi-Rooms
* Reservation Modifications
* Reservation Cancellations

View API Specification [→](/pmsxchange-api/reference/reservations/push.md)
{% endcolumn %}

{% column %}

#### Pull (SM -> PMS) <a href="#pull-sm-greater-than-pms" id="pull-sm-greater-than-pms"></a>

`SOAP/XML`

Retrieve reservations from SiteMinder by polling at regular 2–5 minute intervals.

* Reservation (Initial Delivery)
* Reservation Multi-Rooms
* Reservation Modifications
* Reservation Cancellations

View API Specification [→](/pmsxchange-api/reference/reservations/pull.md)
{% endcolumn %}
{% endcolumns %}

***

{% columns %}
{% column width="50%" %}

#### Upload (PMS -> SM) <a href="#upload-pms-greater-than-sm" id="upload-pms-greater-than-sm"></a>

`SOAP/XML`

Sync PMS reservations back to the SiteMinder Platform.

* Walk-in Reservations
* Direct Booking Channel Reservations
* CRS/GDS/Wholesaler Reservations
* SiteMinder Modification/Cancellation

View API Specification [→](/pmsxchange-api/reference/reservations/upload.md)
{% endcolumn %}

{% column width="50%" %}

#### Import <a href="#import" id="import"></a>

`REST/JSON`

Bulk import all active reservations during initial PMS integration setup.

* GET Reservation Import

View API Specification [→](/pmsxchange-api/reference/reservations/import.md)
{% endcolumn %}
{% endcolumns %}

***

### Payment Transaction Record <a href="#payment-transaction-record" id="payment-transaction-record"></a>

***

{% columns %}
{% column %}

#### SM -> PMS <a href="#sm-greater-than-pms-beta-1" id="sm-greater-than-pms-beta-1"></a>

`SOAP/XML`&#x20;

Retrieve payment transaction data from SiteMinder to your PMS.

* Reserve
* Charge
* Refund

View API Specification [→](/pmsxchange-api/reference/payment-transaction-record.md)
{% endcolumn %}

{% column %}

{% endcolumn %}
{% endcolumns %}

{% hint style="success" icon="sparkles" %}

## Still have questions?

Use the <i class="fa-gitbook-assistant">:gitbook-assistant:</i> **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](/integration-support/integration-support.md).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.siteminder.com/pmsxchange-api/guides/api-overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.