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

PrimaryLangID LanguageCodeEnum

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

EchoToken stringnullable

An arbitrary string returned in the response for tracking/debugging.

TimeStamp stringrequired

The date and time (ISO format) just before the request is sent.

Target TargetEnumrequired

Possible values: [0, 1]

The target environment for this request. TargetEnum: 0=Test | 1=Production

Version number

Default value: 1

The version number of this request format.

MaxResponses integernullable

Default value: 100

The number of hotels to search to.

PageNumber integernullable

The page number for paginated results.

AvailRatesOnly boolean

Default value: true

Indicates whether to return only hotels with available rates (true) or all hotels (false).

BestOnly boolean

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).

OnRequestInd booleannullable

Indicates whether availability is requested on request (true) or not (false).

IsModify booleannullable

Indicates whether this is a request to modify an existing booking (true) or not (false).

RequestedCurrency CurrencyCodeEnum

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.

Array [

PseudoCityCode stringnullable

Default value: BRA

The pseudo city code (PCC).

ISOCountry stringnullable

The ISO 3166-1 alpha-2 country code.

RequestorID objectnullable

Information about the requestor.

ID stringnullable

The ID of the requestor.

Type UniqueIdTypeEnumnullable

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

AvailableOnlyIndicator booleannullable

Indicates whether to return only hotels with available rates (true).

Criterion objectrequired

The main search criteria for finding available hotels.

Address objectnullable

The address around which to search for hotels.

AddressLine stringnullable

The street address or line 1 of the address.

CityCode object nullable

A numerical code for the city.

oneOf

MOD1
MOD2

integer

CityName stringnullable

The name of the city.

CountryCode CountryCodeEnumnullable

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

CountryName stringnullable

The full name of the country.

PostalCode stringnullable

The postal or zip code.

StateProvCode integernullable

A numerical code for the state or province.

StateProv stringnullable

Name of the state or province.

ZoneCode integernullable

A numerical code for the zone or area within the city.

Award objectnullable

The award or rating the hotel should have.

Rating integerrequired

The numerical rating of the award.

Name stringnullable

The name or title of the award.

GetPricesPerGuest boolean

Default value: false

When true rate prices has guest individual prices in tpa extensions. Not implementted!

HotelRefs object[]nullable

A list of hotel references to search for.

Array [

BrandName object nullable

The brand of the hotel (if applicable).

oneOf

MOD1
MOD2

integer

ChainCode object nullable

The code of the hotel chain (if applicable).

oneOf

MOD1
MOD2

integer

ChainName stringnullable

The name of the hotel chain (if applicable).

HotelCode object required

The unique code of the hotel.

oneOf

MOD1
MOD2

integer

HotelName stringnullable

The name of the hotel.

]

Position objectnullable

The geographical position (latitude and longitude) around which to search for hotels.

Latitude stringnullable

The latitude coordinate of the location.

Longitude stringnullable

The longitude coordinate of the location.

Location objectnullable

The location code (e.g., airport code, city code) and its context to search for hotels.

LocationCode stringrequired

A code identifying the location (e.g., airport code, city code).

CodeContext stringrequired

Identifies the context of the identifying code (e.g., IATA, ARC, or internal code).

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.

ID stringrequired

Unique identifier.

Type UniqueIDCodeEnumrequired

Possible values: [14, 25]

Type of the identifier. UniqueIDCodeEnum: 14=Reservation | 25=AssociatedReservation

Reason stringnullable

Reason or context for the identifier, if any.

Radius objectnullable

The maximum distance from the specified location to search for hotels.

DistanceMax integerrequired

The maximum distance from the specified location.

UnitOfMesureCode UnitOfMesureCodeEnumrequired

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

RatePlanCandidatesType object[]nullable

A list of rate plan candidates to filter the search results.

Array [

RatePlanCandidate objectrequired

Information about a potential rate plan candidate for a booking, including group code, promotion code, and rate plan type.

GroupCode stringnullable

The code associated with a group booking or rate.

PromotionCode stringnullable

A promotional code that may offer a discount or special rate.

RatePlanType integernullable

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).

]

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.

Array [

BookingCode integernullable

Preencher algo aqui.

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.

Array [

Age integernullable

The age of the guest (required if AgeQualifyCode=8).

AgeQualifyCode AgeQualifyCodeEnumrequired

Possible values: [10, 8, 7]

A code indicating the age category of the guest (e.g., adult, child). AgeQualifyCodeEnum: 10=Adult | 8=Child | 7=Infant

Count integerrequired

The number of guests of the specified age or age category.

ResGuestRPH integernullable

The Rate Plan Header (RPH) number for the service.

]

Quantity integerrequired

The number of rooms requested for this room stay candidate.

RPH integernullable

The Rate Plan Header (RPH) number for the service.

RoomID integernullable

The unique identifier for the room type.

]

StayDateRange objectrequired

The date range for the hotel stay.

Duration integernullable

The duration of the stay in days.

End stringrequired

The end date of the stay (ISO 8601 format).

Start stringrequired

The start date of the stay (ISO 8601 format).

TPA_Extensions objectnullable

Additional criteria specific to the Travel Partner Agreement (TPA).

AmountIncludingMarkup booleannullable

Default value: true

Indicates if the requested rates should include markup (true) or not (false).

AmountIsPackageRates booleannullable

Indicates if the requested rates should be package rates (true) or not (false).

AmountNotIncludingMarkup booleannullable

Indicates if the requested rates should not include markup (true) or not (false).

BestOnlyWithTaxes boolean

Default value: true

When true indicate that response should include taxes in best price (Best Only). Default is true.

IsForMobile booleannullable

Indicates if the search is from a mobile device (true) or not (false).

MealPlanId MealPlanCodeFilterEnumnullable

Possible values: [1, 3, 10, 12, 14]

Filter results that include the code identifying the meal plan (MPT code). MealPlanCodeFilterEnum: 1=AllInclusive | 3=BedBreakfast | 10=FullBoard | 12=HalfBoard | 14=RoomOnly

MultimediaObjects objectnullable

Control the multimidia data in the response. Not yet implemented.

SendData boolean

Default value: true

Send multimidia data if true.

OnlyPreferredHotels boolean

Default value: false

Indicates if only preferred hotels should be returned in the search results (true) or not (false).

RatePlanIds integer[]nullable

Used to filter source data based on RatePlan IDs. Default is null. Not yet implemented.

RateRoomIds object[]nullable

Used to filter source data based on pairs RatePlan IDs RoomType Ids. Default is null. Not yet implemented.

Array [

RatePlanId integernullable

Used to filter source data based on RatePlan IDs. Default is null.

RoomTypeId integernullable

Used to filter source data based on RoomType IDs. Default is null.

]

RoomTypeIds integer[]nullable

Used to filter source data based on RoomType IDs. Default is null. Not yet implemented.

Responses

application/json

Schema
Example (from schema)

Schema

EchoToken stringnullable

The same token received in the request.

ErrorsType objectnullable

Errors object[]

Array [

Code integerrequired

Error code associated with the warning.

Language LanguageCodeEnumrequired

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

ShortText stringrequired

Short description or summary of the warning.

]

PrimaryLangID LanguageCodeEnum

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

Success objectnullable

property name* string

Target TargetEnumrequired

Possible values: [0, 1]

The environment target. The same value received in the request. TargetEnum: 0=Test | 1=Production

TimeStamp stringrequired

The date in ISO format right before the response is sent.

Version numberrequired

Version of the API being used. The same value received in the request.

WarningsType objectnullable

Warnings object[]

Array [

Code integerrequired

Error code associated with the warning.

Language LanguageCodeEnumrequired

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

ShortText stringrequired

Short description or summary of the warning.

]

Criteria objectnullable

AvailableOnlyIndicator booleannullable

Indicates whether to return only hotels with available rates (true).

Criterion objectrequired

The main search criteria for finding available hotels.

Address objectnullable

The address around which to search for hotels.

AddressLine stringnullable

The street address or line 1 of the address.

CityCode object nullable

A numerical code for the city.

oneOf

MOD1
MOD2

integer

CityName stringnullable

The name of the city.

CountryCode CountryCodeEnumnullable

CountryName stringnullable

The full name of the country.

PostalCode stringnullable

The postal or zip code.

StateProvCode integernullable

A numerical code for the state or province.

StateProv stringnullable

Name of the state or province.

ZoneCode integernullable

A numerical code for the zone or area within the city.

Award objectnullable

The award or rating the hotel should have.

Rating integerrequired

The numerical rating of the award.

Name stringnullable

The name or title of the award.

GetPricesPerGuest boolean

Default value: false

When true rate prices has guest individual prices in tpa extensions. Not implementted!

HotelRefs object[]nullable

A list of hotel references to search for.

Array [

BrandName object nullable

The brand of the hotel (if applicable).

oneOf

MOD1
MOD2

integer

ChainCode object nullable

The code of the hotel chain (if applicable).

oneOf

MOD1
MOD2

integer

ChainName stringnullable

The name of the hotel chain (if applicable).

HotelCode object required

The unique code of the hotel.

oneOf

MOD1
MOD2

integer

HotelName stringnullable

The name of the hotel.

]

Position objectnullable

The geographical position (latitude and longitude) around which to search for hotels.

Latitude stringnullable

The latitude coordinate of the location.

Longitude stringnullable

