Hotel Booking Service

POST /v1/api/Pull/SendHotelRes

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.

HotelReservationsType object

HotelReservations object[]

A list of hotel reservation requests, each detailing the specifics of a desired reservation.

Array [

POS objectnullable

Point of sale information for the request.

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

]

ResGlobalInfo objectrequired

Global information for the reservation request, including guarantees, total cost, and comments.

Guarantee objectrequired

Information about the guarantee for the reservation.

GuaranteesAcceptedType objectrequired

Information about the types of guarantees accepted for the reservation.

GuaranteesAccepted object[]

A list of guarantees accepted for the reservation.

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

]

Total objectrequired

The total cost information for the reservation.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

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

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

CommentsType objectnullable

Comments associated with the reservation.

Comments object[]

A list of comments associated with the room stay.

Array [

Description stringrequired

The text of the comment.

]

HotelReservationsIDsType objectnullable

Identifiers for multiple hotel reservations (if applicable).

HotelReservationIDs object[]nullable

A list of hotel reservation IDs, if applicable.

Array [

ResID_Value stringrequired

The value of the reservation ID (e.g., confirmation number).

ResID_Type stringrequired

The type of the reservation ID (e.g., 14 for reservation locator).

]

ResGuestsType objectrequired

Information about the guests included in the reservation request.

ResGuests object[]

A list of guests associated with the hotel reservation.

Array [

AgeQualifyingCode AgeQualifyCodeEnumrequired

Possible values: [10, 8]

The age qualifying code for the guest (e.g., Adult, Child). AgeQualifyCodeEnum: 10=Adult | 8=Child

PrimaryIndicator booleanrequired

Indicates if this is the primary guest for the reservation (True) or not (False).

Profiles objectrequired

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

ProfileInfos object[]required

A list of profile information objects for multiple guests.

Array [

Profile objectrequired

Detailed profile information of a guest.

Customer objectrequired

The customer's profile information, including personal details and contact information.

PersonName objectrequired

The person's name information.

GivenName stringrequired

The person's given (first) name.

MiddleName stringnullable

The person's middle name (if any).

NamePrefix stringnullable

The person's name prefix (e.g., Mr., Ms., Dr.).

Surname stringnullable

The person's surname (last name).

Address objectnullable

The person's address information.

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.

BirthDate stringnullable

The person's birthdate (ISO 8601 format).

Document objectnullable

The person's identification document information.

DocID stringrequired

The identification document ID (e.g., passport number, driver's license number).

Email stringnullable

The person's email address.

Telephones object[]

A list of the person's telephone numbers.

Array [

Extension stringnullable

The phone number extension.

PhoneNumber stringnullable

The phone number.

PhoneTechType PhoneTechTypeEnumnullable

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

]

ResGuestRPH integerrequired

A reference number for the guest within the reservation.

Age integernullable

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

]

RoomStaysType objectrequired

Information about the room stays requested in the reservation.

RoomStays object[]required

A list of room stay objects, each representing a single room stay within a hotel reservation.

Array [

RPH integernullable

Identifies the room stay for use in the hotel stay.

BasicPropertyInfo objectrequired

Basic information about the hotel or property where the room stay is taking place.

HotelRef objectrequired

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

ChainCode object nullable

The code of the hotel chain (if applicable).

oneOf

MOD1
MOD2

integer

ChainName stringnullable

The name of the hotel chain (if applicable).

HotelName stringnullable

The name of the hotel.

HotelCode object required

The unique code of the hotel.

oneOf

MOD1
MOD2

integer

CommentsType objectnullable

Comments associated with the room stay.

Comments object[]

A list of comments associated with the room stay.

Array [

Description stringrequired

The text of the comment.

]

GuestCountsType objectrequired

Information about the number and types of guests for the room stay.

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]

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

ResGuestRPH integer[]nullable

Used to refer to the guest associated with this reservation.

]

RoomTypes object[]

Information about the room types included in the room stay.

Array [

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.

MinOccupancy integernullable

Minimum guest occupancy allowed in this room type, if applicable.

Occupancies object[]

List of occupancy configurations for this room type.

Array [

AgeQualifyingCode AgeQualifyCodeEnumrequired

Possible values: [10, 8]

AgeQualifyCodeEnum: 10=Adult | 8=Child

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

]

RatePlans object[]

Rate plans associated with the room stay.

Array [

CurrencyCode CurrencyCodeEnumrequired

Currency code for 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

PriceViewableInd booleannullable

Indicates whether the price is viewable.

RatePlanID integerrequired

Unique identifier for the rate plan.

RatePlanName stringnullable

Name of the rate plan.

RatePlanTypeCode integernullable

Type code for the rate plan, if available.

AdditionalDetailsType objectnullable

Additional details associated with the rate plan, if any.

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

]

CancelPenalties object[]nullable

List of cancel penalties for the rate plan, if any.

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.

AmountRule objectnullable

Details about a fixed amount penalty rule.

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 integerrequired

The offset time for the penalty deadline.

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]

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.

]

