Retrieve Rate Availability
Query Overview
The availRates query allows you to retrieve the availability of specific rates in Inventory. The returned fields include:
successratesrateCoderoomsrestrictionsbookingLimitminReleasemaxReleasefreeSaleslengthOfStayfullStayminimummaximum
arrivalminimummaximum
applicableWeekdaysallmondaytuesdaywednesdaythursdayfridaysaturdaysunday
dateRangestartend
adviseMessagescodedescriptionlevelcorrelationIDexternalcodemessage
1. Criteria
When building your query, you need to provide the following input fields:
Mandatory Input
clientCodesupplierCodehotelCoderatesrateCodedateRangestartend
2. Settings
This query allows retrieving availability for specific rates by defining relevant details such as clientCode, supplierCode, hotelCode, and dateRange.
{
"input": {
"clientCode": "ABC123",
"supplierCode": "SUP001",
"hotelCode": "HTL567",
"rates": [
{
"rateCode": "RATE001",
"dateRange": {
"start": "2024-03-01",
"end": "2024-03-10"
}
}
]
}
}
Response Considerations
The query returns the retrieved rates along with success status and possible advise messages.
AvailRatesRs (OBJECT)
rates(RateAvailLoad) - List of rates with availability information.rateCode(String) - The rate code for the rates.dateRange(DateRangeProduct) - Date range applied.start(DateTime) - Start date.end(DateTime) - End date.
restrictions(RestrictionsLoad) - Restrictions applied to the rates.bookingLimit,minRelease,maxRelease,freeSales,stopSalesconditions.
success(Boolean) - Indicates whether the operation was successful.adviseMessages(AdviseMessage) - Messages related to the operation.code(ID) - AM code.type(String) - Error type.description(String) - Error description.level(Enum of AdviseMessageLevel) - Importance level (ERROR, WARN, INFO).external(ExternalMessage) - External message details.correlationID(ID) - Identifier for debugging.
Query Inputs
InventoryAvailRatesInput (INPUT_OBJECT)
Retrieve availability rates query input
Retrieve availability rates query input
clientCode * (String)
Client code.
Client code.
supplierCode * (String)
Travelgate Supplier/Channel code.
Travelgate Supplier/Channel code.
rates * (RateAvailRetrieveInput)
Hotel rates input data.
Hotel rates input data.
rateCode (String)
Rate code to be retrieved.
Rate code to be retrieved.
rooms (String)
List of rooms to be retrieved.
List of rooms to be retrieved.
dateRange (DateRangeProductInput)
Date range to apply
Date range to apply
start * (DateTime)
Start date.
Start date.
end * (DateTime)
End date.
End date.
hotelCode * (String)
Code associated with the hotel.
Code associated with the hotel.
contextCode (String)
Context code.
Context code.
Returned Fields
AvailRatesRs (OBJECT)
Represents the response data for rates availability operations.
Represents the response data for rates availability operations.
rates (RateAvailLoad)
List of rates availabilities. See RateAvailLoad.
List of rates availabilities. See RateAvailLoad.
rateCode (String)
Code associated with the rate.
Code associated with the rate.
rooms (String)
List of rooms associated with the rate.
List of rooms associated with the rate.
restrictions (RestrictionsLoad)
Restrictions for the rate. See RestrictionsLoad.
Restrictions for the rate. See RestrictionsLoad.
bookingLimit (Int)
Booking limit associated with the product.
Booking limit associated with the product.
lengthOfStay (LengthOfStay)
Length of stay associated with the product. See LengthOfStay.
Length of stay associated with the product. See LengthOfStay.
fullStay (FullStay)
Full stay associated with the product. See FullStay.
Full stay associated with the product. See FullStay.
minimum (Int)
Minimum length of the full stay.
Minimum length of the full stay.
maximum (Int)
Maximum length of the full stay.
Maximum length of the full stay.
arrival (InventoryArrivalType)
Arrival associated with the product. See Arrival.
Arrival associated with the product. See Arrival.
minimum (Int)
Minimum length of the arrival period.
Minimum length of the arrival period.
maximum (Int)
Maximum length of the arrival period.
Maximum length of the arrival period.
minRelease (Int)
Minimum release period associated with the product.
Minimum release period associated with the product.
maxRelease (Int)
Maximum release period associated with the product.
Maximum release period associated with the product.
stopSales (StopSales)
Stop sales associated with the product. See StopSales.
Stop sales associated with the product. See StopSales.
closeMaster (Boolean)
Indicates whether to close the master.
Indicates whether to close the master.
closeOnArrival (Boolean)
Indicates whether to close on arrival. Null if not applicable.
Indicates whether to close on arrival. Null if not applicable.
closeOnDeparture (Boolean)
Indicates whether to close on departure. Null if not applicable.
Indicates whether to close on departure. Null if not applicable.
freeSales (Boolean)
Indicates whether the product is available for free sales.
Indicates whether the product is available for free sales.
applicableWeekdays (ApplicableWeekdays)
Weekdays when the rate is applicable. See ApplicableWeekdays.
Weekdays when the rate is applicable. See ApplicableWeekdays.
all (Boolean)
Indicates whether the price or rate is applicable on all days.
Indicates whether the price or rate is applicable on all days.
monday (Boolean)
Indicates whether the price or rate is applicable on Mondays.
Indicates whether the price or rate is applicable on Mondays.
tuesday (Boolean)
Indicates whether the price or rate is applicable on Tuesdays.
Indicates whether the price or rate is applicable on Tuesdays.
wednesday (Boolean)
Indicates whether the price or rate is applicable on Wednesdays.
Indicates whether the price or rate is applicable on Wednesdays.
thursday (Boolean)
Indicates whether the price or rate is applicable on Thursdays.
Indicates whether the price or rate is applicable on Thursdays.
friday (Boolean)
Indicates whether the price or rate is applicable on Fridays.
Indicates whether the price or rate is applicable on Fridays.
saturday (Boolean)
Indicates whether the price or rate is applicable on Saturdays.
Indicates whether the price or rate is applicable on Saturdays.
sunday (Boolean)
Indicates whether the price or rate is applicable on Sundays.
Indicates whether the price or rate is applicable on Sundays.
dateRange (DateRangeProduct)
Date range to apply
Date range to apply
start * (DateTime)
Start date.
Start date.
end * (DateTime)
End date.
End date.
adviseMessages (AdviseMessage)
List of advise messages associated with the operation. See AdviseMessage.
List of advise messages associated with the operation. See AdviseMessage.
code * (ID)
AM code: The following codes can be returned:
AM code: The following codes can be returned:
description * (String)
Error description
Error description
level * (Enum of AdviseMessageLevel)
Indicates the level of importance of the message.
Possible values: ERROR, WARN, INFO.
Possible values:
WARN
ERROR
INFO
Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO.
Possible values:
WARNERRORINFOexternal (ExternalMessage)
Specify the external message.
Specify the external message.
code (String)
External code.
External code.
message * (String)
External message.
External message.
correlationID * (ID)
Identifier to investigate the cause of the error.
Identifier to investigate the cause of the error.
success * (Boolean)
Indicates whether the operation was successful.
Indicates whether the operation was successful.
Examples
Retrieve availability for a specific rate
With this example, we are going to retrieve the availability for a specific rate within a specific date range.
Retrieve availability for a specific rate and room
With this example, we are going to retrieve the availability for a specific rate and specific room within a specific date range.