Hotel property data API

Defines Property Data,Rooms,Rates etc.

post

https://ratehub.rategain.com/supplierhttps://ratehub-uat.rategain.com/supplier

/property_data

The ARI Property Data message defines the information about each property's room types and Rate Plans. Each room type data includes a unique identifier (InvTypeCode), localized name, description, and URLs to room photos. Each Rate plan includes a unique identifier (RatePlanCode), localized name, description, occupancy, and value-adds. You can use a Property Data message to do the following:

1.Define data for one or more properties.

2.Define room type and rate plan information for each property.

3.Control product offerings.

4. Also, you can set actions to do the following:

Add a room type and rate plan to a property.

Remove a room type and rate plan from a property.

Add a Room-Rate Mapping to a Property

Authorizations

BasicAuth

AuthorizationstringRequired

Body

application/xmlapplication/json

The root element of a HotelPropertyDataNotifRQ message.

EchoTokenstring · min: 1 · max: 100Required

A unique identifier for this request message. This value is returned in the response message. Allowed characters are a-z, A-Z, 0-9, _ (underscore), and - (dash). The minimum length of this identifier is 1 (inclusive) and maximum length is 100 (inclusive)

Example: 5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9Pattern: ^[a-zA-Z0-9_-]{1,}$

Timestampstring · date-timeRequired

The creation date and time of this message. The date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z Format :YYYY-MM-DDTHH:mm:ss.SSS+|-HH:mm[Z]

VersionstringOptional

Current API Version. Example- '1.0'

Example: 1.0

Responses

200

Success Response

application/xmlapplication/json

Indicates that the request message was processed successfully or not. Either 'Success' or 'Errors' is present in each message.

Timestampstring · date-timeRequired

The creation date and time of this message. The date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z Format :YYYY-MM-DDTHH:mm:ss.SSS+|-HH:mm[Z]

VersionstringOptional

Current API Version. Example- '1.0'

Example: 1.0

EchoTokenstring · min: 1 · max: 100Required

A unique identifier for this request message. This value is returned in the response message. Allowed characters are a-z, A-Z, 0-9, _ (underscore), and - (dash). The minimum length of this identifier is 1 (inclusive) and maximum length is 100 (inclusive)

Example: 5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9Pattern: ^[a-zA-Z0-9_-]{1,}$

SuccessobjectOptional

Indicates that the request message was processed successfully

400

Bad Request

application/xmlapplication/json

401

Not Authorized

application/xmlapplication/json

405

Request Method Not Supported

application/xmlapplication/json

500

Internal Server Error

application/xmlapplication/json

default

Unexpected error

application/xmlapplication/json

post

/property_data

HTTPcURLJavaScriptPython