Comission objectnullable

Commission information associated with the rate plan, if any.

Percent numberrequired

The commission percentage (e.g., 10.5 for 10.5%).

EffetiveDate stringnullable

Effective date of the rate plan, if available.

ExpireDate stringnullable

Expiration date of the rate plan, if available.

Guarantees object[]nullable

List of guarantees associated with the rate plan, if any.

Array [

GuaranteeCode integernullable

A unique identifier for the guarantee type.

AmountPercent objectnullable

Details about the amount or percentage associated with the guarantee.

CurrencyCode CurrencyCodeEnumrequired

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

Amount numbernullable

The fixed amount, if applicable.

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's deadline.

OffsetDropTime nullable

Possible values: [BeforeArrival, null]

Default value: BeforeArrival

Specifies whether the deadline offset is applied '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

End stringnullable

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

GuaranteeDescription objectnullable

Language-specific descriptions of the guarantee.

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

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

oneOf

MOD1
MOD2

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

]

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

CurrencyCode CurrencyCodeEnumrequired

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 numberrequired

ExchangeRate numberrequired

ExchangeCurrencyCode CurrencyCodeEnumrequired

ExchangeAmount numberrequired

]

Start stringnullable

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

]

MealsIncluded objectnullable

Information about meals included in the rate plan, if any.

Breakfast booleanrequired

Indicates whether breakfast is included (true) or not (false).

Dinner booleanrequired

Indicates whether dinner is included (true) or not (false).

ID stringrequired

The unique identifier for the meal plan.

Lunch booleanrequired

Indicates whether lunch is included (true) or not (Omnibees).

MealPlanCode MealPlanCodeEnumrequired

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

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

ServicePricingType ServicePricingTypeEnumnullable

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

Description stringnullable

A description of the meal plan.

MealPlanIndicator boolean

Default value: true

Indicates whether a meal plan is associated (true) or not (Omnibees).

Name stringnullable

The name of the meal plan.

Price objectnullable

The price details for the meal plan.

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.

Offers object[]

List of offers associated with the rate plan.

Array [

OfferCode stringrequired

The unique code identifying this offer.

RPH stringrequired

The Rate Plan Header (RPH) associated with the offer.

CompatibleOffer object[]

A list of compatible offers that can be combined with this one.

Array [

IncompatibleOfferInidcator boolean

Default value: false

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

OfferRPH stringrequired

The Rate Plan Header (RPH) of the compatible offer.

]

Discount objectnullable

Details about any discounts applied to the offer.

ChargeUnitCode object

The code indicating how the discount is applied (e.g., 'PerRoomPerStay').

oneOf

MOD1
MOD2

string

DiscountPattern stringnullable

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

NightsDiscounted stringnullable

The number of nights to which the discount applies (if applicable).

NightsRequired stringnullable

The minimum number of nights required to qualify for the discount (if applicable).

Percent numbernullable

The percentage of the discount (if applicable).

OfferDescription 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]

LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE

OfferRule objectnullable

Rules and restrictions associated with the offer.

DateRestriction objectnullable

Date restrictions for the offer (if any).

Start stringrequired

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

End stringrequired

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

MaxAdvancedBookingOffset integernullable

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

MinAdvancedBookingOffset integernullable

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

]

PaymentPolicies objectnullable

Payment policies associated with the rate plan, if any.

AcceptedPayments object[]

A list of accepted payment guarantees.

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

]

RatePlanDescription objectnullable

Description of the rate plan, if available.

Description stringnullable

The description of the rate plan.

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

RatePlanInclusions object[]

List of inclusions associated with 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

]

TaxPolicies object[]

List of tax policies associated with the rate plan.

Array [

CurrencyCode CurrencyCodeEnumrequired

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

]

TPA_Extensions objectnullable

Third-party extensions associated with the rate plan, if any.

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.

]

RoomRates object[]

A list of room rates available for the room stay.

Array [

RoomStayCandidateRPH integerrequired

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

EffectiveDate stringrequired

The check-in date for the room stay (ISO 8601 format).

ExpireDate stringrequired

The check-out date for the room stay (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 associated with this room rate.

RatesType objectrequired

Details about the rate types available for this room stay.

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.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

Status stringnullable

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

]

ServiceRPH object[]

A list of Rate Plan Header (RPH) numbers for services included with this room rate.

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

]

Availability objectrequired

Availability information for this room rate.

AvailabilityStatus stringrequired

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

