What is it?
The Hotel Reservation Services API enables you to create, update, cancel, and retrieve reservations from Aven Hospitality's SynXis Central Reservation System (CRS).
This API manages reservation orchestrations relating to booking, modification, cancellation, retrieval, and back-office processing. It allows a Custom Booking Engine, Call Center Application, Property Management System, or other application to manage reservations for a hotel in the SynXis Enterprise Platform.
An agent can reserve a product or packages for a specific hotel. The reservation status can change. Each status has its own set of rules that might need different data. The movement from one status to another can be different depending on the original status and the new one.
| Status | Description | Transition/Reservation Requirements |
|---|---|---|
| Stored | Includes all information related to a reservation, but does not contain blocked inventory, confirmation number, or a confirmed price. | No requirement. |
| Booked | Indicates the pending state of a new reservation where inventory is decremented. A confirmation is generated. However, the reservation stays in a pending state until it is either Ignored or Confirmed. | No requirement. |
| OnHold | An extension of the Booked reservation status, including decremented inventory but also having some overriding attributes such as not needing a payment. | No requirement. After a timeout, based on a time configured by chain, the system will automatically ignore the reservation. |
| Confirmed | This is the final state of a valid reservation, regardless of whether it is a new or a modified reservation. | A guest is required. Inventory will be blocked at the property. Booking policy will be applied including prepayment. |
| Waitlisted | Indicates an attempted booking where the requested product was not available. Therefore, the reservation is waitlisted and stored in the database for confirmation of whether the product becomes available. Guests receive a waitlist e-mail indicating that their reservation could not be confirmed at that time. | A guest is required. |
| Cancelled | The final status of a cancelled reservation. | Prior to cancellation, the system evaluates the cancel policy to determine eligibility. |
| Ignored | Indicates the final state of a pending reservation, which is equivalent to it being (logically) deleted. | The system is the only one that ignores a reservation. |
| PendingModify | Indicates pending changes to a confirmed reservation where inventory is decremented. The changes stay in this pending status until the reservation is either Ignored by the system or Confirmed. | Only reservations with a Confirmed status can be changed to PendingModify status. |
Note: The Reservation Services API endpoints are designed to be used in conjunction with the Reservation Utilities API.
Before You Begin
- You must authenticate before you can use this API. For full instructions, see Get a Token for REST APIs.
- At any time, you can go to this API's Reference Documentation tab, where you can make test calls with the following endpoints.
How to use
This section covers the endpoints for this API.
It also covers examples (use cases) for the following:
- Creating the detailed information in reservations.
- Handling Retailing products or services (ancillaries) in reservations.
GET a list of reservations
This endpoint enables you to retrieve a list of reservations based on a wide variety of search parameters that you can specify.
[GET] /v1/api/reservationFor a reservation to be returned in the response, it must match all search parameters that you specify in your request.
Note: This endpoint provides many search parameters to give you flexibility in how to search and to ensure that you don't receive an overwhelming number of results in the response. Follow the best practice of using as many search parameters as possible in your query to narrow your results. If you use just one search parameter, for example, you might get pages of results and your reservations will be hard to find in those results. In the worst cases of using too few search parameters, when your query returns very large numbers of results, you might experience slow page loading or timeout errors.
Here are some example of available search parameters that you can combine to narrow the results.
- CRS confirmation number, Itinerary number, external reference number, PMS confirmation number.
- Guest's first name, last name, city, phone number, email, loyalty membership ID, credit card.
- Agent's user name or modification dates.
- Guest room stay details, such as arrival date, departure date, rate code, room units, room codes.
- Reservation status, such as stored, booked, ignored, wait listed, confirmed, cancelled, pending modify, pending cancel, on hold, released, and payment pending.
- Property status, such as checked out, in house, no show, turn away, pre-arrival, and none.
Query Parameters
The following table describes the elements that you can include when you query this endpoint:
| Element | Description | Type | Required? |
|---|---|---|---|
| status | You can specify one or more reservation statuses to retrieve applicable reservations. Available values are: Booked, Cancelled, Confirmed, Ignored, OnHold, PendingModify, PaymentPending, Requested, Released, Stored, Waitlisted. To better understand the meaning of each status, see the diagram and table at the top of this page. To specify multiple statuses to be returned, add the statuses separated by commas: /v1/api/reservation?status=Booked,Cancelled,Confirmed | string | Optional |
| onPropertyStatus | You can specify one or more on-property statuses to retrieve applicable reservations. Available values are: CheckedOut, InHouse, NoShow, TurnAway, PreArrival. To specify multiple on-property statuses to be returned, add the statuses separated by commas: /v1/api/reservation?onPropertyStatus=CheckedOut,InHouse,NoShow | string | Optional |
| crsConfirmationNumber | You can specify one or more CRS confirmation numbers to retrieve applicable reservations. To specify multiple CRS confirmation numbers to be returned, add the numbers separated by commas: /v1/api/reservation?crsConfirmationNumber=321,654,987 | string | Optional |
| channelConfirmationNumber | You can specify one or more channel confirmation numbers to retrieve applicable reservations. To specify multiple channel confirmation numbers to be returned, add the numbers separated by commas: /v1/api/reservation?channelConfirmationNumber=321,654,987 | string | Optional |
| pmsConfirmationNumber | You can specify one or more PMS confirmation numbers to retrieve applicable reservations. To specify multiple PMS confirmation numbers to be returned, add the numbers separated by commas: /v1/api/reservation?pmsConfirmationNumber=321,654,987 | string | Optional |
| externalReferenceNumber | You can specify one or more external reference numbers to retrieve applicable reservations. To specify multiple external reference numbers to be returned, add the numbers separated by commas: /v1/api/reservation?externalReferenceNumber=321,654,987 | string | Optional |
| Id | You can specify one or more unique reservation IDs to retrieve applicable reservations. To specify multiple reservation IDs to be returned, add the IDs separated by commas: /v1/api/reservation?Id=a3b21,6c5d4,9e8f7 | string | Optional |
| prospectBookingNumber | You can specify one or more prospect booking numbers to retrieve applicable reservations. To specify multiple prospect booking numbers to be returned, add the numbers separated by commas: /v1/api/reservation?prospectBookingNumber=a3b21,6c5d4,9e8f7 | string | Optional |
| onHoldReleaseTime | You can specify the number of hours after booking that an on-hold reservation will be cancelled if the guest does not confirm the reservation. | integer | Optional |
| autoCancelReleaseTime | You can specify the number of hours after booking that a reservation will be cancelled if the guest does not check in. | integer | Optional |
| bookingChannel | You can specify the booking channel in which the reservation was created. When you specify a booking channel, also add the hotel ID and chain ID for best results, as in this example: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&bookingChannel=WEB | string | Optional |
| roomTypes | You can specify one or more room type codes to retrieve applicable reservations. To specify multiple room type codes to be returned, add the codes separated by commas: /v1/api/reservation?roomTypes=LUXT,KING,KING2 | string | Optional |
| roomUnits | You can specify one or more room unit numbers to retrieve applicable reservations. To specify multiple room unit numbers to be returned, add the numbers separated by commas: /v1/api/reservation?roomUnits=111,222,333 | string | Optional |
| rates | You can specify one or more rate codes to retrieve applicable reservations. To specify multiple rate codes to be returned, add the codes separated by commas: /v1/api/reservation?rates=a3b21,6c5d4,9e8f7 | string | Optional |
| anyReferenceNumber | You can specify a reference number, and the system will search for a matching number in itinerary number, confirmation number, guest CRS reference number, and cancellation number, in that order. The response will include only the first match that it finds. Use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&anyReferenceNumber=12723B0000404 | string | Optional |
| itineraryNumber | You can specify an itinerary number to retrieve applicable reservations. | string | Optional |
| ignorePendingReservation | Set this to true to not include reservations that are pending modifications in the response. Set this to false to include reservations that are pending modifications in the response. | boolean | Optional |
| includeAssociatedReservations | Set this to true to have the response include reservations that are associated in the same itinerary. The associated reservations in the response will be only those with a status of Confirmed or Cancelled. Set this to false to have the response not include reservations that are associated in the same itinerary. | boolean | Optional |
| hotel | You can specify the unique ID of a single hotel property in CRS. | string | Optional |
| chain | You can specify the unique ID of a hotel chain or management group in CRS. | string | Optional |
| cro | You can specify a CRO number to retrieve applicable reservations. The CRO number is the unique ID in CRS for a Central Reservation Office. Use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&cro=14160760 | string | Optional |
| channel | You can specify the channel that requested the reservation. | string | Optional |
| arrival | You can specify an arrival date to retrieve applicable reservations. If you don't specify an arrival date, all arrival dates are included in the response. Use a semicolon to separate the start and end dates. To find arrival dates within a date range, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&arrival=2026-11-01;2026-12-01 If you know the exact date to find, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&arrival=2026-11-01;2026-11-01 | string | Optional |
| departure | You can specify a departure date to retrieve applicable reservations. If you don't specify a departure date, all departure dates are included in the response. Use a semicolon to separate the start and end dates. To find departure dates within a date range, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&departure=2026-11-01;2026-12-01 If you know the exact date to find, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&departure=2026-11-01;2026-11-01 You can also use the following values for departure: None (specifies an unbound search), Past (includes all Past departure dates), Future (includes all Future departure dates). Use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&departure=Future | string | Optional |
| depositDueDate | You can specify a deposit due date to retrieve applicable reservations. If you don't specify a deposit due date, all deposit due dates are included in the response. Use a semicolon to separate the start and end dates. To find deposit due dates within a date range, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&depositDueDate=2026-11-01;2026-12-01 If you know the exact date to find, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&depositDueDate=2026-11-01;2026-11-01 | string | Optional |
| agentUserName | You can specify the username of the call center agent who is associated with the reservation. | string | Optional |
| agentModificationDates | You can specify a date range of agent-modified reservations. Use a semicolon to separate the start and end dates. To find deposit due dates within a date range, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&agentModificationDates=2026-11-01;2026-12-01 If you know the exact date to find, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&agentModificationDates=2026-11-01;2026-11-01 | string | Optional |
| guestId | You can specify the unique Profile ID of the guest. | string | Optional |
| guestFirstName | You can specify the given first name of the guest. The best practice to receive a manageable number of results is to include both first name and last name. If you know the exact first name, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&guestFirstName=Laura&guestLastName=Walker If you don't know the exact first name, you can use a wildcard in the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&guestFirstName=L%&guestLastName=Walker | string | Optional |
| guestLastName | You can specify the Surname / Last name of the guest. The best practice to receive a manageable number of results is to include both first name and last name. If you know the exact last name, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&guestFirstName=Laura&guestLastName=Walker If you don't know the exact last name, you can use a wildcard in the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&guestFirstName=Laura&guestLastName=W%
| string | Optional |
| guestAddressCity | You can specify the city of the guest. | string | Optional |
| guestPhoneNumber | You can specify the phone number of the guest. Use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&guestPhoneNumber=555-123-4567 | string | Optional |
| guestEmail | You can specify the email address of the guest. Use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&guestEmail=laura.walker@email.com | string | Optional |
| guestMembershipId | You can specify the Loyalty Membership number of the guest. | string | Optional |
| guestProgramId | You can specify the Loyalty Program in which the guest is a member. Use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&guestProgramId=LOYALTYPROGRAM | string | Optional |
| guestCreditCard | You can specify the credit card number on the guest profile used for the reservation. | string | Optional |
| isGroupReservation | You can specify group or non-group reservations to retrieve applicable reservations. Use true to search for group reservations: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&isGroupReservation=true Use false to search for non-group reservations: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&isGroupReservation=false | boolean | Optional |
| loyaltyCertificate | You can specify the loyalty certificate number that was applied to a reservation. | string | Optional |
| agentId | You can specify a Booker profile ID that was used to create a reservation. Note: To use agentId, you must also specify an agentType. See agentType below for examples. | string | Optional |
| agentType | You can specify the type of Booker profile ID that was used to create a reservation. Note: To use agentType, you must also specify an agentId. To find an agent ID that is associated with a Booker, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&agentId=789&agentType=Booker To find an agent ID that is a Travel Agency number associated with a Commissionable Account or Booker, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&agentId=789&agentType=IATA To find an agent ID (for a chain agent) that is a Travel Agency number associated with a Commissionable Account or Booker, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&agentId=789&agentType=ChainAgent | string | Optional |
| pageStart | You can specify the starting record to be returned in the response. Use 0 to start at the first record. Use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&pageStart=0&pageSize=1 | string | Optional |
| pageSize | You can specify the number of records to be returned in the response. Use 0 to return all records. Use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&pageStart=0&pageSize=1 | string | Optional |
| sort | You can specify how to sort the results in the response. To sort, use one of the following sort options. To sort in ascending order by your specified option, do not include a minus sign. To sort in descending order by your specified option, include a minus sign before the option. • Use Arrival to sort based on RoomStay.StartDate • Use CheckIn to sort based on RoomStay.StartDate. • Use CrsConfirmationNumber to sort based on CRSConfirmationNumber. • Use CurrentBalance to sort based on TotalAmountIncludingTaxesFees, minus any deposit amounts. • Use Departure to sort based on RoomStay.EndDate. • Use GroupName to sort based on the primary rate name if RoomStay.Group is true. • Use GuestName to sort based on primary guest First and Last Name in Guests.PersonName. • Use PaymentType to sort based on primary payment type code in Guests.Payments. • Use RateAmount to sort based on RoomPrices.TotalPrice.Price.TotalAmountIncludingTaxesFees. • Use RatePlan to sort based on primary product rate code in Product.RateCode. • Use RoomNumber to sort based on Product/RoomUnit. • Use RoomType to sort based on primary product room code in Product.RoomCode. • Use Status to sort based on Status. • Use StayLength to sort based on the difference between RoomStay.EndDate and RoomStay.StartDate. Here is an example that sorts in descending order: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&sort=-Arrival | string | Optional |
| view | You can specify a view to control the amount of information to be returned for each reservation in the response. Use one of the following options: • Use Lookup to view basic information. This is the default. • Use DetailedLookup to view basic information and some additional information. • Use DetailedLookupWithRoomPrices to see the DetailedLookup view along with room prices. • Use Full to view the full information. Use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&view=DetailedLookupWithRoomPrices | string | Optional |
| activityDateRange | You can specify start and end date times to return only the applicable reservation activity. The dates are the UTC DateTime range of the last modification. Use a semicolon to separate the start and end dates. To specify both the start and end date, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&activityDateRange=2026-08-10THH:MM:SS;2026-08-11THH:MM:SS To specify only the end date, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&activityDateRange=;2026-08-10THH:MM:SS To specify only the start date, use the following format: /v1/api/hotel/reservation?hotel=13098&view=Full&chain=12723&activityDateRange=2026-08-10THH:MM:SS; | string | Optional |
Response in JSON
{
"links":[
{
"href":"https://[ENDPOINT]/reservation/api/v1.0/reservation",
"rel":"self"
}
],
"pagination":{
"total":1,
"start":0,
"size":0
},
"reservations":[
{
"Alerts":[
{
"Id":"c020a7fc-a0e9-47a0-bc62-965o5781ba06"
}
],
"BillingLocations":[
{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"BusinessName":"Business Address",
"EmailAddress":"info@abc.com",
"ContactNumbers":[
{
"Type":"Fax",
"Number":"string"
}
],
"Address":{
"AddressLine":[
"123 Main St."
],
"City":"Denver",
"Country":{
"Code":"US"
},
"PostalCode":"70045",
"StateProv":{
"Code":"CO"
}
}
}
],
"BookingDues":{
"PayNow":false,
"CancelPenalty":{
"Amount":150,
"Deadline":"01/06/2026 12:00:00 AM"
},
"Deposit":{
"Amount":0,
"AmountWithoutTax":0,
"Comment":"No deposit required",
"DueDate":"2026-07-05T00:00:00",
"Status":"None"
}
},
"ReservationReferences":[
{
"Number":"C-1099873",
"Type":"string"
}
],
"BookingInfo":{
"BookedBy":"John Doe",
"BookingDate":"2025-07-04T14:54:06",
"ApplicationUserMetaData":"applicationUser12345",
"EntryChannelBookingDate":"2025-07-04T14:54:06",
"ChannelConfirmationNumber":"EX442876",
"EntryChannelCode":"GDS",
"GDS_RecordLocator":"QWDTGE",
"AuthorizationNote":"Payment has been authorized",
"OriginalSource":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"SynXis Booking Engine Webservices."
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"SynXis Booking Engine Webservices."
},
"SubSourceCode":"KYK"
},
"ReservationNotifSource":"OTA"
},
"BookerProfile":{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Role":"Agent"
},
"Brand":{
"Code":"PB1",
"Id":800003,
"Name":"Paradise Brand Group"
},
"CRS_cancellationNumber":"64707XT000968X",
"CRS_confirmationNumber":"64707CU000968",
"CrsConfirmationNumber":"64707CU000968",
"PMS_confirmationNumber":"6598446",
"Chain":{
"Code":"SYHC",
"Id":15458,
"Name":"string"
},
"CRO":{
"Code":"JWMC",
"Id":3426,
"Name":"SynXis CRO"
},
"Channels":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"SynXis Booking Engine Webservices."
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"SynXis Booking Engine Webservices."
},
"SubSourceCode":"KYK",
"SecondarySubSourceCode":"789"
},
"CommissionableAccountProfile":{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"TravelIndustryId":"30000024"
},
"CompanyProfile":{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD"
},
"CouponOfferCode":"Save50",
"CouponOffers":[
{
"Code":"Save50",
"PreferredSortOrder":0
}
],
"Currency":{
"Code":"USD",
"Name":"US Dollars",
"Symbol":"$"
},
"ExternalReferenceNumber":"8876-345",
"Guests":[
{
"CRS_referenceNumber":"string",
"Comments":"string",
"StartDate":"2025-08-29T00:00:00",
"EndDate":"2026-08-31T00:00:00",
"Deposits":[
{
"Amount":115.5,
"AuthorizationCode":"463853",
"Date":"2025-07-31T00:00:00"
}
],
"EmailAddress":[
{
"Type":"Primary",
"Value":"larry.walker@mail.com"
}
],
"Citizenships":[
{
"CountryCode":"US",
"Primary":true
}
],
"ContactNumbers":[
{
"Default":true,
"Number":"55512345678",
"Role":"Home",
"Type":"Mobile",
"Use":"DayTimeContact"
}
],
"DateOfBirth":"1985-05-18",
"Gender":"Male",
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Locations":[
{
"Address":{
"AddressLine":[
"123 Main St."
],
"Business":{
"Name":"Acme, Inc.",
"Unit":"Southeast Branch"
},
"City":"Denver",
"Country":{
"Code":"US"
},
"Default":true,
"PostalCode":"70045",
"StateProv":{
"Code":"CO"
},
"Type":"Home"
},
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Name":"My Home Address"
}
],
"MarketingOptIn":true,
"Payments":[
{
"Amount":125,
"BankDeposit":{
"BankCode":"BA",
"BankName":"Bank of America"
},
"DirectBill":{
"AccountNumber":"8365920440",
"ProjectNumber":"112234",
"Source":"Local"
},
"EWallet":{
"ProviderCode":"EW1",
"WalletPaymentToken":"test1234"
},
"LoyaltyRedemption":{
"Points":500,
"LoyaltyMembership":{
"MembershipID":"YX-12345678",
"ProgramID":"SYNX",
"redemptionLimit":2500,
"pointsOverage":200
}
},
"PaymentCard":{
"AllowedCharges":"A-All Charges",
"CardCode":"VI",
"CardHolder":"Larry Walker",
"CardName":"Visa",
"CardNumber":"4444444444444444",
"CardSecurityCode":"123",
"CompanyName":"Beta Company",
"ExpireDate":"1223",
"Token":"cjzHiunsdfjnkkIbgoinN",
"ReferenceID":"2123554",
"SpecialInstructions":"Special instructions",
"CardValidityStartDate":"2025-08-29T00:00:00",
"CardValidityEndDate":"2026-08-29T00:00:00",
"InstallmentOptionId":"30303130311350000566005346e642b424e6f4",
"FintechPaymentProvider":{
"Code":"FTECHPROV1",
"Name":"Fintech Provider One"
},
"Extension":{
"CurrencyCode":"USD",
"SpecialInstructions":"Special instructions",
"ActivationStartDate":"2025-08-29T00:00:00",
"ActivationEndDate":"2026-08-29T00:00:00",
"AuthorizedAmount":125,
"IsVccPayment":false,
"VccVendor":"Vendor name"
},
"Wallet":{
"Vendor":{
"code":"AmexCheckout"
}
},
"VendorBillingDetails":{
"EmailAddress":"info@abc.com",
"ContactNumbers":[
{
"Type":"Fax",
"Number":"string"
}
],
"Address":{
"AddressLine":[
"123 Main St."
],
"City":"Denver",
"Country":{
"Code":"US"
},
"PostalCode":"70045",
"StateProv":{
"Code":"CO"
}
}
}
},
"Role":"Personal",
"Type":"CreditCard",
"VendorStatus":"Unknown",
"VirtualPayments":[
{
"AllowedCharges":"A-All Charges",
"CardCode":"VI",
"CardHolder":"Larry Walker",
"CardName":"Visa",
"CardNumber":"4444444444444444",
"CardSecurityCode":"123",
"CompanyName":"Beta Company",
"ExpireDate":"1223",
"Token":"cjzHiunsdfjnkkIbgoinN",
"ReferenceID":"2123554",
"SpecialInstructions":"Special instructions",
"CardValidityStartDate":"2025-08-29T00:00:00",
"CardValidityEndDate":"2026-08-29T00:00:00",
"InstallmentOptionId":"303031303113500005660346e642b424e6f4",
"Wallet":{
"Vendor":{
"code":"AmexCheckout",
"WalletPaymentToken":"test1234"
}
}
}
],
"InstallmentOptions":[
{
"NumberOfInstallments":6,
"TotalAmount":200,
"InstallmentAmount":34.75,
"InterestAmount":8.5,
"InterestRate":5
}
]
}
],
"PersonName":{
"GivenName":"Larry",
"MiddleName":"A",
"Prefix":"Mr.",
"Suffix":"Jr.",
"Surname":"Walker",
"PreferredGivenName":"Lenny",
"PreferredSurname":"Wentworth"
},
"ProfileID":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Role":"Primary",
"SpokenLanguages":[
{
"Code":"en",
"Default":true
}
],
"TravelDocuments":[
{
"Type":"MilitaryIdentification",
"HolderName":"Larry Walker",
"Number":"2999-9285820-874",
"IssuingAuthority":"DOJ",
"PlaceOfIssue":"Houston, TX"
}
],
"ProfileExternalReferences":[
{
"Type":"CRM",
"Primary":true,
"Number":"SY820099930"
}
]
}
],
"Hotel":{
"Code":"HOP",
"Id":13098,
"Name":"SynXis Hotel"
},
"ItineraryNumber":"15458B0000888",
"Language":{
"Code":"nl-NL",
"Name":"Dutch"
},
"LoyaltyMemberships":[
{
"Source":"Selected",
"Level":{
"Code":"Gold",
"Name":"Gold Members"
},
"MembershipID":"SY790887688",
"Name":"SynXis Members Only",
"ProgramID":"SYLC",
"EffectiveDate":"2019-08-29T00:00:00",
"EnrollmentCode":"WEB",
"ExpirationDate":"2026-10-23T00:00:00"
}
],
"ReservationAwardList":[
{
"AwardNumber":"1234567890",
"AwardType":"ClubAccess",
"IsPassThroughRedemption":true
}
],
"MarketSegment":{
"Code":"GLEI",
"Name":"Group"
},
"MarketSource":{
"Code":"META",
"Name":"Meta Search"
},
"CampaignDetails":{
"AffiliateUrlId":"AFF-789",
"CampaignId":"CMP-12345",
"PartnerId":"PARTNER-001",
"ReferralId":"REF-2025",
"SourceId":"SRC-ABC"
},
"Notification":{
"SendBookerEmail":false,
"SendGuestEmail":false,
"FromEmailAddress":"reservations@myhotel.com",
"AdditionalEmailAddresses":[
"recipient@destination.com"
],
"LanguageCode":"en-US",
"LanguageId":0,
"EmailTemplate":{
"Code":"HTK1",
"Level":"Hotel"
},
"DeliveryComments":[
{
"Comment":"Guest would like to have flowers in the room",
"Id":"GC1"
}
],
"PublicComment":"Hotel Comment 1"
},
"onHoldReleaseTime":6,
"OnPropertyInstructions":{
"Housekeeping":{
"ScheduleCode":"FC3"
},
"ChargeRoutingList":[
{
"Code":"MH34",
"FolioNumber":"93984952"
}
]
},
"Overrides":[
{
"Type":"PriceOverride",
"Comment":"Honeymoon"
}
],
"Packages":[
{
"Code":"BKFST42",
"Date":"2026-08-29T00:00:00",
"Name":"Breakfast for two",
"Quantity":1,
"QuantityName":"per room",
"redeemLoyalty":true,
"time":"0800",
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
},
"ChargeFrequency":"PerNight",
"ChargeType":"PerPerson",
"ChargeCodes":[
{
"AllowanceAmount":25,
"Codes":[
{
"Type":"ChargeCode",
"Code":"B5938"
}
]
}
],
"BookedDays":[
{
"date":"2026-08-31T00:00:00",
"time":"12:30 PM",
"quantity":1,
"GuestCount":[
{
"AgeQualifiyingCode":"Adult",
"NumGuests":2,
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
}
],
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
}
],
"GuestCount":[
{
"AgeQualifiyingCode":"Adult",
"NumGuests":2,
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
}
],
"CancelPolicy":{
"Code":"1D",
"Description":"Booking must be cancelled 1D prior to arrival",
"CancellationPermitted":true,
"LateCancellationPermitted":true,
"CancelFeeAmount":{
"Amount":90,
"TaxInclusive":true
},
"CancelFeeType":"None",
"CancelPenaltyDate":"2026-08-25T00:00:00",
"CancelTime":"0",
"CancelTimeIn":"2",
"ChargeThreshold":"2",
"ChargeType":"ChargeWithinDays",
"ModificationRestrictions":"ANGDS",
"NoShowFeeAmount":{
"Amount":150,
"TaxInclusive":true
},
"NoShowFeeType":"NumberNightsOfStay",
"Charges":[
{
"CancelFeeAmount":0,
"CancelFeeIncludesTax":true,
"DaysToArrive":0
}
]
}
}
],
"Promotion":{
"AccessKey":{
"Code":"5PCOFF",
"Name":"5% OFF",
"Password":"5PCOFF"
},
"Code":"SUMMER5",
"Name":"Book Now and Save 5%",
"Type":"Promotion"
},
"PurposeOfStay":"Leisure",
"RoomPrices":{
"AveragePrice":{
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
},
"PriceBreakdowns":[
{
"ProductPrices":[
{
"EndDate":"2026-08-31T00:00:00",
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
},
"Product":{
"Id":"57b391d5-f811-4758-9af2-2307021ed427",
"RateCode":"RtStD1",
"RoomCode":"SRm1"
},
"StartDate":"2025-08-29T00:00:00"
}
],
"Type":"Daily"
}
],
"TotalPrice":{
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
},
"ExemptedTaxTypes":[
{
"Code":"DC45",
"Name":"Spa Access",
"Type":"ResortFee",
"Amount":25,
"Points":5000,
"Level":"Hotel",
"Breakdown":[
{
"Date":"2026-03-24T00:00:00.000Z",
"Amount":5,
"Points":5000,
"ReasonCode":"CityTaxExempt"
}
]
}
]
},
"RoomStay":{
"Group":false,
"Suppressed":false,
"EndDate":"2026-08-31T00:00:00",
"GuestCount":[
{
"AgeQualifyingCode":"Child",
"Ages":[
2
],
"NumGuests":2
}
],
"NumRooms":1,
"Products":[
{
"EndDate":"2026-08-31T00:00:00",
"Primary":true,
"Product":{
"DefaultRoomCode":"STD",
"DefaultRateCode":"BAR",
"Id":"57b391d5-f811-4758-9af2-2307021ed427",
"RateCode":"BAR",
"RateName":"Advanced Purchase Rate",
"RoomCode":"A1K",
"RoomName":"Standard King",
"RoomUnit":"201"
},
"Price":{
"Amount":250,
"Points":5000
},
"StartDate":"2024-08-29T00:00:00"
}
],
"redeemLoyalty":true,
"refresh":"New",
"startDate":"2024-08-29T00:00:00",
"CheckInDate":"2026-08-29T00:00:00",
"CheckOutDate":"2026-08-31T00:00:00"
},
"RoomRequests":[
{
"Code":"50001"
}
],
"RuleTrackingList":[
{
"Type":"Comments",
"Id":[
"string"
]
}
],
"Transporation":{
"EstimatedCheckInTime":"12:30 PM",
"EstimatedCheckOutTime":"2:30 PM",
"Details":[
{
"TransferRequest":{
"Code":"TC1",
"Type":"Arrival",
"Chargeable":true,
"RequiresArrangement":true,
"Time":"1PM",
"Mode":"Taxi"
},
"Airline":{
"Code":"AA",
"FlightNumber":"1597"
},
"Location":{
"Code":"DFW",
"Type":"Airport",
"Details":"BS123"
}
}
]
},
"TaxExempt":[
{
"Type":"CityTax"
}
],
"PriceExemptionList":[
{
"endDate":"string",
"startDate":"string",
"exempt":true,
"TaxCode":[
{
"ReasonCode":"MILITARY",
"TaxCode":"BRTX1"
}
],
"Type":[
{
"ReasonCode":"MILITARY",
"Type":"CityTax"
}
]
}
],
"Upgrade":{
"Reason":{
"Code":"UG2"
},
"RoomToCharge":{
"Code":"A1Q"
},
"RoomToStay":{
"Code":"A1K"
}
},
"WaitList":{
"Code":"WL5467",
"Description":"Waiting Payment Information"
},
"status":"Confirmed",
"onPropertyStatus":"InHouse",
"Source":{
"IP_Address":"198.162.1.1",
"BookingURL":"myhotelwebsite.com",
"Telephony":{
"VDN":"VDN1234"
},
"BrowserDetails":{
"ReadyFor3DSVersion":"2.0",
"JavaEnabled":true,
"JavascriptEnabled":true,
"ScreenColorDepth":32,
"ScreenHeight":250,
"ScreenWidth":400,
"TimeZoneOffset":-120,
"ChallengeWindowSize":1
}
},
"singleUsePaymentCardAllowed":false,
"roomStaySplit":"Default",
"links":[
{
"href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
"rel":"self"
}
],
"AdministrativeActions":[
{
"Description":"An email was sent to guest.",
"Date":"2025-07-17T15:44:06",
"UpdatedBy":"John Doe."
}
],
"Activity":[
{
"Type":"ModificationDate",
"Value":"2025-07-17T19:24:57"
}
],
"Content":{
"Discounts":[
{
"links":[
{
"href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
"rel":"self"
}
],
"CouponOffer":{
"links":[
{
"href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
"rel":"self"
}
],
"Code":"TESTCOUPON",
"ReservationReferences":[
{
"Number":"lk3k5lks",
"Type":"lk3k5lks"
}
]
},
"AdjustmentAmount":10,
"AdjustmentPercentage":10,
"AppliedAmount":10,
"AppliedPercentage":10,
"Order":10,
"Type":"Coupon"
}
],
"RateCategories":[
{
"CategoryCode":"3RDP",
"Description":"3rd Party Websites category code",
"Name":"3rd Party Websites"
}
],
"LoyaltyAccrualType":{
"Code":"Loyalty1",
"Name":"Loyalty1 accrual"
},
"Rates":[
{
"CategoryCode":"NEG",
"Code":"SCN2",
"CurrencyCode":"USD",
"Description":"Rate includes breakfast",
"DetailedDescription":"Rate inclusive of breakfast.",
"DisplayName":"string",
"Name":"Negotiated Rate",
"Primary":true,
"Type":"Negotiated"
}
],
"RoomCategories":[
{
"CategoryCode":"SUP",
"Description":"Superior Rooms on High Floor",
"Name":"Superior Rooms"
}
],
"Rooms":[
{
"CategoryCode":"SUP",
"Code":"SUPQ",
"Description":"2 Queen Beds",
"DetailedDescription":"2 Queen Beds-AC-Cable TV-Minibar-Balcony-Desk",
"Name":"Superior Room Queen Beds"
}
],
"RoomRequests":[
{
"Code":"50074",
"Description":"Non-Smoking Room Preferred",
"Name":"Non-Smoking"
}
],
"TaxExemptReasons":[
{
"Code":"CTECode",
"Type":"CityTaxExempt",
"TypeDescription":"City Tax Exempt",
"Description":"CityTaxExemptDescripotion"
}
]
},
"SortOrder":1,
"AutoCancelReleaseTime":"3/7/2026 3:00:00 AM",
"Id":"83e52f78-2909-49ab-91f4-63ce859cdd99",
"BookingPolicy":{
"Code":"GUA",
"Description":"A valid credit card is required.",
"TransactionFeeDisclaimer":"Do you agree with our Privacy Policy?",
"DepositFee":{
"Amount":40,
"DueDays":0,
"DueType":"AtTimeOfBooking",
"TaxInclusive":false,
"IsPrePayment":false,
"Type":"LocalCurrency"
},
"GuaranteeLevel":"Deposit",
"HoldTime":"0",
"Requirements":[
"CreditCard"
]
},
"BookingAgent":{
"EmailAddress":"bookingagent@ba.com",
"PersonName":{
"GivenName":"Larry",
"LegalName":"Larry Walker",
"Surname":"Walker"
},
"Id":"57b391d5-f811-4758-9af2-2307021ed427",
"TravelIndustryID":"TG678965",
"ExternalReferenceIds":[
{
"ExternalReferenceId":"G46291094Q",
"ExternalReferenceType":"PRIVE"
}
]
},
"CancelPolicy":{
"Code":"1D",
"Description":"Booking must be cancelled 1D prior to arrival",
"CancellationPermitted":true,
"LateCancellationPermitted":true,
"CancelFeeAmount":{
"Amount":90,
"TaxInclusive":true
},
"CancelFeeType":"None",
"CancelPenaltyDate":"2026-08-25T00:00:00",
"CancelTime":"0",
"CancelTimeIn":"2",
"ChargeThreshold":"2",
"ChargeType":"ChargeWithinDays",
"ModificationRestrictions":"ANGDS",
"NoShowFeeAmount":{
"Amount":150,
"TaxInclusive":true
},
"NoShowFeeType":"NumberNightsOfStay",
"Charges":[
{
"CancelFeeAmount":0,
"CancelFeeIncludesTax":true,
"DaysToArrive":0
}
]
},
"ProductCancellationRestricted":false,
"ProductModificationRestricted":false,
"CreateDateTime":"2025-07-17T19:24:57",
"UpdateDateTime":"2026-07-17T19:24:57",
"AssociatedReservations":[
{
"CRSConfirmationNumber":"11113EC000239",
"Status":"Confirmed",
"ArrivalDate":"2026-08-26T00:00:00",
"DepartureDate":"2026-08-28T00:00:00"
}
]
}
]
}
Response Elements
The following table explains the elements you receive in the response.
To make the response structure easier to follow, this table prefixes every element with the object and array structure that contains it, like this: ArrayOne.ArrayTwo.ArrayThree.Element
| Element | Description | Type |
|---|---|---|
| links | The array to hold link information about this request. | array |
| links.href | Link to related API request. | string |
| links.rel | Describes relationship between href and current request. | string |
| pagination | The object to hold pagination information about this request. | object |
| pagination.total | Total number of records. | integer |
| pagination.start | Start index of the record. | integer |
| pagination.size | Number of records in the response. | integer |
| reservations | The array to hold the reservation details. | array |
| reservations.Alerts | The array to hold the reservation alert details. | array |
| reservations.Alerts.Id | Unique GUID associated to an Alert. | string |
| reservations.BillingLocations | The array to hold the billing location details. | array |
| reservations.BillingLocations.Id | VAT Identification Number. | string |
| reservations.BillingLocations.BusinessName | Business name of the billing location. | string |
| reservations.BillingLocations.EmailAddress | Email address of the business location. | string |
| reservations.BillingLocations.ContactNumbers | The array to hold contact number details. | array |
| reservations.BillingLocations.ContactNumbers.Type | The type of a contact number, such as Voice, Fax, or Mobile. | string |
| reservations.BillingLocations.ContactNumbers.Number | The billing location contact number. | string |
| reservations.BillingLocations.Address | The object to hold the billing location address. | object |
| reservations.BillingLocations.Address.AddressLine | The street address for the billing location. | string |
| reservations.BillingLocations.Address.City | City associated with an address. | string |
| reservations.BillingLocations.Address.Country | The object to hold the country associated with an address. | object |
| reservations.BillingLocations.Address.Country.Code | The ISO 1366-1 country code. | string |
| reservations.BillingLocations.Address.PostalCode | Postal code associated with an address. | string |
| reservations.BillingLocations.Address.StateProv | The object to hold the state or province associated with an address. | object |
| reservations.BillingLocations.Address.StateProv.Code | Code of a state or province associated with an address. | string |
| reservations.BookingDues | The object to hold the list of charges that are payable now and later. Not supported for the create and update reservation endpoints. | object |
| reservations.BookingDues.PayNow | If this is true, the booking dues are payable at the time of reservation. If this is false, the booking dues are not payable at the time of reservation. | boolean |
| reservations.BookingDues.CancelPenalty | The object to hold information about the cancel penalty. | object |
| reservations.BookingDues.CancelPenalty.Amount | Amount to be collected as penalty. | number |
| reservations.BookingDues.CancelPenalty.Deadline | Last date to cancel without incurring a penalty. | string |
| reservations.BookingDues.Deposit | The object to hold information about the booking dues deposit amount. | object |
| reservations.BookingDues.Deposit.Amount | Value of a required deposit fee for the tax or bill. | number |
| reservations.BookingDues.Deposit.AmountWithoutTax | Value of the deposit amount without tax portion. | number |
| reservations.BookingDues.Deposit.Comment | Use the Comment to add information about a deposit. | string |
| reservations.BookingDues.Deposit.DueDate | Specifies the date, before which the deposit must be received. | string |
| reservations.BookingDues.Deposit.Status | Specifies status of a deposit payment. | string |
| reservations.ReservationReferences | The array to hold information about the reservation references. | array |
| reservations.ReservationReferences.Number | The reference number associated with the reservation. | string |
| reservations.ReservationReferences.Type | The type associated with the reservation reference. | string |
| reservations.BookingInfo | The object to hold information about the booking. | object |
| reservations.BookingInfo.BookedBy | Name of a person who made the reservation. | string |
| reservations.BookingInfo.BookingDate | Date when the booking was created (YYYY-MM-DDTHH:MM:SS). | string |
| reservations.BookingInfo.ApplicationUserMetaData | ApplicationUserMetaData is used to pass the identifier of the person from the external system who modified the reservation. | string |
| reservations.BookingInfo.EntryChannelBookingDate | Date when a booking was reinstated (YYYY-MM-DDTHH:MM:SS). | string |
| reservations.BookingInfo.ChannelConfirmationNumber | This is only applicable when a reservation that an IDS, GDS, or OTA partner was unable to send to the CRS is recreated manually. | string |
| reservations.BookingInfo.EntryChannelCode | Code of an entry channel. This is only applicable when a reservation that an IDS, GDS, or OTA partner was unable to send to the CRS is recreated manually. | string |
| reservations.BookingInfo.GDS_RecordLocator | GDS record locator associated with a reservation. This is only applicable when a reservation that a GDS partner was unable to send to the CRS is recreated manually. | string |
| reservations.BookingInfo.AuthorizationNote | Authorization details related to "Pay Now" option at booking. | string |
| reservations.BookingInfo.OriginalSource | The array to hold the original source to impersonate during a modification. | array |
| reservations.BookingInfo.OriginalSource.PrimaryChannel | The array to hold the Control Center code for a reservation Channel. | array |
| reservations.BookingInfo.OriginalSource.PrimaryChannel.Code | CRS code for a reservation channel. | string |
| reservations.BookingInfo.OriginalSource.PrimaryChannel.Description | CRS booking channel description. | string |
| reservations.BookingInfo.OriginalSource.SecondaryChannel | The array to hold the Control Center code for a reservation Channel. | array |
| reservations.BookingInfo.OriginalSource.SecondaryChannel.Code | CRS code for a reservation channel. | string |
| reservations.BookingInfo.OriginalSource.SecondaryChannel.Description | CRS booking channel description. | string |
| reservations.BookingInfo.OriginalSource.SubSourceCode | Control Center code for a reservation's sub source, interpreted as the third Channel. | string |
| reservations.BookingInfo.ReservationNotifSource | Source of the reservation. This applies to only to the POST and PATCH /reservation/notif endpoints. | string |
| reservations.BookerProfile | The object to hold the booker profile. | object |
| reservations.BookerProfile.Id | A unique number identifying the person who made a reservation. | string |
| reservations.BookerProfile.Role | Specifies role of the booker. | string |
| reservations.Brand | The object to hold the brand information. | object |
| reservations.Brand.Code | Code identifying a specific brand. | string |
| reservations.Brand.Id | Unique number that identifies a specific brand in CRS. | integer |
| reservations.Brand.Name | Name of a brand. | string |
| reservations.CRS_cancellationNumber | CRS cancellation number identifying the reservation which was cancelled. | string |
| reservations.CRS_confirmationNumber | CRS confirmation number identifying a reservation. | string |
| reservations.CrsConfirmationNumber | CRS confirmation number identifying a reservation. | string |
| reservations.PMS_confirmationNumber | PMS confirmation number for the reservation. | string |
| reservations.Chain | The object to hold the chain information. | object |
| reservations.Chain.Code | Unique Code that identifies a hotel chain or management group in CRS. | string |
| reservations.Chain.Id | Unique Id that identifies a hotel chain or management group in CRS. | integer |
| reservations.Chain.Name | SynXis hotel chain. | string |
| reservations.CRO | The object to hold the CRO information. | object |
| reservations.CRO.Code | Code for the Central Reservation Office (CRO) that made a reservation. This value is only added if a CRO is used to book a reservation. | string |
| reservations.CRO.Id | CRS ID for the Central Reservation Office that made a reservation. This value is only added when a CRO is used to book a reservation. | integer |
| reservations.CRO.Name | Name of the Central Reservation Office that made a reservation. This value is only added if a CRO is used to book a reservation. | string |
| reservations.Channels | The object to hold the channel information. | object |
| reservations.Channels.PrimaryChannel | The array to hold the Control Center code for the primary reservation Channel. | array |
| reservations.Channels.PrimaryChannel.Code | CRS code for a reservation channel. | string |
| reservations.Channels.PrimaryChannel.Description | CRS booking channel description. | string |
| reservations.Channels.SecondaryChannel | The array to hold the Control Center code for the secondary reservation Channel. | array |
| reservations.Channels.SecondaryChannel.Code | CRS code for a reservation channel. | string |
| reservations.Channels.SecondaryChannel.Description | CRS booking channel description. | string |
| reservations.Channels.SubSourceCode | Control Center code for a reservation's sub source, interpreted as the third Channel. | string |
| reservations.Channels.SecondarySubSourceCode | Control Center code for a reservation's sub source, interpreted as the fourth Channel. | string |
| reservations.CommissionableAccountProfile | The object to hold the commissionable account profile. | object |
| reservations.CommissionableAccountProfile.Id | ID of a commissionable account. | string |
| reservations.CommissionableAccountProfile.TravelIndustryId | Travel Industry ID of a commissionable account. | string |
| reservations.CompanyProfile | The object to hold the company profile. | object |
| reservations.CompanyProfile.Id | ID of a company profile. | string |
| reservations.CouponOfferCode | Code for a coupon or an offer. | string |
| reservations.CouponOffers | The array to hold the coupon offers. | array |
| reservations.CouponOffers.Code | Code for a coupon or an offer. | string |
| reservations.CouponOffers.PreferredSortOrder | Sort Order for Coupon or an offer. | integer |
| reservations.Currency | The object to hold the reservation currency. | object |
| reservations.Currency.Code | Currency code for the monetary unit. Use ISO 4217, three alpha codes. | string |
| reservations.Currency.Name | Name of the currency. | string |
| reservations.Currency.Symbol | Symbol of the currency. | string |
| reservations.ExternalReferenceNumber | External reference number associated with the reservation. | string |
| reservations.Guests | The array to hold the guest information. | array |
| reservations.Guests.CRS_referenceNumber | CRS Id for a guest. Response parameter only. | string |
| reservations.Guests.Comments | Specifies comments for the guest. Visible in the Aven Hospitality Voice Agent application. | string |
| reservations.Guests.StartDate | Defines check in date for a guest. | string |
| reservations.Guests.EndDate | Defines check out date for a guest. | string |
| reservations.Guests.Deposits | The array to hold the guest deposit information. | array |
| reservations.Guests.Deposits.Amount | Value of a required deposit fee. | number |
| reservations.Guests.Deposits.AuthorizationCode | Authorization code for a deposit. | string |
| reservations.Guests.Deposits.Date | Specifies when a deposit fee should be paid. | string |
| reservations.Guests.EmailAddress | The array to hold email address information of the guest. | array |
| reservations.Guests.EmailAddress.Type | Type of an email address of a guest. | string |
| reservations.Guests.EmailAddress.Value | Type of email address. Available values are: Primary or Mobile. | string |
| reservations.Guests.Citizenships | The array to hold the citizenship information for the guest. | array |
| reservations.Guests.Citizenships.CountryCode | The ISO 1366-1 country code for a country in which the guest is a citizen. | string |
| reservations.Guests.Citizenships.Primary | If this is true, the Country Name associated with citizenship is primary. If this is false, the Country Name associated with citizenship is not primary. | boolean |
| reservations.Guests.ContactNumbers | The array to hold the contact numbers. | array |
| reservations.Guests.ContactNumbers.Default | If this is true, the contact number is the default. If this is false, the contact number is not the default. | boolean |
| reservations.Guests.ContactNumbers.Number | A contact number through which a guest can be reached. | string |
| reservations.Guests.ContactNumbers.Role | Specifies the role of a contact number. Available values are: Unknown, Home, or Office. | string |
| reservations.Guests.ContactNumbers.Type | Specifies the type of a contact number. Available values are: Unknown, Voice, Fax, Mobile, Voice1, Voice2. | string |
| reservations.Guests.ContactNumbers.Use | Specifies the time of day to use for the contact number. Available values are: Unknown, DayTimeContact, EveningContact, or AnytimeContact. | string |
| reservations.Guests.DateOfBirth | Guest date of birth. | string |
| reservations.Guests.Gender | Specifies the gender of a guest. Available values are: Male, Female or Unspecified. | string |
| reservations.Guests.Id | Unique GUID identifying the guest. | string |
| reservations.Guests.Locations | The array to hold the guest locations. | array |
| reservations.Guests.Locations.Address | The object to hold the location address. | object |
| reservations.Guests.Locations.Address.AddressLine | The street-related information associated with the address. | string |
| reservations.Guests.Locations.Address.Business | The object to hold the location's business address. | object |
| reservations.Guests.Locations.Address.Business.Name | Name of a business associated with an address. | string |
| reservations.Guests.Locations.Address.Business.Unit | Business unit associated with an address. | string |
| reservations.Guests.Locations.Address.City | City associated with an address. | string |
| reservations.Guests.Locations.Address.Country | The object to hold the location's country. | object |
| reservations.Guests.Locations.Address.Country.Code | The ISO 1366-1 country code. | string |
| reservations.Guests.Locations.Address.Default | If this is true, the address is the default one. If this is false, the address is not the default one. | boolean |
| reservations.Guests.Locations.Address.PostalCode | Postal code associated with an address. | string |
| reservations.Guests.Locations.Address.StateProv | The object to hold the location's state or province. | object |
| reservations.Guests.Locations.Address.StateProv.Code | Code of a state or province associated with an address. | string |
| reservations.Guests.Locations.Address.Type | Specifies the type of address. Available values are: Home, Billing, BillingTax, Business, Chain, Collection, Contact, CreditCard, Delivery, Deposit, Hotel, Mailing, OtherUse, Permanent, Physical, PreOpeningOffice. | string |
| reservations.Guests.Locations.Id | ID of a location. | string |
| reservations.Guests.Locations.Name | Name of a location. | string |
| reservations.Guests.MarketingOptIn | If this is true, the guest has agreed to receive promotional messages. If this is false, the guest has not agreed to receive promotional messages. | boolean |
| reservations.Guests.Payments | The array to hold payment information. | array |
| reservations.Guests.Payments.Amount | Specifies the amount to be applied to the payment method in a split payment scenario. | number |
| reservations.Guests.Payments.BankDeposit | The object to hold bank deposit information. | object |
| reservations.Guests.Payments.BankDeposit.BankCode | Code of a bank. | string |
| reservations.Guests.Payments.BankDeposit.BankName | Name of a bank. | string |
| reservations.Guests.Payments.DirectBill | The object to hold direct bill information. | object |
| reservations.Guests.Payments.DirectBill.AccountNumber | An account number associated with the direct billing. | string |
| reservations.Guests.Payments.DirectBill.ProjectNumber | Project number associated with the direct billing. | string |
| reservations.Guests.Payments.DirectBill.Source | Specifies the source of direct bill. Available values are: Local, Undefined. | string |
| reservations.Guests.Payments.EWallet | The object to hold e-wallet information. | object |
| reservations.Guests.Payments.EWallet.ProviderCode | Code of an e-wallet provider. | string |
| reservations.Guests.Payments.EWallet.WalletPaymentToken | Vendor payment token if any. | string |
| reservations.Guests.Payments.LoyaltyRedemption | The object to hold loyalty redemption information. | object |
| reservations.Guests.Payments.LoyaltyRedemption.Points | Applicable number of points to be used as payment. | integer |
| reservations.Guests.Payments.LoyaltyRedemption.LoyaltyMembership | The object to hold loyalty membership information. | object |
| reservations.Guests.Payments.LoyaltyRedemption.LoyaltyMembership.MembershipID | Membership of the loyalty program. | string |
| reservations.Guests.Payments.LoyaltyRedemption.LoyaltyMembership.ProgramID | Program ID for the loyalty program. | string |
| reservations.Guests.Payments.LoyaltyRedemption.LoyaltyMembership.redemptionLimit | Specifies the number of points that can be redeemed from the loyalty program account. | integer |
| reservations.Guests.Payments.LoyaltyRedemption.LoyaltyMembership.pointsOverage | Specifies the number of points that is approved beyond the loyalty program account balance. Note that this usage requires specialized hotel configuration. | integer |
| reservations.Guests.Payments.PaymentCard | The array to hold information about the card used for payment. | array |
| reservations.Guests.Payments.PaymentCard.AllowedCharges | Specifies what charges can be charged to the card. | string |
| reservations.Guests.Payments.PaymentCard.CardCode | Code of a credit card. | string |
| reservations.Guests.Payments.PaymentCard.CardHolder | Specifies who is the card holder. | string |
| reservations.Guests.Payments.PaymentCard.CardName | Name of a credit card. | string |
| reservations.Guests.Payments.PaymentCard.CardNumber | Number of a credit card. | string |
| reservations.Guests.Payments.PaymentCard.CardSecurityCode | Security code of a credit card. | string |
| reservations.Guests.Payments.PaymentCard.CompanyName | Company name. | string |
| reservations.Guests.Payments.PaymentCard.ExpireDate | Expiration date of a credit card. | string |
| reservations.Guests.Payments.PaymentCard.Token | Token number associated with the card. | string |
| reservations.Guests.Payments.PaymentCard.ReferenceID | Reference id of the payment. | string |
| reservations.Guests.Payments.PaymentCard.SpecialInstructions | A set of instructions the hotel should use for handling payments. | string |
| reservations.Guests.Payments.PaymentCard.CardValidityStartDate | Defines card validity start date. | string |
| reservations.Guests.Payments.PaymentCard.CardValidityEndDate | Defines card validity end date. | string |
| reservations.Guests.Payments.PaymentCard.InstallmentOptionId | Installment option id for the payment installments. | string |
| reservations.Guests.Payments.PaymentCard.FintechPaymentProvider | The object to hold payment provider information. | object |
| reservations.Guests.Payments.PaymentCard.FintechPaymentProvider.Code | CRS Fintech Payment Provider code (Max length 10 characters). List of supported codes can be found in the Fintech Provider Outbound Mapping page in CRS where the type is Payment Provider. Invalid codes will be ignored. | string |
| reservations.Guests.Payments.PaymentCard.FintechPaymentProvider.Name | CRS Fintech Payment Provider name. Only supported in the GET operation. | string |
| reservations.Guests.Payments.PaymentCard.Extension | The array to extended information about the payment provider. | array |
| reservations.Guests.Payments.PaymentCard.Extension.CurrencyCode | ISO 4217 three alpha currency code. | string |
| reservations.Guests.Payments.PaymentCard.Extension.SpecialInstructions | A set of instructions the hotel should use for handling payments. | string |
| reservations.Guests.Payments.PaymentCard.Extension.ActivationStartDate | Defines card validity start date. | string |
| reservations.Guests.Payments.PaymentCard.Extension.ActivationEndDate | Defines card validity end date. | string |
| reservations.Guests.Payments.PaymentCard.Extension.AuthorizedAmount | Specifies the authorized amount to be applied to the payment method. | number |
| reservations.Guests.Payments.PaymentCard.Extension.IsVccPayment | If this is true, the reservation was made with a virtual credit card (VCC). If this is false, the reservation was not made with a VCC. | boolean |
| reservations.Guests.Payments.PaymentCard.Extension.VccVendor | VccVendor is used to return the vendor company name associated with the VCC payment. | string |
| reservations.Guests.Payments.PaymentCard.Wallet | The object to hold wallet information. | object |
| reservations.Guests.Payments.PaymentCard.Wallet.Vendor | The object to hold wallet vendor information. | object |
| reservations.Guests.Payments.PaymentCard.Wallet.Vendor.code | The wallet vendor code. | string |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails | The array to hold vendor billing information. | array |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.EmailAddress | Email address of the business location. | string |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.ContactNumbers | The array to hold vendor contact number information. | array |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.ContactNumbers.Type | The type for the vendor contact number, such as Fax or Mobile. | string |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.ContactNumbers.Number | The contact number. | string |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.Address | The object to hold vendor billing address. | object |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.Address.AddressLine | The street address for the vendor. | string |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.Address.City | The city associated with the vendor address. | string |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.Address.Country | The object to hold the vendor address country code. | object |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.Address.Country.Code | The ISO 1366-1 country code for the vendor address. | string |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.Address.PostalCode | Postal code associated with an address. | string |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.Address.StateProv | The object to hold the vendor address state or province. | object |
| reservations.Guests.Payments.PaymentCard.VendorBillingDetails.Address.StateProv.Code | Code of a state or province associated with an address. | string |
| reservations.Guests.Payments.Role | Specifies the role of a payment method. Available values are: Alternate, Business, Personal, Primary, Secondary. | string |
| reservations.Guests.Payments.Type | Specifies the type of a payment method. Available values are: BankDeposit, Cash, Check, CreditCard, DirectBill, eWallet, LoyaltyCertificate, LoyaltyPoints, MailDeposit, None, TravelAgent, Undetermined. | string |
| reservations.Guests.Payments.VendorStatus | Specifies the payment status and is only applicable if payment processing is enabled. | string |
| reservations.Guests.Payments.VirtualPayments | Used to communicate a virtual credit card details for Direct Bill reservations if the hotel is enabled for virtual card generation. This is a system generated payment. | array |
| reservations.Guests.Payments.VirtualPayments.AllowedCharges | Specifies what charges can be charged to the card. | string |
| reservations.Guests.Payments.VirtualPayments.CardCode | Code of a credit card. | string |
| reservations.Guests.Payments.VirtualPayments.CardHolder | Specifies who is the card holder. | string |
| reservations.Guests.Payments.VirtualPayments.CardName | Name of a credit card. | string |
| reservations.Guests.Payments.VirtualPayments.CardNumber | Number of a credit card. | string |
| reservations.Guests.Payments.VirtualPayments.CardSecurityCode | Security code of a credit card. | string |
| reservations.Guests.Payments.VirtualPayments.CompanyName | Company name. | string |
| reservations.Guests.Payments.VirtualPayments.ExpireDate | Expiration date of a credit card. | string |
| reservations.Guests.Payments.VirtualPayments.Token | Token number associated with the card. | string |
| reservations.Guests.Payments.VirtualPayments.ReferenceID | Reference id of the payment. | string |
| reservations.Guests.Payments.VirtualPayments.SpecialInstructions | A set of instructions the hotel should use for handling payments. | string |
| reservations.Guests.Payments.VirtualPayments.CardValidityStartDate | Defines card validity start date. | string |
| reservations.Guests.Payments.VirtualPayments.CardValidityEndDate | Defines card validity end date. | string |
| reservations.Guests.Payments.VirtualPayments.InstallmentOptionId | Installment option id for the payment installments. | string |
| reservations.Guests.Payments.VirtualPayments.Wallet | The object to hold wallet information. | object |
| reservations.Guests.Payments.VirtualPayments.Wallet.Vendor | The object to hold wallet vendor information. | object |
| reservations.Guests.Payments.VirtualPayments.Wallet.Vendor.code | The wallet vendor code. | string |
| reservations.Guests.Payments.VirtualPayments.Wallet.Vendor.WalletPaymentToken | The wallet vendor payment token (if any). | string |
| reservations.Guests.Payments.InstallmentOptions | Specifies the installment options applied to the payment if the payment method is enabled for installments. | array |
| reservations.Guests.Payments.InstallmentOptions.NumberOfInstallments | Number of Installments. | integer |
| reservations.Guests.Payments.InstallmentOptions.TotalAmount | Total amount. | number |
| reservations.Guests.Payments.InstallmentOptions.InstallmentAmount | Installment amount. | number |
| reservations.Guests.Payments.InstallmentOptions.InterestAmount | Interest amount. | number |
| reservations.Guests.Payments.InstallmentOptions.InterestRate | Interest rate. | number |
| reservations.Guests.PersonName | The object to hold the guest's name. | object |
| reservations.Guests.PersonName.GivenName | Specifies the Given or First name of a guest. | string |
| reservations.Guests.PersonName.MiddleName | Specifies a middle initial of a guest (maximum of 2 characters). | string |
| reservations.Guests.PersonName.Prefix | Specifies a prefix associated with the name of a guest. | string |
| reservations.Guests.PersonName.Suffix | Specifies a suffix associated with the name of a guest. | string |
| reservations.Guests.PersonName.Surname | Specifies the Surname/Lastname of the guest. | string |
| reservations.Guests.PersonName.PreferredGivenName | Specifies the preferred Given/First name of a guest. | string |
| reservations.Guests.PersonName.PreferredSurname | Specifies the preferred Surname/Lastname of the guest. | string |
| reservations.Guests.ProfileID | The CRS unique profile identifier. | string |
| reservations.Guests.Role | Role of the Guest Available values are: Primary or Additional. | string |
| reservations.Guests.SpokenLanguages | The array to hold information about the languages spoken by the guest. | array |
| reservations.Guests.SpokenLanguages.Code | Language code for the language spoken by the guest. Visible in the Aven Hospitality Voice Agent application. | string |
| reservations.Guests.SpokenLanguages.Default | If this is true, the Code associated with spoken language is the default. If this is false, the Code associated with spoken language is not the default. | boolean |
| reservations.Guests.TravelDocuments | The array to hold travel documentation information of the guest. | array |
| reservations.Guests.TravelDocuments.Type | Type of a travel document used by a guest to confirm their identity. Available values are: AlienRegistrationNumber, CpfTaxNumber, DriversLicense, InsurancePolicyNumber, MilitaryIdentification, NationalIdentityDocument, Passport, TaxExemptionNumber, VaccinationCertificate, VehicleRegistrationorLicenseNumber, or Visa. | string |
| reservations.Guests.TravelDocuments.HolderName | Name of the travel document owner. | string |
| reservations.Guests.TravelDocuments.Number | The number associated with a travel document. Available values are: Not visible in CRS but is available for delivery to 3rd party or PMS. | string |
| reservations.Guests.TravelDocuments.IssuingAuthority | The office which issued a travel document. | string |
| reservations.Guests.TravelDocuments.PlaceOfIssue | The place where a travel document was issued. | string |
| reservations.Guests.ProfileExternalReferences | The array to hold the profile external reference information. | array |
| reservations.Guests.ProfileExternalReferences.Type | Specifies the type of profile. | string |
| reservations.Guests.ProfileExternalReferences.Primary | If this is true, the profile is the primary one. If this is false, the profile is not the primary one. | boolean |
| reservations.Guests.ProfileExternalReferences.Number | The profile identifier. | string |
| reservations.Hotel | The object to hold hotel information. | object |
| reservations.Hotel.Code | Code that uniquely identifies a single hotel property in CRS. | string |
| reservations.Hotel.Id | Unique Id that identifies a hotel in CRS. | integer |
| reservations.Hotel.Name | Name of a hotel. | string |
| reservations.ItineraryNumber | Number of the itinerary. | string |
| reservations.Language | The object to hold information about the language the application displayed to the guest during the booking process. | object |
| reservations.Language.Code | Language code with optional culture code. | string |
| reservations.Language.Name | Name of the language. | string |
| reservations.LoyaltyMemberships | The array to hold information about the guest's loyalty membership. | array |
| reservations.LoyaltyMemberships.Source | Specifies how the membership was chosen to be used on this reservation. Available values are: Proactive, Selected, Unknown. | string |
| reservations.LoyaltyMemberships.Level | The object to hold the loyalty membership level information. | object |
| reservations.LoyaltyMemberships.Level.Code | Code associated with a level reached in a loyalty program. | string |
| reservations.LoyaltyMemberships.Level.Name | Name associated with a level reached in a loyalty program. | string |
| reservations.LoyaltyMemberships.MembershipID | Membership of the loyalty program. | string |
| reservations.LoyaltyMemberships.Name | Name of the loyalty program | string |
| reservations.LoyaltyMemberships.ProgramID | Program ID for the loyalty program. | string |
| reservations.LoyaltyMemberships.EffectiveDate | Effective date for the loyalty program | string |
| reservations.LoyaltyMemberships.EnrollmentCode | Enrollment code for the loyalty program | string |
| reservations.LoyaltyMemberships.ExpirationDate | Expiration date for the loyalty program | string |
| reservations.ReservationAwardList | The array to hold reservation award list information. If the reservation does not include any reservation award, this array does not appear. | array |
| reservations.ReservationAwardList.AwardNumber | Specifies the Award Number. It is optional for a reservation to include an award. However, if it does include an award, it must include an Award Number. This string can include up to 20 characters. | string |
| reservations.ReservationAwardList.AwardType | Specifies the type of the award, which can be your specific award's name or type, such as ClubAcess. It is optional for a reservation to include an award. However, if it does include an award, it is optional to include an Award Type with that award. (In that case, only Award Number is required.) This string can include up to 32 characters. | string |
| reservations.ReservationAwardList.IsPassThroughRedemption | If this is true, the reservation is a pass through redemption reservation. If this is false, the reservation is not a pass through redemption reservation. It is optional for a reservation to include an award. However, if it does include an award, it is optional to include the IsPassThroughRedemption element. (In that case, only Award Number is required.) When IsPassThroughRedemption is true, the system checks for Loyalty Redemption Points. However, the Points are not required and the pass through redemption can proceed without them | boolean |
| reservations.MarketSegment | The object to hold market segment information. | object |
| reservations.MarketSegment.Code | Code of a market segment. | string |
| reservations.MarketSegment.Name | Name of a market segment. | string |
| reservations.MarketSource | The object to hold market source information. | object |
| reservations.MarketSource.Code | Code of a market source. | string |
| reservations.MarketSource.Name | Name of a market source. | string |
| reservations.CampaignDetails | The array to hold campaign details. The CampaignDetails array appears in the response only when the view attribute is set to Full. If view is set to Lookup, DetailedLookup, or DetailedLookupWithRoomPrices, the CampaignDetails array does not appear in the response. | array |
| reservations.CampaignDetails.AffiliateUrlId | Affiliate URL ID for the reservation. Maximum size is 30 characters. | string |
| reservations.CampaignDetails.CampaignId | Campaign ID for the reservation. Maximum size is 10 characters. | string |
| reservations.CampaignDetails.PartnerId | Partner ID for the reservation. Maximum size is 20 characters. | string |
| reservations.CampaignDetails.ReferralId | Referral ID for the reservation. Maximum size is 255 characters. | string |
| reservations.CampaignDetails.SourceId | Source ID for the reservation. Maximum size is 255 characters. | string |
| reservations.Notification | The object to hold information about emails and comments. | object |
| reservations.Notification.SendBookerEmail | If this is true, a notification email must be sent to a booker associated with the reservation. If this is false, there is no requirement to send a notification email to a booker associated with the reservation. | boolean |
| reservations.Notification.SendGuestEmail | If this is true, a notification email must be sent to the guest associated with the reservation. If this is false, there is no requirement to send a notification email to the guest associated with the reservation. Default value is true. | boolean |
| reservations.Notification.FromEmailAddress | Email address used to send any notifications. | string |
| reservations.Notification.AdditionalEmailAddresses | The array to hold additional email addresses for notifications. | array |
| reservations.Notification.LanguageCode | Language code with an optional culture code to use in the email. | string |
| reservations.Notification.LanguageId | Language Id for the email template to use in the email. | integer |
| reservations.Notification.EmailTemplate | The object to hold notification email template information. | object |
| reservations.Notification.EmailTemplate.Code | The code of the email template. | string |
| reservations.Notification.EmailTemplate.Level | The level of the email template. Available values are: Hotel, Chain. | string |
| reservations.Notification.DeliveryComments | The array to hold the Delivery Comment that is visible in Aven Hospitality Voice Agent and guest emails. | array |
| reservations.Notification.DeliveryComments.Comment | Comment can be used to add information about a guest that cannot be captured using the structured data. | string |
| reservations.Notification.DeliveryComments.Id | ID of the delivery comment. | string |
| reservations.Notification.PublicComment | Public comment can be used to add miscellaneous information. The comment is visible in Aven Hospitality Booking Engine, Aven Hospitality Voice Agent, CRS, and guest emails. It is also included in the reservation message to the PMS. | string |
| reservations.onHoldReleaseTime | Specifies the onhold release time in hours. | integer |
| reservations.OnPropertyInstructions | The object to hold instructions for the Property Management System. | object |
| reservations.OnPropertyInstructions.Housekeeping | The object to hold housekeeping instructions. | object |
| reservations.OnPropertyInstructions.Housekeeping.ScheduleCode | Schedule code used by housekeeping. | string |
| reservations.OnPropertyInstructions.ChargeRoutingList | The array to hold the charge routing list. | array |
| reservations.OnPropertyInstructions.ChargeRoutingList.Code | Code of a charge routing. | string |
| reservations.OnPropertyInstructions.ChargeRoutingList.FolioNumber | A folio number to which the charge routing code applies. | string |
| reservations.Overrides | The array to hold override information. | array |
| reservations.Overrides.Type | Type of an override. Available values are: AllowCreditFlagInGuestCompanyBooker, AllowManagementOfChannelConnect, AvailabilityOverride, BlacklistOverride, CancelReservation, DepositCollectionOverride, GroupRateOverride, GuaranteePolicyOverride, LateModificationOverride, ModifyInProgressReservationOverride, OnHoldReservationOverride, PackageSelectionRequiredOverride, PriceOverride, RestrictedRateOverride, RetainPrice, SubsourceOverride. | string |
| reservations.Overrides.Comment | Comment to add information about an override. | string |
| reservations.Packages | The array to hold reservation package information. | array |
| reservations.Packages.Code | Code associated with a package. | string |
| reservations.Packages.Date | Date when a package applies. | string |
| reservations.Packages.Name | Name of a package. | string |
| reservations.Packages.Quantity | Number of packages requested. | integer |
| reservations.Packages.QuantityName | Custom label for a quantity, for example, per bottle or per ticket. | string |
| reservations.Packages.redeemLoyalty | If this is true, the package should be purchased using the loyalty-based payment method (such as points). If this is false, the package should not be purchased using the loyalty-based payment method. | boolean |
| reservations.Packages.time | Time associated with a package. | string |
| reservations.Packages.Price | The array to hold package price information. | array |
| reservations.Packages.Price.CurrencyCode | ISO 4217 three alpha currency code. | string |
| reservations.Packages.Price.DisplayOverrideAsPercentage | If this is true, the price override is displayed as a percentage. If this is false, the price override is not displayed as a percentage. | boolean |
| reservations.Packages.Price.Fees | The object to hold package fee information. | object |
| reservations.Packages.Price.Fees.Amount | Applicable fee amount. | number |
| reservations.Packages.Price.Fees.Points | Total value of the fee points. | integer |
| reservations.Packages.Price.Fees.Breakdown | The array to hold the fee breakdown. | array |
| reservations.Packages.Price.Fees.Breakdown.Amount | Amount of the fee. | number |
| reservations.Packages.Price.Fees.Breakdown.OriginalAmount | Original amount of the fee. | number |
| reservations.Packages.Price.Fees.Breakdown.Points | Applicable fee points. | integer |
| reservations.Packages.Price.Fees.Breakdown.OriginalPoints | Original fee points. | integer |
| reservations.Packages.Price.Fees.Breakdown.Name | Name of the fee. | string |
| reservations.Packages.Price.Fees.Breakdown.Type | Type of the fee. | string |
| reservations.Packages.Price.Fees.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.Packages.Price.Fees.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.Packages.Price.Fees.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.Packages.Price.Fees.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.Packages.Price.Fees.StayFeeAmount | Applicable stay fee amount. | number |
| reservations.Packages.Price.Fees.StayFeePoints | Total value of the stay fee points. | integer |
| reservations.Packages.Price.OriginalAmount | Value of the price before a promotion was applied or a rate was overridden by a person with a permission. | number |
| reservations.Packages.Price.OriginalAmountIncludingTaxesAndFees | Value of the OriginalAmount with taxes and fees included. | number |
| reservations.Packages.Price.Tax | The object to hold package tax information. | object |
| reservations.Packages.Price.Tax.Amount | Applicable tax amount. | number |
| reservations.Packages.Price.Tax.Points | Total value of the points. | integer |
| reservations.Packages.Price.Tax.Breakdown | The array to hold the package tax breakdown. | array |
| reservations.Packages.Price.Tax.Breakdown.Amount | Amount of the tax. | number |
| reservations.Packages.Price.Tax.Breakdown.OriginalAmount | Original amount of the tax. | number |
| reservations.Packages.Price.Tax.Breakdown.Points | Applicable tax payable in points. | integer |
| reservations.Packages.Price.Tax.Breakdown.OriginalPoints | Original tax points. | integer |
| reservations.Packages.Price.Tax.Breakdown.Name | Name of the tax. | string |
| reservations.Packages.Price.Tax.Breakdown.Description | Description of the tax | string |
| reservations.Packages.Price.Tax.Breakdown.Type | Type of the tax. | string |
| reservations.Packages.Price.Tax.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.Packages.Price.Tax.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.Packages.Price.Tax.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.Packages.Price.Tax.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.Packages.Price.Tax.StayTaxAmount | Applicable stay tax amount. | number |
| reservations.Packages.Price.Tax.StayTaxPoints | Total value of the points. | integer |
| reservations.Packages.Price.TaxesFeesIncluded | If this is true, taxes and fees are included in the price. If this is false, the price does not include taxes and fees. | boolean |
| reservations.Packages.Price.TotalAmount | Total value of the price. | number |
| reservations.Packages.Price.AmountPayableNow | Applicable total amount (due at confirmation) excluding any payable at the hotel amount. | number |
| reservations.Packages.Price.AmountPayAtProperty | Applicable total amount payable at the hotel excluding payable now amount. | number |
| reservations.Packages.Price.TotalAmountIncludingTaxesFees | Total value of the price with taxes and fees included. | number |
| reservations.Packages.Price.Points | Total value of the points. | integer |
| reservations.Packages.Price.TotalAmountBeforeExchange | Total value of the price before the loyalty redemption was applied. | number |
| reservations.Packages.Price.TotalAmountWithInclusiveTaxesFees | Total value of the price with only inclusive taxes and fees applied. | number |
| reservations.Packages.Price.TotalTaxExempt | Total value of the taxes and fees exempted. | number |
| reservations.Packages.Price.TotalPrepaidTaxesFees | Total value of the taxes and fees prepaid. | number |
| reservations.Packages.ChargeFrequency | Specifies the charge frequency for a package. | string |
| reservations.Packages.ChargeType | Type of a charge for a package. | string |
| reservations.Packages.ChargeCodes | ADDD!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | array |
| reservations.Packages.ChargeCodes.AllowanceAmount | Allowance amount associated with a charge code. | number |
| reservations.Packages.ChargeCodes.Codes | The array to hold charge code information. | array |
| reservations.Packages.ChargeCodes.Codes.Type | Type of the charge code. | string |
| reservations.Packages.ChargeCodes.Codes.Code | Code of the charge. | string |
| reservations.Packages.BookedDays | The array to hold booked days for the package. | array |
| reservations.Packages.BookedDays.date | Date when a package applies. | date |
| reservations.Packages.BookedDays.time | Time when package applies on day, if applicable. | string |
| reservations.Packages.BookedDays.quantity | Number of requested packages. | integer |
| reservations.Packages.BookedDays.GuestCount | The array to hold the guest count information. | array |
| reservations.Packages.BookedDays.GuestCount.AgeQualifiyingCode | Code representing a business rule that determines the charges for a guest based upon age range. | string |
| reservations.Packages.BookedDays.GuestCount.NumGuests | Number of guests associated with the package. | integer |
| reservations.Packages.BookedDays.GuestCount.Price | The array to hold guest count price information. | array |
| reservations.Packages.BookedDays.GuestCount.Price.CurrencyCode | ISO 4217 three alpha currency code. | string |
| reservations.Packages.BookedDays.GuestCount.Price.DisplayOverrideAsPercentage | If this is true, the price override is displayed as a percentage. If this is false, the price override is not displayed as a percentage. | boolean |
| reservations.Packages.BookedDays.GuestCount.Price.Fees | The object to hold guest count fee information. | object |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Amount | Applicable fee amount. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Points | Total value of the fee points. | integer |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown | The array to hold the guest count fee breakdown. | array |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.Amount | Amount of the fee. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.OriginalAmount | Original amount of the fee. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.Points | Applicable fee points. | integer |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.OriginalPoints | Original fee points. | integer |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.Name | Name of the fee. | string |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.Type | Type of the fee. | string |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.StayFeeAmount | Applicable stay fee amount. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Fees.StayFeePoints | Total value of the stay fee points. | integer |
| reservations.Packages.BookedDays.GuestCount.Price.OriginalAmount | Value of the price before a promotion was applied or a rate was overridden by a person with a permission. | number |
| reservations.Packages.BookedDays.GuestCount.Price.OriginalAmountIncludingTaxesAndFees | Value of the OriginalAmount with taxes and fees included. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Tax | The object to hold the guest count tax information. | object |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Amount | Applicable tax amount. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Points | Total value of the points. | integer |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown | The array to hold the guest count tax breakdown. | array |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.Amount | Amount of the tax. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.OriginalAmount | Original amount of the tax. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.Points | Applicable tax payable in points. | integer |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.OriginalPoints | Original tax points. | integer |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.Name | Name of the tax. | string |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.Description | Description of the tax | string |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.Type | Type of the tax. | string |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.StayTaxAmount | Applicable stay tax amount. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Tax.StayTaxPoints | Total value of the points. | integer |
| reservations.Packages.BookedDays.GuestCount.Price.TaxesFeesIncluded | If this is true, taxes and fees are included in the price. If this is false, the price does not include taxes and fees. | boolean |
| reservations.Packages.BookedDays.GuestCount.Price.TotalAmount | Total value of the price. | number |
| reservations.Packages.BookedDays.GuestCount.Price.AmountPayableNow | Applicable total amount (due at confirmation) excluding any payable at the hotel amount. | number |
| reservations.Packages.BookedDays.GuestCount.Price.AmountPayAtProperty | Applicable total amount payable at the hotel excluding payable now amount. | number |
| reservations.Packages.BookedDays.GuestCount.Price.TotalAmountIncludingTaxesFees | Total value of the price with taxes and fees included. | number |
| reservations.Packages.BookedDays.GuestCount.Price.Points | Total value of the points. | integer |
| reservations.Packages.BookedDays.GuestCount.Price.TotalAmountBeforeExchange | Total value of the price before the loyalty redemption was applied. | number |
| reservations.Packages.BookedDays.GuestCount.Price.TotalAmountWithInclusiveTaxesFees | Total value of the price with only inclusive taxes and fees applied. | number |
| reservations.Packages.BookedDays.GuestCount.Price.TotalTaxExempt | Total value of the taxes and fees exempted. | number |
| reservations.Packages.BookedDays.GuestCount.Price.TotalPrepaidTaxesFees | Total value of the taxes and fees prepaid. | number |
| reservations.Packages.BookedDays.Price | The array to hold the booked days price. | array |
| reservations.Packages.BookedDays.Price.CurrencyCode | ISO 4217 three alpha currency code. | string |
| reservations.Packages.BookedDays.Price.DisplayOverrideAsPercentage | If this is true, the price override is displayed as a percentage. If this is false, the price override is not displayed as a percentage. | boolean |
| reservations.Packages.BookedDays.Price.Fees | The object to hold the booked days fees. | object |
| reservations.Packages.BookedDays.Price.Fees.Amount | Applicable fee amount. | number |
| reservations.Packages.BookedDays.Price.Fees.Points | Total value of the fee points. | integer |
| reservations.Packages.BookedDays.Price.Fees.Breakdown | The array to hold the booked days fees breakdown. | array |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.Amount | Amount of the fee. | number |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.OriginalAmount | Original amount of the fee. | number |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.Points | Applicable fee points. | integer |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.OriginalPoints | Original fee points. | integer |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.Name | Name of the fee. | string |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.Type | Type of the fee. | string |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.Packages.BookedDays.Price.Fees.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.Packages.BookedDays.Price.Fees.StayFeeAmount | Applicable stay fee amount. | number |
| reservations.Packages.BookedDays.Price.Fees.StayFeePoints | Total value of the stay fee points. | integer |
| reservations.Packages.BookedDays.Price.OriginalAmount | Value of the price before a promotion was applied or a rate was overridden by a person with a permission. | number |
| reservations.Packages.BookedDays.Price.OriginalAmountIncludingTaxesAndFees | Value of the OriginalAmount with taxes and fees included. | number |
| reservations.Packages.BookedDays.Price.Tax | The object to hold the booked days tax information. | object |
| reservations.Packages.BookedDays.Price.Tax.Amount | Applicable tax amount. | number |
| reservations.Packages.BookedDays.Price.Tax.Points | Total value of the points. | integer |
| reservations.Packages.BookedDays.Price.Tax.Breakdown | The array to hold the booked days tax breakdown. | array |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.Amount | Amount of the tax. | number |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.OriginalAmount | Original amount of the tax. | number |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.Points | Applicable tax payable in points. | integer |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.OriginalPoints | Original tax points. | integer |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.Name | Name of the tax. | string |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.Description | Description of the tax | string |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.Type | Type of the tax. | string |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.Packages.BookedDays.Price.Tax.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.Packages.BookedDays.Price.Tax.StayTaxAmount | Applicable stay tax amount. | number |
| reservations.Packages.BookedDays.Price.Tax.StayTaxPoints | Total value of the points. | integer |
| reservations.Packages.BookedDays.Price.TaxesFeesIncluded | If this is true, taxes and fees are included in the price. If this is false, the price does not include taxes and fees. | boolean |
| reservations.Packages.BookedDays.Price.TotalAmount | Total value of the price. | number |
| reservations.Packages.BookedDays.Price.AmountPayableNow | Applicable total amount (due at confirmation) excluding any payable at the hotel amount. | number |
| reservations.Packages.BookedDays.Price.AmountPayAtProperty | Applicable total amount payable at the hotel excluding payable now amount. | number |
| reservations.Packages.BookedDays.Price.TotalAmountIncludingTaxesFees | Total value of the price with taxes and fees included. | number |
| reservations.Packages.BookedDays.Price.Points | Total value of the points. | integer |
| reservations.Packages.BookedDays.Price.TotalAmountBeforeExchange | Total value of the price before the loyalty redemption was applied. | number |
| reservations.Packages.BookedDays.Price.TotalAmountWithInclusiveTaxesFees | Total value of the price with only inclusive taxes and fees applied. | number |
| reservations.Packages.BookedDays.Price.TotalTaxExempt | Total value of the taxes and fees exempted. | number |
| reservations.Packages.BookedDays.Price.TotalPrepaidTaxesFees | Total value of the taxes and fees prepaid. | number |
| reservations.Packages.GuestCount | The array to hold the package guest count. | array |
| reservations.Packages.GuestCount.AgeQualifiyingCode | Code representing a business rule that determines the charges for a guest based upon age range. | string |
| reservations.Packages.GuestCount.NumGuests | Number of guests associated with the package. | integer |
| reservations.Packages.GuestCount.Price | The array to hold the package guest count price. | array |
| reservations.Packages.GuestCount.Price.CurrencyCode | ISO 4217 three alpha currency code. | string |
| reservations.Packages.GuestCount.Price.DisplayOverrideAsPercentage | If this is true, the price override is displayed as a percentage. If this is false, the price override is not displayed as a percentage. | boolean |
| reservations.Packages.GuestCount.Price.Fees | The object to hold the package fee information. | object |
| reservations.Packages.GuestCount.Price.Fees.Amount | Applicable fee amount. | number |
| reservations.Packages.GuestCount.Price.Fees.Points | Total value of the fee points. | integer |
| reservations.Packages.GuestCount.Price.Fees.Breakdown | The array to hold the package fee breakdown. | array |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.Amount | Amount of the fee. | number |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.OriginalAmount | Original amount of the fee. | number |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.Points | Applicable fee points. | integer |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.OriginalPoints | Original fee points. | integer |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.Name | Name of the fee. | string |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.Type | Type of the fee. | string |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.Packages.GuestCount.Price.Fees.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.Packages.GuestCount.Price.Fees.StayFeeAmount | Applicable stay fee amount. | number |
| reservations.Packages.GuestCount.Price.Fees.StayFeePoints | Total value of the stay fee points. | integer |
| reservations.Packages.GuestCount.Price.OriginalAmount | Value of the price before a promotion was applied or a rate was overridden by a person with a permission. | number |
| reservations.Packages.GuestCount.Price.OriginalAmountIncludingTaxesAndFees | Value of the OriginalAmount with taxes and fees included. | number |
| reservations.Packages.GuestCount.Price.Tax | The object to hold the package tax information. | object |
| reservations.Packages.GuestCount.Price.Tax.Amount | Applicable tax amount. | number |
| reservations.Packages.GuestCount.Price.Tax.Points | Total value of the points. | integer |
| reservations.Packages.GuestCount.Price.Tax.Breakdown | The array to hold the package tax breakdown. | array |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.Amount | Amount of the tax. | number |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.OriginalAmount | Original amount of the tax. | number |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.Points | Applicable tax payable in points. | integer |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.OriginalPoints | Original tax points. | integer |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.Name | Name of the tax. | string |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.Description | Description of the tax | string |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.Type | Type of the tax. | string |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.Packages.GuestCount.Price.Tax.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.Packages.GuestCount.Price.Tax.StayTaxAmount | Applicable stay tax amount. | number |
| reservations.Packages.GuestCount.Price.Tax.StayTaxPoints | Total value of the points. | integer |
| reservations.Packages.GuestCount.Price.TaxesFeesIncluded | If this is true, taxes and fees are included in the price. If this is false, the price does not include taxes and fees. | boolean |
| reservations.Packages.GuestCount.Price.TotalAmount | Total value of the price. | number |
| reservations.Packages.GuestCount.Price.AmountPayableNow | Applicable total amount (due at confirmation) excluding any payable at the hotel amount. | number |
| reservations.Packages.GuestCount.Price.AmountPayAtProperty | Applicable total amount payable at the hotel excluding payable now amount. | number |
| reservations.Packages.GuestCount.Price.TotalAmountIncludingTaxesFees | Total value of the price with taxes and fees included. | number |
| reservations.Packages.GuestCount.Price.Points | Total value of the points. | integer |
| reservations.Packages.GuestCount.Price.TotalAmountBeforeExchange | Total value of the price before the loyalty redemption was applied. | number |
| reservations.Packages.GuestCount.Price.TotalAmountWithInclusiveTaxesFees | Total value of the price with only inclusive taxes and fees applied. | number |
| reservations.Packages.GuestCount.Price.TotalTaxExempt | Total value of the taxes and fees exempted. | number |
| reservations.Packages.GuestCount.Price.TotalPrepaidTaxesFees | Total value of the taxes and fees prepaid. | number |
| reservations.Packages.CancelPolicy | The array to hold the package cancel policy. | array |
| reservations.Packages.CancelPolicy.Code | Code associated with a cancel policy. | string |
| reservations.Packages.CancelPolicy.Description | Contains detailed information about the cancellation policy. | string |
| reservations.Packages.CancelPolicy.CancellationPermitted | If this is true, the reservation can be cancelled. If this is false, the reservation cannot be cancelled. | boolean |
| reservations.Packages.CancelPolicy.LateCancellationPermitted | If this is true, the guest can cancel the reservation within a cancellation time frame defined in the cancellation policy. A cancellation number is generated, and the room is returned to the inventory. Note that this does not automatically waive any applicable cancellation fees. If this is false, the guest cannot cancel the reservation within a cancellation time frame defined in the cancellation policy. | boolean |
| reservations.Packages.CancelPolicy.CancelFeeAmount | The object to hold the package cancel policy fee amount. | object |
| reservations.Packages.CancelPolicy.CancelFeeAmount.Amount | Specifies a fee that must be paid in case of cancelling the reservation. | number |
| reservations.Packages.CancelPolicy.CancelFeeAmount.TaxInclusive | If this is true, tax is already included in the cancellation fee. If this is false, tax is not already included in the cancellation fee. | boolean |
| reservations.Packages.CancelPolicy.CancelFeeType | Specifies what a cancellation fee is dependent on. | string |
| reservations.Packages.CancelPolicy.CancelPenaltyDate | Specifies the date at which a cancellation fee starts to apply. | string |
| reservations.Packages.CancelPolicy.CancelTime | The latest date at which the guest needs to cancel the reservation to avoid the cancellation fee. | string |
| reservations.Packages.CancelPolicy.CancelTimeIn | The number of hours or days before the reservation date when the guest needs to cancel the reservation to avoid the cancellation fee. | string |
| reservations.Packages.CancelPolicy.ChargeThreshold | Specifies charge type associated with cancellation. | string |
| reservations.Packages.CancelPolicy.ChargeType | Specifies charge type associated with cancellation. | string |
| reservations.Packages.CancelPolicy.ModificationRestrictions | Specifies what modifications to a reservation are allowed and who can make them. | string |
| reservations.Packages.CancelPolicy.NoShowFeeAmount | The object to hold the package no show fee amount. | object |
| reservations.Packages.CancelPolicy.NoShowFeeAmount.Amount | Specifies a fee that is paid in case a guest does not cancel their reservation and does not check in. | number |
| reservations.Packages.CancelPolicy.NoShowFeeAmount.TaxInclusive | If this is true, tax is already included in the no-show fee. If this is false, tax is not already included in the no-show fee. | boolean |
| reservations.Packages.CancelPolicy.NoShowFeeType | Specifies what a no-show fee is dependent on. | string |
| reservations.Packages.CancelPolicy.Charges | The array to hold the package cancel policy charges. | array |
| reservations.Packages.CancelPolicy.Charges.CancelFeeAmount | The fee that must be paid in case of cancelling the reservation. | number |
| reservations.Packages.CancelPolicy.Charges.CancelFeeIncludesTax | If this is true, the cancel fee includes tax. If this is false, the cancel fee does not include tax. | boolean |
| reservations.Packages.CancelPolicy.Charges.DaysToArrive | The number of days to arrive before the cancel policy automatically takes effect. | number |
| reservations.Promotion | The object to hold the promotion information. | object |
| reservations.Promotion.AccessKey | The object to hold the promotion's access key. | object |
| reservations.Promotion.AccessKey.Code | Code of the access key. | string |
| reservations.Promotion.AccessKey.Name | Name of the access key. | string |
| reservations.Promotion.AccessKey.Password | Password for the access key. | string |
| reservations.Promotion.Code | Code associated with a promotion. | string |
| reservations.Promotion.Name | Name of the promotion. | string |
| reservations.Promotion.Type | Access Code type can be specified to filter the results. | string |
| reservations.PurposeOfStay | Reason the guest is making the reservation. | string |
| reservations.RoomPrices | The array to hold the room price information. | array |
| reservations.RoomPrices.AveragePrice | The object to hold the average price. | object |
| reservations.RoomPrices.AveragePrice.Price | The object to hold the price information. | object |
| reservations.RoomPrices.AveragePrice.Price.CurrencyCode | ISO 4217 three alpha currency code. | string |
| reservations.RoomPrices.AveragePrice.Price.DisplayOverrideAsPercentage | If this is true, the price override is displayed as a percentage. If this is false, the price override is not displayed as a percentage. | boolean |
| reservations.RoomPrices.AveragePrice.Price.Fees | The object to hold fees for the average price. | object |
| reservations.RoomPrices.AveragePrice.Price.Fees.Amount | Applicable fee amount. | number |
| reservations.RoomPrices.AveragePrice.Price.Fees.Points | Total value of the fee points. | integer |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown | The array to hold the average price fee breakdown. | array |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.Amount | Amount of the fee. | number |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.OriginalAmount | Original amount of the fee. | number |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.Points | Applicable fee points. | integer |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.OriginalPoints | Original fee points. | integer |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.Name | Name of the fee. | string |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.Type | Type of the fee. | string |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.RoomPrices.AveragePrice.Price.Fees.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.RoomPrices.AveragePrice.Price.Fees.StayFeeAmount | Applicable stay fee amount. | number |
| reservations.RoomPrices.AveragePrice.Price.Fees.StayFeePoints | Total value of the stay fee points. | integer |
| reservations.RoomPrices.AveragePrice.Price.OriginalAmount | Value of the price before a promotion was applied or a rate was overridden by a person with a permission. | number |
| reservations.RoomPrices.AveragePrice.Price.OriginalAmountIncludingTaxesAndFees | Value of the OriginalAmount with taxes and fees included. | number |
| reservations.RoomPrices.AveragePrice.Price.Tax | The object to hold the average price tax information. | object |
| reservations.RoomPrices.AveragePrice.Price.Tax.Amount | Applicable tax amount. | number |
| reservations.RoomPrices.AveragePrice.Price.Tax.Points | Total value of the points. | integer |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown | The array to hold the average price tax breakdown. | array |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.Amount | Amount of the tax. | number |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.OriginalAmount | Original amount of the tax. | number |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.Points | Applicable tax payable in points. | integer |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.OriginalPoints | Original tax points. | integer |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.Name | Name of the tax. | string |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.Description | Description of the tax | string |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.Type | Type of the tax. | string |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.RoomPrices.AveragePrice.Price.Tax.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.RoomPrices.AveragePrice.Price.Tax.StayTaxAmount | Applicable stay tax amount. | number |
| reservations.RoomPrices.AveragePrice.Price.Tax.StayTaxPoints | Total value of the points. | integer |
| reservations.RoomPrices.AveragePrice.Price.TaxesFeesIncluded | If this is true, taxes and fees are included in the price. If this is false, the price does not include taxes and fees. | boolean |
| reservations.RoomPrices.AveragePrice.Price.TotalAmount | Total value of the price. | number |
| reservations.RoomPrices.AveragePrice.Price.AmountPayableNow | Applicable total amount (due at confirmation) excluding any payable at the hotel amount. | number |
| reservations.RoomPrices.AveragePrice.Price.AmountPayAtProperty | Applicable total amount payable at the hotel excluding payable now amount. | number |
| reservations.RoomPrices.AveragePrice.Price.TotalAmountIncludingTaxesFees | Total value of the price with taxes and fees included. | number |
| reservations.RoomPrices.AveragePrice.Price.Points | Total value of the points. | integer |
| reservations.RoomPrices.AveragePrice.Price.TotalAmountBeforeExchange | Total value of the price before the loyalty redemption was applied. | number |
| reservations.RoomPrices.AveragePrice.Price.TotalAmountWithInclusiveTaxesFees | Total value of the price with only inclusive taxes and fees applied. | number |
| reservations.RoomPrices.AveragePrice.Price.TotalTaxExempt | Total value of the taxes and fees exempted. | number |
| reservations.RoomPrices.AveragePrice.Price.TotalPrepaidTaxesFees | Total value of the taxes and fees prepaid. | number |
| reservations.RoomPrices.PriceBreakdowns | The array to hold the room price breakdown. | array |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices | The array to hold product prices for the room price breakdown. | array |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.EndDate | Date when a rate expires. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price | The array to hold the product price. | array |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.CurrencyCode | ISO 4217 three alpha currency code. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.DisplayOverrideAsPercentage | If this is true, the price override is displayed as a percentage. If this is false, the price override is not displayed as a percentage. | boolean |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees | The object to hold product price fees. | object |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Amount | Applicable fee amount. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Points | Total value of the fee points. | integer |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown | The array to hold product price fee breakdown. | array |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.Amount | Amount of the fee. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.OriginalAmount | Original amount of the fee. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.Points | Applicable fee points. | integer |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.OriginalPoints | Original fee points. | integer |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.Name | Name of the fee. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.Type | Type of the fee. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.StayFeeAmount | Applicable stay fee amount. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Fees.StayFeePoints | Total value of the stay fee points. | integer |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.OriginalAmount | Value of the price before a promotion was applied or a rate was overridden by a person with a permission. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.OriginalAmountIncludingTaxesAndFees | Value of the OriginalAmount with taxes and fees included. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax | The object to hold product price tax. | object |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Amount | Applicable tax amount. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Points | Total value of the points. | integer |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown | The array to hold product price tax breakdown. | array |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.Amount | Amount of the tax. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.OriginalAmount | Original amount of the tax. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.Points | Applicable tax payable in points. | integer |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.OriginalPoints | Original tax points. | integer |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.Name | Name of the tax. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.Description | Description of the tax | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.Type | Type of the tax. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.StayTaxAmount | Applicable stay tax amount. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Tax.StayTaxPoints | Total value of the points. | integer |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.TaxesFeesIncluded | If this is true, taxes and fees are included in the price. If this is false, the price does not include taxes and fees. | boolean |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.TotalAmount | Total value of the price. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.AmountPayableNow | Applicable total amount (due at confirmation) excluding any payable at the hotel amount. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.AmountPayAtProperty | Applicable total amount payable at the hotel excluding payable now amount. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.TotalAmountIncludingTaxesFees | Total value of the price with taxes and fees included. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.Points | Total value of the points. | integer |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.TotalAmountBeforeExchange | Total value of the price before the loyalty redemption was applied. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.TotalAmountWithInclusiveTaxesFees | Total value of the price with only inclusive taxes and fees applied. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.TotalTaxExempt | Total value of the taxes and fees exempted. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Price.TotalPrepaidTaxesFees | Total value of the taxes and fees prepaid. | number |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Product | The object to hold product price information. | object |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Product.Id | ID associated with a product. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Product.RateCode | Unique Control Center code for this rate type. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.Product.RoomCode | Code associated with a room. | string |
| reservations.RoomPrices.PriceBreakdowns.ProductPrices.StartDate | Date from which a rate starts to apply. | string |
| reservations.RoomPrices.PriceBreakdowns.Type | Specifies how the price is analyzed. | string |
| reservations.RoomPrices.TotalPrice | The object to hold the room total price. | object |
| reservations.RoomPrices.TotalPrice.Price | The array to hold the price. | array |
| reservations.RoomPrices.TotalPrice.Price.CurrencyCode | ISO 4217 three alpha currency code. | string |
| reservations.RoomPrices.TotalPrice.Price.DisplayOverrideAsPercentage | If this is true, the price override is displayed as a percentage. If this is false, the price override is not displayed as a percentage. | boolean |
| reservations.RoomPrices.TotalPrice.Price.Fees | The object to hold the room total price fees. | object |
| reservations.RoomPrices.TotalPrice.Price.Fees.Amount | Applicable fee amount. | number |
| reservations.RoomPrices.TotalPrice.Price.Fees.Points | Total value of the fee points. | integer |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown | The array to hold the room total price fees breakdown. | array |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.Amount | Amount of the fee. | number |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.OriginalAmount | Original amount of the fee. | number |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.Points | Applicable fee points. | integer |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.OriginalPoints | Original fee points. | integer |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.Name | Name of the fee. | string |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.Type | Type of the fee. | string |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.RoomPrices.TotalPrice.Price.Fees.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.RoomPrices.TotalPrice.Price.Fees.StayFeeAmount | Applicable stay fee amount. | number |
| reservations.RoomPrices.TotalPrice.Price.Fees.StayFeePoints | Total value of the stay fee points. | integer |
| reservations.RoomPrices.TotalPrice.Price.OriginalAmount | Value of the price before a promotion was applied or a rate was overridden by a person with a permission. | number |
| reservations.RoomPrices.TotalPrice.Price.OriginalAmountIncludingTaxesAndFees | Value of the OriginalAmount with taxes and fees included. | number |
| reservations.RoomPrices.TotalPrice.Price.Tax | The object to hold the room total price tax. | object |
| reservations.RoomPrices.TotalPrice.Price.Tax.Amount | Applicable tax amount. | number |
| reservations.RoomPrices.TotalPrice.Price.Tax.Points | Total value of the points. | integer |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown | The array to hold the room total price tax breakdown. | array |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.Amount | Amount of the tax. | number |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.OriginalAmount | Original amount of the tax. | number |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.Points | Applicable tax payable in points. | integer |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.OriginalPoints | Original tax points. | integer |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.Name | Name of the tax. | string |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.Description | Description of the tax | string |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.Type | Type of the tax. | string |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.IsPayAtProperty | If this is true, the amount is payable at the hotel. If this is false, the amount is not payable at the hotel. | boolean |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.IsInclusive | If this is true, the tax is inclusive. If this is false, the tax is not inclusive. | boolean |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.IsPerStay | If this is true, the tax has the PerStay frequency type. If this is false, the tax does not have the PerStay frequency type. | boolean |
| reservations.RoomPrices.TotalPrice.Price.Tax.Breakdown.ExemptType | Conveys the type of exempt where applicable. | string |
| reservations.RoomPrices.TotalPrice.Price.Tax.StayTaxAmount | Applicable stay tax amount. | number |
| reservations.RoomPrices.TotalPrice.Price.Tax.StayTaxPoints | Total value of the points. | integer |
| reservations.RoomPrices.TotalPrice.Price.TaxesFeesIncluded | If this is true, taxes and fees are included in the price. If this is false, the price does not include taxes and fees. | boolean |
| reservations.RoomPrices.TotalPrice.Price.TotalAmount | Total value of the price. | number |
| reservations.RoomPrices.TotalPrice.Price.AmountPayableNow | Applicable total amount (due at confirmation) excluding any payable at the hotel amount. | number |
| reservations.RoomPrices.TotalPrice.Price.AmountPayAtProperty | Applicable total amount payable at the hotel excluding payable now amount. | number |
| reservations.RoomPrices.TotalPrice.Price.TotalAmountIncludingTaxesFees | Total value of the price with taxes and fees included. | number |
| reservations.RoomPrices.TotalPrice.Price.Points | Total value of the points. | integer |
| reservations.RoomPrices.TotalPrice.Price.TotalAmountBeforeExchange | Total value of the price before the loyalty redemption was applied. | number |
| reservations.RoomPrices.TotalPrice.Price.TotalAmountWithInclusiveTaxesFees | Total value of the price with only inclusive taxes and fees applied. | number |
| reservations.RoomPrices.TotalPrice.Price.TotalTaxExempt | Total value of the taxes and fees exempted. | number |
| reservations.RoomPrices.TotalPrice.Price.TotalPrepaidTaxesFees | Total value of the taxes and fees prepaid. | number |
| reservations.RoomPrices.ExemptedTaxTypes | Contains a list of taxes and fees that have been exempted from the reservation price. | array |
| reservations.RoomPrices.ExemptedTaxTypes.Code | Code of a fee or tax which is exempted from the price. | string |
| reservations.RoomPrices.ExemptedTaxTypes.Name | Name of a fee or tax which is exempted from the price. | string |
| reservations.RoomPrices.ExemptedTaxTypes.Type | Type of a fee or tax which is exempted from the price. | string |
| reservations.RoomPrices.ExemptedTaxTypes.Amount | Value of a fee or tax which is exempted from the price. | number |
| reservations.RoomPrices.ExemptedTaxTypes.Points | Total value of the exempted tax and fee points. | integer |
| reservations.RoomPrices.ExemptedTaxTypes.Level | Tax Level. | string |
| reservations.RoomPrices.ExemptedTaxTypes.Breakdown | The array to hold the exempted tax types breakdown. | array |
| reservations.RoomPrices.ExemptedTaxTypes.Breakdown.Date | The exempted tax types breakdown date. | string |
| reservations.RoomPrices.ExemptedTaxTypes.Breakdown.Amount | Breakdown amount of the exempted price. | number |
| reservations.RoomPrices.ExemptedTaxTypes.Breakdown.Points | Points breakdown of the tax or fee exempted. | integer |
| reservations.RoomPrices.ExemptedTaxTypes.Breakdown.ReasonCode | Code of a Exempted Tax Reason. | string |
| reservations.RoomStay | The object to hold room stay information. | object |
| reservations.RoomStay.Group | If this is true, the rate is a group rate. If this is false, the rate is not a group rate. | boolean |
| reservations.RoomStay.Suppressed | If this is true, the rate is a suppressed rate. If this is false, the rate is not a suppressed rate. | boolean |
| reservations.RoomStay.EndDate | Defines the check-out date. | string |
| reservations.RoomStay.GuestCount | The array to hold room stay guest count. | array |
| reservations.RoomStay.GuestCount.AgeQualifyingCode | Code representing a business rule that determines the charges for a guest based upon age range. Available values are: Adult, Child, Senior. | string |
| reservations.RoomStay.GuestCount.Ages | The array to hold room stay guest ages. | array |
| reservations.RoomStay.GuestCount.NumGuests | Number of guests associated with the package. | integer |
| reservations.RoomStay.NumRooms | Specifies how many rooms are requested. | integer |
| reservations.RoomStay.Products | The array to hold room stay products. | array |
| reservations.RoomStay.Products.EndDate | End Date associated with a product. | string |
| reservations.RoomStay.Products.Primary | If this is true, the rate is the primary rate. If this is false, the rate is not the primary rate. | boolean |
| reservations.RoomStay.Products.Product | The object to hold room stay product codes. | object |
| reservations.RoomStay.Products.Product.DefaultRoomCode | Room Code to use in the booking if RoomCode doesn't exist in the system. Only applies to the post and patch reservation/notif endpoints. | string |
| reservations.RoomStay.Products.Product.DefaultRateCode | Rate Code to use in the booking if RateCode doesn't exist in the system. Only applies to the post and patch reservation/notif endpoints. | string |
| reservations.RoomStay.Products.Product.Id | ID associated with a product. | string |
| reservations.RoomStay.Products.Product.RateCode | Unique Control Center code for this rate type. | string |
| reservations.RoomStay.Products.Product.RateName | Name associated with a rate. | string |
| reservations.RoomStay.Products.Product.RoomCode | Code associated with a room. | string |
| reservations.RoomStay.Products.Product.RoomName | Name associated with a room. | string |
| reservations.RoomStay.Products.Product.RoomUnit | Specifies a room unit number associated with a stay date. Only applicable for Property Management Systems. | string |
| reservations.RoomStay.Products.Price | The object to hold the room stay product price. | object |
| reservations.RoomStay.Products.Price.Amount | Amount is used to specify the applicable amount. | number |
| reservations.RoomStay.Products.Price.Points | Points is used to specify the applicable points value. | number |
| reservations.RoomStay.Products.StartDate | Start Date associated with a product. | string |
| reservations.RoomStay.redeemLoyalty | If this is true, the room should be purchased using the loyalty-based payment method (such as points). If this is false, the room should not be purchased using the loyalty-based payment method. | boolean |
| reservations.RoomStay.refresh | Specifies the price refresh type during a modification. Available values are: New, Retain. | string |
| reservations.RoomStay.startDate | Date from which a rate starts to apply. | string |
| reservations.RoomStay.CheckInDate | Defines the check in date. | string |
| reservations.RoomStay.CheckOutDate | Defines the check-out date. | string |
| reservations.RoomRequests | Room Requests map to the OTA Room Amenity codes (RMA) or hotel defined code. | array |
| reservations.RoomRequests.Code | Room Request code. | string |
| reservations.RuleTrackingList | The array to hold the rule type associated with a reservation. | array |
| reservations.RuleTrackingList.Type | Rule type associated with a reservation. | string |
| reservations.RuleTrackingList.Id | The array to hold the ID of a rule type associated with a reservation. | array |
| reservations.Transporation | The object to hold transportation information. | object |
| reservations.Transporation.EstimatedCheckInTime | Specifies the estimated check in time associated with a reservation, if applicable. | string |
| reservations.Transporation.EstimatedCheckOutTime | Specifies the estimated check out time associated with a reservation, if applicable. | string |
| reservations.Transporation.Details | The array to hold transportation details. | array |
| reservations.Transporation.Details.TransferRequest | The object to hold transportation transfer request information. | object |
| reservations.Transporation.Details.TransferRequest.Code | Specifies a transportation code. | string |
| reservations.Transporation.Details.TransferRequest.Type | Specifies whether transportation request is relevant to the arrival or departure of a guest. Available values are: Arrival, Departure. | string |
| reservations.Transporation.Details.TransferRequest.Chargeable | If this is true, the transportation is chargeable. If this is false, the transportation is not chargeable. | boolean |
| reservations.Transporation.Details.TransferRequest.RequiresArrangement | If this is true, transportation arrangements need to be made by the hotel. If this is false, the hotel is not responsible to make the transportation arrangements. | boolean |
| reservations.Transporation.Details.TransferRequest.Time | Arrival or departure time to be communicated to the hotel. | string |
| reservations.Transporation.Details.TransferRequest.Mode | Transportation Method. Available values are: Alternate, Bus, Taxi, Train. | string |
| reservations.Transporation.Details.Airline | The object to hold transportation airline details. | object |
| reservations.Transporation.Details.Airline.Code | Airline Code. | string |
| reservations.Transporation.Details.Airline.FlightNumber | Airline Flight Number. | string |
| reservations.Transporation.Details.Location | The object to hold transportation location details. | object |
| reservations.Transporation.Details.Location.Code | Location Code as defined in CRS. | string |
| reservations.Transporation.Details.Location.Type | Location Type. Available values are: Airport, BoatDock, BusTerminal, TrainStation, Unknown. | string |
| reservations.Transporation.Details.Location.Details | Additional details about the guest arrival/departure location if the arrival/departure is not by Airline. | string |
| reservations.TaxExempt | Deprecated, use RoomPrices/ExemptedTaxTypes | array |
| reservations.TaxExempt.Type | Type of a fee or tax which is exempted from the price. | string |
| reservations.PriceExemptionList | Deprecated, use RoomPrices/ExemptedTaxTypes | array |
| reservations.PriceExemptionList.endDate | End Date for the exemption. If not specified, the stay end date will be used. | string |
| reservations.PriceExemptionList.startDate | Start Date for the exemption. If not specified, the stay start date will be used. | string |
| reservations.PriceExemptionList.exempt | If this is true, the tax or fee should be excluded from the price. If this is false, the tax or fee should not be excluded from the price. | boolean |
| reservations.PriceExemptionList.TaxCode | The array to hold price exemption list tax codes. | array |
| reservations.PriceExemptionList.TaxCode.ReasonCode | The exempt reason code (optional). | string |
| reservations.PriceExemptionList.TaxCode.TaxCode | Specific hotel configured Tax Code to exempt from the price. | string |
| reservations.PriceExemptionList.Type | The array to hold the type of the price exemption list. | array |
| reservations.PriceExemptionList.Type.ReasonCode | The exempt reason code (optional). This code must exist in the Control Center configuration at: Setup > Property> Tax Exempt Reasons. | string |
| reservations.PriceExemptionList.Type.Type | Type of a fee or tax that is exempted from the price. Available values are: BedTax, CityHotelFee, CityTax, CountyTax, EnergyTax, FederalTax, FoodBeverageTax, LodgingTax, MaintenanceFee, MiscellaneousFee, MiscellaneousTax, OccupancyTax, PackageFee, ResortFee, RoomTax, SalesTax, ServiceCharge, StateTax,Surcharge, TotalTax, TourismTax, VAT_GST_Tax. | string |
| reservations.Upgrade | The object to hold information about an upgrade request. | object |
| reservations.Upgrade.Reason | The object to hold the upgrade reason code. | object |
| reservations.Upgrade.Reason.Code | The code to identify the upgrade reason. | string |
| reservations.Upgrade.RoomToCharge | The object to hold the code for the room to charge. | object |
| reservations.Upgrade.RoomToCharge.Code | The code of the room to charge. | string |
| reservations.Upgrade.RoomToStay | The object to hold information about the room to stay. | object |
| reservations.Upgrade.RoomToStay.Code | The code of the room to stay. | string |
| reservations.WaitList | The object to hold information about a wait list request. | object |
| reservations.WaitList.Code | The code of a wait list request. | string |
| reservations.WaitList.Description | Description of a wait list request. | string |
| reservations.status | Current state of the reservation. | string |
| reservations.onPropertyStatus | Conveys a secondary status associated with a reservation. Used by Property Management Systems. Available values are: None, CheckedOut, InHouse, NoShow, PreArrival, TurnAway. | string |
| reservations.Source | The object to hold information about the source IP address. | object |
| reservations.Source.IP_Address | Contains the IP address of the person making the reservation. | string |
| reservations.Source.BookingURL | Contains the URL where the reservation request came from. | string |
| reservations.Source.Telephony | The object to hold information about a telephone reservation. | object |
| reservations.Source.Telephony.VDN | The VDN that needs to be associated with the reservation. | string |
| reservations.Source.BrowserDetails | The object to hold information about the browser in which the reservation was made. | object |
| reservations.Source.BrowserDetails.ReadyFor3DSVersion | The version number for 3D Secure (security protocol for online transactions). | string |
| reservations.Source.BrowserDetails.JavaEnabled | If this is true, the browser had Java enabled. If this is false, the browser had Java disabled. | boolean |
| reservations.Source.BrowserDetails.JavascriptEnabled | If this is true, the browser had JavaScript enabled. If this is false, the browser had JavaScript disabled. | boolean |
| reservations.Source.BrowserDetails.ScreenColorDepth | The browser's screen color depth. | integer |
| reservations.Source.BrowserDetails.ScreenHeight | The browser's screen height. | integer |
| reservations.Source.BrowserDetails.ScreenWidth | The browser's screen width. | integer |
| reservations.Source.BrowserDetails.TimeZoneOffset | The browser's time zone offset. | integer |
| reservations.Source.BrowserDetails.ChallengeWindowSize | The size of the pop up window or i-frame in which a security step appears. | integer |
| reservations.singleUsePaymentCardAllowed | If this is true, a single use credit card is allowed for the reservation. If this is false, a single use credit card is not allowed for the reservation. | boolean |
| reservations.roomStaySplit | Specifies the way to handle splitting of multiple rooms to reservations. The options are: • Default: No preference and let system handle as per chain/hotel settings. • SingleRoomInSameItinerary: Split multiple rooms into single room reservations in same itinerary. • SingleRoomAsMultipleItineraries: Split multiple rooms into single room reservations as multiple itineraries. | string |
| reservations.links | The array to hold link information about this request. | array |
| reservations.links.href | Link to related API request. | string |
| reservations.links.rel | Describes relationship between href and current request. | string |
| reservations.AdministrativeActions | Specifies the administrative actions performed on the reservation. For example, an email was sent to guest, property. | array |
| reservations.AdministrativeActions.Description | Description of the action. | string |
| reservations.AdministrativeActions.Date | Date and time of the action performed. | string |
| reservations.AdministrativeActions.UpdatedBy | Full name of the user who performed the action. | string |
| reservations.Activity | The array to hold the reservation's activity information. | array |
| reservations.Activity.Type | Type of the Activity. | string |
| reservations.Activity.Value | Description or date and time of the activity. | string |
| reservations.Content | The object to hold the reservation's content information. | object |
| reservations.Content.Discounts | The array to hold information about items that discount the reservation. | array |
| reservations.Content.Discounts.links | The object to hold link information about the discounts. | object |
| reservations.Content.Discounts.links.href | Link to related API request. | string |
| reservations.Content.Discounts.links.rel | Describes relationship between href and current request. | string |
| reservations.Content.Discounts.CouponOffer | The array to hold information about the discount coupon offer. | array |
| reservations.Content.Discounts.CouponOffer.links | The object to hold link information about the coupon offer. | object |
| reservations.Content.Discounts.CouponOffer.links.href | Link to related API request. | string |
| reservations.Content.Discounts.CouponOffer.links.rel | Describes relationship between href and current request. | string |
| reservations.Content.Discounts.CouponOffer.Code | Coupon offer code. | string |
| reservations.Content.Discounts.CouponOffer.ReservationReferences | The array to hold the reservation reference number. | array |
| reservations.Content.Discounts.CouponOffer.ReservationReferences.Number | Reference number associated with the reservation. | string |
| reservations.Content.Discounts.CouponOffer.ReservationReferences.Type | Type associated with the reservation reference. | string |
| reservations.Content.Discounts.AdjustmentAmount | Adjustment Amount of the discount. | number |
| reservations.Content.Discounts.AdjustmentPercentage | Adjustment percentage of discount. | number |
| reservations.Content.Discounts.AppliedAmount | Applied Amount of the discount. | number |
| reservations.Content.Discounts.AppliedPercentage | Applied Percentage of the discount. | number |
| reservations.Content.Discounts.Order | Order of the discount. | integer |
| reservations.Content.Discounts.Type | Type of Discount. | string |
| reservations.Content.RateCategories | The array to hold the rate category information. | array |
| reservations.Content.RateCategories.CategoryCode | Code associated to the rate category. | string |
| reservations.Content.RateCategories.Description | Descriptive information about the rate category. | string |
| reservations.Content.RateCategories.Name | Name of the rate category. | string |
| reservations.Content.LoyaltyAccrualType | The object to hold loyalty accrual information. | object |
| reservations.Content.LoyaltyAccrualType.Code | The code for the loyalty accrual type. | string |
| reservations.Content.LoyaltyAccrualType.Name | The description of the loyalty accrual type. | string |
| reservations.Content.Rates | The array to hold content rate information. | array |
| reservations.Content.Rates.CategoryCode | Code associated with a rate category. | string |
| reservations.Content.Rates.Code | Code associated with a rate. | string |
| reservations.Content.Rates.CurrencyCode | ISO 4217 three alpha currency code. | string |
| reservations.Content.Rates.Description | Short descriptive information about the rate. | string |
| reservations.Content.Rates.DetailedDescription | Detailed descriptive information about the rate. | string |
| reservations.Content.Rates.DisplayName | Display name associated with the rate. | string |
| reservations.Content.Rates.Name | Name of the rate. | string |
| reservations.Content.Rates.Primary | If this is true, the rate is the primary rate. If this is not true, the rate is not the primary rate. | boolean |
| reservations.Content.Rates.Type | Type associated to the rate. | string |
| reservations.Content.RoomCategories | The array to hold room category information. | array |
| reservations.Content.RoomCategories.CategoryCode | Code associated with a collection of similar room types. | string |
| reservations.Content.RoomCategories.Description | Description of the room category. | string |
| reservations.Content.RoomCategories.Name | Name of the room category. | string |
| reservations.Content.Rooms | The array to hold room information. | array |
| reservations.Content.Rooms.CategoryCode | Category associated with a room. | string |
| reservations.Content.Rooms.Code | Code associated with a room. | string |
| reservations.Content.Rooms.Description | Short descriptive information about the room. | string |
| reservations.Content.Rooms.DetailedDescription | Detailed descriptive information about the room. | string |
| reservations.Content.Rooms.Name | Name of the room. | string |
| reservations.Content.RoomRequests | The array to hold room request information. | array |
| reservations.Content.RoomRequests.Code | Room Request Code. | string |
| reservations.Content.RoomRequests.Description | Description of the room request. | string |
| reservations.Content.RoomRequests.Name | Name of the room request. | string |
| reservations.Content.TaxExemptReasons | The array to hold tax exempt reasons. | array |
| reservations.Content.TaxExemptReasons.Code | Tax Exempt Reason Code. | string |
| reservations.Content.TaxExemptReasons.Type | Tax Exempt Reason Type. | string |
| reservations.Content.TaxExemptReasons.TypeDescription | Name/Description of the Tax Exempt Reason Type. | string |
| reservations.Content.TaxExemptReasons.Description | Tax Exempt Reason Description. | string |
| reservations.SortOrder | Specifies how the search results should be sorted. | integer |
| reservations.AutoCancelReleaseTime | Auto cancel scheduled release hours associated with the reservation (overrides the booking policy). | string |
| reservations.Id | Unique GUID associated to the reservation. | string |
| reservations.BookingPolicy | The object to hold booking policy information. | object |
| reservations.BookingPolicy.Code | Code for a booking policy. | string |
| reservations.BookingPolicy.Description | Detailed information about a booking policy. | string |
| reservations.BookingPolicy.TransactionFeeDisclaimer | Disclaimer regarding the transaction fee charges. | string |
| reservations.BookingPolicy.DepositFee | The object to hold deposit fee information. | object |
| reservations.BookingPolicy.DepositFee.Amount | Value of a required deposit fee. | number |
| reservations.BookingPolicy.DepositFee.DueDays | The number of days relative to the booking for the dues to paid. This is dependent on the parameter DueType. For example, if DueType is AtTimeOfBooking, DueDays would be 0. | integer |
| reservations.BookingPolicy.DepositFee.DueType | Specifies when a deposit fee should be paid. | string |
| reservations.BookingPolicy.DepositFee.TaxInclusive | If this is true, the deposit fee already includes tax. If this is false, the deposit fee does not already include tax. | boolean |
| reservations.BookingPolicy.DepositFee.IsPrePayment | If this is true, the Aven Hospitality payment processor handles the transaction. If this is false, the PMS (or the property) processes the transaction. | boolean |
| reservations.BookingPolicy.DepositFee.Type | Type of a deposit fee to be chosen from a list of options. | string |
| reservations.BookingPolicy.GuaranteeLevel | Defines the requirements to be fulfilled so that the hotel holds the reservation. The option Guarantee means that the guest needs to provide additional data, as specified in the guarantee policy, for example a credit card number. Deposit means that a deposit must be paid and HoldPeriod indicates that the hotel holds the reservation until a date and no additional requirements are imposed. | string |
| reservations.BookingPolicy.HoldTime | Specifies a period after which a reservation is cancelled, and the rooms are released. | string |
| reservations.BookingPolicy.Requirements | The array to hold booking policy requirements information. | array |
| reservations.BookingAgent | The object to hold booking agent information. | object |
| reservations.BookingAgent.EmailAddress | Email address of the booking agent. | string |
| reservations.BookingAgent.PersonName | The object to hold the booking agent's name. | object |
| reservations.BookingAgent.PersonName.GivenName | Given name of the booking agent. | string |
| reservations.BookingAgent.PersonName.LegalName | Legal name of the booking agent. | string |
| reservations.BookingAgent.PersonName.Surname | Surname of the booking agent. | string |
| reservations.BookingAgent.Id | Id that identifies the booking agent | string |
| reservations.BookingAgent.TravelIndustryID | Travel Industry Id that identifies the booking agent | string |
| reservations.BookingAgent.ExternalReferenceIds | The array to hold booking agent external reference IDs. | array |
| reservations.BookingAgent.ExternalReferenceIds.ExternalReferenceId | Id of the external reference. | string |
| reservations.BookingAgent.ExternalReferenceIds.ExternalReferenceType | Type of the external reference. | string |
| reservations.CancelPolicy | The array to hold cancel policy information. | object |
| reservations.CancelPolicy.Code | Code associated with a cancel policy. | string |
| reservations.CancelPolicy.Description | Contains detailed information about the cancellation policy. | string |
| reservations.CancelPolicy.CancellationPermitted | If this is true, the reservation can be cancelled. If this is false, the reservation cannot be cancelled. | boolean |
| reservations.CancelPolicy.LateCancellationPermitted | If this is true, the guest can cancel the reservation within a cancellation time frame defined in the cancellation policy. A cancellation number is generated, and the room is returned to the inventory. Note that this does not automatically waive any applicable cancellation fees. If this is false, the guest cannot cancel the reservation within a cancellation time frame defined in the cancellation policy. | boolean |
| reservations.CancelPolicy.CancelFeeAmount | The object to hold cancel fee amount information. | object |
| reservations.CancelPolicy.CancelFeeAmount.Amount | Specifies a fee that must be paid in case of cancelling the reservation. | number |
| reservations.CancelPolicy.CancelFeeAmount.TaxInclusive | If this is true, tax is already included in the cancellation fee. If this is false, tax is not already included in the cancellation fee. | boolean |
| reservations.CancelPolicy.CancelFeeType | Specifies what a cancellation fee is dependent on. | string |
| reservations.CancelPolicy.CancelPenaltyDate | Specifies the date at which a cancellation fee starts to apply. | string |
| reservations.CancelPolicy.CancelTime | The latest date at which the guest needs to cancel the reservation to avoid the cancellation fee. | string |
| reservations.CancelPolicy.CancelTimeIn | The number of hours or days before the reservation date when the guest needs to cancel the reservation to avoid the cancellation fee. | string |
| reservations.CancelPolicy.ChargeThreshold | Specifies charge type associated with cancellation. | string |
| reservations.CancelPolicy.ChargeType | Specifies charge type associated with cancellation. | string |
| reservations.CancelPolicy.ModificationRestrictions | Specifies what modifications to a reservation are allowed and who can make them. | string |
| reservations.CancelPolicy.NoShowFeeAmount | The object to hold the no show fee amount. | object |
| reservations.CancelPolicy.NoShowFeeAmount.Amount | Specifies a fee that is paid in case a guest does not cancel their reservation and does not check in. | number |
| reservations.CancelPolicy.NoShowFeeAmount.TaxInclusive | If this is true, tax is already included in the no-show fee. If this is false, tax is not already included in the no-show fee. | boolean |
| reservations.CancelPolicy.NoShowFeeType | Specifies what a no-show fee is dependent on. | string |
| reservations.CancelPolicy.Charges | The array to hold cancel policy charges. This is mainly used for staggered policies, but charge information for non-staggered policies is included. | array |
| reservations.CancelPolicy.Charges.CancelFeeAmount | The amount that must be paid when cancelling a reservation. | number |
| reservations.CancelPolicy.Charges.CancelFeeIncludesTax | If this is true, tax is already included in the cancellation fee. If this is false, tax is not already included in the cancellation fee. | boolean |
| reservations.CancelPolicy.Charges.DaysToArrive | The number of days to arrive before the cancel policy fee is charged. | number |
| reservations.ProductCancellationRestricted | If this is true, attempts to cancel the reservation are restricted. If this is false, attempts to cancel the reservation are not restricted. | boolean |
| reservations.ProductModificationRestricted | If this is true, attempts to modify the reservation are restricted. If this is false, attempts to modify the reservation are not restricted. | boolean |
| reservations.CreateDateTime | The UTC Datetime when the reservation was created. | string |
| reservations.UpdateDateTime | The UTC Datetime of the last update to the reservation. | string |
| reservations.AssociatedReservations | The array to hold information about reservations that are included in the same itinerary. | array |
| reservations.AssociatedReservations.CRSConfirmationNumber | CRS reservation confirmation number. | string |
| reservations.AssociatedReservations.Status | Identifies the reservation status. | string |
| reservations.AssociatedReservations.ArrivalDate | The reservation arrival date. | string |
| reservations.AssociatedReservations.DepartureDate | The reservation departure date. | string |
POST a new reservation
This endpoint tells the system to perform an availability check and then create a new reservation with a reservation status of Booked, Waitlisted, OnHold, or Confirmed.
[POST] /v1/api/reservationThis endpoint allows you to create new reservations or modify existing reservations in a single request. When you create a reservation, the system assigns one or more IDs to the reservation, and you can later use these IDs to identify the reservation during a modification. The response includes the confirmation numbers.
Note: The various endpoints in this Reservation Services API are designed to allow you to create and update a reservation multiple times in multiple steps before the final confirmation. For example, you can initially create a reservation with its stay criteria and status=booked. Then, you can update the reservation to include non-room products or price overrides, while maintaining status=booked. Then, you can update the reservation again to include guest information and payment information, at which time you confirm the reservation by setting the status=confirmed.
You can also jump to more specific examples for the following:
- Creating the detailed information in reservations.
- Handling Retailing products or services (ancillaries) in reservations.
Post Body Parameters
The parameters that you can include in your post body for this endpoint are the details in a reservation record, which are explained in the GET a list of reservations section.
The minimum information that you must add to create a reservation is the following:
To make the response structure easier to follow, this table prefixes every element with the object and array structure that contains it, like this: ArrayOne.ArrayTwo.ArrayThree.Element
| Element | Description | Type | Required? |
|---|---|---|---|
| Chain.Id | Specify the unique ID of a hotel chain or management group in CRS. | string | Required |
| Hotel.Id | Specify the unique ID of a single hotel property in CRS. | string | Required |
| Products.Product.RateCode | Specify the unique Control Center code for this rate type. | string | Required |
| Products.Product.RoomCode | Specify the code associated with the room. | string | Required |
| RoomStay.StartDate | Specify the reservation start date. | string | Required |
| RoomStay.EndDate | Specify the reservation end date. | string | Required |
| Channels.PrimaryChannel.Code | Specify the CRS code for reservation's primary channel. | string | Required |
| Channels.SecondaryChannel.Code | Specify the CRS code for reservation's secondary channel. | string | Required |
| Channels.SubSourceCode | Specify the CRS code for reservation's sub source, interpreted as the third channel. | string | Required |
| RoomStay.GuestCount.NumGuests | Specify the number of guests associated with the reservation. | integer | Required |
| RoomStay.NumRooms | Specify the number of rooms associated with the reservation. | integer | Required |
| status | Specify the reservation status. Some statuses might require more information. For example, the confirmed status requires that you have a primary guest and a guarantee (if the policy requires them). | string | Required |
Post Body Example
The following is an example of the body for this post request:
{
"Alerts":[
{
"Id":"c020a7fc-a0e9-47a0-bc62-965o5781ba06"
}
],
"BillingLocations":[
{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"BusinessName":"Business Address",
"EmailAddress":"info@abc.com",
"ContactNumbers":[
{
"Type":"Fax",
"Number":"string"
}
],
"Address":{
"AddressLine":[
"123 Main St."
],
"City":"Denver",
"Country":{
"Code":"US"
},
"PostalCode":"70045",
"StateProv":{
"Code":"CO"
}
}
}
],
"BookingDues":{
"PayNow":false,
"CancelPenalty":{
"Amount":150,
"Deadline":"01/06/2026 12:00:00 AM"
},
"Deposit":{
"Amount":0,
"AmountWithoutTax":0,
"Comment":"No deposit required",
"DueDate":"2026-07-05T00:00:00",
"Status":"None"
}
},
"ReservationReferences":[
{
"Number":"C-1099873",
"Type":"string"
}
],
"BookingInfo":{
"BookedBy":"John Doe",
"BookingDate":"2026-07-04T14:54:06",
"ApplicationUserMetaData":"applicationUser12345",
"EntryChannelBookingDate":"2026-07-04T14:54:06",
"ChannelConfirmationNumber":"EX442876",
"EntryChannelCode":"GDS",
"GDS_RecordLocator":"QWDTGE",
"AuthorizationNote":"Payment has been authorized",
"OriginalSource":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"Booking Engine Webservices."
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"Booking Engine Webservices."
},
"SubSourceCode":"KYK"
},
"ReservationNotifSource":"OTA"
},
"BookerProfile":{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Role":"Agent"
},
"Brand":{
"Code":"PB1",
"Id":800003,
"Name":"Paradise Brand Group"
},
"CRS_cancellationNumber":"64707XT000968X",
"CRS_confirmationNumber":"64707CU000968",
"CrsConfirmationNumber":"64707CU000968",
"PMS_confirmationNumber":"6598446",
"Chain":{
"Code":"SYHC",
"Id":15458,
"Name":"string"
},
"CRO":{
"Code":"JWMC",
"Id":3426,
"Name":"CRO"
},
"Channels":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"Booking Engine Webservices."
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"Booking Engine Webservices."
},
"SubSourceCode":"KYK",
"SecondarySubSourceCode":"789"
},
"CommissionableAccountProfile":{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"TravelIndustryId":"30000024"
},
"CompanyProfile":{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD"
},
"CouponOfferCode":"Save50",
"CouponOffers":[
{
"Code":"Save50",
"PreferredSortOrder":0
}
],
"Currency":{
"Code":"USD",
"Name":"US Dollars",
"Symbol":"$"
},
"ExternalReferenceNumber":"8876-345",
"Guests":[
{
"CRS_referenceNumber":"string",
"Comments":"string",
"StartDate":"2026-08-29T00:00:00",
"EndDate":"2026-08-31T00:00:00",
"Deposits":[
{
"Amount":115.5,
"AuthorizationCode":"463853",
"Date":"2026-07-31T00:00:00"
}
],
"EmailAddress":[
{
"Type":"Primary",
"Value":"larry.walker@mail.com"
}
],
"Citizenships":[
{
"CountryCode":"US",
"Primary":true
}
],
"ContactNumbers":[
{
"Default":true,
"Number":"55512345678",
"Role":"Home",
"Type":"Mobile",
"Use":"DayTimeContact"
}
],
"DateOfBirth":"1985-05-18",
"Gender":"Male",
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Locations":[
{
"Address":{
"AddressLine":[
"123 Main St."
],
"Business":{
"Name":"Acme, Inc.",
"Unit":"Southeast Branch"
},
"City":"Denver",
"Country":{
"Code":"US"
},
"Default":true,
"PostalCode":"70045",
"StateProv":{
"Code":"CO"
},
"Type":"Home"
},
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Name":"My Home Address"
}
],
"MarketingOptIn":true,
"Payments":[
{
"Amount":125,
"BankDeposit":{
"BankCode":"BA",
"BankName":"Bank of America"
},
"DirectBill":{
"AccountNumber":"8365920440",
"ProjectNumber":"112234",
"Source":"Local"
},
"EWallet":{
"ProviderCode":"EW1"
},
"LoyaltyRedemption":{
"Points":500,
"LoyaltyMembership":{
"MembershipID":"YX-12345678",
"ProgramID":"SYNX",
"redemptionLimit":2500,
"pointsOverage":200
}
},
"PaymentCard":{
"AllowedCharges":"A-All Charges",
"CardCode":"VI",
"CardHolder":"Larry Walker",
"CardName":"Visa",
"CardNumber":"4444444444444444",
"CardSecurityCode":"123",
"CompanyName":"Beta Company",
"ExpireDate":"1223",
"Token":"cjzHiunsdfjnkkIbgoinN",
"ReferenceID":"2123554",
"SpecialInstructions":"Special instructions",
"CardValidityStartDate":"2026-08-29T00:00:00",
"CardValidityEndDate":"2026-08-29T00:00:00",
"InstallmentOptionId":"3030315346e642b424e6f4",
"FintechPaymentProvider":{
"Code":"FTECHPROV1"
},
"Extension":{
"CurrencyCode":"USD",
"SpecialInstructions":"Special instructions",
"ActivationStartDate":"2026-08-29T00:00:00",
"ActivationEndDate":"2026-08-29T00:00:00",
"AuthorizedAmount":125,
"IsVccPayment":false,
"VccVendor":"Vendor name"
},
"Wallet":{
"Vendor":{
"code":"AmexCheckout"
}
}
},
"Role":"Personal",
"Type":"CreditCard",
"VendorStatus":"Unknown",
"VirtualPayments":[
{
"AllowedCharges":"A-All Charges",
"CardCode":"VI",
"CardHolder":"Larry Walker",
"CardName":"Visa",
"CardNumber":"4444444444444444",
"CardSecurityCode":"123",
"CompanyName":"Beta Company",
"ExpireDate":"1223",
"Token":"cjzHiunsdfjnkkIbgoinN",
"ReferenceID":"2123554",
"SpecialInstructions":"Special instructions",
"CardValidityStartDate":"2026-08-29T00:00:00",
"CardValidityEndDate":"2026-08-29T00:00:00",
"InstallmentOptionId":"30303130311357655346e642b424e6f4",
"Wallet":{
"Vendor":{
"code":"AmexCheckout",
"WalletPaymentToken":"test1234"
}
}
}
],
"InstallmentOptions":[
{
"NumberOfInstallments":6,
"TotalAmount":200,
"InstallmentAmount":34.75,
"InterestAmount":8.5,
"InterestRate":5
}
]
}
],
"PersonName":{
"GivenName":"Larry",
"MiddleName":"A",
"Prefix":"Mr.",
"Suffix":"Jr.",
"Surname":"Walker",
"PreferredGivenName":"Lenny",
"PreferredSurname":"Wentworth"
},
"ProfileID":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Role":"Primary",
"SpokenLanguages":[
{
"Code":"en",
"Default":true
}
],
"TravelDocuments":[
{
"Type":"MilitaryIdentification",
"HolderName":"Larry Walker",
"Number":"2999-9285820-874",
"IssuingAuthority":"DOJ",
"PlaceOfIssue":"Houston, TX"
}
],
"ProfileExternalReferences":[
{
"Type":"CRM",
"Primary":true,
"Number":"SY820099930"
}
]
}
],
"Hotel":{
"Code":"HOP",
"Id":13098,
"Name":"SynXis Hotel"
},
"ItineraryNumber":"15458B0000888",
"Language":{
"Code":"nl-NL",
"Name":"Dutch"
},
"LoyaltyMemberships":[
{
"Source":"Selected",
"Level":{
"Code":"Gold",
"Name":"Gold Members"
},
"MembershipID":"SY790887688",
"Name":"SynXis Members Only",
"ProgramID":"SYLC",
"EffectiveDate":"2019-08-29T00:00:00",
"EnrollmentCode":"WEB",
"ExpirationDate":"2026-10-23T00:00:00"
}
],
"MarketSegment":{
"Code":"GLEI",
"Name":"Group"
},
"MarketSource":{
"Code":"META",
"Name":"Meta Search"
},
"CampaignDetails":{
"AffiliateUrlId":"AFF-789",
"CampaignId":"CMP-12345",
"PartnerId":"PARTNER-001",
"ReferralId":"REF-2025",
"SourceId":"SRC-ABC"
},
"Notification":{
"SendBookerEmail":false,
"SendGuestEmail":false,
"FromEmailAddress":"reservations@myhotel.com",
"AdditionalEmailAddresses":[
"recipient@destination.com"
],
"LanguageCode":"en-US",
"LanguageId":0,
"EmailTemplate":{
"Code":"HTK1",
"Level":"Hotel"
},
"DeliveryComments":[
{
"Comment":"Have flowers in the room upon arrival",
"Id":"GC1"
}
],
"PublicComment":"Hotel Comment 1"
},
"onHoldReleaseTime":6,
"OnPropertyInstructions":{
"Housekeeping":{
"ScheduleCode":"FC3"
},
"ChargeRoutingList":[
{
"Code":"MH34",
"FolioNumber":"93984952"
}
]
},
"Overrides":[
{
"Type":"PriceOverride",
"Comment":"Honeymoon"
}
],
"Packages":[
{
"Code":"BKFST42",
"Date":"2026-08-29T00:00:00",
"Name":"Breakfast for two",
"Quantity":1,
"QuantityName":"per room",
"redeemLoyalty":true,
"time":"0800",
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
},
"ChargeFrequency":"PerNight",
"ChargeType":"PerPerson",
"ChargeCodes":[
{
"AllowanceAmount":25,
"Codes":[
{
"Type":"ChargeCode",
"Code":"B5938"
}
]
}
],
"BookedDays":[
{
"date":"2026-08-31T00:00:00",
"time":"12:30 PM",
"quantity":1,
"GuestCount":[
{
"AgeQualifiyingCode":"Adult",
"NumGuests":2,
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
}
],
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
}
],
"GuestCount":[
{
"AgeQualifiyingCode":"Adult",
"NumGuests":2,
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
}
],
"CancelPolicy":{
"Code":"1D",
"Description":"Booking must be cancelled 1D prior to arrival",
"CancellationPermitted":true,
"LateCancellationPermitted":true,
"CancelFeeAmount":{
"Amount":90,
"TaxInclusive":true
},
"CancelFeeType":"None",
"CancelPenaltyDate":"2026-08-25T00:00:00",
"CancelTime":"0",
"CancelTimeIn":"2",
"ChargeThreshold":"2",
"ChargeType":"ChargeWithinDays",
"ModificationRestrictions":"ANGDS",
"NoShowFeeAmount":{
"Amount":150,
"TaxInclusive":true
},
"NoShowFeeType":"NumberNightsOfStay",
"Charges":[
{
"CancelFeeAmount":0,
"CancelFeeIncludesTax":true,
"DaysToArrive":0
}
]
}
}
],
"Promotion":{
"AccessKey":{
"Code":"5PCOFF",
"Name":"5% OFF",
"Password":"5PCOFF"
},
"Code":"SUMMER5",
"Name":"Book Now and Save 5%",
"Type":"Promotion"
},
"PurposeOfStay":"Leisure",
"RoomPrices":{
"AveragePrice":{
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
},
"PriceBreakdowns":[
{
"ProductPrices":[
{
"EndDate":"2026-08-31T00:00:00",
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
},
"Product":{
"Id":"57b391d5-f811-4758-9af2-2307021ed427",
"RateCode":"RtStD1",
"RoomCode":"SRm1"
},
"StartDate":"2026-08-29T00:00:00"
}
],
"Type":"Daily"
}
],
"TotalPrice":{
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
},
"ExemptedTaxTypes":[
{
"Code":"DC45",
"Name":"Spa Access",
"Type":"ResortFee",
"Amount":25,
"Points":5000,
"Level":"Hotel",
"Breakdown":[
{
"Date":"2026-03-24T00:00:00.000Z",
"Amount":5,
"Points":5000,
"ReasonCode":"CityTaxExempt"
}
]
}
]
},
"RoomStay":{
"Group":false,
"Suppressed":false,
"EndDate":"2026-08-31T00:00:00",
"GuestCount":[
{
"AgeQualifyingCode":"Child",
"Ages":[
2
],
"NumGuests":2
}
],
"NumRooms":1,
"Products":[
{
"EndDate":"2026-08-31T00:00:00",
"Primary":true,
"Product":{
"DefaultRoomCode":"STD",
"DefaultRateCode":"BAR",
"Id":"57b391d5-f811-4758-9af2-2307021ed427",
"RateCode":"BAR",
"RateName":"Advanced Purchase Rate",
"RoomCode":"A1K",
"RoomName":"Standard King",
"RoomUnit":"201"
},
"Price":{
"Amount":250,
"Points":5000
},
"StartDate":"2026-08-29T00:00:00"
}
],
"redeemLoyalty":true,
"refresh":"New",
"startDate":"2026-08-29T00:00:00",
"CheckInDate":"2026-08-29T00:00:00",
"CheckOutDate":"2026-08-31T00:00:00"
},
"RoomRequests":[
{
"Code":"50001"
}
],
"RuleTrackingList":[
{
"Type":"Comments",
"Id":[
"string"
]
}
],
"Transporation":{
"EstimatedCheckInTime":"12:30 PM",
"EstimatedCheckOutTime":"2:30 PM",
"Details":[
{
"TransferRequest":{
"Code":"TC1",
"Type":"Arrival",
"Chargeable":true,
"RequiresArrangement":true,
"Time":"1PM",
"Mode":"Taxi"
},
"Airline":{
"Code":"AA",
"FlightNumber":"1597"
},
"Location":{
"Code":"DFW",
"Type":"Airport",
"Details":"BS123"
}
}
]
},
"TaxExempt":[
{
"Type":"CityTax"
}
],
"PriceExemptionList":[
{
"endDate":"string",
"startDate":"string",
"exempt":true,
"TaxCode":[
{
"ReasonCode":"MILITARY",
"TaxCode":"BRTX1",
"Level":"Hotel"
}
],
"Type":[
{
"ReasonCode":"MILITARY",
"Type":"CityTax"
}
]
}
],
"Upgrade":{
"Reason":{
"Code":"UG2"
},
"RoomToCharge":{
"Code":"A1Q"
},
"RoomToStay":{
"Code":"A1K"
}
},
"WaitList":{
"Code":"WL5467",
"Description":"Waiting Payment Information"
},
"status":"Confirmed",
"onPropertyStatus":"InHouse",
"Source":{
"IP_Address":"198.162.1.1",
"BookingURL":"myhotelwebsite.com",
"Telephony":{
"VDN":"VDN1234"
},
"BrowserDetails":{
"ReadyFor3DSVersion":"2.0",
"JavaEnabled":true,
"JavascriptEnabled":true,
"ScreenColorDepth":32,
"ScreenHeight":250,
"ScreenWidth":400,
"TimeZoneOffset":-120,
"ChallengeWindowSize":1
}
},
"singleUsePaymentCardAllowed":false,
"roomStaySplit":"Default"
}Response in JSON
The response to this endpoint is the same as the response for the GET a list of reservations endpoint.
Response Elements
The response elements for this endpoint are the same as the elements for the GET a list of reservations endpoint.
PATCH to update a reservation
This endpoint tells the system to perform an availability check and then modify your specified reservation with your specified data.
[PATCH] /v1/api/reservationPatch Body Parameters
The body parameters are nearly identical to the POST a new reservation endpoint with the exception that this patch is wrapped in a "Reservations": [{ . . . }] node. Each reservation must also include a CrsConfirmationNumber for the reservation to be modified.
The unique element that you must add to this request is TransactionType:
| Element | Description | Type | Required? |
|---|---|---|---|
| TransactionType | Use TransactionType to specify how the system will handle a failure during a bulk update. The available options are Atomic and Default: • Atomic enforces an all or none approach to failures during a bulk update. • Default allows a partial success approach to failures during a bulk update. | string | Required |
Patch Body Example
The following is an example of the body for this patch request:
{
"TransactionType":"Default",
"Reservations":[
{
"Alerts":[
{
"Id":"c020a7fc-a0e9-47a0-bc62-965o5781ba06"
}
],
"BillingLocations":[
{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"BusinessName":"Business Address",
"EmailAddress":"info@abc.com",
"ContactNumbers":[
{
"Type":"Fax",
"Number":"string"
}
],
"Address":{
"AddressLine":[
"123 Main St."
],
"City":"Denver",
"Country":{
"Code":"US"
},
"PostalCode":"70045",
"StateProv":{
"Code":"CO"
}
}
}
],
"BookingDues":{
"PayNow":false,
"CancelPenalty":{
"Amount":150,
"Deadline":"01/06/2026 12:00:00 AM"
},
"Deposit":{
"Amount":0,
"AmountWithoutTax":0,
"Comment":"No deposit required",
"DueDate":"2026-07-05T00:00:00",
"Status":"None"
}
},
"ReservationReferences":[
{
"Number":"C-1099873",
"Type":"string"
}
],
"BookingInfo":{
"BookedBy":"John Doe",
"BookingDate":"2026-07-04T14:54:06",
"ApplicationUserMetaData":"applicationUser12345",
"EntryChannelBookingDate":"2026-07-04T14:54:06",
"ChannelConfirmationNumber":"EX442876",
"EntryChannelCode":"GDS",
"GDS_RecordLocator":"QWDTGE",
"AuthorizationNote":"Payment has been authorized",
"OriginalSource":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"Booking Engine Webservices."
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"Booking Engine Webservices."
},
"SubSourceCode":"KYK"
},
"ReservationNotifSource":"OTA"
},
"BookerProfile":{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Role":"Agent"
},
"Brand":{
"Code":"PB1",
"Id":800003,
"Name":"Paradise Brand Group"
},
"CRS_cancellationNumber":"64707XT000968X",
"CRS_confirmationNumber":"64707CU000968",
"CrsConfirmationNumber":"64707CU000968",
"PMS_confirmationNumber":"6598446",
"Chain":{
"Code":"SYHC",
"Id":15458,
"Name":"string"
},
"CRO":{
"Code":"JWMC",
"Id":3426,
"Name":"CRO"
},
"Channels":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"Booking Engine Webservices."
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE",
"Description":"Booking Engine Webservices."
},
"SubSourceCode":"KYK",
"SecondarySubSourceCode":"789"
},
"CommissionableAccountProfile":{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"TravelIndustryId":"30000024"
},
"CompanyProfile":{
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD"
},
"CouponOfferCode":"Save50",
"CouponOffers":[
{
"Code":"Save50",
"PreferredSortOrder":0
}
],
"Currency":{
"Code":"USD",
"Name":"US Dollars",
"Symbol":"$"
},
"ExternalReferenceNumber":"8876-345",
"Guests":[
{
"CRS_referenceNumber":"string",
"Comments":"string",
"StartDate":"2026-08-29T00:00:00",
"EndDate":"2026-08-31T00:00:00",
"Deposits":[
{
"Amount":115.5,
"AuthorizationCode":"463853",
"Date":"2026-07-31T00:00:00"
}
],
"EmailAddress":[
{
"Type":"Primary",
"Value":"larry.walker@mail.com"
}
],
"Citizenships":[
{
"CountryCode":"US",
"Primary":true
}
],
"ContactNumbers":[
{
"Default":true,
"Number":"55512345678",
"Role":"Home",
"Type":"Mobile",
"Use":"DayTimeContact"
}
],
"DateOfBirth":"1985-05-18",
"Gender":"Male",
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Locations":[
{
"Address":{
"AddressLine":[
"123 Main St."
],
"Business":{
"Name":"Acme, Inc.",
"Unit":"Southeast Branch"
},
"City":"Denver",
"Country":{
"Code":"US"
},
"Default":true,
"PostalCode":"70045",
"StateProv":{
"Code":"CO"
},
"Type":"Home"
},
"Id":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Name":"My Home Address"
}
],
"MarketingOptIn":true,
"Payments":[
{
"Amount":125,
"BankDeposit":{
"BankCode":"BA",
"BankName":"Bank of America"
},
"DirectBill":{
"AccountNumber":"8365920440",
"ProjectNumber":"112234",
"Source":"Local"
},
"EWallet":{
"ProviderCode":"EW1"
},
"LoyaltyRedemption":{
"Points":500,
"LoyaltyMembership":{
"MembershipID":"YX-12345678",
"ProgramID":"SYNX",
"redemptionLimit":2500,
"pointsOverage":200
}
},
"PaymentCard":{
"AllowedCharges":"A-All Charges",
"CardCode":"VI",
"CardHolder":"Larry Walker",
"CardName":"Visa",
"CardNumber":"4444444444444444",
"CardSecurityCode":"123",
"CompanyName":"Beta Company",
"ExpireDate":"1223",
"Token":"cjzHiunsdfjnkkIbgoinN",
"ReferenceID":"2123554",
"SpecialInstructions":"Special instructions",
"CardValidityStartDate":"2026-08-29T00:00:00",
"CardValidityEndDate":"2026-08-29T00:00:00",
"InstallmentOptionId":"303031303113524e6f4",
"FintechPaymentProvider":{
"Code":"FTECHPROV1"
},
"Extension":{
"CurrencyCode":"USD",
"SpecialInstructions":"Special instructions",
"ActivationStartDate":"2026-08-29T00:00:00",
"ActivationEndDate":"2026-08-29T00:00:00",
"AuthorizedAmount":125,
"IsVccPayment":false,
"VccVendor":"Vendor name"
},
"Wallet":{
"Vendor":{
"code":"AmexCheckout"
}
}
},
"Role":"Personal",
"Type":"CreditCard",
"VendorStatus":"Unknown",
"VirtualPayments":[
{
"AllowedCharges":"A-All Charges",
"CardCode":"VI",
"CardHolder":"Larry Walker",
"CardName":"Visa",
"CardNumber":"4444444444444444",
"CardSecurityCode":"123",
"CompanyName":"Beta Company",
"ExpireDate":"1223",
"Token":"cjzHiunsdfjnkkIbgoinN",
"ReferenceID":"2123554",
"SpecialInstructions":"Special instructions",
"CardValidityStartDate":"2026-08-29T00:00:00",
"CardValidityEndDate":"2026-08-29T00:00:00",
"InstallmentOptionId":"3030313031135e642b424e6f4",
"Wallet":{
"Vendor":{
"code":"AmexCheckout",
"WalletPaymentToken":"test1234"
}
}
}
],
"InstallmentOptions":[
{
"NumberOfInstallments":6,
"TotalAmount":200,
"InstallmentAmount":34.75,
"InterestAmount":8.5,
"InterestRate":5
}
]
}
],
"PersonName":{
"GivenName":"Larry",
"MiddleName":"A",
"Prefix":"Mr.",
"Suffix":"Jr.",
"Surname":"Walker",
"PreferredGivenName":"Lenny",
"PreferredSurname":"Wentworth"
},
"ProfileID":"C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
"Role":"Primary",
"SpokenLanguages":[
{
"Code":"en",
"Default":true
}
],
"TravelDocuments":[
{
"Type":"MilitaryIdentification",
"HolderName":"Larry Walker",
"Number":"2999-9285820-874",
"IssuingAuthority":"DOJ",
"PlaceOfIssue":"Houston, TX"
}
],
"ProfileExternalReferences":[
{
"Type":"CRM",
"Primary":true,
"Number":"SY820099930"
}
]
}
],
"Hotel":{
"Code":"HOP",
"Id":13098,
"Name":"SynXis Hotel"
},
"ItineraryNumber":"15458B0000888",
"Language":{
"Code":"nl-NL",
"Name":"Dutch"
},
"LoyaltyMemberships":[
{
"Source":"Selected",
"Level":{
"Code":"Gold",
"Name":"Gold Members"
},
"MembershipID":"SY790887688",
"Name":"SynXis Members Only",
"ProgramID":"SYLC",
"EffectiveDate":"2019-08-29T00:00:00",
"EnrollmentCode":"WEB",
"ExpirationDate":"2026-10-23T00:00:00"
}
],
"MarketSegment":{
"Code":"GLEI",
"Name":"Group"
},
"MarketSource":{
"Code":"META",
"Name":"Meta Search"
},
"CampaignDetails":{
"AffiliateUrlId":"AFF-789",
"CampaignId":"CMP-12345",
"PartnerId":"PARTNER-001",
"ReferralId":"REF-2025",
"SourceId":"SRC-ABC"
},
"Notification":{
"SendBookerEmail":false,
"SendGuestEmail":false,
"FromEmailAddress":"reservations@myhotel.com",
"AdditionalEmailAddresses":[
"recipient@destination.com"
],
"LanguageCode":"en-US",
"LanguageId":0,
"EmailTemplate":{
"Code":"HTK1",
"Level":"Hotel"
},
"DeliveryComments":[
{
"Comment":"Have flowers in the room upon arrival",
"Id":"GC1"
}
],
"PublicComment":"Hotel Comment 1"
},
"onHoldReleaseTime":6,
"OnPropertyInstructions":{
"Housekeeping":{
"ScheduleCode":"FC3"
},
"ChargeRoutingList":[
{
"Code":"MH34",
"FolioNumber":"93984952"
}
]
},
"Overrides":[
{
"Type":"PriceOverride",
"Comment":"Honeymoon"
}
],
"Packages":[
{
"Code":"BKFST42",
"Date":"2026-08-29T00:00:00",
"Name":"Breakfast for two",
"Quantity":1,
"QuantityName":"per room",
"redeemLoyalty":true,
"time":"0800",
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
},
"ChargeFrequency":"PerNight",
"ChargeType":"PerPerson",
"ChargeCodes":[
{
"AllowanceAmount":25,
"Codes":[
{
"Type":"ChargeCode",
"Code":"B5938"
}
]
}
],
"BookedDays":[
{
"date":"2026-08-31T00:00:00",
"time":"12:30 PM",
"quantity":1,
"GuestCount":[
{
"AgeQualifiyingCode":"Adult",
"NumGuests":2,
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
}
],
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
}
],
"GuestCount":[
{
"AgeQualifiyingCode":"Adult",
"NumGuests":2,
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
}
],
"CancelPolicy":{
"Code":"1D",
"Description":"Booking must be cancelled 1D prior to arrival",
"CancellationPermitted":true,
"LateCancellationPermitted":true,
"CancelFeeAmount":{
"Amount":90,
"TaxInclusive":true
},
"CancelFeeType":"None",
"CancelPenaltyDate":"2026-08-25T00:00:00",
"CancelTime":"0",
"CancelTimeIn":"2",
"ChargeThreshold":"2",
"ChargeType":"ChargeWithinDays",
"ModificationRestrictions":"ANGDS",
"NoShowFeeAmount":{
"Amount":150,
"TaxInclusive":true
},
"NoShowFeeType":"NumberNightsOfStay",
"Charges":[
{
"CancelFeeAmount":0,
"CancelFeeIncludesTax":true,
"DaysToArrive":0
}
]
}
}
],
"Promotion":{
"AccessKey":{
"Code":"5PCOFF",
"Name":"5% OFF",
"Password":"5PCOFF"
},
"Code":"SUMMER5",
"Name":"Book Now and Save 5%",
"Type":"Promotion"
},
"PurposeOfStay":"Leisure",
"RoomPrices":{
"AveragePrice":{
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
},
"PriceBreakdowns":[
{
"ProductPrices":[
{
"EndDate":"2026-08-31T00:00:00",
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
},
"Product":{
"Id":"57b391d5-f811-4758-9af2-2307021ed427",
"RateCode":"RtStD1",
"RoomCode":"SRm1"
},
"StartDate":"2026-08-29T00:00:00"
}
],
"Type":"Daily"
}
],
"TotalPrice":{
"Price":{
"CurrencyCode":"USD",
"DisplayOverrideAsPercentage":false,
"Fees":{
"Amount":75,
"Points":5000,
"Breakdown":[
{
"Amount":75,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Resort Fee - SPA Access",
"Type":"Resort Fee",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayFeeAmount":10.5,
"StayFeePoints":5000
},
"OriginalAmount":350,
"OriginalAmountIncludingTaxesAndFees":395.5,
"Tax":{
"Amount":50,
"Points":5000,
"Breakdown":[
{
"Amount":50,
"OriginalAmount":100,
"Points":5000,
"OriginalPoints":10000,
"Name":"Denver City Tax",
"Description":"PKG_TAX_EXCLUSIVE - 10 %",
"Type":"City Tax",
"IsPayAtProperty":true,
"IsInclusive":true,
"IsPerStay":true,
"ExemptType":"None"
}
],
"StayTaxAmount":15,
"StayTaxPoints":5000
},
"TaxesFeesIncluded":false,
"TotalAmount":200,
"AmountPayableNow":200,
"AmountPayAtProperty":135.5,
"TotalAmountIncludingTaxesFees":335.5,
"Points":5000,
"TotalAmountBeforeExchange":200,
"TotalAmountWithInclusiveTaxesFees":200,
"TotalTaxExempt":20,
"TotalPrepaidTaxesFees":10
}
},
"ExemptedTaxTypes":[
{
"Code":"DC45",
"Name":"Spa Access",
"Type":"ResortFee",
"Amount":25,
"Points":5000,
"Level":"Hotel",
"Breakdown":[
{
"Date":"2026-03-24T00:00:00.000Z",
"Amount":5,
"Points":5000,
"ReasonCode":"CityTaxExempt"
}
]
}
]
},
"RoomStay":{
"Group":false,
"Suppressed":false,
"EndDate":"2026-08-31T00:00:00",
"GuestCount":[
{
"AgeQualifyingCode":"Child",
"Ages":[
2
],
"NumGuests":2
}
],
"NumRooms":1,
"Products":[
{
"EndDate":"2026-08-31T00:00:00",
"Primary":true,
"Product":{
"DefaultRoomCode":"STD",
"DefaultRateCode":"BAR",
"Id":"57b391d5-f811-4758-9af2-2307021ed427",
"RateCode":"BAR",
"RateName":"Advanced Purchase Rate",
"RoomCode":"A1K",
"RoomName":"Standard King",
"RoomUnit":"201"
},
"Price":{
"Amount":250,
"Points":5000
},
"StartDate":"2026-08-29T00:00:00"
}
],
"redeemLoyalty":true,
"refresh":"New",
"startDate":"2026-08-29T00:00:00",
"CheckInDate":"2026-08-29T00:00:00",
"CheckOutDate":"2026-08-31T00:00:00"
},
"RoomRequests":[
{
"Code":"50001"
}
],
"RuleTrackingList":[
{
"Type":"Comments",
"Id":[
"string"
]
}
],
"Transporation":{
"EstimatedCheckInTime":"12:30 PM",
"EstimatedCheckOutTime":"2:30 PM",
"Details":[
{
"TransferRequest":{
"Code":"TC1",
"Type":"Arrival",
"Chargeable":true,
"RequiresArrangement":true,
"Time":"1PM",
"Mode":"Taxi"
},
"Airline":{
"Code":"AA",
"FlightNumber":"1597"
},
"Location":{
"Code":"DFW",
"Type":"Airport",
"Details":"BS123"
}
}
]
},
"TaxExempt":[
{
"Type":"CityTax"
}
],
"PriceExemptionList":[
{
"endDate":"string",
"startDate":"string",
"exempt":true,
"TaxCode":[
{
"ReasonCode":"MILITARY",
"TaxCode":"BRTX1",
"Level":"Hotel"
}
],
"Type":[
{
"ReasonCode":"MILITARY",
"Type":"CityTax"
}
]
}
],
"Upgrade":{
"Reason":{
"Code":"UG2"
},
"RoomToCharge":{
"Code":"A1Q"
},
"RoomToStay":{
"Code":"A1K"
}
},
"WaitList":{
"Code":"WL5467",
"Description":"Waiting Payment Information"
},
"status":"Confirmed",
"onPropertyStatus":"InHouse",
"Source":{
"IP_Address":"198.162.1.1",
"BookingURL":"myhotelwebsite.com",
"Telephony":{
"VDN":"VDN1234"
},
"BrowserDetails":{
"ReadyFor3DSVersion":"2.0",
"JavaEnabled":true,
"JavascriptEnabled":true,
"ScreenColorDepth":32,
"ScreenHeight":250,
"ScreenWidth":400,
"TimeZoneOffset":-120,
"ChallengeWindowSize":1
}
},
"singleUsePaymentCardAllowed":false,
"roomStaySplit":"Default"
}
]
}
Important: When you use this endpoint to modify a first-level node, you must include the entire node in your patch body. For example, to modify CommissionableAccountProfile, Guests, LoyaltyMemberships, Notification, Overrides, Packages, PurposeOfStay, RoomStay, Transportation, or Upgrade, you must include data for that entire node. This patch operation is a merge to the reservation record, which means items are added or updated but not removed. To remove an item (such as a package) from a reservation, use the POST a new reservation endpoint, and provide a full overlay of the reservation record.
The following is another patch body example that includes the entire Guests[ ] node in order to change the primary guest from Mr. Larry Walker to Mrs. Laura Walker.
Response in JSON
The response to this endpoint is the same as the response for the GET a list of reservations endpoint.
Response Elements
The response elements for this endpoint are the same as the elements for the GET a list of reservations endpoint.
POST to cancel a reservation
This endpoint enables you to change a reservation's status from Confirmed to Cancelled.
[POST] /v1/api/reservation/cancelIn some situations, a cancellation is not possible, including (but not limited to) the following situations:
- The reservation status is not Confirmed. You can cancel only reservations that are in Confirmed status.
- The reservation is already cancelled.
- The reservation cancel policy does not allow you to cancel.
- The package cancel policy does not allow you to cancel.
- Payment is pending.
Post Body Parameters
The following table describes the parameters to include in your post request:
| Element | Description | Type | Required? |
|---|---|---|---|
| Hotel | The object to hold the hotel ID. | object | Required |
| Id | The unique ID for the hotel in Aven Hospitality's SynXis Central Reservation System (CRS) | integer | Required |
| Crs_confirmationNumber | The CRS Confirmation Number is the identifier of the reservation within the Hotel. | string | Required |
| CrsConfirmationNumber | The CRS Confirmation Number is the identifier of the reservation within the Hotel. | string | Required |
| reservationId | The reservation GUID from the SynXis Central Reservation System. Example: AA000000-0A00-000A-0000-00A000A0A00A | string | Optional |
| Channels | The array to hold information for the primary and secondary channels. | array | Optional |
| PrimaryChannel | The array to hold information for the primary channel. | array | Optional |
| Code | The code that identifies the Primary Channel that is canceling the reservation. | string | Optional |
| Description | The booking channel description from CRS. | string | Optional |
| SecondaryChannel | The array to hold information for the secondary channel. | array | Optional |
| Code | The code that identifies the Secondary Channel that is canceling the reservation. | string | Optional |
| Description | The booking channel description from CRS. | string | Optional |
| SubSourceCode | The Sub Source Code related to the cancellation. This is considered the third-level Channel. | string | Optional |
| SuppressGuestEmail | Set this to true to NOT send an email to the Guest when the reservation is cancelled. Set this to false to send an email to the Guest when the reservation is cancelled. This defaults to false. | boolean | Optional |
| SuppressBookerEmail | Set this to true to NOT send an email to the Booker when the reservation is cancelled. Set this to false to send an email to the Booker when the reservation is cancelled. This defaults to false. | boolean | Optional |
| CancellationDetails | The array to hold details about the cancellation. | array | Optional |
| AuthorizationNote | Administrative action notes for the cancelled reservation. | string | Optional |
| CallerName | The name of the caller who requested to cancel the reservation. | string | Optional |
| ContactNumber | The contact number for the caller (named in CallerName). | string | Optional |
| Comment | Comments about the cancelled reservation. | string | Optional |
| ReasonCode | The reason code associated to the cancelled reservation. | string | Optional |
| OnPropertyStatus | The OnPropertyStatus is a secondary status associated with a reservation. This is used by Property Management Systems. Available values are: None, CheckedOut, NoShow, TurnAway. | string | Optional |
| Source | Array of information about telephony and VDN. | array | Optional |
| Telephony | Array of information about telephony. | array | Optional |
| VDN | The Vector Directory Number that is associated with the reservation. | string | Optional |
| Overrides | Array of relevant override types for the cancellation. Available values are: ReturnCanceledPointsOverride. | string | Optional |
Post Body Example
The following is an example of the body for this post request:
{
"Hotel":{
"Id":11113
},
"CrsConfirmationNumber":"11113EC000239",
"Channels":{
"PrimaryChannel":{
"Code":"WEB"
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE"
},
"SubSourceCode":"KYK"
},
"SuppressGuestEmail":false,
"SuppressBookerEmail":false,
"CancellationDetails":{
"AuthorizationNote":"string",
"CallerName":"Jane Doe",
"ContactNumber":"555-123-4567",
"Comment":"Family issues",
"ReasonCode":"C001"
},
"OnPropertyStatus":"NoShow",
"Overrides":[
"ReturnCanceledPointsOverride"
]
}
Response in JSON
{
"CrsCancellationNumber":"11113X000239"
}Response Elements
The following table explains the elements you receive in the response:
| Element | Description | Type |
|---|---|---|
| crsCancellationNumber | This is the confirmation number of the reservation within the Hotel. | string |
GET history of a reservation
This endpoint enables you to specify a reservation to get the reservation's history.
[GET] /v1/api/reservation/hotel/{hotelId}/{crsConfirmationNumber}/historyPath Parameters
The following table describes the path parameters that you must include when you query this endpoint:
| Element | Description | Type | Required? |
|---|---|---|---|
| hotelId | The ID of the hotel for which you want to find the reservation and history. | integer | Required |
| CrsConfirmationNumber | The CRS Confirmation Number is the identifier of the reservation within the hotel. | string | Required |
Query Parameters
The following table describes the elements that you can include when you query this endpoint:
| Element | Description | Type | Required? |
|---|---|---|---|
| startDate | You can specify a start date for the reservation history that you want to return. If you don't specify a start date but do specify an end date, the start date is assumed to be the date when the reservation was created. The maximum time that you can specify between the start and end dates is 30 days. This time is in UTC format as yyyy-MM-ddTHH:mm:ss. | string | Optional |
| endDate | You can specify an end date for the reservation history that you want to return. If you don't specify an end date but do specify a start date, the end date is assumed to be the current date. The maximum time that you can specify between the start and end dates is 30 days. This time is in UTC format as yyyy-MM-ddTHH:mm:ss. | string | Optional |
| page | You can specify which page of the results you want to see. | integer | Optional |
| pageSize | You can specify the page size. The minimum value is 1000. The maximum value is 10000. | integer | Optional |
Response in JSON
{
"history":[
{
"propertyName":"Status",
"oldValue":"Confirmed",
"newValue":"Cancelled",
"actionType":"Update",
"transactionDate":"2026-08-26T14:30:00",
"userName":"JohnDoe"
}
],
"pagination":{
"total":1,
"start":0,
"size":0
}
}Response Elements
The following table explains the elements you receive in the response:
| Element | Description | Type |
|---|---|---|
| history | The array to hold the reservation history information. | array |
| propertyName | The name of the reservation detail that has been changed in the reservation's history. For example, if the reservation history shows that the reservation status has been changed, the propertyName would show Status. The oldValue and newValue would then show the old status and the new status, respectively. Here are more examples: • If the CampaignId has changed in the reservation's history, the propertyName would show CampaignDetails_CampaignID. • If the AffiliateUrlId has changed in the reservation's history, the propertyName would show CampaignDetails_AffiliateUrlID. • If the PartnerId has changed in the reservation's history, the propertyName would show CampaignDetails_PartnerID. • If the ReferralId has changed in the reservation's history, the propertyName would show CampaignDetails_ReferralID. • If the SourceId has changed in the reservation's history, the propertyName would show CampaignDetails_SourceID. | string |
| oldValue | The value that the reservation detail (named in propertyName) had before it was changed. For example, if the propertyName is Status, the oldValue might be Confirmed. | string |
| newValue | The value that the reservation detail (named in propertyName) had after it was changed. For example, if the propertyName is Status, the newValue might be Cancelled. | string |
| actionType | The type of action that was taken on the reservation detail (named in propertyName). This can be Create, Update, or Delete. | string |
| transactionDate | The date when the action was taken on the reservation detail (named in propertyName). | string |
| userName | The user who performed the action on the reservation detail (named in propertyName). | string |
| pagination | The object to hold pagination information. | object |
| total | The total number of records returned in the response. | integer |
| start | The first record returned in the response. | integer |
| size | The number of records per page returned in the response. | integer |
POST reservation status of ignored
This endpoint enables you to change a reservation's status from Booked to Ignored. You might use this in a multi-step reservation booking process where you use the Ignored status to release any temporarily held room inventory back into general availability.
[POST] /v1/api/reservation/ignorePost Body Parameters
The following table describes the parameters to include in your post request:
| Element | Description | Type | Required? |
|---|---|---|---|
| hotelId | The unique ID for the hotel in Aven Hospitality's SynXis Central Reservation System (CRS) | integer | Required |
| CrsConfirmationNumber | The CRS Confirmation Number is the identifier of the reservation within the Hotel. | string | Required |
| reservationId | The reservation GUID from the SynXis Central Reservation System. Example: AA000000-0A00-000A-0000-00A000A0A00A | string | Optional |
| Channels | The array to hold information for the primary and secondary channels. | array | Optional |
| PrimaryChannel | The array to hold information for the primary channel. | array | Optional |
| Code | The code that identifies the Primary Channel that is changing the status of the reservation. | string | Optional |
| SecondaryChannel | The array to hold information for the secondary channel. | array | Optional |
| Code | The code that identifies the Secondary Channel that is changing the status of the reservation. | string | Optional |
| SubSourceCode | The Sub Source Code related to the status change. This is considered the third-level Channel. | string | Optional |
Post Body Example
The following is an example of the body for this post request:
{
"hotelId":10000,
"crsConfirmationNumber":"10000DV002294",
"reservationId":"AA000000-0A00-000A-0000",
"Channels":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE"
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE"
},
"SubSourceCode":"KYK"
}
}Response in JSON
{
"crsCancellationNumber":"10000DV002294",
"status":"Ignored"
}Response Elements
The following table explains the elements you receive in the response:
| Element | Description | Type |
|---|---|---|
| crsCancellationNumber | This is the confirmation number of the reservation within the Hotel. | string |
| status | The status will be Ignored to show the successful status change. | string |
POST to reinstate a reservation from cancelled to confirmed
This endpoint enables you to reinstate the status of a reservation from Cancelled to Confirmed.
[POST] /v1/api/reservation/reinstateThis operation is most often used when a reservation was accidentally cancelled. This operation does not book a new reservation but simply changes the Cancelled reservation to Confirmed status, which allows the reservation to keep the same CRS Confirmation Number and other details for the guest's convenience.
Note: With this endpoint, you cannot modify any details of the reservation. If you need to reinstate a reservation and modify any details, reinstate it first with this endpoint. After the reinstatement succeeds, use the PATCH /v1/api/reservation endpoint to modify the details. Also, you cannot use this endpoint to reinstate Loyalty reservations where points or free night stays were used during the original confirmation.
The following table describes the parameters to include in your post request:
| Element | Description | Type | Required? |
|---|---|---|---|
| CrsConfirmationNumber | The CRS Confirmation Number is the identifier of the reservation within the Hotel. | string | Required |
| Chain | The array to hold the chain ID. | array | Required |
| Id | The unique ID for the hotel chain or management group in Aven Hospitality's SynXis Central Reservation System (CRS) | string | Required |
| Hotel | The object to hold the hotel ID. | object | Required |
| Id | The unique ID for the hotel in Aven Hospitality's SynXis Central Reservation System (CRS) | integer | Required |
| Channels | The array to hold information for the primary and secondary channels. | array | Required |
| PrimaryChannel | The array to hold information for the primary channel. | array | Required |
| Code | The code that identifies the Primary Channel that is changing the status of the reservation. | string | Required |
| SecondaryChannel | The array to hold information for the secondary channel. | array | Required |
| Code | The code that identifies the Secondary Channel that is changing the status of the reservation. | string | Required |
Post Body Example
The following is an example of the body for this post request:
{
"CrsConfirmationNumber":"10000DV002294",
"Chain":{
"Id":15458
},
"Hotel":{
"Id":15458
},
"Channels":{
"PrimaryChannel":{
"Code":"CRS"
},
"SecondaryChannel":{
"Code":"NGVA"
}
}
}
Response in JSON
{
"CrsConfirmationNumber":"10000DV002294",
"Status":"Confirmed"
}Response Elements
The following table explains the elements you receive in the response:
| Element | Description | Type |
|---|---|---|
| crsConfirmationNumber | This is the confirmation number of the reservation within the Hotel. | string |
| status | The status will be Confirmed to show the successful status change. | string |
GET a reservation
This endpoint enables you to specify the hotel ID and confirmation ID to get a single reservation.
[GET] /v1/api/reservation/hotel/{hotelId}/{id}Path Parameters
The following table describes the path parameters that you must include when you query this endpoint:
| Element | Description | Type | Required? |
|---|---|---|---|
| hotelId | Include the hotelId that uniquely identifies a single hotel property in CRS. | string | Required |
| id | Include an id for the system to match to itinerary number, confirmation number, guest CRS reference number, and cancellation number, in that order. The first match will be returned. | string | Required |
Query Parameters
The following table describes the elements that you can include when you query this endpoint:
| Element | Description | Type | Required? |
|---|---|---|---|
| channel | You can include the channel reading the reservation. Here is an example: /v1/api/reservation/hotel/11113/789?channel=WEB | string | Optional |
| includeAssociatedReservations | You can specify true to return reservations that are associated in the same itinerary. Only reservations with status of Confirmed or Cancelled will be included. You can specify false to not return reservations that are associated in the same itinerary. Here is an example: /v1/api/reservation/hotel/11113/789?includeAssociatedReservations=true | boolean | Optional |
Response in JSON
The response to this endpoint is the same as the response for the GET a list of reservations endpoint.
Response Elements
The response elements for this endpoint are the same as the elements for the GET a list of reservations endpoint.
PATCH to update a reservation (without an availability check)
This endpoint tells the system to update your specified reservation with your specified data without performing an availability check.
[PATCH] /v1/api/reservation/notifThis endpoint's purpose is virtually identical to the PATCH /reservation endpoint, but keep in mind the following differences:
- With this endpoint, the system does not perform an availability check prior to booking. The product requested is assumed to be available.
- This endpoint returns an error if the RoomCode and RateCode do not match a room code and rate code stored in the system. A workaround for the error is to use DefaultRoomCode and DefaultRateCode, which the system will use instead of RoomCode and RateCode if an error is encountered. The Default Room and Rate code must exist in the system, or an error is returned.
- With this endpoint, the calling application should use BookingInfo.ReservationNotifSource to identify the reservation source.
- With this endpoint, reservation rate amount details are required to process a new reservation notification. Rate amount details must be included in RoomStay.Products.Price.Amount.
For full details and examples, see PATCH to update a reservation.
POST to create a reservation (without an availability check)
This endpoint tells the system to create a new reservation without performing an availability check.
[POST] /v1/api/reservation/notifThis endpoint's purpose is virtually identical to the POST /reservation endpoint, but keep in mind the following differences:
- With this endpoint, the system does not perform an availability check prior to booking. The product requested is assumed to be available.
- This endpoint returns an error if the RoomCode and RateCode do not match a room code and rate code stored in the system. A workaround for the error is to use DefaultRoomCode and DefaultRateCode, which the system will use instead of RoomCode and RateCode if an error is encountered. The Default Room and Rate code must exist in the system, or an error is returned.
- With this endpoint, the calling application should use BookingInfo.ReservationNotifSource to identify the reservation source.
- With this endpoint, reservation rate amount details are required to process a new reservation notification. Rate amount details must be included in RoomStay.Products.Price.Amount.
For full details and examples, see POST a new reservation.
Examples for Creating Reservations
The following examples show various details you can add when you create reservations. All of these examples use the [POST] /v1/api/reservation endpoint, except where other endpoints are specified.
Basic Information: Minimum Requirement to Create a Reservation
The minimum required information to create a reservation is:
- Chain
- Hotel
- Product (Room and Rate)
- Stay Dates
- Booking Channel
- Number of Guests
- Number of Rooms
- Status
Always include the minimum basic information, as shown in the following example. With that, you can also add extra information (such as access codes, billing locations, etc.) from the other examples in this section.
Here is an example of the minimum basic reservation:
{
"Chain":{
"Id":14161022
},
"Channels":{
"PrimaryChannel":{
"Code":"WEB"
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE"
}
},
"Hotel":{
"Id":100319
},
"Guests":[
{
"PersonName":{
"GivenName":"John",
"Surname":"Public"
},
"Payments":[
{
"PaymentCard":{
"CardCode":"VI",
"CardHolder":"John Public",
"CardNumber":"444444444444444",
"CardSecurityCode":"123",
"ExpireDate":"1225"
},
"Type":"CreditCard"
}
],
"ContactNumbers":[
{
"Number":"555-123-2717"
}
],
"EmailAddress":[
{
"Value":"john.public@email.com"
}
]
}
],
"RoomStay":{
"StartDate":"2026-06-07",
"EndDate":"2026-06-08",
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":1
}
],
"NumRooms":1,
"Products":[
{
"Product":{
"RateCode":"BAR",
"RoomCode":"LUXQ"
}
}
]
},
"status":"Confirmed"
}
Access Codes: Corporate or Promotion
You can use an access code to apply a special rate to a reservation. Types associated with access codes are Corporate or Promotion.
For a Corporate code search, the system first looks for a Hotel-level company profile. If it does not find one, it then looks for a Chain-level profile.
Here is an example of how to include a Corporate access code:
"Promotion":{
"AccessKey":{
"Password":"DELL"
},
"Type":"Corporate"
}
Here is an example of how to include a Promotion access code:
"Promotion":{
"AccessKey":{
"Password":"5PCOFF"
},
"Type":"Promotion"
}
Billing Location
Billing Location allows guests to enter a billing address (independent of the guest's billing address) and to optionally include a VAT Identification Number.
The Billing Location information is visible in CRS on the Reservation Details page, in SynXis Voice Agent, and in email confirmations.
In order to use this functionality, Enable VAT Billing Address must be configured by the hotel on the Administration > Hotel > Hotel Maintenance page in CRS.
Here is an example of how to include a Billing Location:
{
"BillingLocations":[
{
"Id":"VAT1234567",
"EmailAddress":"test1@email.com",
"BusinessName":"AutoShop",
"Address":{
"AddressLine":[
"123 Main St",
"Add Line 2",
"Add Line 3"
],
"City":"London",
"Country":{
"Code":"UK"
},
"PostalCode":"SE1 9PD"
},
"ContactNumberList":[
{
"Number":"555-123-4567",
"Type":"Voice1"
},
{
"Number":"555-123-9876",
"Type":"Fax"
}
]
}
]
}
Booking Channels
Use Booking Channels to track how a reservation was created or modified.
Here is an example of how to include a Booking Channel:
"Channels":{
"PrimaryChannel":{
"Code":"WEB"
},
"SecondaryChannel":{
"Code":"SYNXISWS_BE"
},
"SubSourceCode":"KYAK",
"SecondarySubSourceCode":789
}
Brand
You can optionally include the Brand when you create a reservation. The Hotel and Chain are part of the minimum requirements.
Here is an example of how to include a Brand:
"Brand":{
"Id":"14545"
}
Commissionable Account
You can include the Commissionable Account, which is the ID of the Travel Agent who made the reservation.
Here is an example of how to include a Commissionable Account:
"CommissionableAccountProfile":{
"TravelIndustryId":"30000024"
}
Coupon Offer Code
You can include coupons to be applied to the reservation.
Here is an example of how to include a coupon offer code:
"CouponOffers":[
{
"Code":"Save50"
}
]
CRO
You can include the Central Reservation Office (CRO) ID that made the reservation.
Here is an example of how to include a CRO:
"CRO":{
"Id":"3426"
}
Guest Information
You can include many details about the guests associated with the reservation.
Here is an example of how to include guest information:
{
"Guests":[
{
"Citizenships":[
{
"CountryCode":"US",
"Primary":true
}
],
"Comments":"This is a guest comment.",
"ContactNumbers":[
{
"Code":"719",
"Default":true,
"Number":"555-2717",
"Role":"Home",
"SortOrder":1,
"Type":"Voice",
"Use":"DayTimeContact"
}
],
"DateOfBirth":"1985-05-18",
"EmailAddress":[
{
"Type":"Primary",
"Value":"jonh.public@email.com",
"Default":true
},
{
"Type":"Mobile",
"Value":"john.public@email2.com",
"Default":false
}
],
"Gender":"Male",
"Locations":[
{
"Address":{
"AddressLine":[
"123 Main St",
"Appt. 201"
],
"City":"Denver",
"Country":{
"Code":"US"
},
"Default":true,
"PostalCode":"80203",
"StateProv":{
"Code":"CO"
},
"Type":"Home"
},
"Name":"Home Address"
}
],
"MarketingOptIn":true,
"Payments":[
{
"Amount":"50",
"PaymentCard":{
"CardCode":"VI",
"CardHolder":"John Public",
"CardNumber":"444444444444444",
"CardSecurityCode":"123",
"ExpireDate":"1225"
},
"Type":"CreditCard"
}
],
"PersonName":{
"GivenName":"John",
"MiddleName":"A",
"Prefix":"Mr.",
"Suffix":"Jr.",
"Surname":"Public",
"PreferredGivenName":"James",
"PreferredSurname":"Smith"
},
"Role":"Primary",
"SpokenLanguages":[
{
"Code":"en",
"Default":true
}
],
"TravelDocuments":[
{
"Type":"MilitaryIdentification",
"HolderName":"John Public",
"Number":"2999-9285820-874",
"IssuingAuthority":"DOJ",
"PlaceOfIssue":"Houston, TX"
}
]
}
]
}
Loyalty Information
You can add loyalty information to a reservation in LoyaltyMemberships. The ProgramID and Level.Code must match a loyalty program on the chain. You can use this for guests who don't have a profile but want to receive credit for a reservation. You can also use it for guests who have a profile with a default loyalty program but want recognition for this reservation to go to a different loyalty program.
Here is an example of how to include loyalty information:
"LoyaltyMemberships":[
{
"Level":{
"Code":"Gold"
},
"MembershipID":"MY790887688",
"ProgramID":"MyLoyalty",
"Source":"Selected"
}
]
Market Segment
You can include market segments that are used to track geographic, demographic, or other customer classifications targeted by a hotel or chain for purchase and use of products and services. For example, a hotel can determine its use of advertising dollars based on the nature of travelers staying in a hotel.
Here is an example of how to include a market segment:
"MarketSegment":{
"code":"LEISURE"
}
Market Source
You can include market sources for a hotel that are based on the content management strategy defined by the primary chain.
Here is an example of how to include a market source:
"MarketSource":{
"code":"REFERRAL"
}
Meal Plans
Meal plans are automatically included in the reservation based on the configuration in CRS. Consequently, there is no provision to pass them in a reservation request.
Multi-Step Reservation
You can place the reservation in any status as you create it. For example, you can create an unconfirmed reservation and give it the Booked status, without adding guests to the reservation. This is typical in a two-stage confirmation process. However, nothing restricts you from confirming a reservation while creating it.
After you create the reservation and a confirmation number is assigned, you can use the confirmation number to reference and update the reservation.
Example scenario: You have a multi-step booking process. First, you create the reservation with stay criteria included, and you specify its status as Booked. Second, you update the reservation to include non-room products or price overrides, and you keep its status as Booked. Third, you update the reservation again to include guest information and payment information, and you change its status to Confirmed.
Here are examples of each step:
Step 1: Use the POST /v1/api/reservation endpoint to create the reservation with a status of Booked.
Your post request looks like this:
{
"Chain":{
"Id":12723
},
"Channels":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE"
},
"SecondaryChannel":{
"Code":"WEB"
}
},
"Hotel":{
"Id":13098
},
"RoomStay":{
"StartDate":"2026-11-01",
"EndDate":"2026-11-02",
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":1
}
],
"NumRooms":1,
"Products":[
{
"Primary":true,
"Product":{
"RateCode":"BAR",
"RoomCode":"LUXT"
}
}
]
},
"status":"Booked"
}
The response to your post looks like this:
{
"reservations":[
{
"CrsConfirmationNumber":"13098CU000379"
}
]
}
Step 2: Use the PATCH /v1/api/reservation endpoint to add a dynamic package to the reservation and keep the status of Booked. Include the CrsConfirmationNumber from the response you received in step 1.
Your patch request looks like this:
{
"Chain":{
"Id":12723
},
"Channels":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE"
},
"SecondaryChannel":{
"Code":"WEB"
}
},
"Hotel":{
"Id":13098
},
"Packages":[
{
"Code":"SPA",
"Date":"2026-11-01",
"Quantity":1,
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":1
}
]
}
],
"CrsConfirmationNumber":"13098CU000379",
"status":"Booked"
}
Step 3: Use the PATCH /v1/api/reservation endpoint to add guest information, payment details, and a status of Confirmed. Include the CrsConfirmationNumber from the response you received in step 1.
Your patch request looks like this:
{
"Chain":{
"Id":12723
},
"Channels":{
"PrimaryChannel":{
"Code":"SYNXISWS_BE"
},
"SecondaryChannel":{
"Code":"WEB"
}
},
"Hotel":{
"Id":13098
},
"Guests":[
{
"ContactNumbers":[
{
"Default":true,
"Number":"55512345678",
"Role":"Home",
"Type":"Mobile"
}
],
"EmailAddress":[
{
"Type":"Primary",
"Value":"larry.walker@email.com"
}
],
"PersonName":{
"GivenName":"Larry",
"Surname":"Walker"
},
"Role":"Primary"
}
],
"CrsConfirmationNumber":"13098CU000379",
"status":"Confirmed"
}
Notifications
To communicate email preferences and reservation comments, you can add the Notification node as you create a reservation.
Here is an example of how to include a notification:
"Notification":{
"AdditionalEmailAddresses":[
"email2@email.com"
],
"SendBookerEmail":false,
"SendGuestEmail":true,
"FromEmailAddress":"myhotel@email.com",
"LanguageCode":"en-US",
"EmailTemplate":{
"Code":"NoPoints",
"Level":"Hotel"
},
"DeliveryComments":[
{
"Comment":"This is a reservation Comment"
}
],
"PublicComment":"Email comments for the guest."
}
On-Hold Reservation
Status is a required element for all reservations you create. You can create a reservation with an On Hold status to remove room inventory until the reservation is confirmed, cancelled manually, or cancelled automatically by the system after a period of time. On Hold reservations override the guarantee and cancel policies assigned to the selected product so that the reservation can be confirmed without a payment method. Guest information is required for On Hold reservations.
Hotels configure a default On Hold Release time in CRS. The release time can be overridden in the API via onHoldReleaseTime.
For example: You create a reservation with a status of On Hold and onHoldReleaseTime=6. That means the guest will have six hours to complete or cancel the reservation before the system will automatically cancel the reservation and return the room inventory.
Setup Requirements:
- The chain must have On Hold Reservations Auto Release enabled in Control Center.
- The API user must have the Access Point named Can Manage On Hold Reservations.
Here is an example of how to include an On Hold status:
{
"Guests":{
"..."
},
"Packages":{
"..."
},
"RoomStay":{
"..."
},
"onHoldReleaseTime":6,
"status":"OnHold"
}
Overrides
If you have the necessary access point assignments, you can override restrictions and system-calculated information. The system determines which overrides to apply to the reservation based on your access points. Optionally, you can include comments for the override.
For example, if a product with rate code BAR and room code DS is unavailable, you can override it by including Type=AvailabilityOverride. Then, the reservation will record that an override occurred without additional information.
Here is an example of how to include an override:
"Overrides":[
{
"Type":"AvailabilityOverride",
"Comment":"Manager Discretion"
}
]
Price Override
If you have the access point named Override Daily Rates, you can override the price of a rate.
Use the override Type=PriceOverride to override the price. You must populate the Reservation.RoomStay.RateList.Rate.Price node in the request whenever the rate override is required.
Each date in the reservation must have a price on rate override. The start and end date of the price is derived from Reservation.RoomStay.RateList.Rate.effectiveDate and Reservation.RoomStay.RateList.Rate.expireDate, respectively.
The discount reason code will be populated from Reservation.RoomStay.RateOverride.Code.
In the following example, the price of the product (RateCode=DS / RoomCode=A1K) will be overridden to $75.00 by including Type=PriceOverride and RoomStay.Price.Amount=75.00.
"RoomStay":{
"StartDate":"2026-12-10",
"EndDate":"2026-12-12",
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":1
}
],
"NumRooms":1,
"Products":[
{
"Primary":true,
"Product":{
"RateCode":"DS",
"RoomCode":"A1K"
}
}
],
"Price":{
"Amount":75.00
}
},
"Overrides":[
{
"AuthorizedBy":"John Smith",
"Type":"PriceOverride",
"Comment":"Honeymoon"
}
]
Packages or Non-Room Products
You can include packages when you create a reservation.
Here is an example of how to include a package:
{
"Chain":{
"..."
},
"Channels":{
"..."
},
"Hotel":{
"..."
},
"Guests":[
"..."
],
"RoomStay":{
"..."
},
"Guests":[
"..."
],
"Packages":[
{
"Code":"BKFST42",
"Date":"2026-08-29T00:00:00",
"Name":"Breakfast for two",
"Quantity":1,
"redeemLoyalty":true,
"time":"0800",
"BookedDays":[
{
"date":"2026-08-31T00:00:00",
"time":"12:30 PM",
"quantity":1,
"GuestCount":[
{
"AgeQualifiyingCode":"Adult",
"NumGuests":2
}
]
}
]
}
]
}
Payment Methods
You can include payment method information when you create a reservation. Hoteliers configure the payment method for a specific rate that is required to confirm a reservation.
Some forms of payment require a redirect to a third-party site. These payment types can be created or modified only in Aven Hospitality's booking applications, not in the Reservation Services API's create or modify reservation endpoints. However, when a reservation already includes one of these payment types, the payment method information does appear in the responses for the Reservation Services API's endpoints that get a list of reservations or get individual reservations.
The following table specifies which payment methods you can include in your create or modify reservation requests, and which you can view in responses to your get reservation requests.
| Payment Method | Can Include in Requests | Can View in Get Responses |
|---|---|---|
| Bank Deposit | No | Yes |
| Credit Card – 3D Secure | No | Yes |
| Credit Card - Guarantee | Yes | Yes |
| Credit Card – Real-Time processing | Yes (hotel setup required) | Yes |
| Cash | Yes | Yes |
| Check | Yes | Yes |
| Direct Bill | Yes (hotel setup required) | Yes |
| Direct Bill – Virtual Payment | No | Yes |
| eWallet | No | Yes |
| Installment Options | No | Yes |
| Loyalty Certificate | No | Yes |
| Loyalty Points | Yes | Yes |
You can also get details about payment methods from the following Aven Hospitality APIs:
- The Hotel Content API get endpoints can return details about payment methods supported by a hotel.
- The Hotel Availability API get endpoint can return details about the payment method requirements for a rate.
Payment Method: Cash or Check
You can include information about whether cash or check was used as the payment method when you create a reservation. Simply include the Type as Cash or as Check. In the Role attribute, you specify whether the payment method is Alternate, Business, Personal, Primary, or Secondary.
Here is an example of how to include a Cash payment. Change the Type from Cash to Check for a check payment method:
{
"Guests":[
{
"Payments":[
{
"Role":"Primary",
"Type":"Cash"
}
]
}
]
}
Payment Method: Credit Card
You can include information about whether a credit card was used as the payment method when you create a reservation. In addition to the Role and Type, you can add information about the CardCode, CardHolder, CardName, CardNumber, CardSecurityCode, CompanyName, and ExpireDate.
The following table lists the credit cards that are supported:
| Card Name | Card Code |
|---|---|
| American Express | AX |
| Carte Blanche | CB |
| China Union Pay | UP |
| Diners Club | DN |
| Discover Card | DS |
| Euro Card | EC |
| Forbrugsforeningskort | FB |
| Japanese Credit Bureau Credit Card | JC |
| Maestro | SW |
| Master Card | MC |
| Visa | VI |
Here is an example of how to include a credit card as payment method:
{
"Guests":[
{
"Payments":[
{
"Role":"Primary",
"Type":"CreditCard",
"PaymentCard":{
"CardCode":"VI",
"CardHolder":"Larry Walker",
"CardName":"Visa",
"CardNumber":"4444444444444444",
"CardSecurityCode":"123",
"CompanyName":"Company",
"ExpireDate":"1225"
}
}
]
}
]
}
Payment Method: Direct Bill
You can include information about whether direct bill was used as the payment method when you create a reservation. Note that hoteliers must configure direct billing as an available payment method in their hotel.
Here is an example of how to include direct bill as the payment method:
{
"Guests":[
{
"Payments":[
{
"Type":"DirectBill",
"DirectBill":{
"AccountNumber":"8365920440",
"ProjectNumber":"112234",
"Source":"Local"
}
}
]
}
]
}
Payment Method: Pass Through Point Redemption
For hotel chains that use their own Custom Booking Engine (CBE), the ability to make point redemption reservations directly with their Customer Relationship Management (CRM) vendor and to communicate the redemption information to the Property Management System (PMS) is crucial for supporting loyalty programs and enhancing the overall guest experience.
Aven Hospitality's REST APIs allow customers to perform points redemptions directly with their CRM application for bookings made through a CBE powered by the Aven Hospitality booking API.
Typically, Aven Hospitality's Central Reservation System (CRS) integrates with the CRM to initiate point redemptions. However, for this scenario, the CBE is directly connected to the CRM. Therefore, no integration is required between the CRM and Aven Hospitality's CRS.
Note: These uses of pass through point redemption do not require an interface between Aven Hospitality's CRS and the CRM provider.
CRS can receive from the CBE the details about the redemption that occurred. CRS stores that information and passes it to the PMS.
In CRS, you can configure points programs at Administration > Chain > Loyalty > Loyalty Programs. Your configuration is added to the Loyalty Program page. The configuration defines whether the loyalty program allows pass through redemption details to be provided to CRS from a Custom Booking Application. The default is for this configuration to be disabled, so you must enable it before you can use these functions.
The following attributes support pass through point redemption:
- ReservationAwardList: This is the array to hold the reservation award list information. If the reservation does not include any reservation award, this array does not appear.
- AwardNumber: This is the Award Number. It is optional for a reservation to include an award. However, if it does include an award, it must include an Award Number. This string can include up to 20 characters.
- AwardType: This is the type of the award, which can be your specific award's name or type, such as ClubAcess. It is optional for a reservation to include an award. However, if it does include an award, it is optional to include an Award Type with that award. (In that case, only Award Number is required.) This string can include up to 32 characters.
- IsPassThroughRedemption: If this is true, the reservation is a pass through redemption reservation. If this is false, the reservation is not a pass through redemption reservation. It is optional for a reservation to include an award. However, if it does include an award, it is optional to include the IsPassThroughRedemption element. (In that case, only Award Number is required.) When IsPassThroughRedemption is true, the system checks for Loyalty Redemption Points. However, the points are not required and the pass through redemption can proceed without them.
The following Reservation Services API endpoints support pass through point redemption:
- GET /v1/api/reservation
- PATCH /v1/api/reservation
- POST /v1/api/reservation
Here is an example of how to include pass through points redemption as you create a reservation:
"ReservationAwardList":[
{
"AwardNumber":"1234567890",
"AwardType":"ClubAccess",
"IsPassThroughRedemption":true
}
],
Payment Method: Point Redemption
You can include point redemption information as you create a reservation. Note that this type of point redemption differs from Pass Through Point Redemption (explained above). This point redemption has two variations:
- Points only
- Partial points
Note: These uses of point redemption require an interface between Aven Hospitality's CRS and the CRM provider, and the loyalty program must support point redemptions.
Points only reservations allow a guest to use points to pay for the room rate and also use a credit card to pay the taxes and fees. Therefore, these reservations include two payment methods: one for the cash portion, and a second for point redemption.
The following example creates a reservation with two payment methods, and it sets RoomStay.redeemLoyalty=true to indicate that this is a point redemption booking:
{
"Guests":[
{
"Payments":[
{
"Type":"CreditCard",
"PaymentCard":{
"CardCode":"VI",
"CardHolder":"Test Test",
"CardName":"Visa",
"CardNumber":"4444444444444444",
"CardSecurityCode":"123",
"ExpireDate":"1225"
}
},
{
"Role":"Alternate",
"Type":"LoyaltyPoints",
"LoyaltyRedemption":{
"LoyaltyMembership":{
"MembershipID":"987654321",
"ProgramID":"MyRewards"
}
}
}
]
}
],
"RoomStay":{
"StartDate":"2026-12-15",
"EndDate":"2026-12-16",
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":1
}
],
"NumRooms":1,
"Products":[
{
"Primary":true,
"Product":{
"RateCode":"PointsOnly",
"RoomCode":"LUXQ"
}
}
],
"redeemLoyalty":true
},
"status":"Confirmed"
}
Partial points reservations deduct a certain amount of points from the loyalty account of the guest, while the remaining balance is paid with cash. This type of rate is only applicable for Points or Cash rates when the guest has selected to pay with points. Guest reasons for selecting to pay with points might be that they don't have enough points to cover the entire cost, or they want to pay fewer points and make up the difference in cash. This model allows the guest to choose the number of points to use, up to their entire point balance.
Example scenario: A chain has configured a Points to USD conversion rate of 0.1 (10 points = $1). The guest performs a shop for a points or cash rate that costs 4,000 points or $400. The guest selects to pay with points but only has 2,000 points in their loyalty account. The system allows the guest to pay for the rate with 2,000 points + $200 ( (4,000 points - 2,000 points) / 0.1 = $200).
In the reservation creation request, you use the redemptionLimit parameter to communicate the number of points that the guess uses for the reservation. The system automatically calculates the remaining cash amount. You post to create the reservation in a Booked status. Then you perform a get request to retrieve the reservation that will include the system-calculated cash amount. If the guest agrees to the cash amount, the reservation can be confirmed.
Here is an example of the Hotel Availability response in which the Amount equals 400 and Points equals 4000:
{
"Product":{
"Prices":{
"Total":{
"Price":{
"Fees":{
"..."
},
"Tax":{
"..."
},
"Total":{
"Amount":400,
"AmountPayableNow":400,
"AmountWithTaxesFees":400,
"AmountWithInclusiveTaxes":400
},
"Amount":400,
"CurrencyCode":"USD",
"Points":4000
}
},
"TaxesFeesIncluded":false
},
"Rate":{
"Code":"Points or Cash"
},
"Room":{
"Code":"LUXQ"
},
"LoyaltyApplicable":true,
"Ref":"Loyalty",
"RefValue":"MyLoyalty"
},
"Available":true
}
Here is an example of creating the reservation, in which status equals Booked and redemptionLimit equals 2000:
{
"Guests":[
{
"Payments":[
{
"Type":"CreditCard",
"PaymentCard":{
"CardCode":"VI",
"CardHolder":"Test Test",
"CardName":"Visa",
"CardNumber":"4444444444444444",
"CardSecurityCode":"123",
"ExpireDate":"1225"
}
},
{
"Role":"Alternate",
"Type":"LoyaltyPoints",
"LoyaltyRedemption":{
"LoyaltyMembership":{
"MembershipID":"987654321",
"ProgramID":"MyRewards",
"redemptionLimit":2000
}
}
}
]
}
],
"RoomStay":{
"StartDate":"2026-12-15",
"EndDate":"2026-12-16",
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":1
}
],
"NumRooms":1,
"Products":[
{
"Primary":true,
"Product":{
"RateCode":"PointsOrCash",
"RoomCode":"LUXQ"
}
}
],
"redeemLoyalty":true
},
"status":"Booked"
}
}
Here is an example of the get endpoint response, in which Points equals 2000 and the system-calculated TotalAmount equals 200.00:
"RoomPrices":{
"TotalPrice":{
"Price":{
"Fees":{
"..."
},
"Tax":{
"..."
},
"CurrencyCode":"USD",
"TotalAmountBeforeExchange":400.0,
"Points":2000,
"TaxesFeesIncluded":false,
"TotalAmount":200.0,
"AmountPayableNow":200.0,
"TotalAmountWithInclusiveTaxesFees":200.0,
"TotalAmountIncludingTaxesFees":200.0,
"OriginalAmountIncludingTaxesAndFees":400.0
}
}
}
Here is an example of the patch request to modify the reservation's status to Confirmed:
{
"Reservations":[
{
"Chain":{
"Id":12345
},
"Channels":{
"PrimaryChannel":{
"Code":"WEB"
},
"SecondaryChannel":{
"Code":"WEB"
}
},
"Hotel":{
"Id":9876
},
"CrsConfirmationNumber":"100319CK002210",
"status":"Confirmed"
}
]
}
Price Exemptions
When you create a reservation, you can include a list of taxes and fees that will be exempt from the reservation price.
Here is an example of how to include a price exemption as you create a reservation:
"PriceExemptionList":[
{
"Exempt":true,
"Type":[
{
"Type":"StateTax",
"ReasonCode":"GOV"
}
]
}
]
Here is an example of the ExemptedTaxTypes node that appears in responses with taxes that have been exempted:
"ExemptedTaxTypes":[
{
"Breakdown":[
{
"Date":"2026-12-10T00:00:00",
"Amount":9.53,
"ReasonCode":"GOV"
},
{
"Date":"2026-12-11T00:00:00",
"Amount":9.53,
"ReasonCode":"GOV"
}
],
"Code":"State",
"Type":"StateTax",
"Name":"State Tax",
"Amount":19.06
}
]
PMS Instructions
You can update the SynXis Property Hub PMS with the following on-property information as you create a reservation:
- Housekeeping
- Charge routing (Note that routing instructions are visible only in SynXis Property Hub and in the Reservation Services API messages)
- On property status
- Room unit assignment
Here is an example of how to include PMS instructions:
"OnPropertyInstructions":{
"Housekeeping":{
"ScheduleCode":"FC3"
},
"ChargeRoutingList":[
{
"Code":"MH34",
"FolioNumber":"93984952"
}
]
},
"OnPropertyStatus":"InHouse",
"RoomStay":{
"StartDate":"{{check_in}}",
"EndDate":"{{check_out}}",
"GuestCount":[
"..."
],
"NumRooms":1,
"Products":[
{
"Primary":true,
"Product":{
"RateCode":"BAR",
"RoomCode":"LUXQ",
"RoomUnit":"201"
}
}
]
}
Room Requests
When you create a reservation, you can specify room requests (special requests) with the RoomRequest.code attribute. These requests are tied to OTA Room Amenity codes (RMA) for room requests configured for the hotel in CRS at Setup > Rooms > Room Requests.
If you pass a RoomRequest element with an OTA Room Amenity Code (code) that matches a room request in CRS, the room request description displays in CRS in the Room Features section on the Reservation Details page.
Here is an example of how to include room request information as you create a reservation:
{
"Chain":{
"..."
},
"Channels":{
"..."
},
"Hotel":{
"..."
},
"Guests":[
"..."
],
"RoomStay":{
"..."
},
"RoomRequests":[
{
"Code":"59001"
},
{
"Code":"BREAK"
}
],
"status":"Confirmed"
}Here is an example of how room request information appears in a get reservations response in its Content/RoomRequests node:
{
"Content":{
"RoomRequests":[
{
"Description":"Away from elevator",
"Code":"59001"
},
{
"Description":"CAFE DA MANHA",
"Code":"BREAK"
}
]
},
"..."
}
Room Stay
When you create a reservation, you can include room stay information, such as the number of rooms, guests, room and rate codes, and so on.
Here is an example of how to include room stay information:
{
"Chain":{
"..."
},
"Channels":{
"..."
},
"Hotel":{
"..."
},
"Guests":[
"..."
],
"RoomStay":{
"StartDate":"2026-11-10",
"EndDate":"2026-11-11",
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":1
},
{
"AgeQualifyingCode":"Child",
"NumGuests":2,
"Ages":[
4,
6
]
}
],
"NumRooms":1,
"Products":[
{
"Primary":true,
"Product":{
"RateCode":"BAR",
"RoomCode":"SUPK"
}
}
]
}"status":"Confirmed"
} Here is an example of how room stay information appears in a get reservations response:
{
"RoomStay":{
"GuestCount":[
{
"Ages":[
4,
6
],
"AgeQualifyingCode":"Child",
"NumGuests":2
},
{
"AgeQualifyingCode":"Adult",
"NumGuests":1
}
],
"NumRooms":1,
"EndDate":"2026-11-10T00:00:00",
"StartDate":"2026-11-12T00:00:00",
"Group":false,
"Suppressed":true,
"Products":[
{
"Product":{
"RateCode":"BAR",
"RoomCode":"SUPK",
"Id":"36fb07b0-0ec4-40a8-9f82-7d6025b621a1"
},
"StartDate":"2026-11-10T00:00:00",
"EndDate":"2026-11-12T00:00:00",
"Primary":true
}
]
}
}
Room Upgrade
When you create a reservation, you can upgrade the guest from one room type to another. Include the room to charge, the room to stay in (upgraded room), and the reason code for the upgrade.
Here is an example of how to include a room upgrade:
{
"Chain":{
"..."
},
"Channels":{
"..."
},
"Hotel":{
"..."
},
"Guests":[
"..."
],
"RoomStay":{
"..."
},
"Upgrade":{
"Reason":{
"Code":"HNYMN"
},
"RoomToCharge":{
"Code":"A1Q"
},
"RoomToStay":{
"Code":"A1K"
}
}"status":"Confirmed"
}Here is an example of how room upgrade information appears in a get reservations response:
{
"Upgrade":{
"Reason":{
"Code":"HNYMN",
"Value":"Honeymoon"
},
"RoomToCharge":{
"Code":"A1Q"
},
"RoomToStay":{
"Code":"A1K"
}
}
}
Source of the Reservation
When you create a reservation, you can include information about the source of the reservation for the booking application to store.
Here is an example of how to include source information:
"Source":{
"IP_Address":"198.162.1.1",
"BookingURL":"myhotelwebsite.com",
"Telephony":{
"VDN":"VDN1234"
}
}
Split Reservation
You can include split reservation information as you create a reservation. The split reservation function enables you to split a multiple-room single reservation into individual reservations. A reservation can be split only if its status is Booked, Wait Listed, or Stored. A reservation cannot be split if a coupon code was applied.
Use the roomStaySplit parameter to specify how to split a multiple-room single reservation The following example shows the parameter set to SingleRoomAsMultipItineraries. You can set the parameter to any of these three options:
- Default: Use this when you have no preference. This lets the system handle the split as per the configured PMS integration settings (Hotel > Admin > Book Multiple Rooms as Itinerary).
- SingleRoomInSameItinerary: Use this to split multiple rooms into single room reservations within the same itinerary. In Control Center, the following setting must be enabled: Hotel > Admin > Book Multiple Rooms as Itinerary.
- SingleRoomAsMultipleItineraries: Use this to split multiple rooms into individual itineraries.
Here is an example of how to include the roomStaySplit parameter as you create a reservation:
"roomStaySplit": "SingleRoomAsMultipleItineraries
Example scenario: An agent shops for three rooms for three adults. She selects the product and then creates a reservation in Booked status to hold the inventory. Next, she wants to manage package assignments at the individual room level. Therefore, she chooses to split the single multi-room reservation into individual reservations. The agent now has three individual reservations so that she can manage the packages individually.
Here is the response you receive when you do not include roomStaySplit, which results in one itinerary and one confirmation number:
{
"reservations":[
{
"CrsConfirmationNumber":"CIAOV7I",
"ItineraryNumber":"12723B0000454",
"Id":"39650eaf-cd7c-46a7-9b8d-967886415546"
}
}
Here is the response you receive when you include roomStaySplit=SingleRoomInSameItinerary, which results in one Itinerary and three confirmation numbers:
{
"reservations":[
{
"Id":"6e94779a-903f-46ad-b2e0-10d0f44a9823",
"CrsConfirmationNumber":"CIAP7JD",
"ItineraryNumber":"12723B0000625"
},
{
"Id":"5941ff61-5981-43ee-b514-e8864aaa4be7",
"CrsConfirmationNumber":"CIAP7JF",
"ItineraryNumber":"12723B0000625"
},
{
"Id":"d9d88d2c-a730-4502-9cb9-8a5a2652c31f",
"CrsConfirmationNumber":"CIAP7JH",
"ItineraryNumber":"12723B0000625"
}
]
}
Here is the response you receive when you include roomStaySplit=SingleRoomAsMultipleItineraries, which results in three Itineraries and three confirmation numbers:
{
"reservations":[
{
"Id":"036a3229-2247-4493-a438-5e52fd778623",
"CrsConfirmationNumber":"CIAP7JJ",
"ItineraryNumber":"12723B0000626"
},
{
"Id":"444d07a6-4e83-4f17-a440-152b7d607c34",
"CrsConfirmationNumber":"CIAP7JL",
"ItineraryNumber":"12723B0000627"
},
{
"Id":"02c7c894-06e5-4168-a235-8107ae94d73e",
"CrsConfirmationNumber":"CIAP7JN",
"ItineraryNumber":"12723B0000628"
}
]
}
Transportation
You can include transportation details as you create a reservation, so that a hotel can know how and when guests are arriving and departing.
Here is an example of how to include transportation details:
{
"Chain":{
"..."
},
"Channels":{
"..."
},
"Hotel":{
"..."
},
"Guests":[
"..."
],
"RoomStay":{
"..."
},
"Transporation":{
"EstimatedCheckInTime":"12:30 PM",
"EstimatedCheckOutTime":"2:30 PM",
"Details":[
{
"TransferRequest":{
"Code":"TC1",
"Type":"Arrival",
"Chargeable":true,
"RequiresArrangement":true,
"Time":"1PM",
"Mode":"Limo"
},
"Airline":{
"Code":"AA",
"FlightNumber":"1597"
},
"Location":{
"Code":"COS",
"Type":"Airport"
}
},
{
"TransferRequest":{
"Code":"TC1",
"Type":"Departure",
"Chargeable":true,
"RequiresArrangement":true,
"Time":"7AM",
"Mode":"Limo"
},
"Airline":{
"Code":"AA",
"FlightNumber":"1598"
},
"Location":{
"Code":"COS",
"Type":"Airport"
}
}
]
},
"status":"Confirmed"
}
Here is an example of how transportation details appear in a response:
{
"Transporation":{
"TransportationInfo":[
{
"Airline":{
"Code":"AA",
"FlightNumber":"1597"
},
"Location":{
"Code":"COS",
"Type":"Airport"
},
"TransferRequest":{
"Code":"TC1",
"Type":"Arrival",
"Chargeable":true,
"RequiresArrangementByHotel":true,
"Mode":"Limo",
"Time":"2026-06-07T13:00:00"
}
},
{
"Airline":{
"Code":"AA",
"FlightNumber":"1598"
},
"Location":{
"Code":"COS",
"Type":"Airport"
},
"TransferRequest":{
"Code":"TC1",
"Type":"Departure",
"Chargeable":true,
"RequiresArrangementByHotel":true,
"Mode":"Limo",
"Time":"2026-06-08T07:00:00"
}
}
],
"EstimatedCheckInTime":"12:30",
"EstimatedCheckOutTime":"14:30"
}
}
Wait List
As you create a reservation, you can specify that it be put on a wait list. You need to have wait list codes configured in Control Center at Setup > Channels > Voice Agent > Wait List Reasons.
In your post body, you include the wait list code and a wait list description. You must also set the status attribute to Waitlisted.
Here is an example of how to include wait list information in your reservation:
{
"Chain":{
"..."
},
"Channels":{
"..."
},
"Hotel":{
"..."
},
"Guests":[
"..."
],
"RoomStay":{
"..."
},
"WaitList":{
"Code":"WL5467",
"Description":"Waiting Payment Information"
},
"status":"Waitlisted"
}
Examples of Reservations with Retailing Ancillaries
The following examples show you how to handle Aven Hospitality Retailing products or services (ancillaries) with your reservations.
Note that some Retailing products and services are not currently supported, such as Coupons, Loyalty Redemption, and Shipping.
Cancel Ancillaries
If you have a reservation that already includes retailing ancillaries, those ancillary items are automatically cancelled when the parent reservation is cancelled (if cancellation policies allow). Cancellation policies are not enforced during modifications of reservations.
Modify Ancillaries without Changing Room Price
To modify or cancel a reservation's ancillary order items without recalculating the room price, use the PATCH /v1/api/reservation endpoint with a request that includes changes to the packages only. If the reservation room, rate, and stay dates are not modified, the room price will not be recalculated.
Modify a Reservation with Single-Step Commit
If you have a single-step commit process and you need to modify a reservation that includes ancillaries, use the PATCH /v1/api/reservation endpoint with the request body set to achieve your desired end state of the reservation and ancillary order items. The single-step commit process immediately modifies the reservation.
Modify a Reservation with Two-Step Commit
If you have a two-step commit process and you need to modify a reservation that includes ancillaries, keep in mind that the two-step commit process allows you to collect all proposed changes in a temporary status (pendingModify) before finalizing or aborting the changes. Follow these general steps:
- Collect updated reservation criteria (room, rate, stay dates) from the guest.
- Enter the reservation pendingModify workflow, providing the updated reservation details in the request.
- Guide the guest through a Summary API and Offer API workflow using the updated reservation stay dates when searching for offers.
- Add (or re-add) order items to the reservation.
- Confirm the modification.
Order Reservation Ancillaries
If you want to use the Reservation Services API endpoints to allow ordering of reservation ancillaries, you can do that with the Packages node of the reservation request. Keep the following in mind:
- Quantities are always requested using an age code. When a product does not use age type pricing, the requested quantity is passed using AgeQualifyingCode= "Adult". When a product uses age type pricing, additional AgeQualifyingCodes are passed as needed.
- Ancillaries inherit the currency from the reservation.
- Inclusion of the ancillaries in the response message indicates they have been ordered successfully. See View Reservation Ancillaries for details on response mapping.
Order requests are formatted the same for all offer scenarios:
"Packages":[
{
"Code":" DISNEY_TICKET",
"Date":"2026-01-01",
"Time":" 06:00:00",
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":2
},
{
"AgeQualifyingCode":"Child",
"NumGuests":1
}
]
}
]
Payments, Deposits, Guarantees
Payments are collected at reservation level only. Order policies for ancillary orders are informational only.
View Reservation Ancillaries
You can view the ancillary order items on a reservation. Ancillaries are included in the reservation response in the Packages collection. Aven Hospitality Retailing ancillaries always have the Type as Dynamic. Static packages (configured outside of Retailing) can also be returned.
Keep in mind these differences in naming conventions between the Offer API and the Reservation Services API for ChargeFrequency:
- Package PerNight = Offer PerInstance
- Package PerStay = Offer PerOrder
Keep in mind these differences in naming conventions between the Offer API and the Reservation Services API for ChargeType:
- Package PerOccupancyType = Offer PerAgeType
- Package PerQuantityName = Offer FlatCharge
Hotel dictates will:
- Have ChargeFrequency = PerNight.
- Contain a BookDays instance for each included Date in the offer.
Here is an example:
{
"ChargeFrequency":"PerNight",
"ChargeType":"PerQuantityName",
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":2
}
],
"Price":{
"CurrencyCode":"USD",
"OriginalAmount":26.0,
"TaxesFeesIncluded":false,
"TotalAmount":26.0,
"TotalAmountIncludingTaxesFees":26.0
},
"BookedDays":[
{
"GuestCount":[
{
"AgeQualifyingCode":"Adult",
"NumGuests":2
}
],
"Price":{
"CurrencyCode":"USD",
"OriginalAmount":26.0,
"TaxesFeesIncluded":false,
"TotalAmount":26.0,
"TotalAmountIncludingTaxesFees":26.0
},
"Date":"2026-10-02T00:00:00",
"Quantity":1
}
],
"QuantityName":"Item",
"PackageExternalReferenceList":[
{
"OrderItemNo":"AVN793RT20914",
"Type":"Sip"
}
],
"Code":"TEST-A1-3",
"Date":"2026-10-02T00:00:00",
"Name":"TESTA1",
"Quantity":1,
"Time":"0001-01-01T00:00:00+00:00",
"Type":"Dynamic",
"ChargeCodes":[
{
"AllowanceAmount":0.0
}
]
}