Hotel Rate

Updates Hotel rates

post

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

/ari/rate

The Rate message (OTA_HotelRateAmountNotifRQ) defines the nightly occupancy rates for each room type and rate plan combination for specific date ranges. As users request specific occupancies, the rate they see depends on how you define prices in your Rate message.

Authorizations

BasicAuth

AuthorizationstringRequired

Body

application/xmlapplication/json

The root element for a message that defines room rate availability.

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

NotifTypestring · enumOptional

The type of notification to apply to every RateAmountMessage. Valid values are: Delta: (the default if NotifType isn't specified) Add or update the existing per-occupancy rates for the room type, rate plan, and dates specified in StatusApplicationControl.

Default: DeltaPossible values:

NotifScopeTypestring · enumOptional

The scope of the NotifType to apply to every 'RateAmountMessage'. Valid values are: ProductRate: (the default if NotifScopeType isn't specified) The NotifType applies to products�combinations of room type (InvTypeCode) and rate plan (RatePlanCode).

Default: ProductRatePossible values:

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

/ari/rate

HTTPcURLJavaScriptPython

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

"<?xml version="1.0" encoding="UTF-8"?>  <OTA_HotelRateAmountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9" TimeStamp="2023-04-14T14:02:16.578Z" Version="1.0" NotifType="Delta" NotifScopeType="ProductRate">
	<POS>
		<Source>
			<RequestorID ID="Partner Key">
			</RequestorID>
		</Source>
	</POS>
	<RateAmountMessages HotelCode="TEST_Hotel">
		<RateAmountMessage>
			<StatusApplicationControl Start="2023-04-14" End="2023-04-14" InvTypeCode="ITC_1" RatePlanCode="RPC_1">
			</StatusApplicationControl>
			<Rates>
				<Rate>
					<BaseByGuestAmts>
						<BaseByGuestAmt AmountBeforeTax="100" AmountAfterTax="100" CurrencyCode="USD" NumberOfGuests="2">
						</BaseByGuestAmt>
					</BaseByGuestAmts>
					<AdditionalGuestAmounts>
						<AdditionalGuestAmount Amount="0" AgeQualifyingCode="10" MaxAge="0">
						</AdditionalGuestAmount>
					</AdditionalGuestAmounts>
				</Rate>
			</Rates>
		</RateAmountMessage>
	</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>"

application/xmlapplication/json

Schema ExampleBase RateBase and Total RateMultiple OccupanciesMultiple Rates and Rooms

<?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 Rates

get

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

/ari/rate/{hotelCode}/{rpc}/{itc}

Authorizations

BasicAuth

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 rate information by hotel code, rate plan code and inventory type code.

EchoTokenstring · 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,}$

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/rate/{hotelCode}/{rpc}/{itc}

HTTPcURLJavaScriptPython

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

200

Success

{
  "EchoToken": "5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9",
  "Timestamp": "2026-05-07T18:50:11.044Z",
  "ApiVersion": "1.0",
  "Message": [
    {
      "LastUpdatedEchoToken": "5fe69c95ed70a9869d9f9af7d8400a6673bb9ce9",
      "CreatedAt": "2026-05-07T18:50:11.044Z",
      "UpdatedAt": "2026-05-07T18:50:11.044Z",
      "HotelCode": "TEST_Hotel",
      "CheckInDate": "2026-05-07",
      "Itc": "ITC_1",
      "RoomName": "text",
      "Rpc": "RPC_1",
      "RateName": "text",
      "Currency": "USD",
      "BaseAmountByGuests": [
        {
          "NumOfAdults": 2,
          "BeforeTax": 100,
          "AfterTax": 100
        }
      ],
      "AdditionalGuestsAmounts": [
        {
          "AgeCode": 1,
          "BeforeTax": 100,
          "MaxAge": 15
        }
      ]
    }
  ],
  "Errors": {
    "Error": [
      {
        "Type": 12,
        "Code": 450,
        "Status": "Not processed",
        "Text": "Error Text"
      }
    ]
  }
}