TPA_Extensions objectnullable

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

ApprovalInvoiced integernullable

Approval number or invoice ID.

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.

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]

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

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.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

]

Total objectrequired

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

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

TPA_Extensions objectnullable

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

SupplierCode stringnullable

The code of the supplier providing the hotel stay.

TotalDiscountValue numbernullable

The total discount value applied to the room stay.

Taxes objectnullable

A breakdown of taxes applied to the room stay total.

Description stringrequired

A description of the tax.

ID integerrequired

The unique identifier for the tax.

Name stringrequired

The name of the tax.

Amount numbernullable

The amount of the tax.

CurrencyCode CurrencyCodeEnumrequired

]

SpecialRequestsType objectnullable

Special requests made by the guest for the room stay.

SpecialRequests object[]

A list of special requests made by the guest for the room stay.

Array [

Description stringrequired

The description of the special request.

]

Total objectrequired

The total cost of the room stay, including taxes and fees.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

TPA_Extensions objectnullable

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

SupplierCode stringnullable

The code of the supplier providing the hotel stay.

TotalDiscountValue numbernullable

The total discount value applied to the room stay.

Taxes objectnullable

A breakdown of taxes applied to the room stay total.

Description stringrequired

A description of the tax.

ID integerrequired

The unique identifier for the tax.

Name stringrequired

The name of the tax.

Amount numbernullable

The amount of the tax.

CurrencyCode CurrencyCodeEnumrequired

Guarantees objectnullable

Information about guarantees associated with the room stay.

Guarantee objectrequired

Information about guarantees for the room, including accepted types.

GuaranteesAcceptedType objectrequired

The types of guarantees accepted for the room.

GuaranteesAccepted objectrequired

Information about guarantees accepted for a room.

GuaranteeAccepted objectrequired

Information about a single guarantee accepted for a room or booking.

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

IndexNumber stringnullable

An index number for the room stay within a larger reservation.

RoomStayStatus objectnullable

The status of the room stay (e.g., reserved, checked in, checked out).

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]

TPA_Extensions objectnullable

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

SupplierCode stringnullable

The code of the supplier providing the service or product.

]

ResStatus objectrequired

The status of the reservation request.

TransactionActionType TransactionActionTypeEnum

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

]

TransactionIdentifier stringnullable

A unique identifier for the booking transaction.

Responses

application/json

Schema
Example (from schema)

Schema

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

The same token received in the request.

TimeStamp stringrequired

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

Target TargetEnumrequired

Possible values: [0, 1]

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

Version numberrequired

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

Success objectnullable

property name* string

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.

]

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.

]

HotelReservationsType object

HotelReservations object[]

A list of hotel reservation responses, each containing details of a confirmed reservation.

Array [

POS objectnullable

Point of sale information for the request.

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]

]

ResGlobalInfo objectrequired

Global information for the reservation request, including guarantees, total cost, and comments.

Guarantee objectrequired

Information about the guarantee for the reservation.

GuaranteesAcceptedType objectrequired

Information about the types of guarantees accepted for the reservation.

GuaranteesAccepted object[]

A list of guarantees accepted for the reservation.

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

]

Total objectrequired

The total cost information for the reservation.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

CommentsType objectnullable

Comments associated with the reservation.

Comments object[]

A list of comments associated with the room stay.

Array [

Description stringrequired

The text of the comment.

]

HotelReservationsIDsType objectnullable

Identifiers for multiple hotel reservations (if applicable).

HotelReservationIDs object[]nullable

A list of hotel reservation IDs, if applicable.

Array [

ResID_Value stringrequired

The value of the reservation ID (e.g., confirmation number).

ResID_Type stringrequired

The type of the reservation ID (e.g., 14 for reservation locator).

]

ResGuestsType objectrequired

Information about the guests included in the reservation request.

ResGuests object[]

A list of guests associated with the hotel reservation.