The longitude coordinate of the location.

Location objectnullable

The location code (e.g., airport code, city code) and its context to search for hotels.

LocationCode stringrequired

A code identifying the location (e.g., airport code, city code).

CodeContext stringrequired

Identifies the context of the identifying code (e.g., IATA, ARC, or internal code).

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.

ID stringrequired

Unique identifier.

Type UniqueIDCodeEnumrequired

Possible values: [14, 25]

Type of the identifier. UniqueIDCodeEnum: 14=Reservation | 25=AssociatedReservation

Reason stringnullable

Reason or context for the identifier, if any.

Radius objectnullable

The maximum distance from the specified location to search for hotels.

DistanceMax integerrequired

The maximum distance from the specified location.

UnitOfMesureCode UnitOfMesureCodeEnumrequired

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

RatePlanCandidatesType object[]nullable

A list of rate plan candidates to filter the search results.

Array [

RatePlanCandidate objectrequired

Information about a potential rate plan candidate for a booking, including group code, promotion code, and rate plan type.

GroupCode stringnullable

The code associated with a group booking or rate.

PromotionCode stringnullable

A promotional code that may offer a discount or special rate.

RatePlanType integernullable

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).

]

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.

Array [

BookingCode integernullable

Preencher algo aqui.

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.

Array [

Age integernullable

The age of the guest (required if AgeQualifyCode=8).

AgeQualifyCode AgeQualifyCodeEnumrequired

Possible values: [10, 8, 7]

A code indicating the age category of the guest (e.g., adult, child). AgeQualifyCodeEnum: 10=Adult | 8=Child | 7=Infant

Count integerrequired

The number of guests of the specified age or age category.

ResGuestRPH integernullable

The Rate Plan Header (RPH) number for the service.

]

Quantity integerrequired

The number of rooms requested for this room stay candidate.

RPH integernullable

The Rate Plan Header (RPH) number for the service.

RoomID integernullable

The unique identifier for the room type.

]

StayDateRange objectrequired

The date range for the hotel stay.

Duration integernullable

The duration of the stay in days.

End stringrequired

The end date of the stay (ISO 8601 format).

Start stringrequired

The start date of the stay (ISO 8601 format).

TPA_Extensions objectnullable

Additional criteria specific to the Travel Partner Agreement (TPA).

AmountIncludingMarkup booleannullable

Default value: true

Indicates if the requested rates should include markup (true) or not (false).

AmountIsPackageRates booleannullable

Indicates if the requested rates should be package rates (true) or not (false).

AmountNotIncludingMarkup booleannullable

Indicates if the requested rates should not include markup (true) or not (false).

BestOnlyWithTaxes boolean

Default value: true

When true indicate that response should include taxes in best price (Best Only). Default is true.

IsForMobile booleannullable

Indicates if the search is from a mobile device (true) or not (false).

MealPlanId MealPlanCodeFilterEnumnullable

Possible values: [1, 3, 10, 12, 14]

Filter results that include the code identifying the meal plan (MPT code). MealPlanCodeFilterEnum: 1=AllInclusive | 3=BedBreakfast | 10=FullBoard | 12=HalfBoard | 14=RoomOnly

MultimediaObjects objectnullable

Control the multimidia data in the response. Not yet implemented.

SendData boolean

Default value: true

Send multimidia data if true.

OnlyPreferredHotels boolean

Default value: false

Indicates if only preferred hotels should be returned in the search results (true) or not (false).

RatePlanIds integer[]nullable

Used to filter source data based on RatePlan IDs. Default is null. Not yet implemented.

RateRoomIds object[]nullable

Used to filter source data based on pairs RatePlan IDs RoomType Ids. Default is null. Not yet implemented.

Array [

RatePlanId integernullable

Used to filter source data based on RatePlan IDs. Default is null.

RoomTypeId integernullable

Used to filter source data based on RoomType IDs. Default is null.

]

RoomTypeIds integer[]nullable

Used to filter source data based on RoomType IDs. Default is null. Not yet implemented.

HotelStaysType objectnullable

HotelStays object[]

A list of hotel stays, each containing details about a specific hotel and its associated room stays.

Array [

Availability object[]nullable

A list of availability information for the hotel stay, including status and warnings.

Array [

Start stringrequired

The start date (ISO 8601 format) for which the availability information is valid.

End stringrequired

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).

Array [

Time stringrequired

The time component of the restriction.

TimeUnit TimeUnitEnumrequired

Possible values: [0]

The unit of time for the restriction. TimeUnitEnum: 0=Day

RestrictionType RestrictionTypeEnumrequired

Possible values: [0, 1, 2, 3]

The type of restriction. RestrictionTypeEnum: 0=MinLOS | 1=MaxLOS | 2=FixedLOS | 3=MinAdvanceBook

]

BasicPropertyInfo objectrequired

Basic information about the hotel, such as address, contact numbers, awards, amenities, and policies.

CurrencyCode CurrencyCodeEnumnullable

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

ImageURL stringnullable

The URL of an image representing the property.

Award objectnullable

A dictionary of awards or ratings for the property, where the key is the award name and the value is the rating.

Rating integerrequired

The numerical rating of the award.

Name stringnullable

The name or title of the award.

Address objectnullable

The address of the property.

AddressLine stringnullable

The street address or line 1 of the address.

CityCode object nullable

A numerical code for the city.

oneOf

MOD1
MOD2

integer

CityName stringnullable

The name of the city.

CountryCode CountryCodeEnumnullable

CountryName stringnullable

The full name of the country.

PostalCode stringnullable

The postal or zip code.

StateProvCode integernullable

A numerical code for the state or province.

StateProv stringnullable

Name of the state or province.

ZoneCode integernullable

A numerical code for the zone or area within the city.

HotelRef objectnullable

Reference information for the hotel, including chain code, chain name, hotel code, and hotel name.

BrandName object nullable

The brand of the hotel (if applicable).

oneOf

MOD1
MOD2

integer

ChainCode object nullable

The code of the hotel chain (if applicable).

oneOf

MOD1
MOD2

integer

ChainName stringnullable

The name of the hotel chain (if applicable).

HotelCode object required

The unique code of the hotel.

oneOf

MOD1
MOD2

integer

HotelName stringnullable

The name of the hotel.

Position objectnullable

The geographic coordinates (latitude and longitude) of the property.

Latitude stringnullable

The latitude coordinate of the location.

Longitude stringnullable

The longitude coordinate of the location.

VendorMessagesType objectnullable

A collection of VendorMessages.

VendorMessages object[]required

List of specific message associated with this vendor.

Array [

Language LanguageCodeEnumrequired

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 stringrequired

Description in plain text format.

]

Price objectrequired

Price information for the hotel stay, including start and end dates, amounts, and currency.

AmountAfterTax numberrequired

The total amount including taxes.

AmountBeforeTax numberrequired

The amount before taxes are applied.

CurrencyCode CurrencyCodeEnumrequired

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

End stringnullable

The end date (ISO 8601 format) for which this price is valid.

Start stringnullable

The start date (ISO 8601 format) for which this price is valid.

Duration stringnullable

The duration for which this price is valid.

RoomStayRPH integerrequired

The Rate Plan Header (RPH) number for the associated room stay.

Status string

Default value: Open

Used to specify an availability status at the Hotel Stay level for a property.

TPA_Extensions objectrequired

Additional information or extensions specific to the Travel Partner Agreement (TPA) for the hotel stay.

SupplierCode stringnullable

The code of the supplier providing the hotel stay.

]

MaxResponses integernullable

The maximum number of hotel responses requested.

POS objectnullable

Sources object[]

A list of source information for the point of sale.

Array [

PseudoCityCode stringnullable

Default value: BRA

The pseudo city code (PCC).

ISOCountry stringnullable

The ISO 3166-1 alpha-2 country code.

RequestorID objectnullable

Information about the requestor.

ID stringnullable

The ID of the requestor.

Type UniqueIdTypeEnumnullable

Possible values: [3, 4, 14, 25]

]

PageNumber integernullable

The page number of the results (for paginated responses).

RoomStaysType objectnullable

MoreIndicator boolean

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.

