Hotel Search

POST /v1/api/Pull/HotelSearch

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.

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]

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

]

Criteria 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

Profile information for the guest, including personal details and contact information.

ProfileInfos object[]

A list of profile information for the reservation guests.

Array [

UniqueID stringnullable

A unique identifier for the profile.

Profile objectrequired

The profile details.

Customer objectrequired

The customer's profile information.

Gender GenderEnum

Possible values: [Male, Female, Unknown]

Default value: Unknown

A numerical code representing the customer's gender. GenderEnum: Male=Male | Female=Female | Unknown=Unknown

BirthDate stringnullable

The customer's birthdate (ISO 8601 format: YYYY-MM-DD).

Email stringnullable

The customer's email address.

Telephones object[]

A list of the customer's phone numbers.

Array [

ShareSyncInd YesOrNoEnum

Possible values: [1, 0]

An indicator for sharing or synchronization. YesOrNoEnum: 1=Yes | 0=No

ShareMarketInd YesOrNoEnum

Possible values: [1, 0]

An indicator for sharing in a market. YesOrNoEnum: 1=Yes | 0=No

PhoneNumber stringnullable

The phone number.

Extension stringnullable

The phone extension (if applicable).

PhoneLocationType PhoneLocationTypeEnumnullable

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

PhoneTechType PhoneTechTypeEnum

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

The technology type of the phone (e.g., Voice, Fax). PhoneTechTypeEnum: 0=None | 1=Voice | 3=Fax | 5=Mobile

]

PersonName objectrequired

The customer's name details.

GivenName stringrequired

The person's given (first) name.

MiddleName stringnullable

The person's middle name (if any).

NamePrefix NamePrefixTypeEnum

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

Default value: 4

The person's name prefix (e.g., Mr., Ms., Dr.). NamePrefixTypeEnum: 1=Mr | 2=Mrs | 3=Miss | 4=None

Surname stringnullable

The person's surname (last name).

Address objectnullable

The customer's address details.

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.

Document objectnullable

The customer's identification document number.

DocType DocTypeEnumnullable

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

Default value: 1

The type of identification document. DocTypeEnum: 1=Cpf | 2=Passport | 3=Rg | 4=BirthCertificate

DocID stringrequired

Identification document number

]

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 objectnullable

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

]

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 objectnullable

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.

]

MaxResponses integernullable

Default value: 100

The number of hotels to search to.

PageNumber integernullable

The page number for paginated results.

PropertiesType objectrequired

MoreIndicator boolean

Default value: false

Indicates that more items are available (true) or not (false).

Properties object[]

A list of properties that match the search criteria.

Array [

CurrencyCode CurrencyCodeEnumnullable

Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]

The currency code (e.g., 'USD', 'EUR') used for prices at this property. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL

ImageURL stringnullable

The URL of an image representing the property.

Award objectnullable

Rating integerrequired

The numerical rating of the award.

Name stringnullable

The name or title of the award.

Address objectnullable

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

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

Latitude stringnullable

The latitude coordinate of the location.

Longitude stringnullable

The longitude coordinate of the location.

VendorMessagesType objectnullable

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.

]

TPA_Extensions objectnullable

SupplierCode stringnullable

....

WLCode integer

Default value: 9

The waitlist code for the rate plan.

AmenitiesType objectnullable

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.

]

Policy objectnullable

CheckInTime stringnullable

The time at which guests can check in to the property.

CheckOutTime stringnullable

The time at which guests must check out of the property.

]

Criteria 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

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

Profile information for the guest, including personal details and contact information.

ProfileInfos object[]

A list of profile information for the reservation guests.