Array [

AgeQualifyingCode AgeQualifyCodeEnumrequired

Possible values: [10, 8]

The age qualifying code for the guest (e.g., Adult, Child). AgeQualifyCodeEnum: 10=Adult | 8=Child

PrimaryIndicator booleanrequired

Indicates if this is the primary guest for the reservation (True) or not (False).

Profiles objectrequired

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

ProfileInfos object[]required

A list of profile information objects for multiple guests.

Array [

Profile objectrequired

Detailed profile information of a guest.

Customer objectrequired

The customer's profile information, including personal details and contact information.

PersonName objectrequired

The person's name information.

GivenName stringrequired

The person's given (first) name.

MiddleName stringnullable

The person's middle name (if any).

NamePrefix stringnullable

The person's name prefix (e.g., Mr., Ms., Dr.).

Surname stringnullable

The person's surname (last name).

Address objectnullable

The person's address information.

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.

BirthDate stringnullable

The person's birthdate (ISO 8601 format).

Document objectnullable

The person's identification document information.

DocID stringrequired

The identification document ID (e.g., passport number, driver's license number).

Email stringnullable

The person's email address.

Telephones object[]

A list of the person's telephone numbers.

Array [

Extension stringnullable

The phone number extension.

PhoneNumber stringnullable

The phone number.

PhoneTechType PhoneTechTypeEnumnullable

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

]

ResGuestRPH integerrequired

A reference number for the guest within the reservation.

Age integernullable

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

]

RoomStaysType objectrequired

Information about the room stays requested in the reservation.

RoomStays object[]required

A list of room stay objects, each representing a single room stay within a hotel reservation.

Array [

RPH integernullable

Identifies the room stay for use in the hotel stay.

BasicPropertyInfo objectrequired

Basic information about the hotel or property where the room stay is taking place.

HotelRef objectrequired

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

ChainCode object nullable

The code of the hotel chain (if applicable).

oneOf

MOD1
MOD2

integer

ChainName stringnullable

The name of the hotel chain (if applicable).

HotelName stringnullable

The name of the hotel.

HotelCode object required

The unique code of the hotel.

oneOf

MOD1
MOD2

integer

CommentsType objectnullable

Comments associated with the room stay.

Comments object[]

A list of comments associated with the room stay.

Array [

Description stringrequired

The text of the comment.

]

GuestCountsType objectrequired

Information about the number and types of guests for the room stay.

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]

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

ResGuestRPH integer[]nullable

Used to refer to the guest associated with this reservation.

]

RoomTypes object[]

Information about the room types included in the room stay.

Array [

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.

MinOccupancy integernullable

Minimum guest occupancy allowed in this room type, if applicable.

Occupancies object[]

List of occupancy configurations for this room type.

Array [

AgeQualifyingCode AgeQualifyCodeEnumrequired

Possible values: [10, 8]

AgeQualifyCodeEnum: 10=Adult | 8=Child

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

]

RatePlans object[]

Rate plans associated with the room stay.

Array [

CurrencyCode CurrencyCodeEnumrequired

PriceViewableInd booleannullable

Indicates whether the price is viewable.

RatePlanID integerrequired

Unique identifier for the rate plan.

RatePlanName stringnullable

Name of the rate plan.

RatePlanTypeCode integernullable

Type code for the rate plan, if available.

AdditionalDetailsType objectnullable

Additional details associated with the rate plan, if any.

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

]

CancelPenalties object[]nullable

List of cancel penalties for the rate plan, if any.

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.

AmountRule objectnullable

Details about a fixed amount penalty rule.

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 integerrequired

The offset time for the penalty deadline.

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]

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.

]

Comission objectnullable

Commission information associated with the rate plan, if any.

Percent numberrequired

The commission percentage (e.g., 10.5 for 10.5%).

EffetiveDate stringnullable

Effective date of the rate plan, if available.

ExpireDate stringnullable

Expiration date of the rate plan, if available.

Guarantees object[]nullable

List of guarantees associated with the rate plan, if any.

Array [

GuaranteeCode integernullable

A unique identifier for the guarantee type.

AmountPercent objectnullable

Details about the amount or percentage associated with the guarantee.

CurrencyCode CurrencyCodeEnumrequired

Amount numbernullable

The fixed amount, if applicable.

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's deadline.

OffsetDropTime nullable

Possible values: [BeforeArrival, null]

Default value: BeforeArrival

Specifies whether the deadline offset is applied '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

End stringnullable

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

GuaranteeDescription objectnullable

Language-specific descriptions of the guarantee.

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

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

oneOf

MOD1
MOD2

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

]

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

CurrencyCode CurrencyCodeEnumrequired

Amount numberrequired

ExchangeRate numberrequired

ExchangeCurrencyCode CurrencyCodeEnumrequired

ExchangeAmount numberrequired

]

Start stringnullable

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

]

MealsIncluded objectnullable

Information about meals included in the rate plan, if any.

Breakfast booleanrequired

Indicates whether breakfast is included (true) or not (false).

Dinner booleanrequired

Indicates whether dinner is included (true) or not (false).

ID stringrequired

The unique identifier for the meal plan.

Lunch booleanrequired

Indicates whether lunch is included (true) or not (Omnibees).

MealPlanCode MealPlanCodeEnumrequired

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

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

ServicePricingType ServicePricingTypeEnumnullable

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

Description stringnullable

A description of the meal plan.

MealPlanIndicator boolean

Default value: true

Indicates whether a meal plan is associated (true) or not (Omnibees).

Name stringnullable

The name of the meal plan.

Price objectnullable

The price details for the meal plan.

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.