POST /supplier/property_data HTTP/1.1
Host: ratehub.rategain.com
Authorization: Basic username:password
Content-Type: application/xml
Accept: */*
Content-Length: 4691

"<?xml version="1.0" encoding="UTF-8"?> <HotelPropertyDataNotifRQ EchoToken="5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9" Timestamp="2023-08-14T08:39:06.218Z" Version="1.0">
    <POS>
        <Source>
            <RequestorID ID="Partner Key">
			</RequestorID>
        </Source>
    </POS>
    <PropertyDataSet NotifType="overlay" HotelCode="TEST_Hotel" HotelName="Hotel Name">
        <RoomsData>
            <RoomData InvTypeCode="ITC_1">
                <Name>
                    <Text Text="room_name" Language="en">
					</Text>
                </Name>
                <Description>
                    <Text Text="room_name" Language="en">
					</Text>
                </Description>
                <OccupancySettings>
                    <MinOccupancy>2</MinOccupancy>
                    <MinAgeChild>8</MinAgeChild>
                    <MaxAgeChild>12</MaxAgeChild>
                    <MaxOccupancy>3</MaxOccupancy>
                    <MaxAdultOccupancy>2</MaxAdultOccupancy>
                    <MaxChildOccupancy>2</MaxChildOccupancy>
                </OccupancySettings>
                <PhotoURLs>
                    <PhotoURL>
                        <Caption>
                            <Text Text="room_name" Language="en">
							</Text>
                        </Caption>
                        <URL>photo_location</URL>
                    </PhotoURL>
                </PhotoURLs>
                <RoomFeatures>
                    <Beds>
                        <Bed Size="single">
                            <Width unit="cm" number="40">
							</Width>
                            <Length unit="cm" number="95">
							</Length>
                        </Bed>
                    </Beds>
                    <Suite>false</Suite>
                    <Capsule>true</Capsule>
                    <Roomsharing>false</Roomsharing>
                    <Outdoor>true</Outdoor>
                    <MobilityAccessible>true</MobilityAccessible>
                    <Smoking>true</Smoking>
                    <BathAndToilet Relation="together">
                        <Bath Bathtub="false" Shower="false">
						</Bath>
                        <Toilet ElectronicBidet="false" MobilityAccessible="false">
						</Toilet>
                    </BathAndToilet>
                    <OpenAirBath>true</OpenAirBath>
                    <AirConditioning>true</AirConditioning>
                    <Balcony>true</Balcony>
                    <Views>
                        <View>AirportView</View>
                    </Views>
                </RoomFeatures>
            </RoomData>
        </RoomsData>
        <RatePlansData>
            <RatePlanData RatePlanCode="RPC_1">
                <Name>
                    <Text Text="room_name" Language="en">
					</Text>
                </Name>
                <Description>
                    <Text Text="room_name" Language="en">
					</Text>
                </Description>
                <CancelPolicies>
                    <CancelPenalty RefundType="FULL" Start="2023-08-14" End="2023-08-14">
                        <AmountPercent Percent="0" BasisType="FullStay">
						</AmountPercent>
                        <Deadline OffsetDropTime="Before" OffsetTimeUnit="Day" OffsetUnitMultiplier="0" OffsetTime="11:59:10">
						</Deadline>
                        <Description>string</Description>
                    </CancelPenalty>
                </CancelPolicies>
                <InternetIncluded>true</InternetIncluded>
                <ParkingIncluded>true</ParkingIncluded>
                <PhotoURLs>
                    <PhotoURL>
                        <Caption>
                            <Text Text="room_name" Language="en">
							</Text>
                        </Caption>
                        <URL>photo_location</URL>
                    </PhotoURL>
                </PhotoURLs>
                <MealsIncluded Breakfast="true" Dinner="true" Lunch="true" MealPlanIndicator="true">
                    <MealPlanCodes>1</MealPlanCodes>
                </MealsIncluded>
                <CheckinTime>10:15:00</CheckinTime>
                <CheckoutTime>18:00:00</CheckoutTime>
            </RatePlanData>
        </RatePlansData>
        <RateRoomMappings>
            <RateRoomMapping RatePlanCode="RPC_1" InvTypeCode="ITC_1">
			</RateRoomMapping>
        </RateRoomMappings>
    </PropertyDataSet>
</HotelPropertyDataNotifRQ>"

application/xmlapplication/json

Schema ExampleBasic Overlay MessageAdd to Existing Property DataRoom Rate MappingRoom CapacityRoom FeaturesNon Refundable Cancel PolicyFully Refundable Cancel PolicyPartially Refundable Cancel Policy

<?xml version="1.0" encoding="UTF-8"?> <HotelNotifRS Timestamp="2023-02-28T11:44:23.691Z" Version="1.0" EchoToken="5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9">
    <Success>
    </Success>
</HotelNotifRS>

Get property Data by hotel code

get

https://ratehub.rategain.com/supplierhttps://ratehub-uat.rategain.com/supplier

/property_data/{hotelCode}

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

hotelCodestringRequired

Query parameters

Requester_IDstringOptional

Responses

200

Success

application/json

Get the whole information of property from the database.

Timestampstring · date-timeOptional

The creation date and time of this message. The date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z Format :YYYY-MM-DDTHH:mm:ss.SSS+|-HH:mm[Z]

VersionstringOptional

Current API Version. Example- '1.0'

Example: 1.0

EcoTokenstring · min: 1 · max: 100Optional

A unique identifier for this request message. This value is returned in the response message. Allowed characters are a-z, A-Z, 0-9, _ (underscore), and - (dash). The minimum length of this identifier is 1 (inclusive) and maximum length is 100 (inclusive)

Example: 5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9Pattern: ^[a-zA-Z0-9_-]{1,}$

get

/property_data/{hotelCode}

HTTPcURLJavaScriptPython

GET /supplier/property_data/{hotelCode} HTTP/1.1
Host: ratehub.rategain.com
Authorization: Basic username:password
Accept: */*

