ARI: Calendar

Update Calendar (ARI)

post

Update the calendar values for the given rooms and date intervals. It takes in input a list. Take care: Every 15 room/day requestes, one more quota is consumed. Please optimize your calls to avoid unuseful requests. Maximum available quota is based on your properties. Likely (but just to give an example) you can perform only 5/6 2 year full update per 5 minutes.

Authorizations

OAuth2authorizationCodeRequired

When you're interacting with an Accommodation/Network you should use this access. Octorate default authentication model to access all the resources relative to an Accommodation. One token = 1 property or the network properties of the ones user has visibility. [More info] https://partner.octorate.com/integration/showcases/authentication.html

Authorization URL: Token URL: Refresh URL:

Bodyobject · CalendarBulkRequest[]

roominteger · int64Optional

The Octorate's room id to update.

dateFromstring · dateOptional

The first date to change in calendar (inclusive). Date must be in format yyyy-mm-dd.

dateTostring · dateOptional

The last date to change in calendar (inclusive). Date must be in format yyyy-mm-dd.

Responses

default

default response

application/json

post/rest/v1/calendar/bulk

POST /connect/rest/v1/calendar/bulk HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

[
  {
    "room": 1,
    "dateFrom": "2026-01-01",
    "dateTo": "2026-01-01",
    "values": {
      "availability": 1,
      "price": 1,
      "minstay": 1,
      "maxstay": 1,
      "stopSells": true,
      "closeToArrival": true,
      "closeToDeparture": true,
      "cutOffDays": 1
    }
  }
]

default

default response

get

Perform a check for availability on Octorate Platform. The response is based on all the preference of the accommodation for the booking engine

Authorizations

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

accommodationstringRequired

productIdinteger · int64Required

Query parameters

startDatestring · dateOptional

endDatestring · dateOptional

Responses

200

Available to book

No content

406

Not available to book

get/rest/v1/calendar/{accommodation}/{productId}/availabilityCheck

GET /connect/rest/v1/calendar/{accommodation}/{productId}/availabilityCheck HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Deprecated

Retrieve calendar request

get

Deprecated: Use the endpoint of failures. Retrieve the calendar update request status by process Id.

Authorizations

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

idinteger · int64Required

Responses

default

default response

application/json

errorstring · nullableOptional

The error message in case of failed request.

Example: Error loading process info!

idinteger · int64Optional

The process id.

Example: 123456

createTimestring · date-timeOptional

The process creation time.

lastUpdatestring · date-timeOptional

The process last update time.

roominteger · int64Optional

The room id.

Example: 12345

dateFromstring · dateOptional

The first date to change in calendar (inclusive) in format yyyy-mm-dd.

dateTostring · dateOptional

The last date to change in calendar (inclusive) in format yyyy-mm-dd.

statusstring · enumOptional

The process status.

Possible values:

get/rest/v1/calendar/process/{id}

GET /connect/rest/v1/calendar/process/{id} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

default

default response

{
  "error": "Error loading process info!",
  "id": 123456,
  "createTime": "2026-01-01T00:00:00.000Z",
  "lastUpdate": "2026-01-01T00:00:00.000Z",
  "room": 12345,
  "dateFrom": "2026-01-01",
  "dateTo": "2026-01-01",
  "status": "NEW",
  "values": {
    "availability": 1,
    "price": 1,
    "minstay": 1,
    "maxstay": 1,
    "stopSells": true,
    "closeToArrival": true,
    "closeToDeparture": true,
    "cutOffDays": 1
  },
  "sent": [
    {
      "date": "2026-01-01",
      "status": "NOT_PROCESSED",
      "values": {
        "availability": 1,
        "price": 1,
        "minstay": 1,
        "maxstay": 1,
        "stopSells": true,
        "closeToArrival": true,
        "closeToDeparture": true,
        "cutOffDays": 1
      },
      "siteId": 123456
    }
  ]
}

get

Read the calendar data

Authorizations

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

accommodationstringRequired

Query parameters

product[]integer · int64[]Optional

Repeatable list of products to search

dateFromstring · dateOptional

The date where the search should be performed

Example: 2020-02-12

dateTostring · dateOptional

The end date of the search

Example: 2020-02-12

sizeinteger · int32 · max: 20Optional

Number of room rates (products) to load per page

Default: 5Example: 10

pageinteger · int32Optional

Page to retrieve

Responses

200

Processed

application/json

idinteger · int64Optional

namestringOptional

objectstringOptional

get/rest/v1/calendar/{accommodation}

GET /connect/rest/v1/calendar/{accommodation} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Processed

{
  "data": [
    {
      "id": 253166,
      "name": "Camera singola Derived",
      "days": [
        {
          "availability": 1,
          "bookable": true,
          "closeToArrival": false,
          "closeToDeparture": false,
          "cutOffDays": 0,
          "date": "2020-04-01",
          "maxStay": 99,
          "minStay": 2,
          "price": 39,
          "stopSells": false
        }
      ]
    }
  ]
}

PreviousProperty: Invoices

NextARI: Rooms & Rates

Last updated 10 months ago