Offers object[]

List of offers associated with the rate plan.

Array [

OfferCode stringrequired

The unique code identifying this offer.

RPH stringrequired

The Rate Plan Header (RPH) associated with the offer.

CompatibleOffer object[]

A list of compatible offers that can be combined with this one.

Array [

IncompatibleOfferInidcator boolean

Default value: false

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

OfferRPH stringrequired

The Rate Plan Header (RPH) of the compatible offer.

]

Discount objectnullable

Details about any discounts applied to the offer.

ChargeUnitCode object

The code indicating how the discount is applied (e.g., 'PerRoomPerStay').

oneOf

MOD1
MOD2

string

DiscountPattern stringnullable

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

NightsDiscounted stringnullable

The number of nights to which the discount applies (if applicable).

NightsRequired stringnullable

The minimum number of nights required to qualify for the discount (if applicable).

Percent numbernullable

The percentage of the discount (if applicable).

OfferDescription 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]

LanguageCodeEnum: 8=BR | 4=PT | 3=ES | 1=EN | 2=FR | 5=DA | 6=IT | 7=DE

OfferRule objectnullable

Rules and restrictions associated with the offer.

DateRestriction objectnullable

Date restrictions for the offer (if any).

Start stringrequired

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

End stringrequired

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

MaxAdvancedBookingOffset integernullable

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

MinAdvancedBookingOffset integernullable

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

]

PaymentPolicies objectnullable

Payment policies associated with the rate plan, if any.

AcceptedPayments object[]

A list of accepted payment guarantees.

Array [

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

]

RatePlanDescription objectnullable

Description of the rate plan, if available.

Description stringnullable

The description of the rate plan.

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

RatePlanInclusions object[]

List of inclusions associated with 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

]

TaxPolicies object[]

List of tax policies associated with the rate plan.

Array [

CurrencyCode CurrencyCodeEnumrequired

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

]

TPA_Extensions objectnullable

Third-party extensions associated with the rate plan, if any.

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.

]

RoomRates object[]

A list of room rates available for the room stay.

Array [

RoomStayCandidateRPH integerrequired

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

EffectiveDate stringrequired

The check-in date for the room stay (ISO 8601 format).

ExpireDate stringrequired

The check-out date for the room stay (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 associated with this room rate.

RatesType objectrequired

Details about the rate types available for this room stay.

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.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

Status stringnullable

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

]

ServiceRPH object[]

A list of Rate Plan Header (RPH) numbers for services included with this room rate.

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

]

Availability objectrequired

Availability information for this room rate.

AvailabilityStatus stringrequired

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

TPA_Extensions objectnullable

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

ApprovalInvoiced integernullable

Approval number or invoice ID.

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.

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]

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

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.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

]

Total objectrequired

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

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

TPA_Extensions objectnullable

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

SupplierCode stringnullable

The code of the supplier providing the hotel stay.

TotalDiscountValue numbernullable

The total discount value applied to the room stay.

Taxes objectnullable

A breakdown of taxes applied to the room stay total.

Description stringrequired

A description of the tax.

ID integerrequired

The unique identifier for the tax.

Name stringrequired

The name of the tax.

Amount numbernullable

The amount of the tax.

CurrencyCode CurrencyCodeEnumrequired

]

SpecialRequestsType objectnullable

Special requests made by the guest for the room stay.

SpecialRequests object[]

A list of special requests made by the guest for the room stay.

Array [

Description stringrequired

The description of the special request.

]

Total objectrequired

The total cost of the room stay, including taxes and fees.

AmountBeforeTax numberrequired

The total cost before taxes.

AmountAfterTax numberrequired

The total cost after 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 integernullable

A numerical code representing the type of charge.

CurrencyCode CurrencyCodeEnumrequired

TPA_Extensions objectnullable

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

SupplierCode stringnullable

The code of the supplier providing the hotel stay.

TotalDiscountValue numbernullable

The total discount value applied to the room stay.

Taxes objectnullable

A breakdown of taxes applied to the room stay total.

Description stringrequired

A description of the tax.

ID integerrequired

The unique identifier for the tax.

Name stringrequired

The name of the tax.

Amount numbernullable

The amount of the tax.

CurrencyCode CurrencyCodeEnumrequired

Guarantees objectnullable

Information about guarantees associated with the room stay.

Guarantee objectrequired

Information about guarantees for the room, including accepted types.

GuaranteesAcceptedType objectrequired

The types of guarantees accepted for the room.

GuaranteesAccepted objectrequired

Information about guarantees accepted for a room.

GuaranteeAccepted objectrequired

Information about a single guarantee accepted for a room or booking.

GuaranteeTypeCode GuaranteeTypeCodeEnumrequired

