v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

RateStrategyOpenApi

Retrieve All Rate Strategies.

Use this endpoint to retrieve an account's associated rate strategy settings.

get/rm-rate-strategies-open-api/rate-strategies

Response

Rate strategies have been received.

countnumber required

Number of rate strategies in the result set

limitnumber required

Maximum number of rate strategies that can be returned in the response

skipnumber required

Number of rate strategies that should be skipped from the result set

requestIdstring required

ID of the request

Example response

{
  "rateStrategies": [
    {
      "name": "my rate strategy name",
      "assignedListingCount": 1,
      "rules": {
        "seasonal": [
          {
            "name": "event name",
            "restriction": {
              "checkInWeekDays": [
                1,
                3,
                5
              ],
              "checkOutWeekDays": [
                1,
                3,
                4,
                5
              ]
            },
            "adjustmentPercentage": 3,
            "minNights": 1,
            "weekDays": [
              0,
              1,
              2,
              3,
              4,
              5,
              6
            ]
          }
        ],
        "events": [
          {
            "name": "event name",
            "restriction": {
              "checkInWeekDays": [
                1,
                3,
                5
              ],
              "checkOutWeekDays": [
                1,
                3,
                4,
                5
              ]
            },
            "adjustmentPercentage": 3,
            "minNights": 1
          }
        ],
        "upcomingAvailability": [
          {
            "name": "upcoming availability rule name",
            "fromDays": 1,
            "toDays": 3,
            "weekDays": [
              1,
              2,
              3,
              5
            ],
            "adjustmentPercentage": 3,
            "minNights": 4
          }
        ],
        "customizedGaps": [
          {
            "name": "gap rule name",
            "fromDays": 2,
            "toDays": 5,
            "adjustmentPercentage": 4,
            "maxGap": 3
          }
        ],
        "lengthOfStay": [
          {
            "adjustmentPercentage": 1,
            "type": "range"
          }
        ],
        "repeatedDays": {
          "0": {
            "adjustmentPercentage": 1,
            "minNights": 2,
            "ctd": true
          },
          "1": {
            "adjustmentPercentage": 1,
            "minNights": 2,
            "ctd": true
          },
          "2": {
            "adjustmentPercentage": 1,
            "minNights": 2,
            "ctd": true
          },
          "3": {
            "adjustmentPercentage": 1,
            "minNights": 2,
            "ctd": true
          },
          "4": {
            "adjustmentPercentage": 1,
            "minNights": 2,
            "ctd": true
          },
          "5": {
            "adjustmentPercentage": 1,
            "minNights": 2,
            "ctd": true
          },
          "6": {
            "adjustmentPercentage": 1,
            "minNights": 2,
            "ctd": true
          }
        }
      },
      "description": "rate strategy best description",
      "singleUnitsCount": 3,
      "multiUnitsCount": 1,
      "subUnitsCount": 4,
      "minAdjustmentPercentage": 5,
      "maxAdjustmentPercentage": 10,
      "minNights": 4,
      "isOptimized": true
    }
  ],
  "count": 10,
  "limit": 10,
  "requestId": "65a0639e9d142279"
}