Array [

AvailabilityStatus stringnullable

The availability status of the room stay (e.g., 'Available', 'NotAvailable').

BasicPropertyInfo objectrequired

Basic information about the hotel or property for this room stay.

CurrencyCode CurrencyCodeEnumnullable

ImageURL stringnullable

The URL of an image representing the property.

Award objectnullable

A dictionary of awards or ratings for the property, where the key is the award name and the value is the rating.

Rating integerrequired

The numerical rating of the award.

Name stringnullable

The name or title of the award.

Address objectnullable

The address of the property.

AddressLine stringnullable

The street address or line 1 of the address.

CityCode object nullable

A numerical code for the city.

oneOf

MOD1
MOD2

integer

CityName stringnullable

The name of the city.

CountryCode CountryCodeEnumnullable

CountryName stringnullable

The full name of the country.

PostalCode stringnullable

The postal or zip code.

StateProvCode integernullable

A numerical code for the state or province.

StateProv stringnullable

Name of the state or province.

ZoneCode integernullable

A numerical code for the zone or area within the city.

HotelRef objectnullable

Reference information for the hotel, including chain code, chain name, hotel code, and hotel name.

BrandName object nullable

The brand of the hotel (if applicable).

oneOf

MOD1
MOD2

integer

ChainCode object nullable

The code of the hotel chain (if applicable).

oneOf

MOD1
MOD2

integer

ChainName stringnullable

The name of the hotel chain (if applicable).

HotelCode object required

The unique code of the hotel.

oneOf

MOD1
MOD2

integer

HotelName stringnullable

The name of the hotel.

Position objectnullable

The geographic coordinates (latitude and longitude) of the property.

Latitude stringnullable

The latitude coordinate of the location.

Longitude stringnullable

The longitude coordinate of the location.

VendorMessagesType objectnullable

A collection of VendorMessages.

VendorMessages object[]required

List of specific message associated with this vendor.

Array [

Language LanguageCodeEnumrequired

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 stringrequired

Description in plain text format.

]

RPH integer

The Rate Plan Header (RPH) number associated with this room stay.

RatePlans object[]

A list of rate plans available for this room stay.

Array [

AdditionalDetailsType objectnullable

Additional details related to the rate plan.

AdditionalDetails object[]

A list of additional details.

Array [

DetailDescription objectrequired

Language-specific description and name for an additional detail.

Description stringnullable

A description of the additional detail.

Name stringrequired

The name or title of the additional detail.

Language LanguageCodeEnumrequired

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

]

EffectiveDate stringnullable

The start date (ISO 8601 format) from which the rate plan is valid.

ExpireDate stringnullable

The end date (ISO 8601 format) until which the rate plan is valid.

PriceViewableInd boolean

Default value: true

Indicates if the price for this rate plan is viewable by the customer (true) or not (false).

RatePlanID integernullable

The unique identifier for the rate plan.

RatePlanName stringnullable

The name or title of the rate plan.

RatePlanTypeCode integernullable

A numerical code representing the type of rate plan.

RatePlanDescription objectnullable

A description of the rate plan, possibly in multiple languages.

Description stringnullable

The description of the rate plan.

Language LanguageCodeEnumrequired

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.

Breakfast booleanrequired

Indicates whether breakfast is included in the meal plan (true) or not (false).

Dinner booleanrequired

Indicates whether dinner is included in the meal plan (true) or not (false).

Lunch booleanrequired

Indicates whether lunch is included in the meal plan (true) or not (false).

MealPlanIndicator boolean

Default value: true

Indicates whether a meal plan is associated with the rate (true) or not (false).

MealPlanCode MealPlanCodeEnumrequired

Possible values: [1, 3, 10, 12]

The code identifying the meal plan (MPT code). MealPlanCodeEnum: 1=AllInclusive | 3=BedBreakfast | 10=FullBoard | 12=HalfBoard

ID integernullable

The unique identifier for the meal plan.

Name stringnullable

The name of the meal plan.

Description stringnullable

A description of the meal plan.

ServicePricingType ServicePricingTypeEnum

Possible values: [7, 12, 18, 19, 20, 21, 25]

Default value: 21

Price objectnullable

The price information for the meal plan, including amount before and after tax.

AmountAfterTax numberrequired

The total amount including taxes.

AmountBeforeTax numberrequired

The amount before taxes are applied.

CurrencyCode CurrencyCodeEnumrequired

End stringnullable

The end date (ISO 8601 format) for which this price is valid.

Start stringnullable

The start date (ISO 8601 format) for which this price is valid.

Duration stringnullable

The duration for which this price is valid.

RatePlanInclusions object[]

A list of inclusions offered as part of the rate plan.

Array [

ID integerrequired

The unique identifier for the rate plan inclusion.

Start stringnullable

The start date (ISO 8601 format) for the inclusion to be valid.

End stringnullable

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.

Name stringnullable

The name of the rate plan inclusion.

Description stringnullable

A description of the rate plan inclusion.

Language LanguageCodeEnumrequired

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.

Array [

Start stringnullable

The start date (ISO 8601 format) of the guarantee period.

End stringnullable

The end date (ISO 8601 format) of the guarantee period.

GuaranteeCode stringnullable

A unique code identifying the type of guarantee.

AmountPercent objectnullable

Details about the amount or percentage associated with the guarantee.

Amount numbernullable

The fixed amount, if applicable.

CurrencyCode CurrencyCodeEnumrequired

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

NmbrOfNights integernullable

The number of nights to which the amount or percentage applies.

Percent numbernullable

The percentage value, if applicable.

DeadLine objectnullable

Information about the guarantee deadline.

OffsetDropTime OffsetDropTimeEnum

Possible values: [0]

Specifies whether the deadline offset is applied 'BeforeArrival'. OffsetDropTimeEnum: 0=BeforeArrival

OffsetUnitMultiplier integernullable

A multiplier for the time unit (e.g., 2 for 2 days).

TimeUnitType TimeUnitEnumnullable

Possible values: [0]

The unit of time for the offset. TimeUnitEnum: 0=Day

GuaranteeDescription objectnullable

Language-specific descriptions of the guarantee.

Language LanguageCodeEnumrequired

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

The language code (e.g., 'EN', 'ES') for the guarantee description. LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

Name stringrequired

The name or title of the guarantee.

Description stringnullable

A detailed description of the guarantee in the specified language.

GuaranteesAcceptedType objectnullable

Information about the types of guarantees accepted.

GuaranteesAccepted object[]

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 18, 19, 29, 24, 30, 98, 99, 38, 100, 101]

RPH integernullable

Provides a reference to a specific form of payment.

GuaranteeID stringnullable

A unique identifier for the guarantee.

PaymentCard objectnullable

Details of the payment card used for the guarantee (if applicable).

CardCode CardCodeTypeEnumrequired

Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]

CardHolderName stringrequired

The name of the cardholder.

CardNumber stringrequired

The payment card number.

ExpireDate stringnullable

The expiration date of the payment card (YYYY-MM-DD format).

SeriesCode stringrequired

The card verification code (CVV) or security code.

Extras object[]nullable

A list of extras that can be included.

Array [

ID stringrequired

The identifier of the extra inclusion.

Description stringnullable

Description of the extra inclusion.

]

CurrencyCode CurrencyCodeEnumnullable

The currency code (e.g., 'USD', 'EUR') for the price. 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

Amount numbernullable

Amount that will be billed for the given guarantee.

ExchangeRate numbernullable

Exchange rate applied in the transaction.

ExchangeCurrencyCode CurrencyCodeEnumnullable

The exchange currency code (e.g., 'USD', 'EUR') for the price. This represents the booked item currency. 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

ExchangeAmount numbernullable

Amount in the item currency.

]

CancelPenalties object[]nullable

A list of cancellation penalties associated with the rate plan.

Array [

NonRefundable booleanrequired

Indicates whether the booking is non-refundable (true) or refundable (false).

AmountPercent objectnullable

Details about the amount or percentage of the penalty.

Amount numbernullable

The fixed amount, if applicable.

CurrencyCode CurrencyCodeEnumrequired

NmbrOfNights integernullable

The number of nights to which the amount or percentage applies.

Percent numbernullable

The percentage value, if applicable.

AmountRules object[]nullable

Details about a fixed amount penalty rule.

Array [

Amount numberrequired

The fixed amount for the penalty rule.

End stringrequired

The end date (ISO 8601 format) for which the rule applies.

Start stringrequired

The start date (ISO 8601 format) for which the rule applies.

CurrencyCode CurrencyCodeEnumnullable

The currency code (e.g., 'USD', 'EUR') for the amount, if applicable. 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

]

DeadLine objectnullable

Information about the penalty deadline.

OffsetDropTime OffsetDropTimeEnum

Possible values: [0]

The offset time for the penalty deadline. OffsetDropTimeEnum: 0=BeforeArrival

OffsetUnitMultiplier integerrequired

A multiplier for the offset time unit.

TimeUnitType TimeUnitEnumrequired

Possible values: [0]

The type of time unit for the offset. TimeUnitEnum: 0=Day

AbsoluteDeadline stringnullable

The absolute deadline date (ISO 8601 format), if applicable.

Duration stringnullable

The duration of the cancellation penalty period.

End stringnullable

The end date (ISO 8601 format) of the penalty period.

PenaltyDescription objectrequired

Language-specific descriptions of the penalty.

Language LanguageCodeEnumrequired

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

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

Name stringrequired

The name or title of the penalty.

Description stringnullable

A detailed description of the penalty in the specified language.

Start stringnullable

The start date (ISO 8601 format) of the penalty period.

]

Commission objectnullable

Information about commissions for the rate plan.

Percent numberrequired

The commission percentage.

TaxPolicies object[]

A list of tax policies applicable to the rate plan.

Array [

CurrencyCode CurrencyCodeEnumrequired

The currency code (e.g., 'USD', 'EUR') for the tax. 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

Description stringnullable

A description of the tax.

ID stringrequired

The unique identifier for the tax policy.

IsPerNight booleanrequired

Indicates if the tax is applied per night (True) or not (False).

IsPerPerson booleanrequired

Indicates if the tax is applied per person (True) or not (False).

IsPerRoom booleanrequired

Indicates if the tax is applied per room (True) or not (False).

IsPerStay booleanrequired

Indicates if the tax is applied per stay (True) or not (False).

IsValuePercentage booleanrequired

Indicates if the tax value is a percentage (True) or a fixed amount (False).

Name stringrequired

The name of the tax.

Value numberrequired

The value of the tax (percentage or fixed amount).

]

Offers object[]nullable

A list of special offers associated with the rate plan.

Array [

OfferCode stringrequired

The unique code identifying the offer.

RPH stringrequired

The RPH associated with the offer.

OfferRules object[]nullable

A list of rules that apply to the offer.

Array [

MaxAdvancedBookingOffset integernullable

The maximum number of days in advance a booking can be made for the offer.

MinAdvancedBookingOffset integernullable

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.

Start stringrequired

The start date (ISO 8601 format) of the date restriction.

End stringrequired

The end date (ISO 8601 format) of the date restriction.

LengthsOfStay objectnullable

Restrictions on the minimum or maximum length of stay for the offer.

ArrivalDateBased boolean

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.

Array [

Time integerrequired

The length of time for the stay restriction. Used in conjunction with the MinMaxMessageType and the TimeUnit to define the length of stay requirements.

TimeUnit TimeUnitEnum

Possible values: [0]

The unit of time for the LengthOfStay. TimeUnitEnum: 0=Day

MinMaxMessageType LOSTypeEnum

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.

ChargeUnitCode ChargeUnitCodeEnum

Possible values: [18]

Default value: 18

The unit to which the discount applies (e.g., PerRoomPerStay, PerPersonPerNight). ChargeUnitCodeEnum: 18=PerRoomPerStay

DiscountPattern stringnullable

The pattern or structure of the discount (if applicable).

NightsDiscounted integernullable

The number of nights that are discounted.

NightsRequired integernullable

The minimum number of nights required to qualify for the discount.

Percent numbernullable

The percentage of the discount.

CompatibleOffer object[]

A list of offers that are compatible with this offer.

Array [

IncompatibleOfferInidcator boolean

Default value: false

Indicates if the offer is incompatible with others (true) or compatible (false).

OfferRPH string[]required

References the other offer(s) with which this offer may be used.

]

Description objectnullable

A description of the offer in multiple languages.

Description stringrequired

The description of the offer.

Language LanguageCodeEnumrequired

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 object[]

A list of accepted payment guarantees.

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 18, 19, 29, 24, 30, 98, 99, 38, 100, 101]

RPH integernullable

Provides a reference to a specific form of payment.

GuaranteeID stringnullable

A unique identifier for the guarantee.

PaymentCard objectnullable

Details of the payment card used for the guarantee (if applicable).

CardCode CardCodeTypeEnumrequired

Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]

CardHolderName stringrequired

The name of the cardholder.

CardNumber stringrequired

The payment card number.

ExpireDate stringnullable

The expiration date of the payment card (YYYY-MM-DD format).

SeriesCode stringrequired

The card verification code (CVV) or security code.

Extras object[]nullable

A list of extras that can be included.

Array [

ID stringrequired

The identifier of the extra inclusion.

Description stringnullable

Description of the extra inclusion.

]

CurrencyCode CurrencyCodeEnumnullable

Amount numbernullable

Amount that will be billed for the given guarantee.

ExchangeRate numbernullable

Exchange rate applied in the transaction.

ExchangeCurrencyCode CurrencyCodeEnumnullable

ExchangeAmount numbernullable

Amount in the item currency.

]

TPA_Extensions objectnullable

Additional information or extensions specific to the Travel Partner Agreement (TPA).

POS objectnullable

Point of sale information for the rate plan.

Sources object[]

A list of source information for the point of sale.

Array [

PseudoCityCode stringnullable

Default value: BRA

The pseudo city code (PCC).

ISOCountry stringnullable

The ISO 3166-1 alpha-2 country code.

RequestorID objectnullable

Information about the requestor.

ID stringnullable

The ID of the requestor.

Type UniqueIdTypeEnumnullable

Possible values: [3, 4, 14, 25]

]

WLCode integer

The waitlist code for the rate plan.

Markup objectnullable

The markup information for the rate plan.

Percent numberrequired

The markup percentage.

Package objectnullable

The package information for the rate plan.

Percent numberrequired

The package percentage.

CurrencyCode CurrencyCodeEnumnullable

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.

Array [

RoomStayCandidateRPH integer

A reference to a requested room stay candidate from the SearchCriteria.

EffectiveDate stringrequired

Check-in date (ISO 8601 format).

ExpireDate stringrequired

Check-out date (ISO 8601 format).

RatePlanID integerrequired

The unique identifier for the rate plan associated with this room rate.

RoomID integerrequired

The unique identifier for the room type associated with this room rate.

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.

Array [

EffectiveDate stringrequired

The effective date for the rate (ISO 8601 format).

MaxLOS integernullable

The maximum length of stay allowed for the rate.

MinLOS integernullable

The minimum length of stay required for the rate.

NumberOfUnits integernullable

The number of available units for the rate.

StayThrough integernullable

Unknown, need further details from Omnibees/Niara documentation.

MinAdvancedBookingOffset integernullable

The minimum number of days in advance a booking must be made.

FPLOS stringnullable

Unknown, need further details from Omnibees/Niara documentation.

Total objectrequired

The total cost information for the rate.

AmountAfterTax numberrequired

The total cost after taxes.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountIncludingMarkup boolean

Default value: false

Indicates if the amount includes markup (true) or not (false).

AmountIsPackage booleannullable

Default value: false

Indicates if the amount is for a package deal (true) or not (false).

ChargeType ChargeTypeEnumnullable

Possible values: [18, 19, 12, 7, 99, 25, 20, 21]

CurrencyCode CurrencyCodeEnumrequired

Status stringnullable

The status of the rate (e.g., 'Available', 'Closed').

AgeQualifyingCode AgeQualifyCodeEnumnullable

Possible values: [10, 8, 7]

The age qualifying code for the rate. AgeQualifyCodeEnum: 10=Adult | 8=Child | 7=Infant

MinAge integernullable

The minimum age required for the rate.

MaxAge integernullable

The maximum age allowed for the rate.

MinGuestApplicable integernullable

The minimum number of guests for which the rate is applicable.

MaxGuestApplicable integernullable

The maximum number of guests for which the rate is applicable.

Duration integernullable

The duration for which this rate is valid.

]

Total objectrequired

The total cost for this room rate, including taxes and fees.

AmountAfterTax numberrequired

The total cost after taxes.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountIncludingMarkup boolean

Default value: false

Indicates if the amount includes markup (true) or not (false).

AmountIsPackage booleannullable

Default value: false

Indicates if the amount is for a package deal (true) or not (false).

ChargeType ChargeTypeEnumnullable

Possible values: [18, 19, 12, 7, 99, 25, 20, 21]

CurrencyCode CurrencyCodeEnumrequired

TPA_Extensions objectnullable

TPA extensions for the room rate total, including the total discount value.

TotalDiscountValue numberrequired

The total discount value applied to the room rate.

ServiceRPHs object[]nullable

Services RPHs (Not yet implemented).

Array [

RPH integerrequired

The Rate Plan Header (RPH) identifier for the service.

IsPerRoom booleannullable

Indicates whether the service is priced per room (True) or not (False).

]

Discount objectnullable

Information about any discounts applied to this room rate.

ChargeUnitCode ChargeUnitCodeEnum

Possible values: [18]

Default value: 18

The unit to which the discount applies (e.g., PerRoomPerStay, PerPersonPerNight). ChargeUnitCodeEnum: 18=PerRoomPerStay

DiscountPattern stringnullable

The pattern or structure of the discount (if applicable).

NightsDiscounted integernullable

The number of nights that are discounted.

NightsRequired integernullable

The minimum number of nights required to qualify for the discount.

Percent numbernullable

The percentage of the discount.

PromotionCode stringnullable

A promotional code applied to this room rate (if any).

GroupCode stringnullable

A group code associated with this room rate (if any).

TPA_Extensions objectnullable

Additional information or extensions specific to the Travel Partner Agreement (TPA).

AmountIncludingMarkup booleannullable

AmountIsPackage booleannullable

ApprovalInvoiced integernullable

Approval number or invoice ID.

GuestsTotalRate object[]nullable

IsPreferredHotel booleannullable

Indicates if it's a preferred hotel (True) or not (False).

IsExclusiveMobile booleannullable

Indicates if it's exclusive for mobile (True) or not (False).

OccupationFor objectnullable

Occupancy details for the rate.

Adults integernullable

The number of adults included in the occupation.

Childs integernullable

The number of children included in the occupation.

Services object[]nullable

A list of services offered by the hotels.

Array [

ID stringrequired

The unique identifier for the service.

ServiceCategoryCode stringnullable

A code representing the category of the service.

ServicePricingType ServicePricingTypeEnumrequired

Possible values: [7, 12, 18, 19, 20, 21, 25]

ServiceDescription objectrequired

A description of the service, including name and language.

Name stringrequired

The name of the service.

Description stringnullable

A description of the service.

Language LanguageCodeEnumrequired

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

ImageURL stringnullable

The URL of an image representing the service (if available).

]

TotalDiscountValue numbernullable

The total discount value applied to the room rate.

SupplierCode stringnullable

Niara code for the room rate. Needed in order to booking service work.

Rates object[]

A list of rate details with TPA extensions.

Array [

AgeQualifyingCode AgeQualifyCodeEnumrequired

Possible values: [10, 8, 7]

The age qualifying code for the rate. AgeQualifyCodeEnum: 10=Adult | 8=Child | 7=Infant

EffectiveDate stringrequired

The effective date for the rate (ISO 8601 format).

MaxGuestApplicable integerrequired

The maximum number of guests applicable for the rate.

MinGuestApplicable integerrequired

The minimum number of guests applicable for the rate.

Total objectrequired

The total cost information for the rate.

AmountAfterTax numberrequired

The total cost after taxes.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountIncludingMarkup boolean

Default value: false

Indicates if the amount includes markup (true) or not (false).

AmountIsPackage booleannullable

Default value: false

Indicates if the amount is for a package deal (true) or not (false).

ChargeType ChargeTypeEnumnullable

Possible values: [18, 19, 12, 7, 99, 25, 20, 21]

CurrencyCode CurrencyCodeEnumrequired

]

Availability object[]

A list of availability information for the room rate.

Array [

AvailabilityStatus stringrequired

The availability status of the room rate (e.g., 'Available', 'NotAvailable').

WarningRPH integernullable

An RPH number for a warning message related to the room rate availability (if any).

]

Guarantee objectnullable

Information about the guarantee associated with the room rate.

Start stringnullable

The start date (ISO 8601 format) of the guarantee period.

End stringnullable

The end date (ISO 8601 format) of the guarantee period.

GuaranteeCode stringnullable

A unique code identifying the type of guarantee.

AmountPercent objectnullable

Details about the amount or percentage associated with the guarantee.

Amount numbernullable

The fixed amount, if applicable.

CurrencyCode CurrencyCodeEnumrequired

NmbrOfNights integernullable

The number of nights to which the amount or percentage applies.

Percent numbernullable

The percentage value, if applicable.

DeadLine objectnullable

Information about the guarantee deadline.

OffsetDropTime OffsetDropTimeEnum

Possible values: [0]

Specifies whether the deadline offset is applied 'BeforeArrival'. OffsetDropTimeEnum: 0=BeforeArrival

OffsetUnitMultiplier integernullable

A multiplier for the time unit (e.g., 2 for 2 days).

TimeUnitType TimeUnitEnumnullable

Possible values: [0]

The unit of time for the offset. TimeUnitEnum: 0=Day

GuaranteeDescription objectnullable

Language-specific descriptions of the guarantee.

Language LanguageCodeEnumrequired

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

The language code (e.g., 'EN', 'ES') for the guarantee description. LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

Name stringrequired

The name or title of the guarantee.

Description stringnullable

A detailed description of the guarantee in the specified language.

GuaranteesAcceptedType objectnullable

Information about the types of guarantees accepted.

GuaranteesAccepted object[]

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 18, 19, 29, 24, 30, 98, 99, 38, 100, 101]

RPH integernullable

Provides a reference to a specific form of payment.

GuaranteeID stringnullable

A unique identifier for the guarantee.

PaymentCard objectnullable

Details of the payment card used for the guarantee (if applicable).

CardCode CardCodeTypeEnumrequired

Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]