Possible values: [2, 5, 8, 3, 4, 38]

RPH integernullable

The Rate Plan Header (RPH) associated with the guarantee (if applicable).

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 stringrequired

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

SeriesCode stringrequired

The card verification code (CVV) or security code.

IndexNumber stringnullable

An index number for the room stay within a larger reservation.

RoomStayStatus objectnullable

The status of the room stay (e.g., reserved, checked in, checked out).

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]

TPA_Extensions objectnullable

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

SupplierCode stringnullable

The code of the supplier providing the service or product.

]

ResStatus objectrequired

The status of the reservation request.

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]

UniqueID objectnullable

A unique identifier for the hotel reservation.

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.

CreateDateTime stringnullable

The date and time the reservation was created (ISO 8601 format).

LastModifyDateTime stringnullable

The date and time the reservation was last modified (ISO 8601 format).

]

MaxResponses integernullable

The maximum number of responses allowed in a single response message.

MoreIndicator booleannullable

Indicates if there are more results available than what is included in this response (true) or not (false).

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 current page number of the response (for paginated responses).

ResResponseType stringnullable

The type of reservation response (e.g., 'Hotel', 'NonHotel').

RetransmissionIndicator booleannullable

Indicates whether this is a retransmission of a previous response (true) or not (false).

TotalRecords integernullable

The total number of records matching the search criteria.

TransactionIdentifier stringnullable

A unique identifier for the booking transaction that matches the one in the request.

ExpectedProcessingTimeInSeconds integernullable

Expected time to process the booking request in the case ResStatus.PMS_ResStatusType = 0 (Requested).

MaximumProcessingTimeInSeconds integernullable

Expected time to process the booking request in the case ResStatus.PMS_ResStatusType = 0 (Requested).

