📈 RMS (Revenue Management System) Flow

The RMS Flow defines how external Revenue Management Systems (such as Beyond, Turbosuite, or custom pricing engines) can integrate with Octorate to exchange pricing, availability, and performance data in real time.

• Read the current calendar status (prices, allocation, and restrictions) to generate recommendations.

• Push bulk ARI updates (price, availability, min/max stay, CTA/CTD, stop-sell, cut-off)

• Perform timely availability checks for validation.

🧭 Flow Overview

1	Retrieve ARI Data	Fetch current prices, availability, and restrictions for specific products and a date range.	GET /rest/v1/calendar/{accommodation}
2	Push Bulk ARI Updates	Send bulk updates for prices, availability, and stay restrictions for multiple rooms and dates.	POST /rest/v1/calendar/bulk
3	Check Availability	Verify if a specific product is bookable for a given check-in/check-out range.	GET /rest/v1/calendar/{accommodation}/{productId}/availabilityCheck
4	Manage Derived Rates	Update the logic (e.g., percentage discount) for rates linked to a parent room.	PATCH /rest/v1/roomrates/{accommodation}/{id} (or /rest/v3/...)
5	Verify Calendar Update	Re-read the calendar data to confirm that all changes have been applied successfully.	GET /rest/v1/calendar/{accommodation}

---

📊 Retrieve Current ARI Data

Scope: Returns, for each product (room or associated rate), the days with ARI attributes.

Main parameters: product[]: repeatable list of product IDs (room/rate) dateFrom, dateTo: date range (yyyy-MM-dd) size, page: pagination (products per page and page)

Endpoint

GET /rest/v1/calendar/{accommodation}?from=2025-12-01&to=2025-12-31

Example Response

{
  "data": [
    {
      "id": 253166,
      "name": "Double Room",
      "days": [
        {
          "date": "2026-03-01",
          "price": 89.00,
          "availability": 3,
          "minStay": 2,
          "maxStay": 30,
          "stopSells": false,
          "closeToArrival": false,
          "closeToDeparture": false,
          "cutOffDays": 0,
          "bookable": true
        }
      ]
    }
  ],
  "page": { "page": 0, "totalPages": 5 }
}

---

🚀 Bulk Calendar Update (ARI Write)

After calculating new pricing strategies, the RMS can efficiently push updates using a single API call. It's important to optimize requests to stay within quota limits.

Description: Updates calendar values for a list of rooms and date intervals. API call quotas are dynamic; monitor the X-RateLimit-Remaining header.

Endpoint

POST /rest/v1/calendar/bulk

Quota: The API enforces limits. Check the X-RateLimit-Remaining-Calendar header for remaining quota.

Example Request

[
  {
    "room": 253166,
    "dateFrom": "2026-03-10",
    "dateTo": "2026-03-15",
    "values": { "price": 95.00, "availability": 3, "minstay": 2 }
  },
  {
    "room": 253170,
    "dateFrom": "2026-03-12",
    "dateTo": "2026-03-12",
    "values": { "stopSells": true }
  }
]

Example Response

{
  "ids": [ 7812341, 7812342 ],
  "warnings": []
}

---

🔍 Perform an Availability Check

Checks if a specific product (room/rate) is bookable for a given date range.

• Key Parameters:

  • accommodation (path): The property ID.

  • productId (path): The product ID.

  • startDate, endDate (query): The date range in yyyy-MM-dd format.

Endpoint

GET /rest/v1/calendar/{accommodation}/{productId}/availabilityCheck?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD

Example Request

GET /rest/v1/calendar/Property/253166/availabilityCheck?startDate=2026-03-10&endDate=2026-03-12

Example Response

Responses:
200 OK: The product is bookable for the requested dates.

406 Not Acceptable: The product is not bookable for the requested dates.

Outcome: The RMS has confirmed that the date range is available and bookable according to Octorate's rules.

---

🔗 Update Derived or Linked Rates

If the RMS manages derived rules (linked rate plans with automatic adjustments), it can also modify derivation logic.

• Description: Updates fields of an existing room or rate. The PATCH operation only replaces the provided fields.

Example Request

PATCH /rest/v1/roomrates/{accommodation}/{roomId}

Example Response

PATCH /rest/v1/roomrates/12345/253170

{
  "derivedRule": {
    "parent": 253166,
    "availability": true,
    "price": "PERCENT",
    "priceValue": -10.0,
    "priceRound": true
  }
}

This request configures rate ID 253170 as derived from room ID 253166:

• availability: true means it follows the parent room's availability.

• price: "PERCENT" indicates a percentage adjustment.

• priceValue: -10.0 applies a 10% discount on the parent's price.

Outcome: The "Non-Refundable" rate is automatically updated whenever the base rate's price changes, maintaining the discount logic without manual intervention.

---

🧾 Verify Updated Calendar

Finally, to ensure all changes have been applied correctly, the RMS can re-read the calendar for the recently updated date range.

GET /rest/v1/calendar/{accommodation}?from=2025-12-10&to=2025-12-15 (same as Step 1)

Example Response

{
  "data": [
    {
      "id": 253166,
      "name": "Double Room",
      "days": [
        {
          "date": "2026-03-10",
          "price": 95.00,
          "availability": 3,
          "minStay": 2,
          // ... other fields
        },
        // ...
      ]
    },
    {
      "id": 253170,
      "name": "Double Room - Non Refundable",
      "days": [
        {
          "date": "2026-03-12",
          "price": 85.50, // Auto-discounted price
          "availability": 3,
          "stopSells": true, // Updated via bulk
          // ...
        },
        // ...
      ]
    }
  ]
}

Outcome: The system confirms full synchronization between the RMS and Octorate. The updated prices and new restrictions are correctly applied and visible.

---

⚠️ Common Errors

HTTP Code	Error	Description
400	ApiParamsExemption	Invalid date range or payload
401	ApiKeyInvalid	Invalid or expired token
403	ApiSecurityException	Insufficient permission for property
429	ApiQuotaException	Too many requests (rate limit)
500	InternalServerError	Unexpected issue from Octorate

---

💡 Best Practices for RMS Integrations

✅ Always push rates and restrictions in small date ranges (max 31 days per request). ✅ Pull ARI data at least once per day to keep sync accurate. ✅ Use the price field only — Octorate handles currency conversions internally. ✅ Combine calendar + roomrates endpoints for complex rate structures. ✅ Use the same OAuth token across accommodations in the same network. ✅ Subscribe to RESERVATION_CREATED and RESERVATION_CANCELLED webhooks if you want to monitor pickup and forecast.

---

🧭 RMS Flow Summary

1. Read: RMS reads current ARI data (GET /calendar) for a specific period.

2. Optimize: RMS calculates new pricing and availability strategies.

3. Push Bulk: RMS sends bulk updates (POST /calendar/bulk).

4. Manage Derived Rules (Optional): RMS updates rules for derived rates (PATCH /roomrates).

5. Verify: RMS verifies the correct application of changes (GET /calendar).

---

This flow provides a robust, bi-directional integration, ensuring that revenue management decisions are implemented efficiently and accurately across Octorate and all connected sales channels.