CardHolderName stringrequired

The name of the cardholder.

CardNumber stringrequired

The payment card number.

ExpireDate stringnullable

The expiration date of the payment card (YYYY-MM-DD format).

SeriesCode stringrequired

The card verification code (CVV) or security code.

Extras object[]nullable

A list of extras that can be included.

Array [

ID stringrequired

The identifier of the extra inclusion.

Description stringnullable

Description of the extra inclusion.

]

CurrencyCode CurrencyCodeEnumnullable

Amount numbernullable

Amount that will be billed for the given guarantee.

ExchangeRate numbernullable

Exchange rate applied in the transaction.

ExchangeCurrencyCode CurrencyCodeEnumnullable

ExchangeAmount numbernullable

Amount in the item currency.

]

CancelPenalty objectnullable

Cancellation penalty.

NonRefundable booleanrequired

Indicates whether the booking is non-refundable (true) or refundable (false).

AmountPercent objectnullable

Details about the amount or percentage of the penalty.

Amount numbernullable

The fixed amount, if applicable.

CurrencyCode CurrencyCodeEnumrequired

NmbrOfNights integernullable

The number of nights to which the amount or percentage applies.

Percent numbernullable

The percentage value, if applicable.

AmountRules object[]nullable

Details about a fixed amount penalty rule.

