v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Open Api Ari Calendar v1

GET Rate Plan Calendar

Retrieves the rate plan's rates, availability and inventory by calendar date.

get/rm-rate-plans-ext/ari-calendar/listing/{listingId}/ratePlan/{ratePlanId}

Path parameters

{"stackTrail":"paths:/rm-rate-plans-ext/ari-calendar/listing/{listingId}/ratePlan/{ratePlanId}:get:parameters:2:schema","oasType":"schema","type":"unknown"}

Rate plan ID.

{"stackTrail":"paths:/rm-rate-plans-ext/ari-calendar/listing/{listingId}/ratePlan/{ratePlanId}:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Property ID.

Query parameters

fromDatestring date-time required

Period start date.

toDatestring date-time required

Period end date.

Response

Success

listingIdstring required

listing id

requestIdstring required

request id

Example response

{
  "ratePlan": {
    "_id": "5fae51c4fdff570029b147e8",
    "accountId": "5213a2d206112710005d96ff",
    "type": "independent",
    "name": "My rate plan",
    "description": "My rate plan description",
    "cancellationPolicy": "firm",
    "mealPlans": [
      "all_inclusive"
    ],
    "availabilityRules": {
      "advanceNotice": 10,
      "bookingWindow": 20
    },
    "pricingModel": "nightly_rate",
    "channelSync": [
      "bookingCom"
    ],
    "active": true,
    "createdAt": "2023-12-01T04:09:27.335Z",
    "updatedAt": "2023-12-01T04:09:27.335Z"
  },
  "days": [
    {
      "minNights": 1,
      "maxNights": 45,
      "allotment": 3,
      "createdAt": "2023-11-27",
      "updatedAt": "2023-11-27"
    }
  ]
}