200

Success

{
  "Timestamp": "2026-05-07T15:55:57.816Z",
  "Version": "1.0",
  "EcoToken": "5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9",
  "HotelPropertyData": [
    {
      "HotelCode": "TEST_Hotel",
      "HotelName": "Hotel Name",
      "RatePlansData": [
        {
          "RatePlanCode": "RPC_1",
          "Name": {
            "Text": {
              "Text": "room_name",
              "Language": "en"
            }
          },
          "Description": {
            "Text": {
              "Text": "room_name",
              "Language": "en"
            }
          },
          "CancelPolicies": {
            "CancelPenalty": [
              {
                "RefundType": "FULL",
                "Start": "2026-05-07",
                "End": "2026-05-07",
                "AmountPercent": {
                  "Percent": 0,
                  "BasisType": "FullStay"
                },
                "Deadline": {
                  "OffsetDropTime": "Before",
                  "OffsetTimeUnit": "Day",
                  "OffsetUnitMultiplier": 1,
                  "OffsetTime": "11:59:10"
                },
                "Description": "text"
              }
            ]
          },
          "InternetIncluded": true,
          "ParkingIncluded": true,
          "PhotoURLs": {
            "PhotoURL": [
              {
                "Caption": {
                  "Text": {
                    "Text": "room_name",
                    "Language": "en"
                  }
                },
                "URL": "photo_location"
              }
            ]
          },
          "MealsIncluded": {
            "Breakfast": true,
            "Dinner": true,
            "Lunch": true,
            "MealPlanIndicator": true,
            "MealPlanCodes": [
              1
            ]
          },
          "CheckinTime": "10:15:00",
          "CheckoutTime": "18:00:00"
        }
      ],
      "RoomsData": [
        {
          "InvTypeCode": "ITC_1",
          "Name": {
            "Text": {
              "Text": "room_name",
              "Language": "en"
            }
          },
          "Description": {
            "Text": {
              "Text": "room_name",
              "Language": "en"
            }
          },
          "OccupancySettings": {
            "MinOccupancy": 2,
            "MinAgeChild": 8,
            "MaxAgeChild": 12,
            "MaxOccupancy": 3,
            "MaxAdultOccupancy": 2,
            "MaxChildOccupancy": 2
          },
          "PhotoURLs": {
            "PhotoURL": [
              {
                "Caption": {
                  "Text": {
                    "Text": "room_name",
                    "Language": "en"
                  }
                },
                "URL": "photo_location"
              }
            ]
          },
          "RoomFeatures": {
            "Beds": {
              "Bed": [
                {
                  "Size": "single",
                  "Width": {
                    "unit": "cm",
                    "number": 40
                  },
                  "Length": {
                    "unit": "cm",
                    "number": 95
                  }
                }
              ]
            },
            "Suite": false,
            "Capsule": true,
            "Roomsharing": false,
            "Outdoor": true,
            "MobilityAccessible": true,
            "Smoking": true,
            "BathAndToilet": {
              "Relation": "together",
              "Bath": {
                "Bathtub": false,
                "Shower": false
              },
              "Toilet": {
                "ElectronicBidet": false,
                "MobilityAccessible": false
              }
            },
            "OpenAirBath": true,
            "AirConditioning": true,
            "Balcony": true,
            "Views": {
              "View": [
                "AirportView"
              ]
            }
          }
        }
      ],
      "RateRoomMappings": [
        {
          "RatePlanCode": "RPC_1",
          "InvTypeCode": "ITC_1"
        }
      ]
    }
  ],
  "Errors": {
    "Error": [
      {
        "Type": 12,
        "Code": 450,
        "Status": "Not processed",
        "Text": "Error Text"
      }
    ]
  }
}