ARI: Rooms & Rates
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
name of this room
Double roomThe id of this product
Number of maximum infants
(*Required only in main tipology) If true, this value means that this room/listing has to be considered as a dormitory room
True if this room is not refundable. Currently is going to be replaced by the rate plans for newer accounts
True if breakfast is included. Currently is going to be replaced by the rate plans for newer accounts
If true this product should be considered in statistics (occupancy,etc..)
If true this product should be visibile in our calendar
If true this product should be visibile in the generated website for the property
If true this product should be visibile in the generated booking engine (engine for reservations) for the property
If true this product should be visibile in the manual reservations when the property search for rooms
How many rooms are sellable? Keep care! This value might impact availability
1Number of available bathroom, the number of the bathrooms will be automatically calculated in the SubRooms
Number of available bedroom, the number of the bedrooms will be automatically calculated in the SubRooms
Number of available BEDS, the number of the beds will be automatically calculated in the SubRooms
Square meters of this room
23The issuer of the legal id (@see legal id)
State of New York, tourism officeLegal id if needed for this room/listing. It could be the region/country/other institution license
MC123FG1Minimum selling price if price is missing
100.23By activating this option, the system will triple the room price as soon as it appears without any availability on the Octorate calendar. The option is to avoid overbooking on portals where there is an allotment on the room in question.
falseThis option, as well as the CutOff days, aims to avoid last minute reservations: every day, at midnight, the system will put the rate in Stop Sale for a number of days corresponding to the value entered!
0This option, will remove the Stop Sell, for a date after X+1 every day! Zero for turn off
0Adults quantity
Guests number in dormitory mode
Children quantity
Police Room / Apartment code
With the iCal connection, Octorate is enabled to check the ics data in order to create correspondence: dates will be synchronized, so that all the dates mistakenly open will then be closed. Reservations and availabilities will then be synced.
Link a cancellation policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the cancel policy
32Link a payment policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the paymeny policy
12Email where octorate shall send notifications about this room
By activating this option, Octorate will triplicate the room price as soon as there will be 0 availability on the calendar. This feature is very useful to avoid overbooking if you manage OTAs that need allotment. Warning: if you get a cancellation, regular price needs to be set manually.
The room categorization
KINGPossible values: Indicate if this room is rms derived
id of the accommodation of this room
999999Rooms hidden by this room
[12345,67889]The iCal random name
TRUE if automatic price increase is enabled
The minimum price if automatic price increase is enabled
The maximum price if automatic price increase is enabled
TRUE if automatic price increase is by percentage
The increment step if automatic price increase is enabled
The preferred checkin clerk
123The preferred checkout clerk
456The preferred housekeeper clerk
789True to show the list of the subrooms in the BE
Processed
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
POST /connect/rest/v1/roomrates/{accommodation} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5123
{
"name": "Double room",
"headline": {
"EN": "Double Room"
},
"basicName": {
"EN": "These are the LanguageMap value in English!"
},
"labels": {
"EN": "These are the LanguageMap value in English!"
},
"infants": 1,
"dormitory": true,
"statistic": true,
"calendar": true,
"website": true,
"bookingEngine": true,
"manualReservations": true,
"quantity": 1,
"squareMetersSize": 23,
"legalIdIssuer": "State of New York, tourism office",
"legalId": "MC123FG1",
"minimumSellingPrice": 100.23,
"derivedRule": {
"parent": 1,
"availability": true,
"stay": true,
"restrictions": true,
"stopSell": true,
"price": "CALENDAR",
"priceValue": 1,
"priceRound": true,
"accommodationId": "text",
"referenceType": "GENERIC",
"id": 1,
"reservationId": 1,
"roomLog": 1,
"invoiceId": 1
},
"location": {
"address": "text",
"civicNumber": "text",
"city": "text",
"locality": "text",
"districtName": "text",
"country": "AF",
"latitude": 1,
"longitude": 1,
"zoom": 1,
"phone": "text",
"zipCode": "text",
"additionalInformation": "text",
"phone2": "text",
"phonePrefix": "text",
"firstLocality": "text"
},
"description": {
"EN": "Double Room is a nice room, book it now!"
},
"wifi": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"nearInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"guestInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"invoiceInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tripeThePrice": false,
"closeNextDays": 0,
"openNextDays": 0,
"adults": 1,
"guestsDormitory": 1,
"children": 1,
"policeCode": 1,
"ratePlans": [
{
"id": 1,
"internalLabel": "text",
"label": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"title": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"treatment": "ROOM_ONLY",
"accommodationId": "text",
"ratePlanDates": [
{
"id": 1,
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"ratePlanId": 1
}
],
"roomIds": [
1
],
"priceModel": "PERCENT",
"price": 1,
"showPrices": true,
"paymentPolicy": {
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"cancellationPolicy": {
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"extras": [
{
"id": 123,
"ratePlanId": 42,
"productId": 88,
"quantity": 2,
"price": 15,
"date": "2026-01-01",
"createTime": "2026-01-01T00:00:00.000Z",
"mandatory": true,
"applyOnFirstDay": false,
"accommodationId": "ROME1234"
}
],
"priority": 1,
"accommodationName": "text"
}
],
"amenities": [
{
"internalLabel": "text",
"id": 1,
"internalName": "text",
"label": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"aiEnabled": true,
"suggested": true,
"image": "text"
}
],
"icalUrls": [
"text"
],
"cancellationPolicyId": 32,
"paymentPolicyId": 12,
"notificationEmail": "text",
"tripleThePrice": true,
"roomCategory": "KING",
"rmsDerived": true,
"accommodationId": "999999",
"hideRooms": [
12345,
67889
],
"getiCalRandomName": "text",
"revenueActive": true,
"revenueMinPrice": 1,
"revenueMaxPrice": 1,
"revenueMaxIncrementPercent": true,
"revenueMaxIncrement": 1,
"preferredCheckinClerk": 123,
"preferredCheckoutClerk": 456,
"preferredHousekeeperClerk": 789,
"roomMaintenances": [
{
"id": 1,
"roomId": 1,
"createTime": "2026-01-01T00:00:00.000Z",
"title": "text",
"description": "text",
"startDate": "2026-01-01T00:00:00.000Z",
"frequency": "NONE",
"user": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"attachment": {
"id": 17,
"name": "image.jpg",
"type": "JPEG",
"url": "http://mysite.com/image.jpg",
"previewUrl": "http://mysite.com/thumb/image.jpg",
"content": "text",
"repository": "ROOM"
},
"sendDate": "2026-01-01T00:00:00.000Z"
}
],
"subRooms": [
{
"privateSpace": true,
"type": "BEDROOM",
"maxGuests": 1,
"roomNumber": 1,
"subRoomBeds": [
{
"quantity": 1,
"bedType": "KING"
}
],
"subRoomBathroom": {
"halfBathroom": true,
"privateSpace": true,
"type": "BEDROOM",
"bathtubPresent": true,
"showerPresent": true
}
}
],
"showSubroomDetail": true,
"roomAmenities": [
null
],
"activitiesInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"headlineLangMap": {
"EN": "These are the LanguageMap value in English!"
},
"descriptionLangMap": {
"EN": "These are the LanguageMap value in English!"
},
"checkinInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"data": [
{
"id": 207677,
"name": "TEST EXTRA",
"accommodation": {
"currency": "EUR",
"id": "112696",
"name": "La Pergola di Venezia",
"timeZone": "Europe/Rome"
},
"enabled": false,
"mandatory": false,
"refundable": false,
"basePrice": 0,
"description": {},
"model": "BOOKING",
"taxPercent": 0,
"title": {}
},
{
"id": 207678,
"name": "TEST EXTRA",
"accommodation": {
"currency": "EUR",
"id": "112696",
"name": "La Pergola di Venezia",
"timeZone": "Europe/Rome"
},
"enabled": false,
"mandatory": false,
"refundable": false,
"basePrice": 0,
"description": {},
"model": "BOOKING",
"taxPercent": 0,
"title": {}
}
]
}Aggregate rooms in order to create a suite: Let the availability be the same between many rooms. You could have for instance the Single App. + Single App.. that may be booked together in the Suite Appar.
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
The accommodation where you want to operate
The product you want to aggregate. Keep care: All derived rules existing on this room will be cleared. Number of sellable rooms for this product will be set to 1
Array of products to add to this suite. Keep care: They should be base rooms (in availability) and not a suite
Processed
name of this room
Double roomThe id of this product
Number of maximum infants
(*Required only in main tipology) If true, this value means that this room/listing has to be considered as a dormitory room
True if this room is not refundable. Currently is going to be replaced by the rate plans for newer accounts
True if breakfast is included. Currently is going to be replaced by the rate plans for newer accounts
If true this product should be considered in statistics (occupancy,etc..)
If true this product should be visibile in our calendar
If true this product should be visibile in the generated website for the property
If true this product should be visibile in the generated booking engine (engine for reservations) for the property
If true this product should be visibile in the manual reservations when the property search for rooms
How many rooms are sellable? Keep care! This value might impact availability
1Number of available bathroom, the number of the bathrooms will be automatically calculated in the SubRooms
Number of available bedroom, the number of the bedrooms will be automatically calculated in the SubRooms
Number of available BEDS, the number of the beds will be automatically calculated in the SubRooms
Square meters of this room
23The issuer of the legal id (@see legal id)
State of New York, tourism officeLegal id if needed for this room/listing. It could be the region/country/other institution license
MC123FG1Minimum selling price if price is missing
100.23By activating this option, the system will triple the room price as soon as it appears without any availability on the Octorate calendar. The option is to avoid overbooking on portals where there is an allotment on the room in question.
falseThis option, as well as the CutOff days, aims to avoid last minute reservations: every day, at midnight, the system will put the rate in Stop Sale for a number of days corresponding to the value entered!
0This option, will remove the Stop Sell, for a date after X+1 every day! Zero for turn off
0Adults quantity
Guests number in dormitory mode
Children quantity
Police Room / Apartment code
With the iCal connection, Octorate is enabled to check the ics data in order to create correspondence: dates will be synchronized, so that all the dates mistakenly open will then be closed. Reservations and availabilities will then be synced.
Link a cancellation policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the cancel policy
32Link a payment policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the paymeny policy
12Email where octorate shall send notifications about this room
By activating this option, Octorate will triplicate the room price as soon as there will be 0 availability on the calendar. This feature is very useful to avoid overbooking if you manage OTAs that need allotment. Warning: if you get a cancellation, regular price needs to be set manually.
The room categorization
KINGPossible values: Indicate if this room is rms derived
id of the accommodation of this room
999999Rooms hidden by this room
[12345,67889]The iCal random name
TRUE if automatic price increase is enabled
The minimum price if automatic price increase is enabled
The maximum price if automatic price increase is enabled
TRUE if automatic price increase is by percentage
The increment step if automatic price increase is enabled
The preferred checkin clerk
123The preferred checkout clerk
456The preferred housekeeper clerk
789True to show the list of the subrooms in the BE
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
POST /connect/rest/v1/roomrates/{accommodation}/{product}/suite HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"name": "Double room",
"id": 1,
"headline": {
"EN": "Double Room"
},
"basicName": {
"EN": "These are the LanguageMap value in English!"
},
"labels": {
"EN": "These are the LanguageMap value in English!"
},
"infants": 1,
"dormitory": true,
"statistic": true,
"calendar": true,
"website": true,
"bookingEngine": true,
"manualReservations": true,
"quantity": 1,
"squareMetersSize": 23,
"legalIdIssuer": "State of New York, tourism office",
"legalId": "MC123FG1",
"minimumSellingPrice": 100.23,
"derivedRule": {
"parent": 1,
"availability": true,
"stay": true,
"restrictions": true,
"stopSell": true,
"price": "CALENDAR",
"priceValue": 1,
"priceRound": true,
"accommodationId": "text",
"referenceType": "GENERIC",
"id": 1,
"reservationId": 1,
"roomLog": 1,
"invoiceId": 1
},
"location": {
"address": "text",
"civicNumber": "text",
"city": "text",
"locality": "text",
"districtName": "text",
"country": "AF",
"latitude": 1,
"longitude": 1,
"zoom": 1,
"phone": "text",
"zipCode": "text",
"additionalInformation": "text",
"phone2": "text",
"phonePrefix": "text",
"firstLocality": "text"
},
"description": {
"EN": "Double Room is a nice room, book it now!"
},
"wifi": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"nearInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"guestInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"invoiceInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tripeThePrice": false,
"closeNextDays": 0,
"openNextDays": 0,
"adults": 1,
"guestsDormitory": 1,
"children": 1,
"policeCode": 1,
"ratePlans": [
{
"id": 1,
"internalLabel": "text",
"label": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"title": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"treatment": "ROOM_ONLY",
"accommodationId": "text",
"ratePlanDates": [
{
"id": 1,
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"ratePlanId": 1
}
],
"roomIds": [
1
],
"priceModel": "PERCENT",
"price": 1,
"showPrices": true,
"paymentPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"cancellationPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"extras": [
{
"id": 123,
"ratePlanId": 42,
"productId": 88,
"quantity": 2,
"price": 15,
"date": "2026-01-01",
"createTime": "2026-01-01T00:00:00.000Z",
"mandatory": true,
"applyOnFirstDay": false,
"accommodationId": "ROME1234"
}
],
"priority": 1,
"accommodationName": "text"
}
],
"amenities": [
{
"internalLabel": "text",
"id": 1,
"internalName": "text",
"label": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"aiEnabled": true,
"suggested": true,
"image": "text"
}
],
"icalUrls": [
"text"
],
"cancellationPolicyId": 32,
"paymentPolicyId": 12,
"notificationEmail": "text",
"tripleThePrice": true,
"roomCategory": "KING",
"rmsDerived": true,
"accommodationId": "999999",
"hideRooms": [
12345,
67889
],
"getiCalRandomName": "text",
"revenueActive": true,
"revenueMinPrice": 1,
"revenueMaxPrice": 1,
"revenueMaxIncrementPercent": true,
"revenueMaxIncrement": 1,
"preferredCheckinClerk": 123,
"preferredCheckoutClerk": 456,
"preferredHousekeeperClerk": 789,
"roomMaintenances": [
{
"id": 1,
"roomId": 1,
"createTime": "2026-01-01T00:00:00.000Z",
"title": "text",
"description": "text",
"startDate": "2026-01-01T00:00:00.000Z",
"frequency": "NONE",
"user": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"attachment": {
"id": 17,
"name": "image.jpg",
"type": "JPEG",
"url": "http://mysite.com/image.jpg",
"previewUrl": "http://mysite.com/thumb/image.jpg",
"content": "text",
"sortOrder": 12,
"repository": "ROOM",
"error": "12"
},
"sendDate": "2026-01-01T00:00:00.000Z"
}
],
"subRooms": [
{
"id": 1,
"roomId": 1,
"privateSpace": true,
"type": "BEDROOM",
"maxGuests": 1,
"roomNumber": 1,
"subRoomBeds": [
{
"id": 1,
"subRoomId": 1,
"quantity": 1,
"bedType": "KING"
}
],
"subRoomBathroom": {
"id": 1,
"subRoomId": 1,
"halfBathroom": true,
"privateSpace": true,
"type": "BEDROOM",
"bathtubPresent": true,
"showerPresent": true
}
}
],
"showSubroomDetail": true,
"roomAmenities": [
{
"id": 1,
"roomId": 1,
"amenityId": 1,
"details": "text",
"title": "text"
}
],
"activitiesInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"checkinInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]Delete The provided image
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
Accommodation Id
Room or Rate Id
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
DELETE /connect/rest/v1/roomrates/{accommodation}/{productId}/image HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Delete The provided pms room image
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
Accommodation Id
Room or Rate Id
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
DELETE /connect/rest/v1/roomrates/{accommodation}/{productId}/pmsRoomImage/{pmsRoomImageId} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Delete a product (room or rate)
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
Accommodation Id
Room or Rate Id
Product successfully deleted
name of this room
Double roomThe id of this product
Number of maximum infants
(*Required only in main tipology) If true, this value means that this room/listing has to be considered as a dormitory room
True if this room is not refundable. Currently is going to be replaced by the rate plans for newer accounts
True if breakfast is included. Currently is going to be replaced by the rate plans for newer accounts
If true this product should be considered in statistics (occupancy,etc..)
If true this product should be visibile in our calendar
If true this product should be visibile in the generated website for the property
If true this product should be visibile in the generated booking engine (engine for reservations) for the property
If true this product should be visibile in the manual reservations when the property search for rooms
How many rooms are sellable? Keep care! This value might impact availability
1Number of available bathroom, the number of the bathrooms will be automatically calculated in the SubRooms
Number of available bedroom, the number of the bedrooms will be automatically calculated in the SubRooms
Number of available BEDS, the number of the beds will be automatically calculated in the SubRooms
Square meters of this room
23The issuer of the legal id (@see legal id)
State of New York, tourism officeLegal id if needed for this room/listing. It could be the region/country/other institution license
MC123FG1Minimum selling price if price is missing
100.23By activating this option, the system will triple the room price as soon as it appears without any availability on the Octorate calendar. The option is to avoid overbooking on portals where there is an allotment on the room in question.
falseThis option, as well as the CutOff days, aims to avoid last minute reservations: every day, at midnight, the system will put the rate in Stop Sale for a number of days corresponding to the value entered!
0This option, will remove the Stop Sell, for a date after X+1 every day! Zero for turn off
0Adults quantity
Guests number in dormitory mode
Children quantity
Police Room / Apartment code
With the iCal connection, Octorate is enabled to check the ics data in order to create correspondence: dates will be synchronized, so that all the dates mistakenly open will then be closed. Reservations and availabilities will then be synced.
Link a cancellation policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the cancel policy
32Link a payment policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the paymeny policy
12Email where octorate shall send notifications about this room
By activating this option, Octorate will triplicate the room price as soon as there will be 0 availability on the calendar. This feature is very useful to avoid overbooking if you manage OTAs that need allotment. Warning: if you get a cancellation, regular price needs to be set manually.
The room categorization
KINGPossible values: Indicate if this room is rms derived
id of the accommodation of this room
999999Rooms hidden by this room
[12345,67889]The iCal random name
TRUE if automatic price increase is enabled
The minimum price if automatic price increase is enabled
The maximum price if automatic price increase is enabled
TRUE if automatic price increase is by percentage
The increment step if automatic price increase is enabled
The preferred checkin clerk
123The preferred checkout clerk
456The preferred housekeeper clerk
789True to show the list of the subrooms in the BE
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
DELETE /connect/rest/v1/roomrates/{accommodation}/{productId} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"name": "Double room",
"id": 1,
"headline": {
"EN": "Double Room"
},
"basicName": {
"EN": "These are the LanguageMap value in English!"
},
"labels": {
"EN": "These are the LanguageMap value in English!"
},
"infants": 1,
"dormitory": true,
"statistic": true,
"calendar": true,
"website": true,
"bookingEngine": true,
"manualReservations": true,
"quantity": 1,
"squareMetersSize": 23,
"legalIdIssuer": "State of New York, tourism office",
"legalId": "MC123FG1",
"minimumSellingPrice": 100.23,
"derivedRule": {
"parent": 1,
"availability": true,
"stay": true,
"restrictions": true,
"stopSell": true,
"price": "CALENDAR",
"priceValue": 1,
"priceRound": true,
"accommodationId": "text",
"referenceType": "GENERIC",
"id": 1,
"reservationId": 1,
"roomLog": 1,
"invoiceId": 1
},
"location": {
"address": "text",
"civicNumber": "text",
"city": "text",
"locality": "text",
"districtName": "text",
"country": "AF",
"latitude": 1,
"longitude": 1,
"zoom": 1,
"phone": "text",
"zipCode": "text",
"additionalInformation": "text",
"phone2": "text",
"phonePrefix": "text",
"firstLocality": "text"
},
"description": {
"EN": "Double Room is a nice room, book it now!"
},
"wifi": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"nearInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"guestInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"invoiceInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tripeThePrice": false,
"closeNextDays": 0,
"openNextDays": 0,
"adults": 1,
"guestsDormitory": 1,
"children": 1,
"policeCode": 1,
"ratePlans": [
{
"id": 1,
"internalLabel": "text",
"label": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"title": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"treatment": "ROOM_ONLY",
"accommodationId": "text",
"ratePlanDates": [
{
"id": 1,
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"ratePlanId": 1
}
],
"roomIds": [
1
],
"priceModel": "PERCENT",
"price": 1,
"showPrices": true,
"paymentPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"cancellationPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"extras": [
{
"id": 123,
"ratePlanId": 42,
"productId": 88,
"quantity": 2,
"price": 15,
"date": "2026-01-01",
"createTime": "2026-01-01T00:00:00.000Z",
"mandatory": true,
"applyOnFirstDay": false,
"accommodationId": "ROME1234"
}
],
"priority": 1,
"accommodationName": "text"
}
],
"amenities": [
{
"internalLabel": "text",
"id": 1,
"internalName": "text",
"label": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"aiEnabled": true,
"suggested": true,
"image": "text"
}
],
"icalUrls": [
"text"
],
"cancellationPolicyId": 32,
"paymentPolicyId": 12,
"notificationEmail": "text",
"tripleThePrice": true,
"roomCategory": "KING",
"rmsDerived": true,
"accommodationId": "999999",
"hideRooms": [
12345,
67889
],
"getiCalRandomName": "text",
"revenueActive": true,
"revenueMinPrice": 1,
"revenueMaxPrice": 1,
"revenueMaxIncrementPercent": true,
"revenueMaxIncrement": 1,
"preferredCheckinClerk": 123,
"preferredCheckoutClerk": 456,
"preferredHousekeeperClerk": 789,
"roomMaintenances": [
{
"id": 1,
"roomId": 1,
"createTime": "2026-01-01T00:00:00.000Z",
"title": "text",
"description": "text",
"startDate": "2026-01-01T00:00:00.000Z",
"frequency": "NONE",
"user": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"attachment": {
"id": 17,
"name": "image.jpg",
"type": "JPEG",
"url": "http://mysite.com/image.jpg",
"previewUrl": "http://mysite.com/thumb/image.jpg",
"content": "text",
"sortOrder": 12,
"repository": "ROOM",
"error": "12"
},
"sendDate": "2026-01-01T00:00:00.000Z"
}
],
"subRooms": [
{
"id": 1,
"roomId": 1,
"privateSpace": true,
"type": "BEDROOM",
"maxGuests": 1,
"roomNumber": 1,
"subRoomBeds": [
{
"id": 1,
"subRoomId": 1,
"quantity": 1,
"bedType": "KING"
}
],
"subRoomBathroom": {
"id": 1,
"subRoomId": 1,
"halfBathroom": true,
"privateSpace": true,
"type": "BEDROOM",
"bathtubPresent": true,
"showerPresent": true
}
}
],
"showSubroomDetail": true,
"roomAmenities": [
{
"id": 1,
"roomId": 1,
"amenityId": 1,
"details": "text",
"title": "text"
}
],
"activitiesInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"checkinInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Delete The provided image
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
Accommodation Id
Room or Rate Id
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
DELETE /connect/rest/v1/roomrates/{accommodation}/{productId}/image/{imageId} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
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
Processed
name of this room
Double roomThe id of this product
Number of maximum infants
(*Required only in main tipology) If true, this value means that this room/listing has to be considered as a dormitory room
True if this room is not refundable. Currently is going to be replaced by the rate plans for newer accounts
True if breakfast is included. Currently is going to be replaced by the rate plans for newer accounts
If true this product should be considered in statistics (occupancy,etc..)
If true this product should be visibile in our calendar
If true this product should be visibile in the generated website for the property
If true this product should be visibile in the generated booking engine (engine for reservations) for the property
If true this product should be visibile in the manual reservations when the property search for rooms
How many rooms are sellable? Keep care! This value might impact availability
1Number of available bathroom, the number of the bathrooms will be automatically calculated in the SubRooms
Number of available bedroom, the number of the bedrooms will be automatically calculated in the SubRooms
Number of available BEDS, the number of the beds will be automatically calculated in the SubRooms
Square meters of this room
23The issuer of the legal id (@see legal id)
State of New York, tourism officeLegal id if needed for this room/listing. It could be the region/country/other institution license
MC123FG1Minimum selling price if price is missing
100.23By activating this option, the system will triple the room price as soon as it appears without any availability on the Octorate calendar. The option is to avoid overbooking on portals where there is an allotment on the room in question.
falseThis option, as well as the CutOff days, aims to avoid last minute reservations: every day, at midnight, the system will put the rate in Stop Sale for a number of days corresponding to the value entered!
0This option, will remove the Stop Sell, for a date after X+1 every day! Zero for turn off
0Adults quantity
Guests number in dormitory mode
Children quantity
Police Room / Apartment code
With the iCal connection, Octorate is enabled to check the ics data in order to create correspondence: dates will be synchronized, so that all the dates mistakenly open will then be closed. Reservations and availabilities will then be synced.
Link a cancellation policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the cancel policy
32Link a payment policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the paymeny policy
12Email where octorate shall send notifications about this room
By activating this option, Octorate will triplicate the room price as soon as there will be 0 availability on the calendar. This feature is very useful to avoid overbooking if you manage OTAs that need allotment. Warning: if you get a cancellation, regular price needs to be set manually.
The room categorization
KINGPossible values: Indicate if this room is rms derived
id of the accommodation of this room
999999Rooms hidden by this room
[12345,67889]The iCal random name
TRUE if automatic price increase is enabled
The minimum price if automatic price increase is enabled
The maximum price if automatic price increase is enabled
TRUE if automatic price increase is by percentage
The increment step if automatic price increase is enabled
The preferred checkin clerk
123The preferred checkout clerk
456The preferred housekeeper clerk
789True to show the list of the subrooms in the BE
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
GET /connect/rest/v1/roomrates/{accommodation}/{roomid} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"name": "Double room",
"id": 1,
"headline": {
"EN": "Double Room"
},
"basicName": {
"EN": "These are the LanguageMap value in English!"
},
"labels": {
"EN": "These are the LanguageMap value in English!"
},
"infants": 1,
"dormitory": true,
"statistic": true,
"calendar": true,
"website": true,
"bookingEngine": true,
"manualReservations": true,
"quantity": 1,
"squareMetersSize": 23,
"legalIdIssuer": "State of New York, tourism office",
"legalId": "MC123FG1",
"minimumSellingPrice": 100.23,
"derivedRule": {
"parent": 1,
"availability": true,
"stay": true,
"restrictions": true,
"stopSell": true,
"price": "CALENDAR",
"priceValue": 1,
"priceRound": true,
"accommodationId": "text",
"referenceType": "GENERIC",
"id": 1,
"reservationId": 1,
"roomLog": 1,
"invoiceId": 1
},
"location": {
"address": "text",
"civicNumber": "text",
"city": "text",
"locality": "text",
"districtName": "text",
"country": "AF",
"latitude": 1,
"longitude": 1,
"zoom": 1,
"phone": "text",
"zipCode": "text",
"additionalInformation": "text",
"phone2": "text",
"phonePrefix": "text",
"firstLocality": "text"
},
"description": {
"EN": "Double Room is a nice room, book it now!"
},
"wifi": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"nearInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"guestInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"invoiceInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tripeThePrice": false,
"closeNextDays": 0,
"openNextDays": 0,
"adults": 1,
"guestsDormitory": 1,
"children": 1,
"policeCode": 1,
"ratePlans": [
{
"id": 1,
"internalLabel": "text",
"label": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"title": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"treatment": "ROOM_ONLY",
"accommodationId": "text",
"ratePlanDates": [
{
"id": 1,
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"ratePlanId": 1
}
],
"roomIds": [
1
],
"priceModel": "PERCENT",
"price": 1,
"showPrices": true,
"paymentPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"cancellationPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"extras": [
{
"id": 123,
"ratePlanId": 42,
"productId": 88,
"quantity": 2,
"price": 15,
"date": "2026-01-01",
"createTime": "2026-01-01T00:00:00.000Z",
"mandatory": true,
"applyOnFirstDay": false,
"accommodationId": "ROME1234"
}
],
"priority": 1,
"accommodationName": "text"
}
],
"amenities": [
{
"internalLabel": "text",
"id": 1,
"internalName": "text",
"label": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"aiEnabled": true,
"suggested": true,
"image": "text"
}
],
"icalUrls": [
"text"
],
"cancellationPolicyId": 32,
"paymentPolicyId": 12,
"notificationEmail": "text",
"tripleThePrice": true,
"roomCategory": "KING",
"rmsDerived": true,
"accommodationId": "999999",
"hideRooms": [
12345,
67889
],
"getiCalRandomName": "text",
"revenueActive": true,
"revenueMinPrice": 1,
"revenueMaxPrice": 1,
"revenueMaxIncrementPercent": true,
"revenueMaxIncrement": 1,
"preferredCheckinClerk": 123,
"preferredCheckoutClerk": 456,
"preferredHousekeeperClerk": 789,
"roomMaintenances": [
{
"id": 1,
"roomId": 1,
"createTime": "2026-01-01T00:00:00.000Z",
"title": "text",
"description": "text",
"startDate": "2026-01-01T00:00:00.000Z",
"frequency": "NONE",
"user": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"attachment": {
"id": 17,
"name": "image.jpg",
"type": "JPEG",
"url": "http://mysite.com/image.jpg",
"previewUrl": "http://mysite.com/thumb/image.jpg",
"content": "text",
"sortOrder": 12,
"repository": "ROOM",
"error": "12"
},
"sendDate": "2026-01-01T00:00:00.000Z"
}
],
"subRooms": [
{
"id": 1,
"roomId": 1,
"privateSpace": true,
"type": "BEDROOM",
"maxGuests": 1,
"roomNumber": 1,
"subRoomBeds": [
{
"id": 1,
"subRoomId": 1,
"quantity": 1,
"bedType": "KING"
}
],
"subRoomBathroom": {
"id": 1,
"subRoomId": 1,
"halfBathroom": true,
"privateSpace": true,
"type": "BEDROOM",
"bathtubPresent": true,
"showerPresent": true
}
}
],
"showSubroomDetail": true,
"roomAmenities": [
{
"id": 1,
"roomId": 1,
"amenityId": 1,
"details": "text",
"title": "text"
}
],
"activitiesInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"checkinInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Translate the missing descriptions of the room reading from the provided language
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
Processed
name of this room
Double roomThe id of this product
Number of maximum infants
(*Required only in main tipology) If true, this value means that this room/listing has to be considered as a dormitory room
True if this room is not refundable. Currently is going to be replaced by the rate plans for newer accounts
True if breakfast is included. Currently is going to be replaced by the rate plans for newer accounts
If true this product should be considered in statistics (occupancy,etc..)
If true this product should be visibile in our calendar
If true this product should be visibile in the generated website for the property
If true this product should be visibile in the generated booking engine (engine for reservations) for the property
If true this product should be visibile in the manual reservations when the property search for rooms
How many rooms are sellable? Keep care! This value might impact availability
1Number of available bathroom, the number of the bathrooms will be automatically calculated in the SubRooms
Number of available bedroom, the number of the bedrooms will be automatically calculated in the SubRooms
Number of available BEDS, the number of the beds will be automatically calculated in the SubRooms
Square meters of this room
23The issuer of the legal id (@see legal id)
State of New York, tourism officeLegal id if needed for this room/listing. It could be the region/country/other institution license
MC123FG1Minimum selling price if price is missing
100.23By activating this option, the system will triple the room price as soon as it appears without any availability on the Octorate calendar. The option is to avoid overbooking on portals where there is an allotment on the room in question.
falseThis option, as well as the CutOff days, aims to avoid last minute reservations: every day, at midnight, the system will put the rate in Stop Sale for a number of days corresponding to the value entered!
0This option, will remove the Stop Sell, for a date after X+1 every day! Zero for turn off
0Adults quantity
Guests number in dormitory mode
Children quantity
Police Room / Apartment code
With the iCal connection, Octorate is enabled to check the ics data in order to create correspondence: dates will be synchronized, so that all the dates mistakenly open will then be closed. Reservations and availabilities will then be synced.
Link a cancellation policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the cancel policy
32Link a payment policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the paymeny policy
12Email where octorate shall send notifications about this room
By activating this option, Octorate will triplicate the room price as soon as there will be 0 availability on the calendar. This feature is very useful to avoid overbooking if you manage OTAs that need allotment. Warning: if you get a cancellation, regular price needs to be set manually.
The room categorization
KINGPossible values: Indicate if this room is rms derived
id of the accommodation of this room
999999Rooms hidden by this room
[12345,67889]The iCal random name
TRUE if automatic price increase is enabled
The minimum price if automatic price increase is enabled
The maximum price if automatic price increase is enabled
TRUE if automatic price increase is by percentage
The increment step if automatic price increase is enabled
The preferred checkin clerk
123The preferred checkout clerk
456The preferred housekeeper clerk
789True to show the list of the subrooms in the BE
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
PATCH /connect/rest/v1/roomrates/{accommodation}/{roomid}/translateMissingDescriptions/{language} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"{
"name": "Double room",
"id": 1,
"headline": {
"EN": "Double Room"
},
"basicName": {
"EN": "These are the LanguageMap value in English!"
},
"labels": {
"EN": "These are the LanguageMap value in English!"
},
"infants": 1,
"dormitory": true,
"statistic": true,
"calendar": true,
"website": true,
"bookingEngine": true,
"manualReservations": true,
"quantity": 1,
"squareMetersSize": 23,
"legalIdIssuer": "State of New York, tourism office",
"legalId": "MC123FG1",
"minimumSellingPrice": 100.23,
"derivedRule": {
"parent": 1,
"availability": true,
"stay": true,
"restrictions": true,
"stopSell": true,
"price": "CALENDAR",
"priceValue": 1,
"priceRound": true,
"accommodationId": "text",
"referenceType": "GENERIC",
"id": 1,
"reservationId": 1,
"roomLog": 1,
"invoiceId": 1
},
"location": {
"address": "text",
"civicNumber": "text",
"city": "text",
"locality": "text",
"districtName": "text",
"country": "AF",
"latitude": 1,
"longitude": 1,
"zoom": 1,
"phone": "text",
"zipCode": "text",
"additionalInformation": "text",
"phone2": "text",
"phonePrefix": "text",
"firstLocality": "text"
},
"description": {
"EN": "Double Room is a nice room, book it now!"
},
"wifi": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"nearInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"guestInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"invoiceInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tripeThePrice": false,
"closeNextDays": 0,
"openNextDays": 0,
"adults": 1,
"guestsDormitory": 1,
"children": 1,
"policeCode": 1,
"ratePlans": [
{
"id": 1,
"internalLabel": "text",
"label": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"title": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"treatment": "ROOM_ONLY",
"accommodationId": "text",
"ratePlanDates": [
{
"id": 1,
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"ratePlanId": 1
}
],
"roomIds": [
1
],
"priceModel": "PERCENT",
"price": 1,
"showPrices": true,
"paymentPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"cancellationPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"extras": [
{
"id": 123,
"ratePlanId": 42,
"productId": 88,
"quantity": 2,
"price": 15,
"date": "2026-01-01",
"createTime": "2026-01-01T00:00:00.000Z",
"mandatory": true,
"applyOnFirstDay": false,
"accommodationId": "ROME1234"
}
],
"priority": 1,
"accommodationName": "text"
}
],
"amenities": [
{
"internalLabel": "text",
"id": 1,
"internalName": "text",
"label": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"aiEnabled": true,
"suggested": true,
"image": "text"
}
],
"icalUrls": [
"text"
],
"cancellationPolicyId": 32,
"paymentPolicyId": 12,
"notificationEmail": "text",
"tripleThePrice": true,
"roomCategory": "KING",
"rmsDerived": true,
"accommodationId": "999999",
"hideRooms": [
12345,
67889
],
"getiCalRandomName": "text",
"revenueActive": true,
"revenueMinPrice": 1,
"revenueMaxPrice": 1,
"revenueMaxIncrementPercent": true,
"revenueMaxIncrement": 1,
"preferredCheckinClerk": 123,
"preferredCheckoutClerk": 456,
"preferredHousekeeperClerk": 789,
"roomMaintenances": [
{
"id": 1,
"roomId": 1,
"createTime": "2026-01-01T00:00:00.000Z",
"title": "text",
"description": "text",
"startDate": "2026-01-01T00:00:00.000Z",
"frequency": "NONE",
"user": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"attachment": {
"id": 17,
"name": "image.jpg",
"type": "JPEG",
"url": "http://mysite.com/image.jpg",
"previewUrl": "http://mysite.com/thumb/image.jpg",
"content": "text",
"sortOrder": 12,
"repository": "ROOM",
"error": "12"
},
"sendDate": "2026-01-01T00:00:00.000Z"
}
],
"subRooms": [
{
"id": 1,
"roomId": 1,
"privateSpace": true,
"type": "BEDROOM",
"maxGuests": 1,
"roomNumber": 1,
"subRoomBeds": [
{
"id": 1,
"subRoomId": 1,
"quantity": 1,
"bedType": "KING"
}
],
"subRoomBathroom": {
"id": 1,
"subRoomId": 1,
"halfBathroom": true,
"privateSpace": true,
"type": "BEDROOM",
"bathtubPresent": true,
"showerPresent": true
}
}
],
"showSubroomDetail": true,
"roomAmenities": [
{
"id": 1,
"roomId": 1,
"amenityId": 1,
"details": "text",
"title": "text"
}
],
"activitiesInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"checkinInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}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
Product Form Processed
name of this room
Double roomThe id of this product
Number of maximum infants
(*Required only in main tipology) If true, this value means that this room/listing has to be considered as a dormitory room
True if this room is not refundable. Currently is going to be replaced by the rate plans for newer accounts
True if breakfast is included. Currently is going to be replaced by the rate plans for newer accounts
If true this product should be considered in statistics (occupancy,etc..)
If true this product should be visibile in our calendar
If true this product should be visibile in the generated website for the property
If true this product should be visibile in the generated booking engine (engine for reservations) for the property
If true this product should be visibile in the manual reservations when the property search for rooms
How many rooms are sellable? Keep care! This value might impact availability
1Number of available bathroom, the number of the bathrooms will be automatically calculated in the SubRooms
Number of available bedroom, the number of the bedrooms will be automatically calculated in the SubRooms
Number of available BEDS, the number of the beds will be automatically calculated in the SubRooms
Square meters of this room
23The issuer of the legal id (@see legal id)
State of New York, tourism officeLegal id if needed for this room/listing. It could be the region/country/other institution license
MC123FG1Minimum selling price if price is missing
100.23By activating this option, the system will triple the room price as soon as it appears without any availability on the Octorate calendar. The option is to avoid overbooking on portals where there is an allotment on the room in question.
falseThis option, as well as the CutOff days, aims to avoid last minute reservations: every day, at midnight, the system will put the rate in Stop Sale for a number of days corresponding to the value entered!
0This option, will remove the Stop Sell, for a date after X+1 every day! Zero for turn off
0Adults quantity
Guests number in dormitory mode
Children quantity
Police Room / Apartment code
With the iCal connection, Octorate is enabled to check the ics data in order to create correspondence: dates will be synchronized, so that all the dates mistakenly open will then be closed. Reservations and availabilities will then be synced.
Link a cancellation policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the cancel policy
32Link a payment policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the paymeny policy
12Email where octorate shall send notifications about this room
By activating this option, Octorate will triplicate the room price as soon as there will be 0 availability on the calendar. This feature is very useful to avoid overbooking if you manage OTAs that need allotment. Warning: if you get a cancellation, regular price needs to be set manually.
The room categorization
KINGPossible values: Indicate if this room is rms derived
id of the accommodation of this room
999999Rooms hidden by this room
[12345,67889]The iCal random name
TRUE if automatic price increase is enabled
The minimum price if automatic price increase is enabled
The maximum price if automatic price increase is enabled
TRUE if automatic price increase is by percentage
The increment step if automatic price increase is enabled
The preferred checkin clerk
123The preferred checkout clerk
456The preferred housekeeper clerk
789True to show the list of the subrooms in the BE
Not Modified (empty response): The content you've present excluding required fields doesn't change anything inside Octorate.
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
PATCH /connect/rest/v1/roomrates/{accommodation}/{id} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"{
"adults": 5
}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
The rooms to move, copy or run rules
The destination accommodation. Empty if new structure
The new accommodation name
Operation completed successfully
No content
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
POST /connect/rest/v2/roomrates/{accommodation}/copy HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 373
{
"roomIds": [
1
],
"destinationAccommodationId": "text",
"newAccommodationName": "text",
"newAccommodationPlace": {
"address": "text",
"civicNumber": "text",
"city": "text",
"locality": "text",
"districtName": "text",
"country": "AF",
"latitude": 1,
"longitude": 1,
"zoom": 1,
"phone": "text",
"zipCode": "text",
"additionalInformation": "text",
"phone2": "text",
"phonePrefix": "text",
"firstLocality": "text"
}
}No content
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
Only if you need, you can filter by one or many specific ID, setting up multiple times the param ids[]
Processed
name of this room
Double roomThe id of this product
Number of maximum infants
(*Required only in main tipology) If true, this value means that this room/listing has to be considered as a dormitory room
True if this room is not refundable. Currently is going to be replaced by the rate plans for newer accounts
True if breakfast is included. Currently is going to be replaced by the rate plans for newer accounts
If true this product should be considered in statistics (occupancy,etc..)
If true this product should be visibile in our calendar
If true this product should be visibile in the generated website for the property
If true this product should be visibile in the generated booking engine (engine for reservations) for the property
If true this product should be visibile in the manual reservations when the property search for rooms
How many rooms are sellable? Keep care! This value might impact availability
1Number of available bathroom, the number of the bathrooms will be automatically calculated in the SubRooms
Number of available bedroom, the number of the bedrooms will be automatically calculated in the SubRooms
Number of available BEDS, the number of the beds will be automatically calculated in the SubRooms
Square meters of this room
23The issuer of the legal id (@see legal id)
State of New York, tourism officeLegal id if needed for this room/listing. It could be the region/country/other institution license
MC123FG1Minimum selling price if price is missing
100.23By activating this option, the system will triple the room price as soon as it appears without any availability on the Octorate calendar. The option is to avoid overbooking on portals where there is an allotment on the room in question.
falseThis option, as well as the CutOff days, aims to avoid last minute reservations: every day, at midnight, the system will put the rate in Stop Sale for a number of days corresponding to the value entered!
0This option, will remove the Stop Sell, for a date after X+1 every day! Zero for turn off
0Adults quantity
Guests number in dormitory mode
Children quantity
Police Room / Apartment code
With the iCal connection, Octorate is enabled to check the ics data in order to create correspondence: dates will be synchronized, so that all the dates mistakenly open will then be closed. Reservations and availabilities will then be synced.
Link a cancellation policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the cancel policy
32Link a payment policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the paymeny policy
12Email where octorate shall send notifications about this room
By activating this option, Octorate will triplicate the room price as soon as there will be 0 availability on the calendar. This feature is very useful to avoid overbooking if you manage OTAs that need allotment. Warning: if you get a cancellation, regular price needs to be set manually.
The room categorization
KINGPossible values: Indicate if this room is rms derived
id of the accommodation of this room
999999Rooms hidden by this room
[12345,67889]The iCal random name
TRUE if automatic price increase is enabled
The minimum price if automatic price increase is enabled
The maximum price if automatic price increase is enabled
TRUE if automatic price increase is by percentage
The increment step if automatic price increase is enabled
The preferred checkin clerk
123The preferred checkout clerk
456The preferred housekeeper clerk
789True to show the list of the subrooms in the BE
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
GET /connect/rest/v2/roomrates/{accommodation}/connections HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"name": "Double room",
"id": 1,
"headline": {
"EN": "Double Room"
},
"basicName": {
"EN": "These are the LanguageMap value in English!"
},
"labels": {
"EN": "These are the LanguageMap value in English!"
},
"infants": 1,
"dormitory": true,
"statistic": true,
"calendar": true,
"website": true,
"bookingEngine": true,
"manualReservations": true,
"quantity": 1,
"squareMetersSize": 23,
"legalIdIssuer": "State of New York, tourism office",
"legalId": "MC123FG1",
"minimumSellingPrice": 100.23,
"derivedRule": {
"parent": 1,
"availability": true,
"stay": true,
"restrictions": true,
"stopSell": true,
"price": "CALENDAR",
"priceValue": 1,
"priceRound": true,
"accommodationId": "text",
"referenceType": "GENERIC",
"id": 1,
"reservationId": 1,
"roomLog": 1,
"invoiceId": 1
},
"location": {
"address": "text",
"civicNumber": "text",
"city": "text",
"locality": "text",
"districtName": "text",
"country": "AF",
"latitude": 1,
"longitude": 1,
"zoom": 1,
"phone": "text",
"zipCode": "text",
"additionalInformation": "text",
"phone2": "text",
"phonePrefix": "text",
"firstLocality": "text"
},
"description": {
"EN": "Double Room is a nice room, book it now!"
},
"wifi": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"nearInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"guestInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"invoiceInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tripeThePrice": false,
"closeNextDays": 0,
"openNextDays": 0,
"adults": 1,
"guestsDormitory": 1,
"children": 1,
"policeCode": 1,
"ratePlans": [
{
"id": 1,
"internalLabel": "text",
"label": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"title": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"treatment": "ROOM_ONLY",
"accommodationId": "text",
"ratePlanDates": [
{
"id": 1,
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"ratePlanId": 1
}
],
"roomIds": [
1
],
"priceModel": "PERCENT",
"price": 1,
"showPrices": true,
"paymentPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"cancellationPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"extras": [
{
"id": 123,
"ratePlanId": 42,
"productId": 88,
"quantity": 2,
"price": 15,
"date": "2026-01-01",
"createTime": "2026-01-01T00:00:00.000Z",
"mandatory": true,
"applyOnFirstDay": false,
"accommodationId": "ROME1234"
}
],
"priority": 1,
"accommodationName": "text"
}
],
"amenities": [
{
"internalLabel": "text",
"id": 1,
"internalName": "text",
"label": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"aiEnabled": true,
"suggested": true,
"image": "text"
}
],
"icalUrls": [
"text"
],
"cancellationPolicyId": 32,
"paymentPolicyId": 12,
"notificationEmail": "text",
"tripleThePrice": true,
"roomCategory": "KING",
"rmsDerived": true,
"accommodationId": "999999",
"hideRooms": [
12345,
67889
],
"getiCalRandomName": "text",
"revenueActive": true,
"revenueMinPrice": 1,
"revenueMaxPrice": 1,
"revenueMaxIncrementPercent": true,
"revenueMaxIncrement": 1,
"preferredCheckinClerk": 123,
"preferredCheckoutClerk": 456,
"preferredHousekeeperClerk": 789,
"roomMaintenances": [
{
"id": 1,
"roomId": 1,
"createTime": "2026-01-01T00:00:00.000Z",
"title": "text",
"description": "text",
"startDate": "2026-01-01T00:00:00.000Z",
"frequency": "NONE",
"user": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"attachment": {
"id": 17,
"name": "image.jpg",
"type": "JPEG",
"url": "http://mysite.com/image.jpg",
"previewUrl": "http://mysite.com/thumb/image.jpg",
"content": "text",
"sortOrder": 12,
"repository": "ROOM",
"error": "12"
},
"sendDate": "2026-01-01T00:00:00.000Z"
}
],
"subRooms": [
{
"id": 1,
"roomId": 1,
"privateSpace": true,
"type": "BEDROOM",
"maxGuests": 1,
"roomNumber": 1,
"subRoomBeds": [
{
"id": 1,
"subRoomId": 1,
"quantity": 1,
"bedType": "KING"
}
],
"subRoomBathroom": {
"id": 1,
"subRoomId": 1,
"halfBathroom": true,
"privateSpace": true,
"type": "BEDROOM",
"bathtubPresent": true,
"showerPresent": true
}
}
],
"showSubroomDetail": true,
"roomAmenities": [
{
"id": 1,
"roomId": 1,
"amenityId": 1,
"details": "text",
"title": "text"
}
],
"activitiesInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"checkinInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]Through this call you can retrieve all the Inventory of Octorate platform. Please take note, we consider both typology or rate as products. We don't yet allow to separate them and mixing after. We define the relationship between these products using the field derivedRule where you can setup the relationship between the current object and the parent (i.e. +5 eur, follow avail,etc..) We strongly suggest you to have also a look to the backoffice of the user to understand better how this products are linked. New accommodation or new product for an apartment? All depends on where the linked services should be located. I.e. we support sending statistical data and sending information to the police setting up only one credential for accommodation. If you're sure that all the products belongs to the same configuration you can set up them inside the same property (An example might be defining the building, with always the same external credentials, and inside the single apartment as products) Migrating from V1? We've changed the amenity model to introduce some more details, We've also introduced the read-only field 'images' to speed up your development
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
List of fields to filter in the response. Can be usefull to save bandwith and get quicker response from this server. Values are separated by comma, only applies to the first level, like this: 'id, name'
id,nameOnly if you need, you can filter by one or many specific ID, setting up multiple times the param ids[]
Processed
name of this room
Double roomThe id of this product
Number of maximum infants
(*Required only in main tipology) If true, this value means that this room/listing has to be considered as a dormitory room
True if this room is not refundable. Currently is going to be replaced by the rate plans for newer accounts
True if breakfast is included. Currently is going to be replaced by the rate plans for newer accounts
If true this product should be considered in statistics (occupancy,etc..)
If true this product should be visibile in our calendar
If true this product should be visibile in the generated website for the property
If true this product should be visibile in the generated booking engine (engine for reservations) for the property
If true this product should be visibile in the manual reservations when the property search for rooms
How many rooms are sellable? Keep care! This value might impact availability
1Number of available bathroom, the number of the bathrooms will be automatically calculated in the SubRooms
Number of available bedroom, the number of the bedrooms will be automatically calculated in the SubRooms
Number of available BEDS, the number of the beds will be automatically calculated in the SubRooms
Square meters of this room
23The issuer of the legal id (@see legal id)
State of New York, tourism officeLegal id if needed for this room/listing. It could be the region/country/other institution license
MC123FG1Minimum selling price if price is missing
100.23By activating this option, the system will triple the room price as soon as it appears without any availability on the Octorate calendar. The option is to avoid overbooking on portals where there is an allotment on the room in question.
falseThis option, as well as the CutOff days, aims to avoid last minute reservations: every day, at midnight, the system will put the rate in Stop Sale for a number of days corresponding to the value entered!
0This option, will remove the Stop Sell, for a date after X+1 every day! Zero for turn off
0Adults quantity
Guests number in dormitory mode
Children quantity
Police Room / Apartment code
With the iCal connection, Octorate is enabled to check the ics data in order to create correspondence: dates will be synchronized, so that all the dates mistakenly open will then be closed. Reservations and availabilities will then be synced.
Link a cancellation policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the cancel policy
32Link a payment policy. It can be used only with the old system where as we do not support rate plans. In case of rateplans, directly link the rate plan with the paymeny policy
12Email where octorate shall send notifications about this room
By activating this option, Octorate will triplicate the room price as soon as there will be 0 availability on the calendar. This feature is very useful to avoid overbooking if you manage OTAs that need allotment. Warning: if you get a cancellation, regular price needs to be set manually.
The room categorization
KINGPossible values: Indicate if this room is rms derived
id of the accommodation of this room
999999Rooms hidden by this room
[12345,67889]The iCal random name
TRUE if automatic price increase is enabled
The minimum price if automatic price increase is enabled
The maximum price if automatic price increase is enabled
TRUE if automatic price increase is by percentage
The increment step if automatic price increase is enabled
The preferred checkin clerk
123The preferred checkout clerk
456The preferred housekeeper clerk
789True to show the list of the subrooms in the BE
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
GET /connect/rest/v2/roomrates/{accommodation} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"name": "Double room",
"id": 1,
"headline": {
"EN": "Double Room"
},
"basicName": {
"EN": "These are the LanguageMap value in English!"
},
"labels": {
"EN": "These are the LanguageMap value in English!"
},
"infants": 1,
"dormitory": true,
"statistic": true,
"calendar": true,
"website": true,
"bookingEngine": true,
"manualReservations": true,
"quantity": 1,
"squareMetersSize": 23,
"legalIdIssuer": "State of New York, tourism office",
"legalId": "MC123FG1",
"minimumSellingPrice": 100.23,
"derivedRule": {
"parent": 1,
"availability": true,
"stay": true,
"restrictions": true,
"stopSell": true,
"price": "CALENDAR",
"priceValue": 1,
"priceRound": true,
"accommodationId": "text",
"referenceType": "GENERIC",
"id": 1,
"reservationId": 1,
"roomLog": 1,
"invoiceId": 1
},
"location": {
"address": "text",
"civicNumber": "text",
"city": "text",
"locality": "text",
"districtName": "text",
"country": "AF",
"latitude": 1,
"longitude": 1,
"zoom": 1,
"phone": "text",
"zipCode": "text",
"additionalInformation": "text",
"phone2": "text",
"phonePrefix": "text",
"firstLocality": "text"
},
"description": {
"EN": "Double Room is a nice room, book it now!"
},
"wifi": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"nearInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"guestInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"invoiceInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tripeThePrice": false,
"closeNextDays": 0,
"openNextDays": 0,
"adults": 1,
"guestsDormitory": 1,
"children": 1,
"policeCode": 1,
"ratePlans": [
{
"id": 1,
"internalLabel": "text",
"label": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"title": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"treatment": "ROOM_ONLY",
"accommodationId": "text",
"ratePlanDates": [
{
"id": 1,
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"ratePlanId": 1
}
],
"roomIds": [
1
],
"priceModel": "PERCENT",
"price": 1,
"showPrices": true,
"paymentPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"cancellationPolicy": {
"id": 12,
"stepType": "CANCELLATION",
"disabled": true,
"codice": "123456",
"ignoreRatePlan": true,
"accommodationId": "123456",
"title": "Refundable 30 days",
"days": 30,
"beforeCheckin": true,
"notRefundable": true,
"newReservations": true,
"chargeCreditCard": true,
"valueFixed": 100,
"valuePercent": 50,
"valueNights": 2,
"templateId": 101,
"templateNotify": 102,
"checkinFrom": "2026-01-01T00:00:00.000Z",
"checkinTo": "2026-01-01T00:00:00.000Z",
"createdFrom": "2026-01-01T00:00:00.000Z",
"createdTo": "2026-01-01T00:00:00.000Z",
"vcc": true,
"hour": "16:00",
"roomIds": [
"text"
],
"portalNames": [
"text"
],
"filterPayMode": [
"UNKNOWN"
],
"calculateValues": [
"ROOM"
],
"cancellationTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cancellationDetail": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"refundAfterDays": 30
},
"extras": [
{
"id": 123,
"ratePlanId": 42,
"productId": 88,
"quantity": 2,
"price": 15,
"date": "2026-01-01",
"createTime": "2026-01-01T00:00:00.000Z",
"mandatory": true,
"applyOnFirstDay": false,
"accommodationId": "ROME1234"
}
],
"priority": 1,
"accommodationName": "text"
}
],
"amenities": [
{
"internalLabel": "text",
"id": 1,
"internalName": "text",
"label": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"aiEnabled": true,
"suggested": true,
"image": "text"
}
],
"icalUrls": [
"text"
],
"cancellationPolicyId": 32,
"paymentPolicyId": 12,
"notificationEmail": "text",
"tripleThePrice": true,
"roomCategory": "KING",
"rmsDerived": true,
"accommodationId": "999999",
"hideRooms": [
12345,
67889
],
"getiCalRandomName": "text",
"revenueActive": true,
"revenueMinPrice": 1,
"revenueMaxPrice": 1,
"revenueMaxIncrementPercent": true,
"revenueMaxIncrement": 1,
"preferredCheckinClerk": 123,
"preferredCheckoutClerk": 456,
"preferredHousekeeperClerk": 789,
"roomMaintenances": [
{
"id": 1,
"roomId": 1,
"createTime": "2026-01-01T00:00:00.000Z",
"title": "text",
"description": "text",
"startDate": "2026-01-01T00:00:00.000Z",
"frequency": "NONE",
"user": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"attachment": {
"id": 17,
"name": "image.jpg",
"type": "JPEG",
"url": "http://mysite.com/image.jpg",
"previewUrl": "http://mysite.com/thumb/image.jpg",
"content": "text",
"sortOrder": 12,
"repository": "ROOM",
"error": "12"
},
"sendDate": "2026-01-01T00:00:00.000Z"
}
],
"subRooms": [
{
"id": 1,
"roomId": 1,
"privateSpace": true,
"type": "BEDROOM",
"maxGuests": 1,
"roomNumber": 1,
"subRoomBeds": [
{
"id": 1,
"subRoomId": 1,
"quantity": 1,
"bedType": "KING"
}
],
"subRoomBathroom": {
"id": 1,
"subRoomId": 1,
"halfBathroom": true,
"privateSpace": true,
"type": "BEDROOM",
"bathtubPresent": true,
"showerPresent": true
}
}
],
"showSubroomDetail": true,
"roomAmenities": [
{
"id": 1,
"roomId": 1,
"amenityId": 1,
"details": "text",
"title": "text"
}
],
"activitiesInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"checkinInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]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
The rooms to move, copy or run rules
The destination accommodation. Empty if new structure
The new accommodation name
Operation completed successfully
No content
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
POST /connect/rest/v2/roomrates/{accommodation}/move HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 373
{
"roomIds": [
1
],
"destinationAccommodationId": "text",
"newAccommodationName": "text",
"newAccommodationPlace": {
"address": "text",
"civicNumber": "text",
"city": "text",
"locality": "text",
"districtName": "text",
"country": "AF",
"latitude": 1,
"longitude": 1,
"zoom": 1,
"phone": "text",
"zipCode": "text",
"additionalInformation": "text",
"phone2": "text",
"phonePrefix": "text",
"firstLocality": "text"
}
}No content
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
The rooms to move, copy or run rules
Operation completed successfully
No content
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
POST /connect/rest/v2/roomrates/{accommodation}/runRules HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"roomIds": [
1
]
}No content
Update the room rate
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
Invalid Request
There is something wrong with you api key
Access to the resource is forbidden
Internal Server Error, something bad occourend on Octorate side
PATCH /connect/rest/v2/roomrates/{accommodationId}/{roomRateId} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"No content
Last updated