Hotel Availability
POST/v1/api/Pull/GetHotelAvail
Introdution
This API endpoint allows the retrieval of hotel availability information based on specific criteria provided in the request payload.
It allows clients to query for available hotels according to various parameters such as date range, location, number of guests, and preferred amenities.
By sending a POST request to this endpoint with appropriate parameters, the client application can receive a comprehensive response detailing available hotels, room types, rates, and any additional services offered.
The endpoint ensures flexibility by allowing optional parameters to be included, such as maximum number of responses, page number for pagination, and language preferences.
Additionally, the response structure is designed to provide detailed information on each available hotel stay, including room details, pricing, and any associated warnings or errors.
Filtering out rates
It's possible to control which rates you would search/book using the filters defined in
HotelSearchCriteria.Criterion.TPA_Extensions.
Return only NET Rates
To retrieve only NET rates, apply the following filters:
{
"AmountIncludingMarkup": false,
"AmountNotIncludingMarkup": true,
"AmountIsPackageRates": false
}
Return Only Commissionable Rates
To filter for only commissionable rates, use these filters:
{
"AmountIncludingMarkup": true,
"AmountNotIncludingMarkup": false,
"AmountIsPackageRates": false
}
Return Only Non-Package Rates
To get only the rates that don't require being part of a package, apply this filter:
{
"AmountIsPackageRates": false
}
If a filter value is null, it'll be considered the default value.
Please note that it is possible for a rate to be both commissionable and part of a package.
Request
- application/json
Body
- Array [
- ]
- Array [
- MOD1
- MOD2
- MOD1
- MOD2
- ]
- MOD1
- MOD2
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Default value: 8
The primary language code for the request (e.g., 'BR' for Brazilian Portuguese).
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
An arbitrary string returned in the response for tracking/debugging.
The date and time (ISO format) just before the request is sent.
Possible values: [0, 1]
The target environment for this request.
TargetEnum:
0=Test | 1=Production
Default value: 1
The version number of this request format.
Default value: 100
The number of hotels to search to.
The page number for paginated results.
Default value: true
Indicates whether to return only hotels with available rates (true) or all hotels (false).
Default value: true
(Note: if not passed, the default value is true) Indicates whether to return only the best available rate for each hotel (true) or all available rates (false).
Indicates whether availability is requested on request (true) or not (false).
Indicates whether this is a request to modify an existing booking (true) or not (false).
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
Default value: 1
The requested currency for the prices in the response.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
POSType objectnullable
Sources object[]
A list of source information for the point of sale.
Default value: BRA
The pseudo city code (PCC).
The ISO 3166-1 alpha-2 country code.
RequestorID objectnullable
Information about the requestor.
The ID of the requestor.
Possible values: [3, 4, 14, 25]
A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).
UniqueIdTypeEnum:
3=CorporationRepresentative | 4=Company | 14=Reservation | 25=AssociatedReservation
HotelSearchCriteria object
Criterion objectrequired
The main search criteria for finding available hotels.
HotelRefs object[]nullable
A list of hotel references to search for.
ChainCode object nullable
The code of the hotel chain (if applicable).
integer
string
The name of the hotel chain (if applicable).
The name of the hotel.
HotelCode object required
The unique code of the hotel.
integer
string
Address objectnullable
The address around which to search for hotels.
The street address or line 1 of the address.
CityCode object nullable
A numerical code for the city.
integer
string
The name of the city.
Possible values: [161, 177, 209, 95, 168, 94, 60, 189, 186, 24, 104, 56, 63, 198, 49, 171, 102, 113, 109, 148, 158, 29, 200, 97, 195, 73, 71, 68, 181, 82, 44, 72, 112, 27, 118, 79, 132, 32, 75, 199, 120, 90, 42, 18, 156, 159, 108, 211, 210, 54, 122, 114, 39, 129, 183, 178, 137, 121, 17, 149, 30, 196, 188, 180, 36, 92, 124, 141, 138, 204, 103, 110, 150, 208, 190, 93, 111, 187, 155, 123, 52, 41, 45, 106, 101, 107, 173, 66, 160, 134, 25, 127, 131, 152, 176, 197, 140, 205, 143, 74, 116, 46, 169, 55, 157, 115, 99, 81, 70, 146, 43, 191, 86, 128, 35, 77, 172, 167, 78, 85, 50, 145, 125, 194, 179, 136, 126, 19, 62, 91, 201, 185, 184, 142, 26, 33, 80, 119, 96, 133, 76, 20, 117, 174, 61, 147, 206, 166, 98, 175, 135, 58, 38, 21, 139, 31, 48, 87, 219, 182, 153, 203, 40, 100, 65, 59, 28, 193, 162, 64, 22, 163, 214, 218, 164, 216, 83, 34, 69, 84, 89, 144, 57, 207, 67, 53, 151, 88, 23, 51, 37, 154, 130, 105, 192, 165, 217, 47, 202, 170, 213, 215, 212]
The three-letter country code (ISO 3166-1 alpha-3).
CountryCodeEnum:
161=RW | 177=SO | 209=YE | 95=IQ | 168=SA | 94=IR | 60=CY | 189=TZ | 186=SY | 24=AM | 104=KE | 56=CD | 63=DJ | 198=UG | 49=CF | 171=SC | 102=JO | 113=LB | 109=KW | 148=OM | 158=QA | 29=BH | 200=AE | 97=IL | 195=TR | 73=ET | 71=ER | 68=EG | 181=SD | 82=GR | 44=BI | 72=EE | 112=LV | 27=AZ | 118=LT | 79=GE | 132=MD | 32=BY | 75=FI | 199=UA | 120=MK | 90=HU | 42=BG | 18=AL | 156=PL | 159=RO | 108=XK | 211=ZW | 210=ZM | 54=KM | 122=MW | 114=LS | 39=BW | 129=MU | 183=SZ | 178=ZA | 137=MZ | 121=MG | 17=AF | 149=PK | 30=BD | 196=TM | 188=TJ | 180=LK | 36=BT | 92=IN | 124=MV | 141=NP | 138=MM | 204=UZ | 103=KZ | 110=KG | 150=PW | 208=VD | 190=TH | 93=ID | 111=LA | 187=TW | 155=PH | 123=MY | 52=CN | 41=BN | 45=KH | 106=KP | 101=JP | 107=KR | 173=SG | 66=TP | 160=RU | 134=MN | 25=AU | 127=MH | 131=FM | 152=PG | 176=SB | 197=TV | 140=NR | 205=VU | 143=NZ | 74=FJ | 116=LY | 46=CM | 169=SN | 55=CG | 157=PT | 115=LR | 99=CI | 81=GH | 70=GQ | 146=NG | 43=BF | 191=TG | 86=GW | 128=MR | 35=BJ | 77=GA | 172=SL | 167=ST | 78=GM | 85=GN | 50=TD | 145=NE | 125=ML | 194=TN | 179=ES | 136=MA | 126=MT | 19=DZ | 62=DK | 91=IS | 201=GB | 185=CH | 184=SE | 142=NL | 26=AT | 33=BE | 80=DE | 119=LU | 96=IE | 133=MC | 76=FR | 20=AD | 117=LI | 174=SK | 61=CZ | 147=NO | 206=VA | 166=SM | 98=IT | 175=SI | 135=ME | 58=HR | 38=BA | 21=AO | 139=NA | 31=BB | 48=CV | 87=GY | 219=GF | 182=SR | 153=PY | 203=UY | 40=BR | 100=JM | 65=DO | 59=CU | 28=BS | 193=TT | 162=KN | 64=DM | 22=AG | 163=LC | 214=AW | 218=VG | 164=VC | 216=MF | 83=GD | 34=BZ | 69=SV | 84=GT | 89=HN | 144=NI | 57=CR | 207=VE | 67=EC | 53=CO | 151=PA | 88=HT | 23=AR | 51=CL | 37=BO | 154=PE | 130=MX | 105=KI | 192=TO | 165=WS | 217=PR | 47=CA | 202=US | 170=RS | 213=CW | 215=BQ | 212=HK
The full name of the country.
The postal or zip code.
A numerical code for the state or province.
Name of the state or province.
A numerical code for the zone or area within the city.
StayDateRange objectrequired
The date range for the hotel stay.
The end date of the stay (ISO 8601 format).
The start date of the stay (ISO 8601 format).
RoomStayCandidatesType objectrequired
The desired room types and occupancy for the stay.
RoomStayCandidates object[]required
A list of potential room stay candidates, each with guest count information and quantity.
GuestCountsType objectrequired
Information about the number of guests in the room stay candidate.
GuestCounts object[]
A list of guest counts, each specifying the number of guests in a particular age category.
The age of the guest (required if AgeQualifyCode=8).
The number of guests of the specified age or age category.
Possible values: [10, 8]
A code indicating the age category of the guest (e.g., adult, child).
AgeQualifyCodeEnum:
10=Adult | 8=Child
The number of rooms requested for this room stay candidate.
Position objectnullable
The geographical position (latitude and longitude) around which to search for hotels.
The latitude coordinate of the location.
The longitude coordinate of the location.
Location objectnullable
The location code (e.g., airport code, city code) and its context to search for hotels.
A code identifying the location (e.g., airport code, city code).
Identifies the context of the identifying code (e.g., IATA, ARC, or internal code).
Radius objectnullable
The maximum distance from the specified location to search for hotels.
The maximum distance from the specified location.
Possible values: [1, 2, 3, 6, 7]
The unit of measure in a code format. Refer to OpenTravel RoomAmenity List Unit of Measure RoomAmenity (UOM).
UnitOfMesureCodeEnum:
1=Miles | 2=Kilometers | 3=Meters | 6=Yards | 7=Feet
Award objectnullable
The award or rating the hotel should have.
The numerical rating of the award.
The name or title of the award.
GetPricesPerGuest objectnullable
Indicates whether prices should be returned per guest.
RatePlanCandidatesType object[]
A list of rate plan candidates, each with its associated information for price calculation.
RatePlanCandidate objectrequired
Information about a potential rate plan candidate for a booking, including group code, promotion code, and rate plan type.
The code associated with a group booking or rate.
A promotional code that may offer a discount or special rate.
An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT).
RatePlanCandidatesType object[]nullable
A list of rate plan candidates to filter the search results.
RatePlanCandidate objectrequired
Information about a potential rate plan candidate for a booking, including group code, promotion code, and rate plan type.
The code associated with a group booking or rate.
A promotional code that may offer a discount or special rate.
An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT).
ProfilesType objectnullable
Profile information for the guests included in the search.
ProfileInfo objectrequired
Information about a user's profile, including a unique identifier.
UniqueID objectrequired
Unique identifier details for the profile, typically referencing a reservation locator or loyalty program number.
The value of the unique identifier (e.g., confirmation number, booking reference).
The type of unique identifier.
TPA_Extensions objectnullable
Additional criteria specific to the Travel Partner Agreement (TPA).
Default value: true
Indicates if the requested rates should include markup (true) or not (false).
Default value: true
Indicates if the requested rates should not include markup (true) or not (false).
Default value: true
Indicates if the requested rates should be package rates (true) or not (false).
Default value: false
Indicates if only preferred hotels should be returned in the search results (true) or not (false).
Default value: false
Indicates if the search should include all room types that fit the occupancy requirements (true) or not (false).
Default value: false
Indicates if the search is from a mobile device (true) or not (false).
Possible values: [1, 3, 10, 12, 14]
Filter resulrs that include the code identifying the meal plan (MPT code).
MealPlanCodeFilterEnum:
1=AllInclusive | 3=BedBreakfast | 10=FullBoard | 12=HalfBoard | 14=RoomOnly
Responses
- 200
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- MOD1
- MOD2
- MOD1
- MOD2
- ]
- MOD1
- MOD2
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- ]
- MOD1
- MOD2
- MOD1
- MOD2
- MOD1
- MOD2
- Array [
- ]
- ]
- Array [
- MOD1
- MOD2
- MOD1
- MOD2
- MOD1
- MOD2
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- ]
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- ]
- Array [
- ]
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Default value: 8
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
The same token received in the request.
The date in ISO format right before the response is sent.
Possible values: [0, 1]
The environment target. The same value received in the request.
TargetEnum:
0=Test | 1=Production
Version of the API being used. The same value received in the request.
Success objectnullable
WarningsType objectnullable
Warnings object[]
Error code associated with the warning.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Short description or summary of the warning.
ErrorsType objectnullable
Errors object[]
Error code associated with the warning.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Short description or summary of the warning.
The maximum number of hotel responses requested.
The page number of the results (for paginated responses).
HotelSearchCriteria objectnullable
Criterion objectrequired
The main search criteria for finding available hotels.
HotelRefs object[]nullable
A list of hotel references to search for.
ChainCode object nullable
The code of the hotel chain (if applicable).
integer
string
The name of the hotel chain (if applicable).
The name of the hotel.
HotelCode object required
The unique code of the hotel.
integer
string
Address objectnullable
The address around which to search for hotels.
The street address or line 1 of the address.
CityCode object nullable
A numerical code for the city.
integer
string
The name of the city.
Possible values: [161, 177, 209, 95, 168, 94, 60, 189, 186, 24, 104, 56, 63, 198, 49, 171, 102, 113, 109, 148, 158, 29, 200, 97, 195, 73, 71, 68, 181, 82, 44, 72, 112, 27, 118, 79, 132, 32, 75, 199, 120, 90, 42, 18, 156, 159, 108, 211, 210, 54, 122, 114, 39, 129, 183, 178, 137, 121, 17, 149, 30, 196, 188, 180, 36, 92, 124, 141, 138, 204, 103, 110, 150, 208, 190, 93, 111, 187, 155, 123, 52, 41, 45, 106, 101, 107, 173, 66, 160, 134, 25, 127, 131, 152, 176, 197, 140, 205, 143, 74, 116, 46, 169, 55, 157, 115, 99, 81, 70, 146, 43, 191, 86, 128, 35, 77, 172, 167, 78, 85, 50, 145, 125, 194, 179, 136, 126, 19, 62, 91, 201, 185, 184, 142, 26, 33, 80, 119, 96, 133, 76, 20, 117, 174, 61, 147, 206, 166, 98, 175, 135, 58, 38, 21, 139, 31, 48, 87, 219, 182, 153, 203, 40, 100, 65, 59, 28, 193, 162, 64, 22, 163, 214, 218, 164, 216, 83, 34, 69, 84, 89, 144, 57, 207, 67, 53, 151, 88, 23, 51, 37, 154, 130, 105, 192, 165, 217, 47, 202, 170, 213, 215, 212]
The three-letter country code (ISO 3166-1 alpha-3).
CountryCodeEnum:
161=RW | 177=SO | 209=YE | 95=IQ | 168=SA | 94=IR | 60=CY | 189=TZ | 186=SY | 24=AM | 104=KE | 56=CD | 63=DJ | 198=UG | 49=CF | 171=SC | 102=JO | 113=LB | 109=KW | 148=OM | 158=QA | 29=BH | 200=AE | 97=IL | 195=TR | 73=ET | 71=ER | 68=EG | 181=SD | 82=GR | 44=BI | 72=EE | 112=LV | 27=AZ | 118=LT | 79=GE | 132=MD | 32=BY | 75=FI | 199=UA | 120=MK | 90=HU | 42=BG | 18=AL | 156=PL | 159=RO | 108=XK | 211=ZW | 210=ZM | 54=KM | 122=MW | 114=LS | 39=BW | 129=MU | 183=SZ | 178=ZA | 137=MZ | 121=MG | 17=AF | 149=PK | 30=BD | 196=TM | 188=TJ | 180=LK | 36=BT | 92=IN | 124=MV | 141=NP | 138=MM | 204=UZ | 103=KZ | 110=KG | 150=PW | 208=VD | 190=TH | 93=ID | 111=LA | 187=TW | 155=PH | 123=MY | 52=CN | 41=BN | 45=KH | 106=KP | 101=JP | 107=KR | 173=SG | 66=TP | 160=RU | 134=MN | 25=AU | 127=MH | 131=FM | 152=PG | 176=SB | 197=TV | 140=NR | 205=VU | 143=NZ | 74=FJ | 116=LY | 46=CM | 169=SN | 55=CG | 157=PT | 115=LR | 99=CI | 81=GH | 70=GQ | 146=NG | 43=BF | 191=TG | 86=GW | 128=MR | 35=BJ | 77=GA | 172=SL | 167=ST | 78=GM | 85=GN | 50=TD | 145=NE | 125=ML | 194=TN | 179=ES | 136=MA | 126=MT | 19=DZ | 62=DK | 91=IS | 201=GB | 185=CH | 184=SE | 142=NL | 26=AT | 33=BE | 80=DE | 119=LU | 96=IE | 133=MC | 76=FR | 20=AD | 117=LI | 174=SK | 61=CZ | 147=NO | 206=VA | 166=SM | 98=IT | 175=SI | 135=ME | 58=HR | 38=BA | 21=AO | 139=NA | 31=BB | 48=CV | 87=GY | 219=GF | 182=SR | 153=PY | 203=UY | 40=BR | 100=JM | 65=DO | 59=CU | 28=BS | 193=TT | 162=KN | 64=DM | 22=AG | 163=LC | 214=AW | 218=VG | 164=VC | 216=MF | 83=GD | 34=BZ | 69=SV | 84=GT | 89=HN | 144=NI | 57=CR | 207=VE | 67=EC | 53=CO | 151=PA | 88=HT | 23=AR | 51=CL | 37=BO | 154=PE | 130=MX | 105=KI | 192=TO | 165=WS | 217=PR | 47=CA | 202=US | 170=RS | 213=CW | 215=BQ | 212=HK
The full name of the country.
The postal or zip code.
A numerical code for the state or province.
Name of the state or province.
A numerical code for the zone or area within the city.
StayDateRange objectrequired
The date range for the hotel stay.
The end date of the stay (ISO 8601 format).
The start date of the stay (ISO 8601 format).
RoomStayCandidatesType objectrequired
The desired room types and occupancy for the stay.
RoomStayCandidates object[]required
A list of potential room stay candidates, each with guest count information and quantity.
GuestCountsType objectrequired
Information about the number of guests in the room stay candidate.
GuestCounts object[]
A list of guest counts, each specifying the number of guests in a particular age category.
The age of the guest (required if AgeQualifyCode=8).
The number of guests of the specified age or age category.
Possible values: [10, 8]
A code indicating the age category of the guest (e.g., adult, child).
AgeQualifyCodeEnum:
10=Adult | 8=Child
The number of rooms requested for this room stay candidate.
Position objectnullable
The geographical position (latitude and longitude) around which to search for hotels.
The latitude coordinate of the location.
The longitude coordinate of the location.
Location objectnullable
The location code (e.g., airport code, city code) and its context to search for hotels.
A code identifying the location (e.g., airport code, city code).
Identifies the context of the identifying code (e.g., IATA, ARC, or internal code).
Radius objectnullable
The maximum distance from the specified location to search for hotels.
The maximum distance from the specified location.
Possible values: [1, 2, 3, 6, 7]
The unit of measure in a code format. Refer to OpenTravel RoomAmenity List Unit of Measure RoomAmenity (UOM).
UnitOfMesureCodeEnum:
1=Miles | 2=Kilometers | 3=Meters | 6=Yards | 7=Feet
Award objectnullable
The award or rating the hotel should have.
The numerical rating of the award.
The name or title of the award.
GetPricesPerGuest objectnullable
Indicates whether prices should be returned per guest.
RatePlanCandidatesType object[]
A list of rate plan candidates, each with its associated information for price calculation.
RatePlanCandidate objectrequired
Information about a potential rate plan candidate for a booking, including group code, promotion code, and rate plan type.
The code associated with a group booking or rate.
A promotional code that may offer a discount or special rate.
An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT).
RatePlanCandidatesType object[]nullable
A list of rate plan candidates to filter the search results.
RatePlanCandidate objectrequired
Information about a potential rate plan candidate for a booking, including group code, promotion code, and rate plan type.
The code associated with a group booking or rate.
A promotional code that may offer a discount or special rate.
An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT).
ProfilesType objectnullable
Profile information for the guests included in the search.
ProfileInfo objectrequired
Information about a user's profile, including a unique identifier.
UniqueID objectrequired
Unique identifier details for the profile, typically referencing a reservation locator or loyalty program number.
The value of the unique identifier (e.g., confirmation number, booking reference).
The type of unique identifier.
TPA_Extensions objectnullable
Additional criteria specific to the Travel Partner Agreement (TPA).
Default value: true
Indicates if the requested rates should include markup (true) or not (false).
Default value: true
Indicates if the requested rates should not include markup (true) or not (false).
Default value: true
Indicates if the requested rates should be package rates (true) or not (false).
Default value: false
Indicates if only preferred hotels should be returned in the search results (true) or not (false).
Default value: false
Indicates if the search should include all room types that fit the occupancy requirements (true) or not (false).
Default value: false
Indicates if the search is from a mobile device (true) or not (false).
Possible values: [1, 3, 10, 12, 14]
Filter resulrs that include the code identifying the meal plan (MPT code).
MealPlanCodeFilterEnum:
1=AllInclusive | 3=BedBreakfast | 10=FullBoard | 12=HalfBoard | 14=RoomOnly
POSType objectnullable
Sources object[]
A list of source information for the point of sale.
Default value: BRA
The pseudo city code (PCC).
The ISO 3166-1 alpha-2 country code.
RequestorID objectnullable
Information about the requestor.
The ID of the requestor.
Possible values: [3, 4, 14, 25]
A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).
UniqueIdTypeEnum:
3=CorporationRepresentative | 4=Company | 14=Reservation | 25=AssociatedReservation
HotelStaysType objectnullable
HotelStays object[]
A list of hotel stays, each containing details about a specific hotel and its associated room stays.
The Rate Plan Header (RPH) number for the associated room stay.
Availability object[]nullable
A list of availability information for the hotel stay, including status and warnings.
The start date (ISO 8601 format) for which the availability information is valid.
The end date (ISO 8601 format) for which the availability information is valid.
Restriction object[]
A list of restrictions that apply to the availability (e.g., minimum stay, closed to arrival).
The time component of the restriction.
Possible values: [0]
The unit of time for the restriction.
TimeUnitEnum:
0=Day
Possible values: [0, 1, 2, 3]
The type of restriction.
RestrictionTypeEnum:
0=MinLOS | 1=MaxLOS | 2=FixedLOS | 3=MinAdvanceBook
TPA_Extensions objectrequired
Additional information or extensions specific to the Travel Partner Agreement (TPA) for the hotel stay.
The code of the supplier providing the hotel stay.
Price objectrequired
Price information for the hotel stay, including start and end dates, amounts, and currency.
The total amount including taxes.
The amount before taxes are applied.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the prices.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
The end date (ISO 8601 format) for which this price is valid.
The start date (ISO 8601 format) for which this price is valid.
BasicPropertyInfo objectrequired
Basic information about the hotel, such as address, contact numbers, awards, amenities, and policies.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') used for prices at this property.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
The URL of an image representing the property.
Award object
A dictionary of awards or ratings for the property, where the key is the award name and the value is the rating.
Address objectrequired
The address of the property.
The street address or line 1 of the address.
CityCode object nullable
A numerical code for the city.
integer
string
The name of the city.
Possible values: [161, 177, 209, 95, 168, 94, 60, 189, 186, 24, 104, 56, 63, 198, 49, 171, 102, 113, 109, 148, 158, 29, 200, 97, 195, 73, 71, 68, 181, 82, 44, 72, 112, 27, 118, 79, 132, 32, 75, 199, 120, 90, 42, 18, 156, 159, 108, 211, 210, 54, 122, 114, 39, 129, 183, 178, 137, 121, 17, 149, 30, 196, 188, 180, 36, 92, 124, 141, 138, 204, 103, 110, 150, 208, 190, 93, 111, 187, 155, 123, 52, 41, 45, 106, 101, 107, 173, 66, 160, 134, 25, 127, 131, 152, 176, 197, 140, 205, 143, 74, 116, 46, 169, 55, 157, 115, 99, 81, 70, 146, 43, 191, 86, 128, 35, 77, 172, 167, 78, 85, 50, 145, 125, 194, 179, 136, 126, 19, 62, 91, 201, 185, 184, 142, 26, 33, 80, 119, 96, 133, 76, 20, 117, 174, 61, 147, 206, 166, 98, 175, 135, 58, 38, 21, 139, 31, 48, 87, 219, 182, 153, 203, 40, 100, 65, 59, 28, 193, 162, 64, 22, 163, 214, 218, 164, 216, 83, 34, 69, 84, 89, 144, 57, 207, 67, 53, 151, 88, 23, 51, 37, 154, 130, 105, 192, 165, 217, 47, 202, 170, 213, 215, 212]
The three-letter country code (ISO 3166-1 alpha-3).
CountryCodeEnum:
161=RW | 177=SO | 209=YE | 95=IQ | 168=SA | 94=IR | 60=CY | 189=TZ | 186=SY | 24=AM | 104=KE | 56=CD | 63=DJ | 198=UG | 49=CF | 171=SC | 102=JO | 113=LB | 109=KW | 148=OM | 158=QA | 29=BH | 200=AE | 97=IL | 195=TR | 73=ET | 71=ER | 68=EG | 181=SD | 82=GR | 44=BI | 72=EE | 112=LV | 27=AZ | 118=LT | 79=GE | 132=MD | 32=BY | 75=FI | 199=UA | 120=MK | 90=HU | 42=BG | 18=AL | 156=PL | 159=RO | 108=XK | 211=ZW | 210=ZM | 54=KM | 122=MW | 114=LS | 39=BW | 129=MU | 183=SZ | 178=ZA | 137=MZ | 121=MG | 17=AF | 149=PK | 30=BD | 196=TM | 188=TJ | 180=LK | 36=BT | 92=IN | 124=MV | 141=NP | 138=MM | 204=UZ | 103=KZ | 110=KG | 150=PW | 208=VD | 190=TH | 93=ID | 111=LA | 187=TW | 155=PH | 123=MY | 52=CN | 41=BN | 45=KH | 106=KP | 101=JP | 107=KR | 173=SG | 66=TP | 160=RU | 134=MN | 25=AU | 127=MH | 131=FM | 152=PG | 176=SB | 197=TV | 140=NR | 205=VU | 143=NZ | 74=FJ | 116=LY | 46=CM | 169=SN | 55=CG | 157=PT | 115=LR | 99=CI | 81=GH | 70=GQ | 146=NG | 43=BF | 191=TG | 86=GW | 128=MR | 35=BJ | 77=GA | 172=SL | 167=ST | 78=GM | 85=GN | 50=TD | 145=NE | 125=ML | 194=TN | 179=ES | 136=MA | 126=MT | 19=DZ | 62=DK | 91=IS | 201=GB | 185=CH | 184=SE | 142=NL | 26=AT | 33=BE | 80=DE | 119=LU | 96=IE | 133=MC | 76=FR | 20=AD | 117=LI | 174=SK | 61=CZ | 147=NO | 206=VA | 166=SM | 98=IT | 175=SI | 135=ME | 58=HR | 38=BA | 21=AO | 139=NA | 31=BB | 48=CV | 87=GY | 219=GF | 182=SR | 153=PY | 203=UY | 40=BR | 100=JM | 65=DO | 59=CU | 28=BS | 193=TT | 162=KN | 64=DM | 22=AG | 163=LC | 214=AW | 218=VG | 164=VC | 216=MF | 83=GD | 34=BZ | 69=SV | 84=GT | 89=HN | 144=NI | 57=CR | 207=VE | 67=EC | 53=CO | 151=PA | 88=HT | 23=AR | 51=CL | 37=BO | 154=PE | 130=MX | 105=KI | 192=TO | 165=WS | 217=PR | 47=CA | 202=US | 170=RS | 213=CW | 215=BQ | 212=HK
The full name of the country.
The postal or zip code.
A numerical code for the state or province.
Name of the state or province.
A numerical code for the zone or area within the city.
HotelRef objectrequired
Reference information for the hotel, including chain code, chain name, hotel code, and hotel name.
ChainCode object nullable
The code of the hotel chain (if applicable).
integer
string
The name of the hotel chain (if applicable).
The name of the hotel.
HotelCode object required
The unique code of the hotel.
integer
string
Position objectrequired
The geographic coordinates (latitude and longitude) of the property.
The latitude coordinate of the location.
The longitude coordinate of the location.
VendorMessagesType objectnullable
A collection of VendorMessages.
VendorMessages object[]required
List of specific message associated with this vendor.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the message.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Description in plain text format.
RoomStaysType objectnullable
Default value: false
Indicates if there are more room stays available (true) or not (false).
RoomStays object[]
A list of room stays for the hotel availability response.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code for the room stay information (e.g., 'EN', 'ES').
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
The Rate Plan Header (RPH) number associated with this room stay.
An RPH number for a warning message related to this room stay (if any).
The availability status of the room stay (e.g., 'Available', 'NotAvailable').
BasicPropertyInfo objectrequired
Basic information about the hotel or property for this room stay.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') used for prices at this property.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
The URL of an image representing the property.
Award object
A dictionary of awards or ratings for the property, where the key is the award name and the value is the rating.
Address objectrequired
The address of the property.
The street address or line 1 of the address.
CityCode object nullable
A numerical code for the city.
integer
string
The name of the city.
Possible values: [161, 177, 209, 95, 168, 94, 60, 189, 186, 24, 104, 56, 63, 198, 49, 171, 102, 113, 109, 148, 158, 29, 200, 97, 195, 73, 71, 68, 181, 82, 44, 72, 112, 27, 118, 79, 132, 32, 75, 199, 120, 90, 42, 18, 156, 159, 108, 211, 210, 54, 122, 114, 39, 129, 183, 178, 137, 121, 17, 149, 30, 196, 188, 180, 36, 92, 124, 141, 138, 204, 103, 110, 150, 208, 190, 93, 111, 187, 155, 123, 52, 41, 45, 106, 101, 107, 173, 66, 160, 134, 25, 127, 131, 152, 176, 197, 140, 205, 143, 74, 116, 46, 169, 55, 157, 115, 99, 81, 70, 146, 43, 191, 86, 128, 35, 77, 172, 167, 78, 85, 50, 145, 125, 194, 179, 136, 126, 19, 62, 91, 201, 185, 184, 142, 26, 33, 80, 119, 96, 133, 76, 20, 117, 174, 61, 147, 206, 166, 98, 175, 135, 58, 38, 21, 139, 31, 48, 87, 219, 182, 153, 203, 40, 100, 65, 59, 28, 193, 162, 64, 22, 163, 214, 218, 164, 216, 83, 34, 69, 84, 89, 144, 57, 207, 67, 53, 151, 88, 23, 51, 37, 154, 130, 105, 192, 165, 217, 47, 202, 170, 213, 215, 212]
The three-letter country code (ISO 3166-1 alpha-3).
CountryCodeEnum:
161=RW | 177=SO | 209=YE | 95=IQ | 168=SA | 94=IR | 60=CY | 189=TZ | 186=SY | 24=AM | 104=KE | 56=CD | 63=DJ | 198=UG | 49=CF | 171=SC | 102=JO | 113=LB | 109=KW | 148=OM | 158=QA | 29=BH | 200=AE | 97=IL | 195=TR | 73=ET | 71=ER | 68=EG | 181=SD | 82=GR | 44=BI | 72=EE | 112=LV | 27=AZ | 118=LT | 79=GE | 132=MD | 32=BY | 75=FI | 199=UA | 120=MK | 90=HU | 42=BG | 18=AL | 156=PL | 159=RO | 108=XK | 211=ZW | 210=ZM | 54=KM | 122=MW | 114=LS | 39=BW | 129=MU | 183=SZ | 178=ZA | 137=MZ | 121=MG | 17=AF | 149=PK | 30=BD | 196=TM | 188=TJ | 180=LK | 36=BT | 92=IN | 124=MV | 141=NP | 138=MM | 204=UZ | 103=KZ | 110=KG | 150=PW | 208=VD | 190=TH | 93=ID | 111=LA | 187=TW | 155=PH | 123=MY | 52=CN | 41=BN | 45=KH | 106=KP | 101=JP | 107=KR | 173=SG | 66=TP | 160=RU | 134=MN | 25=AU | 127=MH | 131=FM | 152=PG | 176=SB | 197=TV | 140=NR | 205=VU | 143=NZ | 74=FJ | 116=LY | 46=CM | 169=SN | 55=CG | 157=PT | 115=LR | 99=CI | 81=GH | 70=GQ | 146=NG | 43=BF | 191=TG | 86=GW | 128=MR | 35=BJ | 77=GA | 172=SL | 167=ST | 78=GM | 85=GN | 50=TD | 145=NE | 125=ML | 194=TN | 179=ES | 136=MA | 126=MT | 19=DZ | 62=DK | 91=IS | 201=GB | 185=CH | 184=SE | 142=NL | 26=AT | 33=BE | 80=DE | 119=LU | 96=IE | 133=MC | 76=FR | 20=AD | 117=LI | 174=SK | 61=CZ | 147=NO | 206=VA | 166=SM | 98=IT | 175=SI | 135=ME | 58=HR | 38=BA | 21=AO | 139=NA | 31=BB | 48=CV | 87=GY | 219=GF | 182=SR | 153=PY | 203=UY | 40=BR | 100=JM | 65=DO | 59=CU | 28=BS | 193=TT | 162=KN | 64=DM | 22=AG | 163=LC | 214=AW | 218=VG | 164=VC | 216=MF | 83=GD | 34=BZ | 69=SV | 84=GT | 89=HN | 144=NI | 57=CR | 207=VE | 67=EC | 53=CO | 151=PA | 88=HT | 23=AR | 51=CL | 37=BO | 154=PE | 130=MX | 105=KI | 192=TO | 165=WS | 217=PR | 47=CA | 202=US | 170=RS | 213=CW | 215=BQ | 212=HK
The full name of the country.
The postal or zip code.
A numerical code for the state or province.
Name of the state or province.
A numerical code for the zone or area within the city.
HotelRef objectrequired
Reference information for the hotel, including chain code, chain name, hotel code, and hotel name.
ChainCode object nullable
The code of the hotel chain (if applicable).
integer
string
The name of the hotel chain (if applicable).
The name of the hotel.
HotelCode object required
The unique code of the hotel.
integer
string
Position objectrequired
The geographic coordinates (latitude and longitude) of the property.
The latitude coordinate of the location.
The longitude coordinate of the location.
VendorMessagesType objectnullable
A collection of VendorMessages.
VendorMessages object[]required
List of specific message associated with this vendor.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the message.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Description in plain text format.
RoomTypes object[]
A list of room types included in this room stay.
The minimum number of guests allowed for this room type.
The maximum number of guests allowed for this room type.
The number of available units of this room type.
The unique identifier for the room type.
The name of the room type.
RoomDescription objectnullable
A description of the room type in multiple languages.
A description of the room type.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Occupancies object[]
A list of occupancy options for this room type, specifying age restrictions and minimum/maximum occupancy.
Possible values: [10, 8]
The age qualifying code for the occupancy (e.g., Adult, Child).
AgeQualifyCodeEnum:
10=Adult | 8=Child
The maximum number of guests allowed for this occupancy type.
The minimum number of guests required for this occupancy type.
RatePlans object[]
A list of rate plans available for this room stay.
The start date (ISO 8601 format) from which the rate plan is valid.
The end date (ISO 8601 format) until which the rate plan is valid.
Indicates if the price for this rate plan is viewable by the customer (true) or not (false).
The unique identifier for the rate plan.
The name or title of the rate plan.
A numerical code representing the type of rate plan.
RatePlanDescription objectnullable
A description of the rate plan, possibly in multiple languages.
A description of the rate plan.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
MealsIncluded objectnullable
Details about meals included in the rate plan.
Indicates whether breakfast is included in the meal plan (true) or not (false).
Indicates whether dinner is included in the meal plan (true) or not (false).
Indicates whether lunch is included in the meal plan (true) or not (false).
Default value: true
Indicates whether a meal plan is associated with the rate (true) or not (false).
Possible values: [1, 3, 10, 12]
The code identifying the meal plan (MPT code).
MealPlanCodeEnum:
1=AllInclusive | 3=BedBreakfast | 10=FullBoard | 12=HalfBoard
The unique identifier for the meal plan.
The name of the meal plan.
A description of the meal plan.
Possible values: [7, 12, 18, 19, 20, 21, 25]
The service pricing type for the meal plan (CHG code).
ServicePricingTypeEnum:
7=PerPerson | 12=PerStay | 18=PerRoomPerStay | 19=PerRoomPerNight | 20=PerPersonPerStay | 21=PerPersonPerNight | 25=PerRoom | 19=PerNight
Price objectnullable
The price information for the meal plan, including amount before and after tax.
The total amount including taxes.
The amount before taxes are applied.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the prices.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
RatePlanInclusions object[]
A list of inclusions offered as part of the rate plan.
The unique identifier for the rate plan inclusion.
The start date (ISO 8601 format) for the inclusion to be valid.
The end date (ISO 8601 format) for the inclusion to be valid.
RatePlanInclusionDesciption objectnullable
Rate Plan descriptions. There is a typo in the field name that was left to not break compatibility with the Omnibees API.
The name of the rate plan inclusion.
A description of the rate plan inclusion.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Guarantees object[]nullable
A list of guarantees associated with the rate plan.
The start date (ISO 8601 format) of the guarantee period.
The end date (ISO 8601 format) of the guarantee period.
A unique code identifying the type of guarantee.
AmountPercent objectnullable
Details about the amount or percentage associated with the guarantee.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount or percentage.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
The fixed amount, if applicable.
The number of nights to which the amount or percentage applies.
The percentage value, if applicable.
Deadline objectnullable
Information about the guarantee deadline.
Possible values: [BeforeArrival, null]
Default value: BeforeArrival
Specifies when the offset time is applied (e.g., 'BeforeArrival').
A multiplier for the time unit of the offset (e.g., 2 for 2 days).
Possible values: [0]
The unit of time for the offset (e.g., 'Day').
TimeUnitEnum:
0=Day
GuaranteeDescription objectnullable
Language-specific descriptions of the guarantee.
The name or title of the guarantee.
A detailed description of the guarantee.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
GuaranteesAcceptedType objectnullable
Information about the types of guarantees accepted.
GuaranteeAccepted object[]
A list of guarantees accepted for the booking.
Possible values: [2, 5, 8, 3, 4, 38]
The type of guarantee accepted (numerical code).
GuaranteeTypeCodeEnum:
2=DirectBill | 5=CreditCard | 8=Deposit | 3=Voucher | 4=PrePay | 38=None
The Rate Plan Header (RPH) associated with the guarantee (if applicable).
A unique identifier for the guarantee.
PaymentCard objectnullable
Details of the payment card used for the guarantee (if applicable).
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]
The code or type of the payment card.
CardCodeTypeEnum:
1=Visa | 2=MasterCard | 3=AmericanExpress | 4=Discover | 5=HiperCard | 6=DinnersClub | 7=JCB | 8=Electron | 9=EuroCard | 10=EnRouteCard | 11=Laser | 12=Maestro | 13=Solo | 14=PayPal | 15=Aura | 16=Liberate | 17=Elo | 18=Hotelcard
The name of the cardholder.
The payment card number.
The expiration date of the payment card (YYYY-MM-DD format).
The card verification code (CVV) or security code.
CancelPenalties object[]nullable
A list of cancellation penalties associated with the rate plan.
The start date (ISO 8601 format) of the cancellation penalty period.
The end date (ISO 8601 format) of the cancellation penalty period.
Indicates if the booking is non-refundable (true) or refundable (false).
PenaltyDescription objectrequired
A description of the cancellation penalty, including the name.
The name or title of the penalty.
A detailed description of the penalty.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Default value: 8
The language code (e.g., 'EN', 'ES') for the penalty description.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
DeadLine objectnullable
The deadline for applying the cancellation penalty.
A multiplier for the time unit in the offset.
Possible values: [0]
The type of time unit for the offset.
TimeUnitEnum:
0=Day
The offset time for the deadline.
Defines the absolute deadline. Either this or the offset attributes may be used.
AmountPercent objectnullable
The amount or percentage of the cancellation penalty.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount or percentage.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
The fixed amount, if applicable.
The number of nights to which the amount or percentage applies.
The percentage value, if applicable.
AmountRule objectnullable
The rule for calculating the cancellation penalty amount.
The fixed amount for the penalty rule.
The start date (ISO 8601 format) for which the rule applies.
The end date (ISO 8601 format) for which the rule applies.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
Commission objectnullable
Information about commissions for the rate plan.
The commission percentage.
TaxPolicies object[]
A list of tax policies applicable to the rate plan.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the tax amount.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
A description of the tax.
The unique identifier for the tax policy.
Indicates whether the tax is applied per night (true) or not (false).
Indicates whether the tax is applied per person (true) or not (false).
Indicates whether the tax is applied per room (true) or not (false).
Indicates whether the tax is applied per stay (true) or not (false).
Indicates whether the tax value is a percentage (true) or a fixed amount (false).
The name of the tax.
The value of the tax, either a percentage or a fixed amount.
AdditionalDetailsType objectnullable
Additional details related to the rate plan.
AdditionalDetails object[]
A list of additional details.
DetailDescription objectrequired
Language-specific description and name for an additional detail.
A description of the additional detail.
The name or title of the additional detail.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
Offers object[]nullable
A list of special offers associated with the rate plan.
The unique code identifying the offer.
The RPH associated with the offer.
OfferRules object[]nullable
A list of rules that apply to the offer.
The maximum number of days in advance a booking can be made for the offer.
The minimum number of days in advance a booking must be made for the offer.
DateRestriction objectnullable
Date restrictions for when the offer is valid.
The start date (ISO 8601 format) for which the restriction applies.
The end date (ISO 8601 format) for which the restriction applies.
LengthsOfStay objectnullable
Restrictions on the minimum or maximum length of stay for the offer.
Default value: true
Indicates if the length of stay restriction is based on the arrival date (true) or not (false).
LengthsOfStay object[]required
A list of length of stay restrictions.
The length of time for the stay restriction. Used in conjunction with the MinMaxMessageType and the TimeUnit to define the length of stay requirements.
Possible values: [0]
The unit of time for the LengthOfStay.
TimeUnitEnum:
0=Day
Possible values: [0, 1]
Indicates whether it's a minimum (0) or maximum (1) length of stay restriction.
LOSTypeEnum:
0=SetMinLOS | 1=SetMaxLOS
Discount objectnullable
Information about any discounts associated with the offer.
Possible values: [18]
Default value: 18
The unit to which the discount applies (e.g., PerRoomPerStay, PerPersonPerNight).
ChargeUnitCodeEnum:
18=PerRoomPerStay
The pattern or structure of the discount (if applicable).
The number of nights that are discounted.
The minimum number of nights required to qualify for the discount.
The percentage of the discount.
CompatibleOffer object[]
A list of offers that are compatible with this offer.
Default value: false
Indicates if the offer is incompatible with other offers (true) or compatible (false).
The Rate Plan Header (RPH) of the compatible offer.
Description objectnullable
A description of the offer in multiple languages.
A description of the offer.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
PaymentPolicies objectnullable
Payment policies applicable to the rate plan.
AcceptedPayments objectnullable
Details about accepted payment methods for the booking.
AcceptedPayment object[]
A list of accepted payment methods for the booking.
Possible values: [2, 5, 8, 3, 4, 38]
The type of guarantee accepted (numerical code).
GuaranteeTypeCodeEnum:
2=DirectBill | 5=CreditCard | 8=Deposit | 3=Voucher | 4=PrePay | 38=None
The Rate Plan Header (RPH) associated with the guarantee (if applicable).
A unique identifier for the guarantee.
PaymentCard objectnullable
Details of the payment card used for the guarantee (if applicable).
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]
The code or type of the payment card.
CardCodeTypeEnum:
1=Visa | 2=MasterCard | 3=AmericanExpress | 4=Discover | 5=HiperCard | 6=DinnersClub | 7=JCB | 8=Electron | 9=EuroCard | 10=EnRouteCard | 11=Laser | 12=Maestro | 13=Solo | 14=PayPal | 15=Aura | 16=Liberate | 17=Elo | 18=Hotelcard
The name of the cardholder.
The payment card number.
The expiration date of the payment card (YYYY-MM-DD format).
The card verification code (CVV) or security code.
TPA_Extensions objectnullable
Additional information or extensions specific to the Travel Partner Agreement (TPA).
POSType object[]nullable
Point of Sale (POS) information related to the rate plan.
Sources object[]
A list of source information for the point of sale.
Default value: BRA
The pseudo city code (PCC).
The ISO 3166-1 alpha-2 country code.
RequestorID objectnullable
Information about the requestor.
The ID of the requestor.
Possible values: [3, 4, 14, 25]
A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).
UniqueIdTypeEnum:
3=CorporationRepresentative | 4=Company | 14=Reservation | 25=AssociatedReservation
The waitlist code for the rate plan.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for prices in the rate plan.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
RoomRates object[]
A list of room rates available for this room stay.
The Rate Plan Header (RPH) number for the room stay candidate.
Check-in date (ISO 8601 format).
Check-out date (ISO 8601 format).
The unique identifier for the rate plan associated with this room rate.
The unique identifier for the room type associated with this room rate.
A promotional code applied to this room rate (if any).
A group code associated with this room rate (if any).
Availability object[]
A list of availability information for the room rate.
The availability status of the room rate (e.g., 'Available', 'NotAvailable').
An RPH number for a warning message related to the room rate availability (if any).
RatesType objectrequired
Details about the different rate types available for this room.
Rates object[]
A list of rate details for the hotel or room type.
The effective date for the rate (ISO 8601 format).
The maximum length of stay allowed for the rate.
The minimum length of stay required for the rate.
The number of available units for the rate.
Unknown, need further details from Omnibees/Niara documentation.
The minimum number of days in advance a booking must be made.
Unknown, need further details from Omnibees/Niara documentation.
Total objectrequired
The total cost information for the rate.
The total cost before taxes.
The total cost after taxes.
Default value: false
Indicates if the amount includes markup (true) or not (false).
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
A numerical code representing the type of charge.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
The status of the rate (e.g., 'Available', 'Closed').
Discount objectnullable
Information about any discounts applied to this room rate.
Possible values: [18]
Default value: 18
The unit to which the discount applies (e.g., PerRoomPerStay, PerPersonPerNight).
ChargeUnitCodeEnum:
18=PerRoomPerStay
The pattern or structure of the discount (if applicable).
The number of nights that are discounted.
The minimum number of nights required to qualify for the discount.
The percentage of the discount.
ServiceRPH object[]
A list of Rate Plan Headers (RPHs) for services included with this room rate.
The Rate Plan Header (RPH) number for the service.
Total objectrequired
The total cost for this room rate, including taxes and fees.
The total cost before taxes.
The total cost after taxes.
Default value: false
Indicates if the amount includes markup (true) or not (false).
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
A numerical code representing the type of charge.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
TPA_Extensions objectnullable
TPA extensions for the room rate total, including the total discount value.
The total discount value applied to the room rate.
TPA_Extensions objectnullable
Additional information or extensions specific to the Travel Partner Agreement (TPA).
Approval number or invoice ID.
Indicates if it's a preferred hotel (True) or not (False).
Indicates if it's exclusive for mobile (True) or not (False).
OccupationFor objectnullable
Occupancy details for the rate.
The number of adults included in the occupation.
The number of children included in the occupation.
Niara code for the room rate. Needed in order to booking service work.
Rates object[]
A list of rate details with TPA extensions.
Possible values: [10, 8]
The age qualifying code for the rate.
AgeQualifyCodeEnum:
10=Adult | 8=Child
The effective date for the rate (ISO 8601 format).
The maximum number of guests applicable for the rate.
The minimum number of guests applicable for the rate.
Total objectrequired
The total cost information for the rate.
The total cost before taxes.
The total cost after taxes.
Default value: false
Indicates if the amount includes markup (true) or not (false).
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
A numerical code representing the type of charge.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
Total objectrequired
The total cost for this room stay, including taxes and fees.
The total cost before taxes.
The total cost after taxes.
Default value: false
Indicates if the amount includes markup (true) or not (false).
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
A numerical code representing the type of charge.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
TPA_Extensions objectnullable
Additional information or extensions specific to the Travel Partner Agreement (TPA).
Approval number or invoice ID.
Indicates if it's a preferred hotel (True) or not (False).
Indicates if it's exclusive for mobile (True) or not (False).
OccupationFor objectnullable
Occupancy details for the rate.
The number of adults included in the occupation.
The number of children included in the occupation.
Niara code for the room rate. Needed in order to booking service work.
Rates object[]
A list of rate details with TPA extensions.
Possible values: [10, 8]
The age qualifying code for the rate.
AgeQualifyCodeEnum:
10=Adult | 8=Child
The effective date for the rate (ISO 8601 format).
The maximum number of guests applicable for the rate.
The minimum number of guests applicable for the rate.
Total objectrequired
The total cost information for the rate.
The total cost before taxes.
The total cost after taxes.
Default value: false
Indicates if the amount includes markup (true) or not (false).
Default value: false
Indicates if the amount is for a package deal (true) or not (false).
A numerical code representing the type of charge.
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the amount.
CurrencyCodeEnum:
1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
Services object[]
A list of services offered by the hotels.
The unique identifier for the service.
A code representing the category of the service.
Possible values: [7, 12, 18, 19, 20, 21, 25]
The pricing type for the service (CHG code).
ServicePricingTypeEnum:
7=PerPerson | 12=PerStay | 18=PerRoomPerStay | 19=PerRoomPerNight | 20=PerPersonPerStay | 21=PerPersonPerNight | 25=PerRoom | 19=PerNight
ServiceDescription object
The name of the service.
A description of the service.
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
The language code (e.g., 'EN', 'ES') for the description.
LanguageCodeEnum:
8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE
The URL of an image representing the service (if available).
Default value: 1
The number of pages for the requested MaxResponses.
{
"PrimaryLangID": 8,
"EchoToken": "string",
"TimeStamp": "string",
"Target": 0,
"Version": 0,
"Success": {},
"WarningsType": {
"Warnings": [
{
"Code": 0,
"Language": 8,
"ShortText": "string"
}
]
},
"ErrorsType": {
"Errors": [
{
"Code": 0,
"Language": 8,
"ShortText": "string"
}
]
},
"MaxResponses": 0,
"PageNumber": 0,
"HotelSearchCriteria": {
"Criterion": {
"HotelRefs": [
{
"ChainCode": 0,
"ChainName": "string",
"HotelName": "string",
"HotelCode": 0
}
],
"Address": {
"AddressLine": "string",
"CityCode": 0,
"CityName": "string",
"CountryCode": 161,
"CountryName": "string",
"PostalCode": "string",
"StateProvCode": 0,
"StateProv": "string",
"ZoneCode": 0
},
"StayDateRange": {
"End": "string",
"Start": "string"
},
"RoomStayCandidatesType": {
"RoomStayCandidates": [
{
"GuestCountsType": {
"GuestCounts": [
{
"Age": 0,
"Count": 0,
"AgeQualifyCode": 10
}
]
},
"Quantity": 0
}
]
},
"Position": {
"Latitude": "string",
"Longitude": "string"
},
"Location": {
"LocationCode": "string",
"CodeContext": "string"
},
"Radius": {
"DistanceMax": 0,
"UnitOfMesureCode": 1
},
"Award": {
"Rating": 0,
"Name": "string"
},
"GetPricesPerGuest": {
"RatePlanCandidatesType": [
{
"RatePlanCandidate": {
"GroupCode": "string",
"PromotionCode": "string",
"RatePlanType": 0
}
}
]
},
"RatePlanCandidatesType": [
{
"RatePlanCandidate": {
"GroupCode": "string",
"PromotionCode": "string",
"RatePlanType": 0
}
}
],
"ProfilesType": {
"ProfileInfo": {
"UniqueID": {
"ID": "string",
"Type": "string"
}
}
},
"TPA_Extensions": {
"AmountIncludingMarkup": true,
"AmountNotIncludingMarkup": true,
"AmountIsPackageRates": true,
"OnlyPreferredHotels": false,
"IncludeAllFittingOccupations": false,
"IsForMobile": false,
"MealPlanId": 1
}
}
},
"POSType": {
"Sources": [
{
"PseudoCityCode": "BRA",
"ISOCountry": "string",
"RequestorID": {
"ID": "string",
"Type": 3
}
}
]
},
"HotelStaysType": {
"HotelStays": [
{
"RoomStayRPH": 0,
"Availability": [
{
"Start": "string",
"End": "string",
"Restriction": [
{
"Time": "string",
"TimeUnit": 0,
"RestrictionType": 0
}
]
}
],
"TPA_Extensions": {
"SupplierCode": "string"
},
"Price": {
"AmountAfterTax": 0,
"AmountBeforeTax": 0,
"CurrencyCode": 1,
"End": "string",
"Start": "string"
},
"BasicPropertyInfo": {
"CurrencyCode": 1,
"ImageURL": "string",
"Award": {},
"Address": {
"AddressLine": "string",
"CityCode": 0,
"CityName": "string",
"CountryCode": 161,
"CountryName": "string",
"PostalCode": "string",
"StateProvCode": 0,
"StateProv": "string",
"ZoneCode": 0
},
"HotelRef": {
"ChainCode": 0,
"ChainName": "string",
"HotelName": "string",
"HotelCode": 0
},
"Position": {
"Latitude": "string",
"Longitude": "string"
},
"VendorMessagesType": {
"VendorMessages": [
{
"Language": 8,
"Description": "string"
}
]
}
}
}
]
},
"RoomStaysType": {
"ModeIndicator": false,
"RoomStays": [
{
"RoomStayLanguage": 8,
"RPH": 0,
"WarningRPH": 0,
"AvailabilityStatus": "string",
"BasicPropertyInfo": {
"CurrencyCode": 1,
"ImageURL": "string",
"Award": {},
"Address": {
"AddressLine": "string",
"CityCode": 0,
"CityName": "string",
"CountryCode": 161,
"CountryName": "string",
"PostalCode": "string",
"StateProvCode": 0,
"StateProv": "string",
"ZoneCode": 0
},
"HotelRef": {
"ChainCode": 0,
"ChainName": "string",
"HotelName": "string",
"HotelCode": 0
},
"Position": {
"Latitude": "string",
"Longitude": "string"
},
"VendorMessagesType": {
"VendorMessages": [
{
"Language": 8,
"Description": "string"
}
]
}
},
"RoomTypes": [
{
"MinOccupancy": 0,
"MaxOccupancy": 0,
"NumberOfUnits": 0,
"RoomID": 0,
"RoomName": "string",
"RoomDescription": {
"Description": "string",
"Language": 8
},
"Occupancies": [
{
"AgeQualifyingCode": 10,
"MaxOccupancy": 0,
"MinOccupancy": 0
}
]
}
],
"RatePlans": [
{
"EffetiveDate": "string",
"ExpireDate": "string",
"PriceViewableInd": true,
"RatePlanID": 0,
"RatePlanName": "string",
"RatePlanTypeCode": 0,
"RatePlanDescription": {
"Description": "string",
"Language": 8
},
"MealsIncluded": {
"Breakfast": true,
"Dinner": true,
"Lunch": true,
"MealPlanIndicator": true,
"MealPlanCode": 1,
"ID": 0,
"Name": "string",
"Description": "string",
"ServicePricingType": 7,
"Price": {
"AmountAfterTax": 0,
"AmountBeforeTax": 0,
"CurrencyCode": 1
}
},
"RatePlanInclusions": [
{
"ID": 0,
"Start": "string",
"End": "string",
"RatePlanInclusionDesciption": {
"Name": "string",
"Description": "string",
"Language": 8
}
}
],
"Guarantees": [
{
"Start": "string",
"End": "string",
"GuaranteeCode": "string",
"AmountPercent": {
"CurrencyCode": 1,
"Amount": 0,
"NmbrOfNights": 0,
"Percent": 0
},
"Deadline": {
"OffsetUnitMultiplier": 0,
"TimeUnitType": 0
},
"GuaranteeDescription": {
"Name": "string",
"Description": "string",
"Language": 8
},
"GuaranteesAcceptedType": {
"GuaranteeAccepted": [
{
"GuaranteeTypeCode": 2,
"RPH": 0,
"GuaranteeID": "string",
"PaymentCard": {
"CardCode": 1,
"CardHolderName": "string",
"CardNumber": "string",
"ExpireDate": "string",
"SeriesCode": "string"
}
}
]
}
}
],
"CancelPenalties": [
{
"Start": "string",
"End": "string",
"NonRefundable": true,
"PenaltyDescription": {
"Name": "string",
"Description": "string",
"Language": 8
},
"DeadLine": {
"OffsetUnitMultiplier": 0,
"TimeUnitType": 0,
"OffsetDropTime": 0,
"AbsoluteDeadline": "string"
},
"AmountPercent": {
"CurrencyCode": 1,
"Amount": 0,
"NmbrOfNights": 0,
"Percent": 0
},
"AmountRule": {
"Amount": 0,
"Start": "string",
"End": "string",
"CurrencyCode": 1
}
}
],
"Commission": {
"Percent": 0
},
"TaxPolicies": [
{
"CurrencyCode": 1,
"Description": "string",
"ID": "string",
"IsPerNight": true,
"IsPerPerson": true,
"IsPerRoom": true,
"IsPerStay": true,
"IsValuePercentage": true,
"Name": "string",
"Value": 0
}
],
"AdditionalDetailsType": {
"AdditionalDetails": [
{
"DetailDescription": {
"Description": "string",
"Name": "string",
"Language": 8
}
}
]
},
"Offers": [
{
"OfferCode": "string",
"RPH": "string",
"OfferRules": [
{
"MaxAdvancedBookingOffset": 0,
"MinAdvancedBookingOffset": 0,
"DateRestriction": {
"Start": "string",
"End": "string"
},
"LengthsOfStay": {
"ArrivalDateBased": true,
"LengthsOfStay": [
{
"Time": 0,
"TimeUnit": 0,
"MinMaxMessageType": 0
}
]
}
}
],
"Discount": {
"ChargeUnitCode": 18,
"DiscountPattern": "string",
"NightsDiscounted": 0,
"NightsRequired": 0,
"Percent": 0
},
"CompatibleOffer": [
{
"IncompatibleOfferInidcator": false,
"OfferRPH": "string"
}
],
"Description": {
"Description": "string",
"Language": 8
}
}
],
"PaymentPolicies": {
"AcceptedPayments": {
"AcceptedPayment": [
{
"GuaranteeTypeCode": 2,
"RPH": 0,
"GuaranteeID": "string",
"PaymentCard": {
"CardCode": 1,
"CardHolderName": "string",
"CardNumber": "string",
"ExpireDate": "string",
"SeriesCode": "string"
}
}
]
}
},
"TPA_Extensions": {
"POSType": [
{
"Sources": [
{
"PseudoCityCode": "BRA",
"ISOCountry": "string",
"RequestorID": {
"ID": "string",
"Type": 3
}
}
]
}
],
"WLCode": "string"
},
"CurrencyCode": 1
}
],
"RoomRates": [
{
"RoomStayCandidateRPH": 0,
"EffectiveDate": "string",
"ExpireDate": "string",
"RatePlanID": 0,
"RoomID": 0,
"PromotionCode": "string",
"GroupCode": "string",
"Availability": [
{
"AvailabilityStatus": "string",
"WarningRPH": 0
}
],
"RatesType": {
"Rates": [
{
"EffectiveDate": "string",
"MaxLOS": 0,
"MinLOS": 0,
"NumberOfUnits": 0,
"StayThrough": 0,
"MinAdvancedBookingOffset": 0,
"FPLOS": "string",
"Total": {
"AmountBeforeTax": 0,
"AmountAfterTax": 0,
"AmountIncludingMarkup": false,
"AmountIsPackage": false,
"ChargeType": 0,
"CurrencyCode": 1
},
"Status": "string"
}
]
},
"Discount": {
"ChargeUnitCode": 18,
"DiscountPattern": "string",
"NightsDiscounted": 0,
"NightsRequired": 0,
"Percent": 0
},
"ServiceRPH": [
{
"RPH": 0
}
],
"Total": {
"AmountBeforeTax": 0,
"AmountAfterTax": 0,
"AmountIncludingMarkup": false,
"AmountIsPackage": false,
"ChargeType": 0,
"CurrencyCode": 1,
"TPA_Extensions": {
"TotalDiscountValue": 0
}
},
"TPA_Extensions": {
"ApprovalInvoiced": 0,
"IsPreferredHotel": true,
"IsExclusiveMobile": true,
"OccupationFor": {
"Adults": 0,
"Childs": 0
},
"SupplierCode": "string",
"Rates": [
{
"AgeQualifyingCode": 10,
"EffectiveDate": "string",
"MaxGuestApplicable": 0,
"MinGuestApplicable": 0,
"Total": {
"AmountBeforeTax": 0,
"AmountAfterTax": 0,
"AmountIncludingMarkup": false,
"AmountIsPackage": false,
"ChargeType": 0,
"CurrencyCode": 1
}
}
]
}
}
],
"Total": {
"AmountBeforeTax": 0,
"AmountAfterTax": 0,
"AmountIncludingMarkup": false,
"AmountIsPackage": false,
"ChargeType": 0,
"CurrencyCode": 1
},
"TPA_Extensions": {
"ApprovalInvoiced": 0,
"IsPreferredHotel": true,
"IsExclusiveMobile": true,
"OccupationFor": {
"Adults": 0,
"Childs": 0
},
"SupplierCode": "string",
"Rates": [
{
"AgeQualifyingCode": 10,
"EffectiveDate": "string",
"MaxGuestApplicable": 0,
"MinGuestApplicable": 0,
"Total": {
"AmountBeforeTax": 0,
"AmountAfterTax": 0,
"AmountIncludingMarkup": false,
"AmountIsPackage": false,
"ChargeType": 0,
"CurrencyCode": 1
}
}
]
}
}
]
},
"Services": [
{
"ID": "string",
"ServiceCategoryCode": "string",
"ServicePricingType": 7,
"ServiceDescription": {
"Name": "string",
"Description": "string",
"Language": 8,
"ImageURL": "string"
}
}
],
"TotalPages": 1
}