{
  "PrimaryLangID": 8,
  "EchoToken": "string",
  "TimeStamp": "string",
  "Target": 0,
  "Version": 0,
  "Success": {},
  "WarningsType": {
    "Warnings": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "ErrorsType": {
    "Errors": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "HotelReservationsType": {
    "HotelReservations": [
      {
        "POS": {
          "Sources": [
            {
              "PseudoCityCode": "BRA",
              "ISOCountry": "string",
              "RequestorID": {
                "ID": "string",
                "Type": 3
              }
            }
          ]
        },
        "ResGlobalInfo": {
          "Guarantee": {
            "GuaranteesAcceptedType": {
              "GuaranteesAccepted": [
                {
                  "GuaranteeTypeCode": 2,
                  "RPH": 0,
                  "GuaranteeID": "string",
                  "PaymentCard": {
                    "CardCode": 1,
                    "CardHolderName": "string",
                    "CardNumber": "string",
                    "ExpireDate": "string",
                    "SeriesCode": "string"
                  }
                }
              ]
            }
          },
          "Total": {
            "AmountBeforeTax": 0,
            "AmountAfterTax": 0,
            "AmountIncludingMarkup": false,
            "AmountIsPackage": false,
            "ChargeType": 0,
            "CurrencyCode": 1
          },
          "CommentsType": {
            "Comments": [
              {
                "Description": "string"
              }
            ]
          },
          "HotelReservationsIDsType": {
            "HotelReservationIDs": [
              {
                "ResID_Value": "string",
                "ResID_Type": "string"
              }
            ]
          }
        },
        "ResGuestsType": {
          "ResGuests": [
            {
              "AgeQualifyingCode": 10,
              "PrimaryIndicator": true,
              "Profiles": {
                "ProfileInfos": [
                  {
                    "Profile": {
                      "Customer": {
                        "PersonName": {
                          "GivenName": "string",
                          "MiddleName": "string",
                          "NamePrefix": "string",
                          "Surname": "string"
                        },
                        "Address": {
                          "AddressLine": "string",
                          "CityCode": 0,
                          "CityName": "string",
                          "CountryCode": 161,
                          "CountryName": "string",
                          "PostalCode": "string",
                          "StateProvCode": 0,
                          "StateProv": "string",
                          "ZoneCode": 0
                        },
                        "BirthDate": "string",
                        "Document": {
                          "DocID": "string"
                        },
                        "Email": "string",
                        "Telephones": [
                          {
                            "Extension": "string",
                            "PhoneNumber": "string",
                            "PhoneTechType": 0
                          }
                        ]
                      }
                    }
                  }
                ]
              },
              "ResGuestRPH": 0,
              "Age": 0
            }
          ]
        },
        "RoomStaysType": {
          "RoomStays": [
            {
              "RPH": 0,
              "BasicPropertyInfo": {
                "HotelRef": {
                  "ChainCode": 0,
                  "ChainName": "string",
                  "HotelName": "string",
                  "HotelCode": 0
                }
              },
              "CommentsType": {
                "Comments": [
                  {
                    "Description": "string"
                  }
                ]
              },
              "GuestCountsType": {
                "GuestCounts": [
                  {
                    "Age": 0,
                    "Count": 0,
                    "AgeQualifyCode": 10,
                    "ResGuestRPH": [
                      0
                    ]
                  }
                ]
              },
              "RoomTypes": [
                {
                  "MaxOccupancy": 0,
                  "NumberOfUnits": 0,
                  "RoomID": 0,
                  "RoomName": "string",
                  "MinOccupancy": 0,
                  "Occupancies": [
                    {
                      "AgeQualifyingCode": 10,
                      "MaxOccupancy": 0,
                      "MinOccupancy": 0
                    }
                  ],
                  "RoomDescription": {
                    "Language": 8,
                    "Description": "string"
                  }
                }
              ],
              "RatePlans": [
                {
                  "CurrencyCode": 1,
                  "PriceViewableInd": true,
                  "RatePlanID": 0,
                  "RatePlanName": "string",
                  "RatePlanTypeCode": 0,
                  "AdditionalDetailsType": {
                    "AdditionalDetails": [
                      {
                        "DetailDescription": {
                          "Description": "string",
                          "Name": "string",
                          "Language": 8
                        }
                      }
                    ]
                  },
                  "CancelPenalties": [
                    {
                      "NonRefundable": true,
                      "AmountPercent": {
                        "Amount": 0,
                        "CurrencyCode": 1,
                        "NmbrOfNights": 0,
                        "Percent": 0
                      },
                      "AmountRule": {
                        "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"
                    }
                  ],
                  "Comission": {
                    "Percent": 0
                  },
                  "EffetiveDate": "string",
                  "ExpireDate": "string",
                  "Guarantees": [
                    {
                      "GuaranteeCode": 0,
                      "AmountPercent": {
                        "CurrencyCode": 1,
                        "Amount": 0,
                        "NmbrOfNights": 0,
                        "Percent": 0
                      },
                      "Deadline": {
                        "OffsetUnitMultiplier": 0,
                        "TimeUnitType": 0
                      },
                      "End": "string",
                      "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"
                            }
                          }
                        ]
                      },
                      "Start": "string"
                    }
                  ],
                  "MealsIncluded": {
                    "Breakfast": true,
                    "Dinner": true,
                    "ID": "string",
                    "Lunch": true,
                    "MealPlanCode": 1,
                    "ServicePricingType": 7,
                    "Description": "string",
                    "MealPlanIndicator": true,
                    "Name": "string",
                    "Price": {
                      "AmountAfterTax": 0,
                      "AmountBeforeTax": 0,
                      "CurrencyCode": 1,
                      "End": "string",
                      "Start": "string"
                    }
                  },
                  "Offers": [
                    {
                      "OfferCode": "string",
                      "RPH": "string",
                      "CompatibleOffer": [
                        {
                          "IncompatibleOfferInidcator": false,
                          "OfferRPH": "string"
                        }
                      ],
                      "Discount": {
                        "ChargeUnitCode": "string",
                        "DiscountPattern": "string",
                        "NightsDiscounted": "string",
                        "NightsRequired": "string",
                        "Percent": 0
                      },
                      "OfferDescription": {
                        "Description": "string",
                        "Language": 8
                      },
                      "OfferRule": {
                        "DateRestriction": {
                          "Start": "string",
                          "End": "string"
                        },
                        "MaxAdvancedBookingOffset": 0,
                        "MinAdvancedBookingOffset": 0
                      }
                    }
                  ],
                  "PaymentPolicies": {
                    "AcceptedPayments": [
                      {
                        "GuaranteeTypeCode": 2,
                        "RPH": 0,
                        "GuaranteeID": "string",
                        "PaymentCard": {
                          "CardCode": 1,
                          "CardHolderName": "string",
                          "CardNumber": "string",
                          "ExpireDate": "string",
                          "SeriesCode": "string"
                        }
                      }
                    ]
                  },
                  "RatePlanDescription": {
                    "Description": "string",
                    "Language": 8
                  },
                  "RatePlanInclusions": [
                    {
                      "ID": 0,
                      "Start": "string",
                      "End": "string",
                      "RatePlanInclusionDesciption": {
                        "Name": "string",
                        "Description": "string",
                        "Language": 8
                      }
                    }
                  ],
                  "TaxPolicies": [
                    {
                      "CurrencyCode": 1,
                      "Description": "string",
                      "ID": "string",
                      "IsPerNight": true,
                      "IsPerPerson": true,
                      "IsPerRoom": true,
                      "IsPerStay": true,
                      "IsValuePercentage": true,
                      "Name": "string",
                      "Value": 0
                    }
                  ],
                  "TPA_Extensions": {
                    "POS": {
                      "Sources": [
                        {
                          "PseudoCityCode": "BRA",
                          "ISOCountry": "string",
                          "RequestorID": {
                            "ID": "string",
                            "Type": 3
                          }
                        }
                      ]
                    },
                    "WLCode": 0
                  }
                }
              ],
              "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": {
                          "AmountBeforeTax": 0,
                          "AmountAfterTax": 0,
                          "AmountIncludingMarkup": false,
                          "AmountIsPackage": false,
                          "ChargeType": 0,
                          "CurrencyCode": 1
                        },
                        "Status": "string"
                      }
                    ]
                  },
                  "ServiceRPH": [
                    {
                      "RPH": 0,
                      "IsPerRoom": true
                    }
                  ],
                  "Availability": {
                    "AvailabilityStatus": "string"
                  },
                  "TPA_Extensions": {
                    "ApprovalInvoiced": 0,
                    "IsPreferredHotel": true,
                    "IsExclusiveMobile": true,
                    "OccupationFor": {
                      "Adults": 0,
                      "Childs": 0
                    },
                    "SupplierCode": "string",
                    "Rates": [
                      {
                        "AgeQualifyingCode": 10,
                        "EffectiveDate": "string",
                        "MaxGuestApplicable": 0,
                        "MinGuestApplicable": 0,
                        "Total": {
                          "AmountBeforeTax": 0,
                          "AmountAfterTax": 0,
                          "AmountIncludingMarkup": false,
                          "AmountIsPackage": false,
                          "ChargeType": 0,
                          "CurrencyCode": 1
                        }
                      }
                    ]
                  },
                  "Total": {
                    "AmountBeforeTax": 0,
                    "AmountAfterTax": 0,
                    "AmountIncludingMarkup": false,
                    "AmountIsPackage": false,
                    "ChargeType": 0,
                    "CurrencyCode": 1,
                    "TPA_Extensions": {
                      "SupplierCode": "string",
                      "TotalDiscountValue": 0
                    },
                    "Taxes": {
                      "Description": "string",
                      "ID": 0,
                      "Name": "string",
                      "Amount": 0,
                      "CurrencyCode": 1
                    }
                  }
                }
              ],
              "SpecialRequestsType": {
                "SpecialRequests": [
                  {
                    "Description": "string"
                  }
                ]
              },
              "Total": {
                "AmountBeforeTax": 0,
                "AmountAfterTax": 0,
                "AmountIncludingMarkup": false,
                "AmountIsPackage": false,
                "ChargeType": 0,
                "CurrencyCode": 1,
                "TPA_Extensions": {
                  "SupplierCode": "string",
                  "TotalDiscountValue": 0
                },
                "Taxes": {
                  "Description": "string",
                  "ID": 0,
                  "Name": "string",
                  "Amount": 0,
                  "CurrencyCode": 1
                }
              },
              "Guarantees": {
                "Guarantee": {
                  "GuaranteesAcceptedType": {
                    "GuaranteesAccepted": {
                      "GuaranteeAccepted": {
                        "GuaranteeTypeCode": 2,
                        "RPH": 0,
                        "GuaranteeID": "string",
                        "PaymentCard": {
                          "CardCode": 1,
                          "CardHolderName": "string",
                          "CardNumber": "string",
                          "ExpireDate": "string",
                          "SeriesCode": "string"
                        }
                      }
                    }
                  }
                }
              },
              "IndexNumber": "string",
              "RoomStayStatus": {
                "TransactionActionType": 0,
                "PMS_ResStatusType": 0
              },
              "TPA_Extensions": {
                "SupplierCode": "string"
              }
            }
          ]
        },
        "ResStatus": {
          "TransactionActionType": 0,
          "PMS_ResStatusType": 0
        },
        "UniqueID": {
          "ID": "string",
          "Type": 14,
          "Reason": "string"
        },
        "CreateDateTime": "string",
        "LastModifyDateTime": "string"
      }
    ]
  },
  "MaxResponses": 0,
  "MoreIndicator": true,
  "POS": {
    "Sources": [
      {
        "PseudoCityCode": "BRA",
        "ISOCountry": "string",
        "RequestorID": {
          "ID": "string",
          "Type": 3
        }
      }
    ]
  },
  "PageNumber": 0,
  "ResResponseType": "string",
  "RetransmissionIndicator": true,
  "TotalRecords": 0,
  "TransactionIdentifier": "string",
  "ExpectedProcessingTimeInSeconds": 0,
  "MaximumProcessingTimeInSeconds": 0
}

Hotel Booking Service

/v1/api/Pull/SendHotelRes

Request​

Body

Responses​

Request

Responses