Retrieve Reservations
SynXis provides several use cases for retrieving reservations via GET operations. All search criteria in the request must match the reservation before it will be included in the response.
For example, a client of the API may decide that authenticated guests only need to provide a reservation confirmation number and non-authenticated guests must provide a confirmation number, first name, last name, email, and phone number.
Please Note: This API is flexible and provides many ways to retrieve reservations. If the search parameters are too broad, then the results may be paginated or the response may not return due to a timeout error. It is recommended to provide as many search parameters as possible to narrow down the results and avoid these issues.
REST Method/Endpoint
| Method | Endpoint |
|---|---|
GET | https://[environment]/v1/api/reservation |
GET | https://[environment]/v1/api/reservation/hotel/{hotelId}/{id} |
Retrieve Reservation Request using crsConfirmationNumber
/v1/api/hotel/availability?hotel=100319&view=full&chain=14161022&crsConfirmationNumber=100319CK001125
Retrieve Reservation Response Example
{
"AlertList": [
{
"Description": "Key Pickup",
"DetailedDescription": "Room Key pickup is located on the first floor in Suite #100.",
"Validity": {
"End": "2024-07-14T00:00:00",
"Start": "2022-07-14T00:00:00"
},
"Visibility": {
"End": "2024-07-14T00:00:00",
"Start": "2022-07-14T00:00:00"
},
"Id": "64a875c1-8402-46a6-a084-64ff9c9a9537",
"Name": "Key Pickup",
"Type": "Hotel"
},
{
"Description": "Pool Closed due to renovation",
"DetailedDescription": "The pool will be closed for renovation. During this time guests may use a pool located nearby.",
"Validity": {
"End": "2023-06-30T00:00:00",
"Start": "2022-07-07T00:00:00"
},
"Visibility": {
"End": "2023-06-30T00:00:00",
"Start": "2022-07-06T00:00:00"
},
"Id": "53788e27-b00c-4814-a0db-912bbee0173e",
"Name": "Pool Closed",
"Type": "Hotel"
}
],
"BookingDues": {
"Deposit": {
"DueDate": "2022-07-14T00:00:00",
"Amount": 50.0,
"AmountWithoutTax": 50.0,
"Status": "None"
},
"CancelPenalty": {
"ChargeList": [],
"Amount": 115.0,
"Deadline": "06/04/2023 12:00:00 AM"
},
"NoShowCharge": {
"Amount": 115.0
}
},
"BookingPolicy": {
"DepositFee": {
"Amount": 50.0,
"DueDays": 0,
"DueType": "AtTimeOfBooking",
"TaxInclusive": false,
"IsPrePayment": true,
"Type": "PercentAmountOfStay"
},
"Description": "A credit card guarantee is necessary to complete the reservation.",
"GuaranteeLevel": "Guarantee",
"HoldTime": "0000",
"Requirements": [
"CreditCard",
"AllIATA_Numbers",
"DirectBill"
],
"Code": "24H",
"AllowPay": true
},
"Brand": {
"Code": "LOY_BRAND",
"Id": 14161030,
"Name": "Loyalty Test Brand"
},
"BookingInfo": {
"BookedBy": "Amy Doe",
"BookingDate": "2022-07-14T21:12:08",
"ModifiedBy": "Amy Doe",
"EntryChannelBookingDate": "2022-07-14T21:12:08"
},
"CancelPolicy": {
"CancelFeeAmount": {
"TaxInclusive": true,
"Value": 1.0
},
"CancelFeeType": "NumberNightsOfStay",
"CancelPenaltyDate": "2023-06-04T00:00:00",
"CancelTime": "0000",
"CancelTimeIn": "3",
"ChargeThreshold": "3",
"ChargeType": "ChargeWithinDays",
"Description": "Cancel within 24 hours of arrival to avoid penalty of 1 night of room + tax",
"ModificationRestrictions": "ANGDS",
"NoShowFeeAmount": {
"TaxInclusive": true,
"Value": 1.0
},
"NoShowFeeType": "NumberNightsOfStay",
"Charges": [
{
"DaysToArrive": 3,
"CancelFeeIncludesTax": true,
"CancelFeeAmount": 1.0
}
],
"CancellationPermitted": true,
"Code": "24X",
"LateCancellationPermitted": true
},
"CommissionPolicy": {
"Commission": {
"Value": 0.1,
"UnitType": "Percentage",
"CalculationType": "PerNight"
},
"Code": "CP1",
"Description": "CP1 (10%"
},
"Chain": {
"Code": "LOYALTY",
"Id": 14161022,
"Name": "Loyalty Test Chain"
},
"Guests": [
{
"Payments": [
{
"PaymentCard": {
"CardHolder": "John Public",
"CardCode": "VI",
"CardName": "VISA",
"CardNumber": "XXXXXXXXXXX4444",
"Token": "94934712-6f8b-45e3-8bec-8a06fdfb82a7",
"ExpireDate": "12/25"
},
"Role": "Primary",
"Type": "CreditCard",
"VendorStatus": "Unknown"
}
],
"EmailAddress": [
{
"Default": true,
"Type": "Primary",
"Value": "john.public@email.com"
}
],
"PersonName": {
"GivenName": "John",
"Prefix": "",
"Surname": "Public"
},
"CRS_referenceNumber": "100319GW000877",
"Role": "Primary",
"EndDate": "06/08/2023 12:00:00 AM",
"StartDate": "06/07/2023 12:00:00 AM",
"DenyChargeToRoom": false,
"MarketingOptIn": false,
"ContactNumbers": [
{
"Number": "682-605-2717",
"Code": "",
"Default": true,
"SortOrder": 0,
"Type": "Voice",
"Role": "Home",
"Use": "Unknown"
}
]
}
],
"Content": {
"Rates": [
{
"Description": "This rate is used for updating Dev Studio.",
"DetailedDescription": "Best Available Rate",
"CategoryCode": "Hotel_Level_Rate_Cat",
"Code": "Dev Studio",
"EffectiveDate": "2023-06-07T00:00:00",
"ExpireDate": "2023-06-07T00:00:00",
"Name": "Dev Studio Demo Rate",
"Primary": true
}
],
"Rooms": [
{
"DetailedDescription": "Deluxe Room Two Queen Beds-AC-Cable TV-Minibar-Bathroom-Hari Drier-Closet-Balcony-Desk-Internet-Safe",
"Description": "Deluxe Room Two Queen Beds",
"CategoryCode": "CHAIN_RM_CAT",
"Code": "LUXQ",
"Name": "Deluxe Room Queen Beds"
}
],
"RateCategories": [
{
"Description": "",
"CategoryCode": "Hotel_Level_Rate_Cat",
"Name": "Hotel_Level_Rate_Cat"
}
],
"RoomCategories": [
{
"Description": "",
"CategoryCode": "CHAIN_RM_CAT",
"Name": "Chain Level Room Category"
}
]
},
"Currency": {
"Name": "US Dollars",
"Symbol": "$",
"Code": "USD"
},
"Overrides": [],
"Hotel": {
"Id": 100319,
"Code": "LOYAL1",
"Name": "Loyalty Hotel 1 - DO NOT TOUCH!!!"
},
"Language": {
"Code": "en-US",
"Name": "Default"
},
"MarketSegment": {
"Code": "LEISURE",
"Name": "Leisure Segment"
},
"MarketSource": {
"Code": "REFERRAL",
"Name": "Referral from another website"
},
"RoomPrices": {
"PriceBreakdowns": [
{
"Type": "Daily",
"ProductPrices": [
{
"Price": {
"Fees": {
"Breakdown": [
{
"Description": "CITY_FEE",
"Amount": 5.0,
"Code": "CITYFEE",
"Level": "Hotel",
"Name": "CITYFEE",
"Type": "CityHotelFee",
"IsPayAtProperty": false
}
],
"Amount": 5.0
},
"Tax": {
"Breakdown": [
{
"Description": "STATE 10%",
"Amount": 10.0,
"Code": "STATE 10%",
"Level": "Hotel",
"Name": "STATE 10%",
"Type": "BedTax",
"IsPayAtProperty": false
}
],
"Amount": 10.0
},
"CurrencyCode": "USD",
"DisplayOverrideAsPercentage": false,
"TotalAmount": 100.0,
"AmountPayableNow": 115.0,
"AmountPayAtProperty": 0.0,
"TotalAmountWithInclusiveTaxesFees": 100.0,
"TotalAmountIncludingTaxesFees": 115.0,
"OriginalAmountIncludingTaxesAndFees": 115.0
},
"Product": {
"RateCode": "Dev Studio",
"RoomCode": "LUXQ"
},
"EndDate": "2023-06-07T00:00:00",
"StartDate": "2023-06-07T00:00:00"
}
]
}
],
"TotalPrice": {
"Price": {
"Fees": {
"Breakdown": [
{
"Description": "CITY_FEE",
"Amount": 5.0,
"Code": "CITYFEE",
"Level": "Hotel",
"Name": "CITYFEE",
"Type": "CityHotelFee",
"IsPayAtProperty": false
}
],
"Amount": 5.0
},
"Tax": {
"Breakdown": [
{
"Description": "STATE 10%",
"Amount": 10.0,
"Code": "STATE 10%",
"Level": "Hotel",
"Name": "STATE 10%",
"Type": "BedTax",
"IsPayAtProperty": false
}
],
"Amount": 10.0
},
"CurrencyCode": "USD",
"TaxesFeesIncluded": false,
"TotalAmount": 100.0,
"AmountPayableNow": 115.0,
"TotalAmountWithInclusiveTaxesFees": 100.0,
"TotalAmountIncludingTaxesFees": 115.0,
"OriginalAmountIncludingTaxesAndFees": 115.0
}
},
"AveragePrice": {
"Price": {
"Fees": {
"Breakdown": [
{
"Description": "CITY_FEE",
"Amount": 5.0,
"Code": "CITYFEE",
"Level": "Hotel",
"Name": "CITYFEE",
"Type": "CityHotelFee",
"IsPayAtProperty": false
}
],
"Amount": 5.0,
"StayFeeAmount": 0.0
},
"Tax": {
"Breakdown": [
{
"Description": "STATE 10%",
"Amount": 10.0,
"Code": "STATE 10%",
"Level": "Hotel",
"Name": "STATE 10%",
"Type": "BedTax",
"IsPayAtProperty": false
}
],
"Amount": 10.0,
"StayTaxAmount": 0.0
},
"CurrencyCode": "USD",
"TaxesFeesIncluded": false,
"TotalAmount": 100.0,
"AmountPayableNow": 115.0,
"AmountPayAtProperty": 0.0,
"TotalAmountWithInclusiveTaxesFees": 100.0,
"TotalAmountIncludingTaxesFees": 115.0
}
}
},
"Transporation": {},
"Notification": {
"LanguageCode": "en-US"
},
"RoomStay": {
"GuestCount": [
{
"AgeQualifyingCode": "Child",
"NumGuests": 0
},
{
"AgeQualifyingCode": "Adult",
"NumGuests": 1
}
],
"NumRooms": 1,
"EndDate": "2023-06-08T00:00:00",
"StartDate": "2023-06-07T00:00:00",
"Group": false,
"Suppressed": false,
"Products": [
{
"Product": {
"RateCode": "Dev Studio",
"RoomCode": "LUXQ",
"Id": "03e73aa4-23da-42d6-a307-43167c5a6bda"
},
"StartDate": "2023-06-07T00:00:00",
"EndDate": "2023-06-08T00:00:00",
"Primary": true
}
]
},
"RuleTrackingList": [],
"Source": {
"IP_Address": "",
"BookingUrl": ""
},
"OnPropertyInstructions": {
"ChargeRoutingList": []
},
"AdministrativeActions": [
{
"Description": "7/14/2022 9:13:42 PM Res Retrieved by OTA Interface",
"UpdatedBy": "IntegRezPoster User",
"Date": "2022-07-14T14:13:42"
},
{
"Description": "E-mail ReservationGuestConfirmation (Guest: John Public | Guest Confirm #: 100319GW000877) was sent successfully.",
"UpdatedBy": "",
"Date": "2022-07-14T14:12:52"
}
],
"CancellationPermitted": true,
"CRS_confirmationNumber": "100319CK001125",
"ItineraryNumber": "14161022B0000805",
"Id": "2fa55a36-d08d-4e3a-b465-62bb2a813c03",
"ChannelConfirmationNumber": "",
"Status": "Confirmed",
"OnHoldReleaseTime": 0,
"OnPropertyStatus": "None",
"PurposeOfStay": "Leisure",
"SingleUsePaymentCardAllowed": false,
"SortOrder": 0,
"AutoCancelReleaseTime": "7/15/2022 6:59:00 AM",
"CRSConfirmationNumber": "100319CK001125",
"Channels": {
"PrimaryChannel": {
"Code": "WEB",
"Description": "Booking Engine"
},
"SecondaryChannel": {
"Code": "SYNXISWS_BE",
"Description": "SynXis Webservices Booking Engine"
}
},
"Activity": [
{
"Type": "BookDate",
"Value": "2022-07-14T14:12:08"
},
{
"Type": "BookedByUser",
"Value": "Amy Doe"
},
{
"Type": "ModifiedByUser",
"Value": "Amy Doe"
},
{
"Type": "ModificationDate",
"Value": "2022-07-14T14:12:08"
},
{
"Type": "OnHoldScheduledReleaseDate",
"Value": "2022-07-14T23:59:00"
}
]
}