Response
The Lead Available response is broken down into different sections.
- Available
- ArrivalDate
- DepartureDate
- Hotel
- Paging
- AllocationBlockList
- Failures
- Price
- PriceGroup
{
"paging": {...},
"leadAvailabilityList": [
{
"Hotel": {...},
"AllocationBlockList": [],
"LeastRestrictiveFailure": [...],
"Failures": [...],
"Price": [...],
"PriceGroup": [...],
"Available": true,
"ArrivalDate": "2022-11-20",
"DepartureDate": "2022-11-21"
}
]
}
Available
Indicates if the hotel is available or not for the specified @ArrivalDate and @DepartureDate.
Note: Lead Availability pricing is returned even if the hotel is not available. It is up to the client to determine whether or not to show pricing if the hotel is not available.
| Parameter | Description | Type |
|---|---|---|
| Available | Indicates if the hotel is available. | Boolean |
{
"leadAvailabilityList": [
{
"Available": true
}
]
}
ArrivalDate and DepartureDate
Specifies the Arrival and Departure dates for the Lead Availability pricing data.
| Parameter | Description | Type |
|---|---|---|
| ArrivalDate | Arrival date of the stay. | String(Date) |
| DepartureDate | Departure date of the stay. | String(Date) |
{
"leadAvailabilityList": [
{
"ArrivalDate": "2022-11-20",
"DepartureDate": "2022-11-21"
}
]
}
Hotel
Hotel associated with the Lead Availability pricing data. If multiple hotels are included in the request, then the response will contain a leadAvailabilityList item for each.
| Parameter | Description | Type |
|---|---|---|
| Id | Id that uniquely identifies a single hotel property in SynXis CR. | Integer |
{
"leadAvailabilityList": [
{
"Hotel": {
"Id": 13098
}
}
]
}
Paging
The paging section indicates how many results are included in the response.
Note: The API supports a maximum @Size of 100 items in the response. If @Total is more than 100, then pagination would need to be used to cycle through the entire result set.
| Parameter | Description | Type |
|---|---|---|
| Size | Indicates the number of records returned in the response. | Integer |
| Start | Indicates the starting record in the response. | Integer |
| Total | Indicates the total number of records identified in the request. | Integer |
Example: Lead Avail Shop for 1 hotel without including lengthOfStay will return:
{
"paging": {
"Size": 1,
"Start": 0,
"Total": 1
}
}Example: Lead Avail Shop for 2 hotels without including lengthOfStay will return:
{
"paging": {
"Size": 2,
"Start": 0,
"Total": 2
}
}Example: Lead Avail Shop for 1 hotel, 10 nights, and including lengthOfStay will return:
By including lengthOfStay in the request, the paging total will equal the number of nights requested.
{
"paging": {
"Size": 10,
"Start": 0,
"Total": 10
}
}
AllocationBlockList
Includes block information associated with Groups.
Note: This is a future use element. No data is currently returned.
LeastRestrictiveFailure
Identifies the one failure that if fixed will have the highest chance of getting availability for the property.
Note: This node is only returned if the hotel is not available.
| Parameter | Description | Type |
|---|---|---|
| OverrideAllowed | Indicates if the failure can be overridden. | Boolean |
| AdditionalInformation | Descriptive information associated with the failure. | String |
| Level | Level related information associated with the failure. Values: Currency, General, GroupInventory, HotelControl, HotelInventory, Hurdling, ProductControl, Rate, RateControl, ResultLimit, Room, RoomControl, RoomInventory, Yielding, RateCategoryRoomCategory, DefaultRateControl, RateCategoryRoomType, RateCategoryControl, RoomCategoryControl, Onshore | String |
| Cause | Failure cause related information. Values: AboveMaxPrice, AfterGroupCutoffDate, Available, BaseBarExcluded, BaseRateInactive, BelowHurdlePrice, BelowMinPrice, BelowYieldingMinStayDays, ByRequestOnly, Closed, ClosedByYielding, EndTime, FullPatternLengthOfStayNoArrival, HotelNotActive, HotelSuspended, HotelTerminated, InactiveBarRate, InvalidChannelSelection, InvalidGroupRateStatus, InvalidHotelSelection, InvalidInterval, InvalidNumberOfDays, InvalidOccupantQuantity, LeadDaysTime, Limit, LinkedRateNotFound, MaxAdultOccupancyExceeded, MaxChildOccupancyExceeded, MaxHurdleSoldQuantityExceeded, MaxLeadDays, MaxOccupancyExceeded, MaxSellDate, MaxStayArrive, MaxStayThrough, NoArrive, NoAvailableInventory, NoBaseSeasonForDerived, NoDeparture, NoFullPatternLengthOfStayID, NoInventoryDefined, NoPriceOnBaseRate, NoPriceOnBaseRateForDerived, NoProduct, NoSeasonOrOverride, NoSellDay, Other, OverrideHasNoPrice, ProductAvailabilityFiltered, RateLinkedToRequestedCurrency, RequestedNotIncluded, SameDay, SeasonalClosure, StartTime, StayDatePastActiveDate, SystemError, Threshold, UnavailableBARDerivationOption, Unknown, YieldingNoArrive, ZeroFinalPrice | String |
Example: A Lead Availability request for 5 adults returned a LeastRestrictiveFailure with the following information:
- @AdditionalInformation=5 - Indicates that 5 guests were requested
- @Cause=MaxOccupancyExceeded - Indicates that the hotel is not able to accommodate the number of guests
- @Level=Room - Indicates that the Room is the level for @Cause
- @OverrideAllowed=true - Indicates that a user with the correct permissions can override this failure.
{
"leadAvailabilityList": [
{
"LeastRestrictiveFailure": {
"AdditionalInformation": "5",
"Cause": "MaxOccupancyExceeded",
"Level": "Room",
"OverrideAllowed": true
}
}
]
}
Failures
List of failures and the percentage of products affected by the failure. This node is returned if the hotel is available or not.
Failure vs. Least Restrictive Failures The response can include @Failure and @LeastRestrictiveFailure nodes for each hotel to detail why products are not available. This information allows the client to potentially change the search criteria to overcome the failure reason and obtain availability.
| Parameter | Description | Type |
|---|---|---|
| Cause | Failure cause related information. Values: AboveMaxPrice, AfterGroupCutoffDate, Available, BaseBarExcluded, BaseRateInactive, BelowHurdlePrice, BelowMinPrice, BelowYieldingMinStayDays, ByRequestOnly, Closed, ClosedByYielding, EndTime, FullPatternLengthOfStayNoArrival, HotelNotActive, HotelSuspended, HotelTerminated, InactiveBarRate, InvalidChannelSelection, InvalidGroupRateStatus, InvalidHotelSelection, InvalidInterval, InvalidNumberOfDays, InvalidOccupantQuantity, LeadDaysTime, Limit, LinkedRateNotFound, MaxAdultOccupancyExceeded, MaxChildOccupancyExceeded, MaxHurdleSoldQuantityExceeded, MaxLeadDays, MaxOccupancyExceeded, MaxSellDate, MaxStayArrive, MaxStayThrough, NoArrive, NoAvailableInventory, NoBaseSeasonForDerived, NoDeparture, NoFullPatternLengthOfStayID, NoInventoryDefined, NoPriceOnBaseRate, NoPriceOnBaseRateForDerived, NoProduct, NoSeasonOrOverride, NoSellDay, Other, OverrideHasNoPrice, ProductAvailabilityFiltered, RateLinkedToRequestedCurrency, RequestedNotIncluded, SameDay, SeasonalClosure, StartTime, StayDatePastActiveDate, SystemError, Threshold, UnavailableBARDerivationOption, Unknown, YieldingNoArrive, ZeroFinalPrice | String |
| Percentage | Percentage of products affected by the failure. | Integer |
{
"leadAvailabilityList": [
{
"Failures": [
{
"Cause": "NoAvailableInventory",
"Percentage": 21
},
{
"Cause": "NoSeasonOrOverride",
"Percentage": 27
},
{
"Cause": "ZeroFinalPrice",
"Percentage": 27
},
{
"Cause": "MinStayArrive",
"Percentage": 21
}
]
}
]
}
Price
Contains information for each supported Price Type
| Parameter | Description | Type |
|---|---|---|
| Amount | Applicable amount. | Number |
| AmountWithTaxesFees | Applicable amount with taxes and fees. | Number |
| CurrencyCode | ISO 4217 three alpha currency code. | String |
| Type | Indicates the type of price. Values: Average, Minimum, Maximum, MinimumAvg, MaximumAvg, MinimumFirstNight, MaximumFirstNight, MinimumHighestPriceWithInclusiveTax, MaximumHighestPriceWithInclusiveTax | String |
| Product/Room/Code | Code used to specify a room. | String |
| Product/Rate/Code | Code used to specify a rate. | String |
| Fees/Amount | Applicable fee amount. | Number |
| Tax/Amount | Applicable tax amount. | Number |
The following Price Types represent at least one product denoted by Room/@Code and Rate/@Code.
- Maximum: The maximum total priced product.
- Minimum: The minimum total priced product.
The following Price Types do not reflect the price of any specific product and could be a combination of multiple products. They provide a general pricing guideline but do not represent a bookable product.
- Average: The sum of all product total prices divided by the number of products.
- Maximum Average: The maximum daily average across all products.
- Minimum Average: The minimum daily average across all products.
- Maximum First Night: The maximum first-night price across all products.
- Maximum First Night: The maximum first-night price across all products.
- Maximum Highest Price with Inclusive Tax: The maximum highest room price inclusive of taxes across all products.
- Minimum Highest Price with Inclusive Tax: The minimum highest room price inclusive of taxes across all products.
{
"leadAvailabilityList": [
{
"Price": [
{
"Fees": {
"Amount": 8.99
},
"Product": {
"Room": {
"Code": "SUEX"
},
"Rate": {
"Code": "RR"
}
},
"Tax": {
"Amount": 45.35
},
"Amount": 625.0,
"AmountWithTaxesFees": 686.13,
"CurrencyCode": "USD",
"Type": "Maximum"
},
{
"Fees": {
"Amount": 10.99
},
"Product": {
"Room": {
"Code": "SUPT"
},
"Rate": {
"Code": "COUPONPROMO"
}
},
"Tax": {
"Amount": 19.1
},
"Amount": 101.25,
"AmountWithTaxesFees": 132.65,
"CurrencyCode": "USD",
"Type": "Minimum"
},
{
"Amount": 293.48,
"AmountWithTaxesFees": 336.55,
"CurrencyCode": "USD",
"Type": "Average"
},
{
"Amount": 625.0,
"AmountWithTaxesFees": 679.34,
"CurrencyCode": "USD",
"Type": "MaximumAvg"
},
{
"Amount": 101.25,
"AmountWithTaxesFees": 131.34,
"CurrencyCode": "USD",
"Type": "MinimumAvg"
},
{
"Amount": 101.25,
"AmountWithTaxesFees": 131.34,
"CurrencyCode": "USD",
"Type": "MinimumFirstNight"
},
{
"Amount": 625.0,
"AmountWithTaxesFees": 679.34,
"CurrencyCode": "USD",
"Type": "MaximumFirstNight"
},
{
"Amount": 625.0,
"CurrencyCode": "USD",
"Type": "MaximumHighestPriceWithInclusiveTax"
},
{
"Amount": 101.25,
"CurrencyCode": "USD",
"Type": "MinimumHighestPriceWithInclusiveTax"
}
]
}
]
}
PriceGroup
Contains products identified by a qualified search (i.e. rate code, rate class, access code). The @price and @priceGroup nodes provide a comparison between qualified searched products and all the products included in the general response.
If there are no qualified search parameters, then @price and @priceGroup will be identical.
In a qualified search, a priceGroup item is returned for each qualified search parameter. Each pricing type contains a @Ref and @RefValue to indicate the how the product is associated to it.
| Parameter | Description | Type |
|---|---|---|
| Amount | Applicable amount. | Number |
| AmountWithTaxesFees | Applicable amount with taxes and fees. | Number |
| CurrencyCode | ISO 4217 three alpha currency code. | String |
| Type | Indicates the type of price. Values: Average, Minimum, Maximum, MinimumAvg, MaximumAvg, MinimumFirstNight, MaximumFirstNight, MinimumHighestPriceWithInclusiveTax, MaximumHighestPriceWithInclusiveTax | String |
| Ref | Reference for the price, if not set it indicates it applies to all applicable products. Values: AccessCode, Agent, ChannelizedRateAccessCode, Corporate, Group, Loyalty, Rate, RateClass, RateFilter, Room, RoomFeature, Template, Unknown | Number |
| RefValue | Reference value the @Ref attribute. | Number |
| Product/Room/Code | Code used to specify a room. | String |
| Product/Rate/Code | Code used to specify a rate. | String |
| Fees/Amount | Applicable fee amount. | Number |
| Tax/Amount | Applicable tax amount. | Number |
Example: A qualified Lead Avail Request.
A request specifying two rate codes (BAR and ADV) results in @PriceGroup with two array items. The first item contains pricing for the ADV rate code (@Ref=Rate, @RefValue=ADV) and the second item contains pricing for the BAR rate code (@Ref=Rate, @RefValue=BAR).
{
"leadAvailabilityList": [
{
"PriceGroup": [
{
"Product": {
"Room": {
"Code": "SUPK"
},
"Rate": {
"Code": "ADV"
}
},
"Amount": 200,
"AmountWithTaxesFees": 200,
"CurrencyCode": "AUD",
"Type": "Maximum",
"Ref": "Rate",
"RefValue": "ADV"
},
{
"Product": {
"Room": {
"Code": "SUPK"
},
"Rate": {
"Code": "ADV"
}
},
"Amount": 200,
"AmountWithTaxesFees": 200,
"CurrencyCode": "AUD",
"Type": "Minimum",
"Ref": "Rate",
"RefValue": "ADV"
},
{
"Amount": 154.06,
"CurrencyCode": "USD",
"Type": "Average",
"Ref": "Rate",
"RefValue": "ADV"
},
{
"Amount": 77.032178889808947,
"AmountWithTaxesFees": 77.032178889808947,
"CurrencyCode": "USD",
"Type": "MaximumAvg",
"Ref": "Rate",
"RefValue": "ADV"
},
{
"Amount": 77.032178889808947,
"AmountWithTaxesFees": 77.032178889808947,
"CurrencyCode": "USD",
"Type": "MinimumAvg",
"Ref": "Rate",
"RefValue": "ADV"
},
{
"Amount": 100,
"AmountWithTaxesFees": 100,
"CurrencyCode": "AUD",
"Type": "MinimumFirstNight",
"Ref": "Rate",
"RefValue": "ADV"
},
{
"Amount": 100,
"AmountWithTaxesFees": 100,
"CurrencyCode": "AUD",
"Type": "MaximumFirstNight",
"Ref": "Rate",
"RefValue": "ADV"
},
{
"Amount": 100,
"CurrencyCode": "AUD",
"Type": "MaximumHighestPriceWithInclusiveTax",
"Ref": "Rate",
"RefValue": "ADV"
},
{
"Amount": 100,
"CurrencyCode": "AUD",
"Type": "MinimumHighestPriceWithInclusiveTax",
"Ref": "Rate",
"RefValue": "ADV"
},
{
"Product": {
"Room": {
"Code": "HCP"
},
"Rate": {
"Code": "BAR"
}
},
"Tax": {
"Amount": 28.6
},
"Amount": 308,
"AmountWithTaxesFees": 336.6,
"CurrencyCode": "USD",
"Type": "Maximum",
"Ref": "Rate",
"RefValue": "BAR"
},
{
"Product": {
"Room": {
"Code": "SUPK"
},
"Rate": {
"Code": "BAR"
}
},
"Tax": {
"Amount": 17.6
},
"Amount": 208,
"AmountWithTaxesFees": 225.6,
"CurrencyCode": "USD",
"Type": "Minimum",
"Ref": "Rate",
"RefValue": "BAR"
},
{
"Amount": 222.72,
"CurrencyCode": "USD",
"Type": "Average",
"Ref": "Rate",
"RefValue": "BAR"
},
{
"Amount": 154,
"AmountWithTaxesFees": 168.3,
"CurrencyCode": "USD",
"Type": "MaximumAvg",
"Ref": "Rate",
"RefValue": "BAR"
},
{
"Amount": 104,
"AmountWithTaxesFees": 112.8,
"CurrencyCode": "USD",
"Type": "MinimumAvg",
"Ref": "Rate",
"RefValue": "BAR"
},
{
"Amount": 104,
"AmountWithTaxesFees": 112.8,
"CurrencyCode": "USD",
"Type": "MinimumFirstNight",
"Ref": "Rate",
"RefValue": "BAR"
},
{
"Amount": 154,
"AmountWithTaxesFees": 168.3,
"CurrencyCode": "USD",
"Type": "MaximumFirstNight",
"Ref": "Rate",
"RefValue": "BAR"
},
{
"Amount": 154,
"CurrencyCode": "USD",
"Type": "MaximumHighestPriceWithInclusiveTax",
"Ref": "Rate",
"RefValue": "BAR"
},
{
"Amount": 104,
"CurrencyCode": "USD",
"Type": "MinimumHighestPriceWithInclusiveTax",
"Ref": "Rate",
"RefValue": "BAR"
}
]
}
]
}