Hotel Availability

Updates Hotel Availability

post

/ari/avail

The Availability message (OTA_HotelAvailNotifRQ) defines whether a product (room type combined with rate plan) for a given itinerary can be sold for the applicable dates. When you send an Availability message, you indicate whether the availability or restrictions for a product has changed. The Availability message lets you define restrictions which control the overall availability of a booking. One notable type of restriction is "nightly availability": whether the product can be sold on a particular date. For a stay (from check-in to check-out) to be bookable, there must be nightly availability on all dates, and all other booking and stay restrictions must be met.

Authorizations

AuthorizationstringRequired

Body

The OTA_AvailNotifRQ is the message that sends the notification of the availability status of a hotel.

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

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

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

SuccessobjectOptional

Indicates that the request message was processed successfully

400

Bad Request

401

Not Authorized

405

Request Method Not Supported

500

Internal Server Error

default

Unexpected error

post

/ari/avail

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

"<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9" TimeStamp="2023-04-14T13:57:09.804Z" Version="1.0">
	<POS>
		<Source>
			<RequestorID ID="Partner Key">
			</RequestorID>
		</Source>
	</POS>
	<AvailStatusMessages HotelCode="TEST_Hotel">
		<AvailStatusMessage>
			<StatusApplicationControl Start="2023-04-14" End="2023-04-14" InvTypeCode="ITC_1" RatePlanCode="RPC_1">
			</StatusApplicationControl>
			<LengthsOfStay>
				<LengthOfStay Time="5" TimeUnit="Day" MinMaxMessageType="FullPatternLOS">
					<LOS_Pattern FullPatternLOS="YNYNNNN">
					</LOS_Pattern>
				</LengthOfStay>
			</LengthsOfStay>
			<RestrictionStatus MaxAdvancedBookingOffset="0" MinAdvancedBookingOffset="0" Restriction="Arrival" Status="Open">
			</RestrictionStatus>
		</AvailStatusMessage>
	</AvailStatusMessages>
</OTA_HotelAvailNotifRQ>"

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

Get Hotel Availability

get

/ari/avail/{hotelCode}/{rpc}/{itc}

Authorizations

AuthorizationstringRequired

Path parameters

hotelCodestringRequired

rpcstringRequired

itcstringRequired

Query parameters

datesstring · yyyy-MM-dd[]Required

List of check-in dates

Requester_IDstringOptional

Responses

200

Success

application/json

Get the availability information by hotel code, rate plan code and inventory type code.

EchoTokenstring · min: 1 · max: 100Optional

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

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]

ApiVersionstringOptional

Current API Version. Example- '1.0'

Example: 1.0

get

/ari/avail/{hotelCode}/{rpc}/{itc}

GET /supplier/ari/avail/{hotelCode}/{rpc}/{itc}?dates=text HTTP/1.1
Host: ratehub.rategain.com
Authorization: Basic username:password
Accept: */*

200

Success

{
  "EchoToken": "5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9",
  "Timestamp": "2026-05-08T03:24:14.619Z",
  "ApiVersion": "1.0",
  "Message": [
    {
      "LastUpdatedEchoToken": "5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9",
      "CreatedAt": "2026-05-08T03:24:14.619Z",
      "UpdatedAt": "2026-05-08T03:24:14.619Z",
      "HotelCode": "TEST_Hotel",
      "CheckInDate": "2026-05-08",
      "Itc": "ITC_1",
      "RoomName": "text",
      "Rpc": "RPC_1",
      "RateName": "text",
      "Restrictions": {
        "MaxAdvOffset": 5,
        "MinAdvOffset": 2,
        "Arrival": true,
        "Departure": true,
        "Master": true
      },
      "LosStatus": {
        "MaxLOS": 5,
        "MinLOS": 2,
        "ForwardMaxStay": 4,
        "ForwardMinStay": 2,
        "FpLOS": "YNYNNNN"
      }
    }
  ],
  "Errors": {
    "Error": [
      {
        "Type": 12,
        "Code": 450,
        "Status": "Not processed",
        "Text": "Error Text"
      }
    ]
  }
}

Last updated 1 year ago

hashtagUpdates Hotel Availability

hashtagGet Hotel Availability

Updates Hotel Availability

Get Hotel Availability