Array [

Amount numberrequired

The fixed amount for the penalty rule.

End stringrequired

The end date (ISO 8601 format) for which the rule applies.

Start stringrequired

The start date (ISO 8601 format) for which the rule applies.

CurrencyCode CurrencyCodeEnumnullable

]

DeadLine objectnullable

Information about the penalty deadline.

OffsetDropTime OffsetDropTimeEnum

Possible values: [0]

The offset time for the penalty deadline. OffsetDropTimeEnum: 0=BeforeArrival

OffsetUnitMultiplier integerrequired

A multiplier for the offset time unit.

TimeUnitType TimeUnitEnumrequired

Possible values: [0]

The type of time unit for the offset. TimeUnitEnum: 0=Day

AbsoluteDeadline stringnullable

The absolute deadline date (ISO 8601 format), if applicable.

Duration stringnullable

The duration of the cancellation penalty period.

End stringnullable

The end date (ISO 8601 format) of the penalty period.

PenaltyDescription objectrequired

Language-specific descriptions of the penalty.

Language LanguageCodeEnumrequired

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

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

Name stringrequired

The name or title of the penalty.

Description stringnullable

A detailed description of the penalty in the specified language.

Start stringnullable

The start date (ISO 8601 format) of the penalty period.

]

RoomTypes object[]

A list of room types included in this room stay.

Array [

AmenitiesType objectnullable

Amenities type.

RoomAmenities object[]

Room level amenities.

Array [

RoomAmenity stringrequired

Identifies the types of room amenities offered by the property.

Code stringrequired

Identifies the types of room amenities offered by the property.

]

MaxOccupancy integernullable

Max guest occupancy.

NumberOfUnits integernullable

Quantity of rooms available in the property for this room type.

RoomID integerrequired

Unique identifier for the room.

RoomName stringnullable

Name of the room type.

Occupancies object[]

A list of occupancy options for this room type, specifying age restrictions and minimum/maximum occupancy.

Array [

AgeQualifyingCode AgeQualifyCodeEnumrequired

Possible values: [10, 8, 7]

AgeQualifyCodeEnum: 10=Adult | 8=Child | 7=Infant

MaxOccupancy integernullable

MinOccupancy integernullable

]

RoomDescription objectnullable

Description of the room type, if available.

Language LanguageCodeEnumrequired

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

Description stringnullable

]

TPA_Extensions objectnullable

Additional information or extensions specific to the Travel Partner Agreement (TPA).

AmountIncludingMarkup booleannullable

AmountIsPackage booleannullable

ApprovalInvoiced integernullable

Approval number or invoice ID.

GuestsTotalRate object[]nullable

IsPreferredHotel booleannullable

Indicates if it's a preferred hotel (True) or not (False).

IsExclusiveMobile booleannullable

Indicates if it's exclusive for mobile (True) or not (False).

OccupationFor objectnullable

Occupancy details for the rate.

Adults integernullable

The number of adults included in the occupation.

Childs integernullable

The number of children included in the occupation.

Services object[]nullable

A list of services offered by the hotels.

Array [

ID stringrequired

The unique identifier for the service.

ServiceCategoryCode stringnullable

A code representing the category of the service.

ServicePricingType ServicePricingTypeEnumrequired

Possible values: [7, 12, 18, 19, 20, 21, 25]

ServiceDescription objectrequired

A description of the service, including name and language.

Name stringrequired

The name of the service.

Description stringnullable

A description of the service.

Language LanguageCodeEnumrequired

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

ImageURL stringnullable

The URL of an image representing the service (if available).

]

TotalDiscountValue numbernullable

The total discount value applied to the room rate.

SupplierCode stringnullable

Niara code for the room rate. Needed in order to booking service work.

Rates object[]

A list of rate details with TPA extensions.

Array [

AgeQualifyingCode AgeQualifyCodeEnumrequired

Possible values: [10, 8, 7]

The age qualifying code for the rate. AgeQualifyCodeEnum: 10=Adult | 8=Child | 7=Infant

EffectiveDate stringrequired

The effective date for the rate (ISO 8601 format).

MaxGuestApplicable integerrequired

The maximum number of guests applicable for the rate.

MinGuestApplicable integerrequired

The minimum number of guests applicable for the rate.

Total objectrequired

The total cost information for the rate.

AmountAfterTax numberrequired

The total cost after taxes.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountIncludingMarkup boolean

Default value: false

Indicates if the amount includes markup (true) or not (false).

AmountIsPackage booleannullable

Default value: false

Indicates if the amount is for a package deal (true) or not (false).

ChargeType ChargeTypeEnumnullable

Possible values: [18, 19, 12, 7, 99, 25, 20, 21]

CurrencyCode CurrencyCodeEnumrequired

]

Total objectrequired

The total cost for this room stay, including taxes and fees.

AmountAfterTax numberrequired

The total cost after taxes.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountIncludingMarkup boolean

Default value: false

Indicates if the amount includes markup (true) or not (false).

AmountIsPackage booleannullable

Default value: false

Indicates if the amount is for a package deal (true) or not (false).

ChargeType ChargeTypeEnumnullable

Possible values: [18, 19, 12, 7, 99, 25, 20, 21]

CurrencyCode CurrencyCodeEnumrequired

CommentsType objectnullable