Array [

UniqueID stringnullable

A unique identifier for the profile.

Profile objectrequired

The profile details.

Customer objectrequired

The customer's profile information.

Gender GenderEnum

Possible values: [Male, Female, Unknown]

Default value: Unknown

A numerical code representing the customer's gender. GenderEnum: Male=Male | Female=Female | Unknown=Unknown

BirthDate stringnullable

The customer's birthdate (ISO 8601 format: YYYY-MM-DD).

Email stringnullable

The customer's email address.

Telephones object[]

A list of the customer's phone numbers.

Array [

ShareSyncInd YesOrNoEnum

Possible values: [1, 0]

An indicator for sharing or synchronization. YesOrNoEnum: 1=Yes | 0=No

ShareMarketInd YesOrNoEnum

Possible values: [1, 0]

An indicator for sharing in a market. YesOrNoEnum: 1=Yes | 0=No

PhoneNumber stringnullable

The phone number.

Extension stringnullable

The phone extension (if applicable).

PhoneLocationType PhoneLocationTypeEnumnullable

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

PhoneTechType PhoneTechTypeEnum

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

The technology type of the phone (e.g., Voice, Fax). PhoneTechTypeEnum: 0=None | 1=Voice | 3=Fax | 5=Mobile

]

PersonName objectrequired

The customer's name details.

GivenName stringrequired

The person's given (first) name.

MiddleName stringnullable

The person's middle name (if any).

NamePrefix NamePrefixTypeEnum

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

Default value: 4

The person's name prefix (e.g., Mr., Ms., Dr.). NamePrefixTypeEnum: 1=Mr | 2=Mrs | 3=Miss | 4=None

Surname stringnullable

The person's surname (last name).

Address objectnullable

The customer's address details.

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.

Document objectnullable

The customer's identification document number.

DocType DocTypeEnumnullable

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

Default value: 1

The type of identification document. DocTypeEnum: 1=Cpf | 2=Passport | 3=Rg | 4=BirthCertificate

DocID stringrequired

Identification document number

]

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 objectnullable

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

]

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 objectnullable

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.

{
  "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"
      }
    ]
  },
  "MaxResponses": 100,
  "PageNumber": 0,
  "PropertiesType": {
    "MoreIndicator": false,
    "Properties": [
      {
        "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"
            }
          ]
        },
        "TPA_Extensions": {
          "SupplierCode": "string",
          "WLCode": 9
        },
        "AmenitiesType": {
          "RoomAmenities": [
            {
              "RoomAmenity": "string",
              "Code": "string"
            }
          ]
        },
        "Policy": {
          "CheckInTime": "string",
          "CheckOutTime": "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": {
          "ProfileInfos": [
            {
              "UniqueID": "string",
              "Profile": {
                "Customer": {
                  "Gender": "Unknown",
                  "BirthDate": "string",
                  "Email": "string",
                  "Telephones": [
                    {
                      "ShareSyncInd": 1,
                      "ShareMarketInd": 1,
                      "PhoneNumber": "string",
                      "Extension": "string",
                      "PhoneLocationType": 1,
                      "PhoneTechType": 0
                    }
                  ],
                  "PersonName": {
                    "GivenName": "string",
                    "MiddleName": "string",
                    "NamePrefix": 4,
                    "Surname": "string"
                  },
                  "Address": {
                    "AddressLine": "string",
                    "CityCode": 0,
                    "CityName": "string",
                    "CountryCode": 161,
                    "CountryName": "string",
                    "PostalCode": "string",
                    "StateProvCode": 0,
                    "StateProv": "string",
                    "ZoneCode": 0
                  },
                  "Document": {
                    "DocType": 1,
                    "DocID": "string"
                  }
                }
              }
            }
          ]
        }
      },
      "Radius": {
        "DistanceMax": 0,
        "UnitOfMesureCode": 1
      },
      "RatePlanCandidatesType": [
        {
          "RatePlanCandidate": {
            "GroupCode": "string",
            "PromotionCode": "string",
            "RatePlanType": 0
          }
        }
      ],
      "RoomStayCandidatesType": {
        "RoomStayCandidates": [
          {
            "BookingCode": 0,
            "GuestCountsType": {
              "GuestCounts": [
                {
                  "Age": 0,
                  "Count": 0,
                  "AgeQualifyCode": 10,
                  "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
        ]
      }
    }
  }
}

Hotel Search

/v1/api/Pull/HotelSearch

Request​

Body

Responses​

Request

Responses