A collection of Comment objects. Comments which apply to the whole Reservation or a particular Room Stay.

Comments object[]

A list of comments, each with a name and description.

Array [

Language LanguageCodeEnumnullable

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

Description stringnullable

A descriptive text.

Name stringnullable

The name associated with the description.

]

SpecialRequestsType objectnullable

The SpecialRequest object indicates special requests for the whole Reservation, or a particular Room Stay.

SpecialRequests object[]

The SpecialRequest object indicates special requests for a particular guest, service or reservation.

Array [

Name stringnullable

Name in plain text format

Language LanguageCodeEnumnullable

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

Description stringnullable

Description in plain text format.

]

IndexNumber stringnullable

A unique number (e.g. segment number or index number) used to further identify a booked item within a list of booked items

RoomStayStatus objectnullable

Identifies the status of the room stay.

TransactionActionType TransactionActionTypeEnumnullable

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]

PMS_ResStatusType PMS_ResStatusTypeEnumnullable

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

Guarantees object[]nullable

Guarantee information that applies to the rate plan. A maximum of 5 occurances are available for use depending on the context. Not yet implemented.

Array [

Start stringnullable

The start date (ISO 8601 format) of the guarantee period.

End stringnullable

The end date (ISO 8601 format) of the guarantee period.

GuaranteeCode stringnullable

A unique code identifying the type of guarantee.

AmountPercent objectnullable

Details about the amount or percentage associated with the guarantee.

Amount numbernullable

The fixed amount, if applicable.

CurrencyCode CurrencyCodeEnumrequired

NmbrOfNights integernullable

The number of nights to which the amount or percentage applies.

Percent numbernullable

The percentage value, if applicable.

DeadLine objectnullable

Information about the guarantee deadline.

OffsetDropTime OffsetDropTimeEnum

Possible values: [0]

Specifies whether the deadline offset is applied 'BeforeArrival'. OffsetDropTimeEnum: 0=BeforeArrival

OffsetUnitMultiplier integernullable

A multiplier for the time unit (e.g., 2 for 2 days).

TimeUnitType TimeUnitEnumnullable

Possible values: [0]

The unit of time for the offset. TimeUnitEnum: 0=Day

GuaranteeDescription objectnullable

Language-specific descriptions of the guarantee.

Language LanguageCodeEnumrequired

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

The language code (e.g., 'EN', 'ES') for the guarantee description. LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

Name stringrequired

The name or title of the guarantee.

Description stringnullable

A detailed description of the guarantee in the specified language.

GuaranteesAcceptedType objectnullable

Information about the types of guarantees accepted.

GuaranteesAccepted object[]

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 18, 19, 29, 24, 30, 98, 99, 38, 100, 101]

RPH integernullable

Provides a reference to a specific form of payment.

GuaranteeID stringnullable

A unique identifier for the guarantee.

PaymentCard objectnullable

Details of the payment card used for the guarantee (if applicable).

CardCode CardCodeTypeEnumrequired

Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18]

CardHolderName stringrequired

The name of the cardholder.

CardNumber stringrequired

The payment card number.

ExpireDate stringnullable

The expiration date of the payment card (YYYY-MM-DD format).

SeriesCode stringrequired

The card verification code (CVV) or security code.

Extras object[]nullable

A list of extras that can be included.

Array [

ID stringrequired

The identifier of the extra inclusion.

Description stringnullable

Description of the extra inclusion.

]

CurrencyCode CurrencyCodeEnumnullable

Amount numbernullable

Amount that will be billed for the given guarantee.

ExchangeRate numbernullable

Exchange rate applied in the transaction.

ExchangeCurrencyCode CurrencyCodeEnumnullable

ExchangeAmount numbernullable

Amount in the item currency.

]

GuestCountsType objectnullable

Information about the number of guests staying in the room.

GuestCounts object[]

A list of guest counts by age category.

Array [

Age integernullable

The age of the guest (required if AgeQualifyCode=8).

Count integerrequired

The number of guests of the specified age or age category.

AgeQualifyCode AgeQualifyCodeEnumrequired

Possible values: [10, 8, 7]

AgeQualifyCodeEnum: 10=Adult | 8=Child | 7=Infant

ResGuestRPH integer[]nullable

Used to refer to the guest associated with this reservation.

]

Reference stringnullable

A reference number or identifier for the room stay.

RoomStayCandidateRPH integernullable

A reference to a requested room stay candidate from the SearchCriteria.

]

Services object[]nullable

A list of services offered by the hotels.

Array [

ID stringrequired

The unique identifier for the service.

ServiceCategoryCode stringnullable

A code representing the category of the service.

ServicePricingType ServicePricingTypeEnumrequired

Possible values: [7, 12, 18, 19, 20, 21, 25]

ServiceDescription object

Name stringrequired

The name of the service.

Description stringnullable

A description of the service.

Language LanguageCodeEnumrequired

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

ImageURL stringnullable

The URL of an image representing the service (if available).

]

TPA_Extensions objectnullable

AmountIncludingMarkup booleannullable

AmountIsPackage booleannullable

ApprovalInvoiced integernullable

Approval number or invoice ID.

GuestsTotalRate object[]nullable

IsPreferredHotel booleannullable

Indicates if it's a preferred hotel (True) or not (False).

IsExclusiveMobile booleannullable

Indicates if it's exclusive for mobile (True) or not (False).

OccupationFor objectnullable

Occupancy details for the rate.

Adults integernullable

The number of adults included in the occupation.

Childs integernullable

The number of children included in the occupation.

Services object[]nullable

A list of services offered by the hotels.

Array [

ID stringrequired

The unique identifier for the service.

ServiceCategoryCode stringnullable

A code representing the category of the service.

ServicePricingType ServicePricingTypeEnumrequired

Possible values: [7, 12, 18, 19, 20, 21, 25]

ServiceDescription objectrequired

A description of the service, including name and language.

Name stringrequired

The name of the service.

Description stringnullable

A description of the service.

Language LanguageCodeEnumrequired

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

ImageURL stringnullable

The URL of an image representing the service (if available).

]

TotalDiscountValue numbernullable

The total discount value applied to the room rate.

SupplierCode stringnullable

Niara code for the room rate. Needed in order to booking service work.

Rates object[]

A list of rate details with TPA extensions.

Array [

AgeQualifyingCode AgeQualifyCodeEnumrequired

Possible values: [10, 8, 7]

The age qualifying code for the rate. AgeQualifyCodeEnum: 10=Adult | 8=Child | 7=Infant

EffectiveDate stringrequired

The effective date for the rate (ISO 8601 format).

MaxGuestApplicable integerrequired

The maximum number of guests applicable for the rate.

MinGuestApplicable integerrequired

The minimum number of guests applicable for the rate.

Total objectrequired

The total cost information for the rate.

AmountAfterTax numberrequired

The total cost after taxes.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountIncludingMarkup boolean

Default value: false

Indicates if the amount includes markup (true) or not (false).

AmountIsPackage booleannullable

Default value: false

Indicates if the amount is for a package deal (true) or not (false).

ChargeType ChargeTypeEnumnullable

Possible values: [18, 19, 12, 7, 99, 25, 20, 21]

CurrencyCode CurrencyCodeEnumrequired

]

TotalPages integer

Default value: 1

The number of pages for the requested MaxResponses.

{
  "EchoToken": "string",
  "ErrorsType": {
    "Errors": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "PrimaryLangID": 8,
  "Success": {},
  "Target": 0,
  "TimeStamp": "string",
  "Version": 0,
  "WarningsType": {
    "Warnings": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "Criteria": {
    "AvailableOnlyIndicator": true,
    "Criterion": {
      "Address": {
        "AddressLine": "string",
        "CityCode": 0,
        "CityName": "string",
        "CountryCode": 161,
        "CountryName": "string",
        "PostalCode": "string",
        "StateProvCode": 0,
        "StateProv": "string",
        "ZoneCode": 0
      },
      "Award": {
        "Rating": 0,
        "Name": "string"
      },
      "GetPricesPerGuest": false,
      "HotelRefs": [
        {
          "BrandName": 0,
          "ChainCode": 0,
          "ChainName": "string",
          "HotelCode": 0,
          "HotelName": "string"
        }
      ],
      "Position": {
        "Latitude": "string",
        "Longitude": "string"
      },
      "Location": {
        "LocationCode": "string",
        "CodeContext": "string"
      },
      "ProfilesType": {
        "ProfileInfo": {
          "UniqueID": {
            "ID": "string",
            "Type": 14,
            "Reason": "string"
          }
        }
      },
      "Radius": {
        "DistanceMax": 0,
        "UnitOfMesureCode": 1
      },
      "RatePlanCandidatesType": [
        {
          "RatePlanCandidate": {
            "GroupCode": "string",
            "PromotionCode": "string",
            "RatePlanType": 0
          }
        }
      ],
      "RoomStayCandidatesType": {
        "RoomStayCandidates": [
          {
            "BookingCode": 0,
            "GuestCountsType": {
              "GuestCounts": [
                {
                  "Age": 0,
                  "AgeQualifyCode": 10,
                  "Count": 0,
                  "ResGuestRPH": 0
                }
              ]
            },
            "Quantity": 0,
            "RPH": 0,
            "RoomID": 0
          }
        ]
      },
      "StayDateRange": {
        "Duration": 0,
        "End": "string",
        "Start": "string"
      },
      "TPA_Extensions": {
        "AmountIncludingMarkup": true,
        "AmountIsPackageRates": true,
        "AmountNotIncludingMarkup": true,
        "BestOnlyWithTaxes": true,
        "IsForMobile": true,
        "MealPlanId": 1,
        "MultimediaObjects": {
          "SendData": true
        },
        "OnlyPreferredHotels": false,
        "RatePlanIds": [
          0
        ],
        "RateRoomIds": [
          {
            "RatePlanId": 0,
            "RoomTypeId": 0
          }
        ],
        "RoomTypeIds": [
          0
        ]
      }
    }
  },
  "HotelStaysType": {
    "HotelStays": [
      {
        "Availability": [
          {
            "Start": "string",
            "End": "string",
            "Restriction": [
              {
                "Time": "string",
                "TimeUnit": 0,
                "RestrictionType": 0
              }
            ]
          }
        ],
        "BasicPropertyInfo": {
          "CurrencyCode": 1,
          "ImageURL": "string",
          "Award": {
            "Rating": 0,
            "Name": "string"
          },
          "Address": {
            "AddressLine": "string",
            "CityCode": 0,
            "CityName": "string",
            "CountryCode": 161,
            "CountryName": "string",
            "PostalCode": "string",
            "StateProvCode": 0,
            "StateProv": "string",
            "ZoneCode": 0
          },
          "HotelRef": {
            "BrandName": 0,
            "ChainCode": 0,
            "ChainName": "string",
            "HotelCode": 0,
            "HotelName": "string"
          },
          "Position": {
            "Latitude": "string",
            "Longitude": "string"
          },
          "VendorMessagesType": {
            "VendorMessages": [
              {
                "Language": 8,
                "Description": "string"
              }
            ]
          }
        },
        "Price": {
          "AmountAfterTax": 0,
          "AmountBeforeTax": 0,
          "CurrencyCode": 1,
          "End": "string",
          "Start": "string",
          "Duration": "string"
        },
        "RoomStayRPH": 0,
        "Status": "Open",
        "TPA_Extensions": {
          "SupplierCode": "string"
        }
      }
    ]
  },
  "MaxResponses": 0,
  "POS": {
    "Sources": [
      {
        "PseudoCityCode": "BRA",
        "ISOCountry": "string",
        "RequestorID": {
          "ID": "string",
          "Type": 3
        }
      }
    ]
  },
  "PageNumber": 0,
  "RoomStaysType": {
    "MoreIndicator": false,
    "RoomStays": [
      {
        "AvailabilityStatus": "string",
        "BasicPropertyInfo": {
          "CurrencyCode": 1,
          "ImageURL": "string",
          "Award": {
            "Rating": 0,
            "Name": "string"
          },
          "Address": {
            "AddressLine": "string",
            "CityCode": 0,
            "CityName": "string",
            "CountryCode": 161,
            "CountryName": "string",
            "PostalCode": "string",
            "StateProvCode": 0,
            "StateProv": "string",
            "ZoneCode": 0
          },
          "HotelRef": {
            "BrandName": 0,
            "ChainCode": 0,
            "ChainName": "string",
            "HotelCode": 0,
            "HotelName": "string"
          },
          "Position": {
            "Latitude": "string",
            "Longitude": "string"
          },
          "VendorMessagesType": {
            "VendorMessages": [
              {
                "Language": 8,
                "Description": "string"
              }
            ]
          }
        },
        "RPH": 0,
        "RatePlans": [
          {
            "AdditionalDetailsType": {
              "AdditionalDetails": [
                {
                  "DetailDescription": {
                    "Description": "string",
                    "Name": "string",
                    "Language": 8
                  }
                }
              ]
            },
            "EffectiveDate": "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": 21,
              "Price": {
                "AmountAfterTax": 0,
                "AmountBeforeTax": 0,
                "CurrencyCode": 1,
                "End": "string",
                "Start": "string",
                "Duration": "string"
              }
            },
            "RatePlanInclusions": [
              {
                "ID": 0,
                "Start": "string",
                "End": "string",
                "RatePlanInclusionDesciption": {
                  "Name": "string",
                  "Description": "string",
                  "Language": 8
                }
              }
            ],
            "Guarantees": [
              {
                "Start": "string",
                "End": "string",
                "GuaranteeCode": "string",
                "AmountPercent": {
                  "Amount": 0,
                  "CurrencyCode": 1,
                  "NmbrOfNights": 0,
                  "Percent": 0
                },
                "DeadLine": {
                  "OffsetDropTime": 0,
                  "OffsetUnitMultiplier": 0,
                  "TimeUnitType": 0
                },
                "GuaranteeDescription": {
                  "Language": 8,
                  "Name": "string",
                  "Description": "string"
                },
                "GuaranteesAcceptedType": {
                  "GuaranteesAccepted": [
                    {
                      "GuaranteeTypeCode": 2,
                      "RPH": 0,
                      "GuaranteeID": "string",
                      "PaymentCard": {
                        "CardCode": 1,
                        "CardHolderName": "string",
                        "CardNumber": "string",
                        "ExpireDate": "string",
                        "SeriesCode": "string"
                      },
                      "Extras": [
                        {
                          "ID": "string",
                          "Description": "string"
                        }
                      ],
                      "CurrencyCode": 1,
                      "Amount": 0,
                      "ExchangeRate": 0,
                      "ExchangeCurrencyCode": 1,
                      "ExchangeAmount": 0
                    }
                  ]
                }
              }
            ],
            "CancelPenalties": [
              {
                "NonRefundable": true,
                "AmountPercent": {
                  "Amount": 0,
                  "CurrencyCode": 1,
                  "NmbrOfNights": 0,
                  "Percent": 0
                },
                "AmountRules": [
                  {
                    "Amount": 0,
                    "End": "string",
                    "Start": "string",
                    "CurrencyCode": 1
                  }
                ],
                "DeadLine": {
                  "OffsetDropTime": 0,
                  "OffsetUnitMultiplier": 0,
                  "TimeUnitType": 0,
                  "AbsoluteDeadline": "string"
                },
                "Duration": "string",
                "End": "string",
                "PenaltyDescription": {
                  "Language": 8,
                  "Name": "string",
                  "Description": "string"
                },
                "Start": "string"
              }
            ],
            "Commission": {
              "Percent": 0
            },
            "TaxPolicies": [
              {
                "CurrencyCode": 1,
                "Description": "string",
                "ID": "string",
                "IsPerNight": true,
                "IsPerPerson": true,
                "IsPerRoom": true,
                "IsPerStay": true,
                "IsValuePercentage": true,
                "Name": "string",
                "Value": 0
              }
            ],
            "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": [
                {
                  "GuaranteeTypeCode": 2,
                  "RPH": 0,
                  "GuaranteeID": "string",
                  "PaymentCard": {
                    "CardCode": 1,
                    "CardHolderName": "string",
                    "CardNumber": "string",
                    "ExpireDate": "string",
                    "SeriesCode": "string"
                  },
                  "Extras": [
                    {
                      "ID": "string",
                      "Description": "string"
                    }
                  ],
                  "CurrencyCode": 1,
                  "Amount": 0,
                  "ExchangeRate": 0,
                  "ExchangeCurrencyCode": 1,
                  "ExchangeAmount": 0
                }
              ]
            },
            "TPA_Extensions": {
              "POS": {
                "Sources": [
                  {
                    "PseudoCityCode": "BRA",
                    "ISOCountry": "string",
                    "RequestorID": {
                      "ID": "string",
                      "Type": 3
                    }
                  }
                ]
              },
              "WLCode": 0,
              "Markup": {
                "Percent": 0
              },
              "Package": {
                "Percent": 0
              }
            },
            "CurrencyCode": 1
          }
        ],
        "RoomRates": [
          {
            "RoomStayCandidateRPH": 0,
            "EffectiveDate": "string",
            "ExpireDate": "string",
            "RatePlanID": 0,
            "RoomID": 0,
            "RatesType": {
              "Rates": [
                {
                  "EffectiveDate": "string",
                  "MaxLOS": 0,
                  "MinLOS": 0,
                  "NumberOfUnits": 0,
                  "StayThrough": 0,
                  "MinAdvancedBookingOffset": 0,
                  "FPLOS": "string",
                  "Total": {
                    "AmountAfterTax": 0,
                    "AmountBeforeTax": 0,
                    "AmountIncludingMarkup": false,
                    "AmountIsPackage": false,
                    "ChargeType": 18,
                    "CurrencyCode": 1
                  },
                  "Status": "string",
                  "AgeQualifyingCode": 10,
                  "MinAge": 0,
                  "MaxAge": 0,
                  "MinGuestApplicable": 0,
                  "MaxGuestApplicable": 0,
                  "Duration": 0
                }
              ]
            },
            "Total": {
              "AmountAfterTax": 0,
              "AmountBeforeTax": 0,
              "AmountIncludingMarkup": false,
              "AmountIsPackage": false,
              "ChargeType": 18,
              "CurrencyCode": 1,
              "TPA_Extensions": {
                "TotalDiscountValue": 0
              }
            },
            "ServiceRPHs": [
              {
                "RPH": 0,
                "IsPerRoom": true
              }
            ],
            "Discount": {
              "ChargeUnitCode": 18,
              "DiscountPattern": "string",
              "NightsDiscounted": 0,
              "NightsRequired": 0,
              "Percent": 0
            },
            "PromotionCode": "string",
            "GroupCode": "string",
            "TPA_Extensions": {
              "AmountIncludingMarkup": true,
              "AmountIsPackage": true,
              "ApprovalInvoiced": 0,
              "GuestsTotalRate": [
                {}
              ],
              "IsPreferredHotel": true,
              "IsExclusiveMobile": true,
              "OccupationFor": {
                "Adults": 0,
                "Childs": 0
              },
              "Services": [
                {
                  "ID": "string",
                  "ServiceCategoryCode": "string",
                  "ServicePricingType": 7,
                  "ServiceDescription": {
                    "Name": "string",
                    "Description": "string",
                    "Language": 8,
                    "ImageURL": "string"
                  }
                }
              ],
              "TotalDiscountValue": 0,
              "SupplierCode": "string",
              "Rates": [
                {
                  "AgeQualifyingCode": 10,
                  "EffectiveDate": "string",
                  "MaxGuestApplicable": 0,
                  "MinGuestApplicable": 0,
                  "Total": {
                    "AmountAfterTax": 0,
                    "AmountBeforeTax": 0,
                    "AmountIncludingMarkup": false,
                    "AmountIsPackage": false,
                    "ChargeType": 18,
                    "CurrencyCode": 1
                  }
                }
              ]
            },
            "Availability": [
              {
                "AvailabilityStatus": "string",
                "WarningRPH": 0
              }
            ],
            "Guarantee": {
              "Start": "string",
              "End": "string",
              "GuaranteeCode": "string",
              "AmountPercent": {
                "Amount": 0,
                "CurrencyCode": 1,
                "NmbrOfNights": 0,
                "Percent": 0
              },
              "DeadLine": {
                "OffsetDropTime": 0,
                "OffsetUnitMultiplier": 0,
                "TimeUnitType": 0
              },
              "GuaranteeDescription": {
                "Language": 8,
                "Name": "string",
                "Description": "string"
              },
              "GuaranteesAcceptedType": {
                "GuaranteesAccepted": [
                  {
                    "GuaranteeTypeCode": 2,
                    "RPH": 0,
                    "GuaranteeID": "string",
                    "PaymentCard": {
                      "CardCode": 1,
                      "CardHolderName": "string",
                      "CardNumber": "string",
                      "ExpireDate": "string",
                      "SeriesCode": "string"
                    },
                    "Extras": [
                      {
                        "ID": "string",
                        "Description": "string"
                      }
                    ],
                    "CurrencyCode": 1,
                    "Amount": 0,
                    "ExchangeRate": 0,
                    "ExchangeCurrencyCode": 1,
                    "ExchangeAmount": 0
                  }
                ]
              }
            },
            "CancelPenalty": {
              "NonRefundable": true,
              "AmountPercent": {
                "Amount": 0,
                "CurrencyCode": 1,
                "NmbrOfNights": 0,
                "Percent": 0
              },
              "AmountRules": [
                {
                  "Amount": 0,
                  "End": "string",
                  "Start": "string",
                  "CurrencyCode": 1
                }
              ],
              "DeadLine": {
                "OffsetDropTime": 0,
                "OffsetUnitMultiplier": 0,
                "TimeUnitType": 0,
                "AbsoluteDeadline": "string"
              },
              "Duration": "string",
              "End": "string",
              "PenaltyDescription": {
                "Language": 8,
                "Name": "string",
                "Description": "string"
              },
              "Start": "string"
            }
          }
        ],
        "RoomTypes": [
          {
            "AmenitiesType": {
              "RoomAmenities": [
                {
                  "RoomAmenity": "string",
                  "Code": "string"
                }
              ]
            },
            "MaxOccupancy": 0,
            "NumberOfUnits": 0,
            "RoomID": 0,
            "RoomName": "string",
            "Occupancies": [
              {
                "AgeQualifyingCode": 10,
                "MaxOccupancy": 0,
                "MinOccupancy": 0
              }
            ],
            "RoomDescription": {
              "Language": 8,
              "Description": "string"
            }
          }
        ],
        "TPA_Extensions": {
          "AmountIncludingMarkup": true,
          "AmountIsPackage": true,
          "ApprovalInvoiced": 0,
          "GuestsTotalRate": [
            {}
          ],
          "IsPreferredHotel": true,
          "IsExclusiveMobile": true,
          "OccupationFor": {
            "Adults": 0,
            "Childs": 0
          },
          "Services": [
            {
              "ID": "string",
              "ServiceCategoryCode": "string",
              "ServicePricingType": 7,
              "ServiceDescription": {
                "Name": "string",
                "Description": "string",
                "Language": 8,
                "ImageURL": "string"
              }
            }
          ],
          "TotalDiscountValue": 0,
          "SupplierCode": "string",
          "Rates": [
            {
              "AgeQualifyingCode": 10,
              "EffectiveDate": "string",
              "MaxGuestApplicable": 0,
              "MinGuestApplicable": 0,
              "Total": {
                "AmountAfterTax": 0,
                "AmountBeforeTax": 0,
                "AmountIncludingMarkup": false,
                "AmountIsPackage": false,
                "ChargeType": 18,
                "CurrencyCode": 1
              }
            }
          ]
        },
        "Total": {
          "AmountAfterTax": 0,
          "AmountBeforeTax": 0,
          "AmountIncludingMarkup": false,
          "AmountIsPackage": false,
          "ChargeType": 18,
          "CurrencyCode": 1
        },
        "CommentsType": {
          "Comments": [
            {
              "Language": 8,
              "Description": "string",
              "Name": "string"
            }
          ]
        },
        "SpecialRequestsType": {
          "SpecialRequests": [
            {
              "Name": "string",
              "Language": 8,
              "Description": "string"
            }
          ]
        },
        "IndexNumber": "string",
        "RoomStayStatus": {
          "TransactionActionType": 0,
          "PMS_ResStatusType": 0
        },
        "Guarantees": [
          {
            "Start": "string",
            "End": "string",
            "GuaranteeCode": "string",
            "AmountPercent": {
              "Amount": 0,
              "CurrencyCode": 1,
              "NmbrOfNights": 0,
              "Percent": 0
            },
            "DeadLine": {
              "OffsetDropTime": 0,
              "OffsetUnitMultiplier": 0,
              "TimeUnitType": 0
            },
            "GuaranteeDescription": {
              "Language": 8,
              "Name": "string",
              "Description": "string"
            },
            "GuaranteesAcceptedType": {
              "GuaranteesAccepted": [
                {
                  "GuaranteeTypeCode": 2,
                  "RPH": 0,
                  "GuaranteeID": "string",
                  "PaymentCard": {
                    "CardCode": 1,
                    "CardHolderName": "string",
                    "CardNumber": "string",
                    "ExpireDate": "string",
                    "SeriesCode": "string"
                  },
                  "Extras": [
                    {
                      "ID": "string",
                      "Description": "string"
                    }
                  ],
                  "CurrencyCode": 1,
                  "Amount": 0,
                  "ExchangeRate": 0,
                  "ExchangeCurrencyCode": 1,
                  "ExchangeAmount": 0
                }
              ]
            }
          }
        ],
        "GuestCountsType": {
          "GuestCounts": [
            {
              "Age": 0,
              "Count": 0,
              "AgeQualifyCode": 10,
              "ResGuestRPH": [
                0
              ]
            }
          ]
        },
        "Reference": "string",
        "RoomStayCandidateRPH": 0
      }
    ]
  },
  "Services": [
    {
      "ID": "string",
      "ServiceCategoryCode": "string",
      "ServicePricingType": 7,
      "ServiceDescription": {
        "Name": "string",
        "Description": "string",
        "Language": 8,
        "ImageURL": "string"
      }
    }
  ],
  "TPA_Extensions": {
    "AmountIncludingMarkup": true,
    "AmountIsPackage": true,
    "ApprovalInvoiced": 0,
    "GuestsTotalRate": [
      {}
    ],
    "IsPreferredHotel": true,
    "IsExclusiveMobile": true,
    "OccupationFor": {
      "Adults": 0,
      "Childs": 0
    },
    "Services": [
      {
        "ID": "string",
        "ServiceCategoryCode": "string",
        "ServicePricingType": 7,
        "ServiceDescription": {
          "Name": "string",
          "Description": "string",
          "Language": 8,
          "ImageURL": "string"
        }
      }
    ],
    "TotalDiscountValue": 0,
    "SupplierCode": "string",
    "Rates": [
      {
        "AgeQualifyingCode": 10,
        "EffectiveDate": "string",
        "MaxGuestApplicable": 0,
        "MinGuestApplicable": 0,
        "Total": {
          "AmountAfterTax": 0,
          "AmountBeforeTax": 0,
          "AmountIncludingMarkup": false,
          "AmountIsPackage": false,
          "ChargeType": 18,
          "CurrencyCode": 1
        }
      }
    ]
  },
  "TotalPages": 1
}

Hotel Availability

/v1/api/Pull/GetHotelAvail

Introdution​

Filtering out rates​

Return only NET Rates​

Return Only Commissionable Rates​

Return Only Non-Package Rates​

Request​

Body

Responses​

Introdution

Filtering out rates

Return only NET Rates

Return Only Commissionable Rates

Return Only Non-Package Rates

Request

Responses