Lodging Details API

Guidance and examples for accessing the Lodging Details API

The Lodging Details API allows you to search extended information about the rate, charges, fees, and financial terms associated with booking a single lodging rate plan offer.

Endpoint

MethodEndpointPrerequisites
GEThttps://apim.expedia.com/hotels/details/[offerToken]

To complete a Details API call you must have an offerToken from the Listing API

Required Headers

Key:Expedia API key
Authorization:Expedia API Authorization String
Accept:application/vnd.exp-hotel.v3+json
Partner-Transaction-Id:[Partner TransactionID String]

Optional Headers

Accept-Encoding:gzip [More info on gzip]

Next Steps

  • Book one hotel offer via Lodging Booking API.

Example Hotel Details Query

Hotel Details Request

https://apim.expedia.com/hotels/details/[offerToken]?Price=231.75&currency=USD

Hotel Details Response

Redundant image and amenity listings have been removed from examples for the sake of brevity while reflecting actual file structure. Actual API response will return many more listed items.

{
    "TransactionId": "6b318849-af44-4788-ab10-6a3921a48b51",
    "Warnings": [{
            "Code": "PRICE_DECREASED",
            "Description": "Price changed. The total price of your trip decreased.",
            "OriginalPrice": {
                "Value": 1678.9,
                "Currency": "USD"
            },
            "NewPrice": {
                "Value": 1619.4,
                "Currency": "USD"
            },
            "ChangedAmount": {
                "Value": 59.5,
                "Currency": "USD"
            },
            "ChangedPercentage": "3.543987%"
        }
    ],
    "StayDates": {
        "CheckInDate": "2022-09-19",
        "CheckOutDate": "2022-09-25"
    },
    "LengthOfStay": 6,
    "NumberOfRooms": 1,
    "Occupants": [{
            "Adults": 2
        }
    ],
    "ValidFormsOfPayment": [{
            "PaymentMethod": "DebitCard",
            "Name": "AmericanExpress",
            "PaymentSubMethod": "AmericanExpress",
            "BrandName": "AmericanExpress"
        }, {
            "PaymentMethod": "CreditCard",
            "Name": "AmericanExpress",
            "PaymentSubMethod": "AmericanExpress",
            "BrandName": "AmericanExpress"
        }, {
            "PaymentMethod": "DebitCard",
            "Name": "Visa",
            "PaymentSubMethod": "Visa",
            "BrandName": "Visa"
        }, {
            "PaymentMethod": "CreditCard",
            "Name": "Visa",
            "PaymentSubMethod": "Visa",
            "BrandName": "Visa"
        }, {
            "PaymentMethod": "PayPal",
            "Name": "PayPal",
            "PaymentSubMethod": "PayPal",
            "BrandName": "PayPal"
        }
    ],
    "HotelDetails": {
        "Id": 20230,
        "Name": "Fairmont Olympic Hotel",
        "LocalCurrencyCode": "USD",
        "Location": {
            "Address": {
                "Address1": "411 University St",
                "City": "Seattle",
                "Province": "WA",
                "Country": "USA",
                "PostalCode": 98101
            },
            "GeoLocation": {
                "Latitude": 47.60831,
                "Longitude": -122.33481
            },
            "Neighborhood": {
                "Id": "6004997",
                "Name": "Fremont"
            }
        },
        "PhoneInfos": [{
                "CountryCode": "44",
                "AreaCode": "207",
                "Number": "9285200",
                "ExtensionNumber": "3114"
            }
        ],
        "Description": {
            "LocationTeaser": "Built on the original site of the University of Washington, this grand hotel is just a few blocks from the Seattle Art Museum, Pacific Place shops, the Pike Place Market, and the convention center.",
            "HotelTeaser": "A top-notch fitness club and spa features a pool, a spa tub, beauty services, plus exercise machines with DVDs attached. The business center offers computer stations. WiFi is available for a fee.",
            "RoomTeaser": "Renovated in May 2016, guestrooms feature upholstered chairs, mid-century modern furniture, and city views. Amenities include high-speed Internet access, coffee/tea maker and cordless phones."
        },
        "Status": "AVAILABLE",
        "RenovationsAndClosures": ["The following facilities are closed seasonally each year. They will be closed from 27 January to 01 February:
            - Bar/Lounge
            - Dining venue
            "],
        "ChainAndBrandInfo": {
            "ChainId": 2168,
            "ChainName": "Club Quarters",
            "BrandId": 2168,
            "BrandName": "Club Quarters"
        },
        "StarRating": 5,
        "PetFriendly": false,
        "IsOfficialRating": false,
        "Policies": {
            "CheckInStartTime": "3 PM",
            "CheckInEndTime": "3 PM",
            "CheckOutTime": "noon",
            "PetPolicies": ["Pets allowed for an extra charge of USD 50 per pet, per stay"],
            "ChildrenAndExtraBedsPolicies": [
                "Children are welcome.",
                "Kids stay free! Up to 3 children 17 years old and younger stay free when using existing bedding.",
                "Rollaway/extra beds are available for USD 30.0 per night.",
                "Free cribs (infant beds)!"
            ]
        },
        "Media": [{
                "Type": 2,
                "Title": "Restaurant",
                "Size": "t",
                "Url": "https://images.trvl-media.com/hotels/1000000/30000/20300/20230/20230_29_t.jpg"
            }, {
                "Type": 1,
                "Title": "Banquet Hall",
                "Size": "t",
                "Url": "https://images.trvl-media.com/hotels/1000000/30000/20300/20230/20230_166_t.jpg"
            }, {
                "Type": 2,
                "Title": "Hotel Bar",
                "Size": "t",
                "Url": "https://images.trvl-media.com/hotels/1000000/30000/20300/20230/20230_20_t.jpg"
            }
        ],
        "HotelAmenities": [{
                "Id": 3,
                "Name": "Bar/lounge"
            }, {
                "Id": 324,
                "Name": "Coffee/tea in common areas"
            }, {
                "Id": 2043,
                "Name": "Multilingual staff"
            }
        ],
        "RoomAmenities": [{
                "Id": 1,
                "Name": "Air conditioning"
            }, {
                "Id": 2559,
                "Name": "Down comforter"
            }
        ],
        "Accessibility": [
            "Accessible bathroom",
            "Roll-in shower",
            "In-room accessibility"
        ],
        "RoomTypes": [{
                "Description": "Room, 1 King Bed (Fairmont Room) - Early Booking Promo 2",
                "RoomKey": "CgUyMDIzMBIuCgkyMDEzMDQ1OTcSCTIwNjMyNzYwMRoCMjQqCDIwMTcwNzI1MggyMDE3MDcyNioDCgEy",
                "OfferId": "CgUyMDIzMBIuCgkyMDEzMDQ1OTcSCTIwNjMyNzYwMRoCMjQqCDIwMTcwNzI1MggyMDE3MDcyNioDCgEy",
                "RatePlans": [{
                        "RoomTypeId": 201304596,
                        "RatePlanId": 209772708,
                        "RateRuleId": 231313220,
                        "InventorySourceId": 24,
                        "StayDates": {
                            "CheckInDate": "2022-09-19",
                            "CheckOutDate": "2022-09-25"
                        },
                        "RemainingCount": 3,
                        "Price": {
                            "BaseRate": {
                                "Value": 1390.5,
                                "Currency": "USD"
                            },
                            "TaxesAndFees": {
                                "Value": 228.9,
                                "Currency": "USD"
                            },
                            "TotalPrice": {
                                "Value": 1619.4,
                                "Currency": "USD"
                            },
                            "AvgNightlyRate": {
                                "Value": 231.75,
                                "Currency": "USD"
                            },
                            "HotelMandatoryFees": {
                                "Value": "2.63",
                                "Currency": "USD",
                                "LocalCurrencyPrice": {
                                    "Value": "2.00",
                                    "Currency": "GBP"
                                }
                            },
                            "RoomRates": [{
                                    "RoomIndex": 1,
                                    "BaseRate": {
                                        "Value": 1390.5,
                                        "Currency": "USD"
                                    },
                                    "TaxesAndFees": {
                                        "Value": 228.9,
                                        "Currency": "USD"
                                    },
                                    "TotalPrice": {
                                        "Value": 1619.4,
                                        "Currency": "USD"
                                    },
                                    "TaxesAndFeesDetails": [{
                                            "CategoryCode": 420,
                                            "Value": 12,
                                            "Currency": "USD"
                                        }, {
                                            "CategoryCode": 404,
                                            "Value": 97.32,
                                            "Currency": "USD"
                                        }, {
                                            "CategoryCode": 407,
                                            "Value": 119.58,
                                            "Currency": "USD"
                                        }
                                    ],
                                    "MandatoryFeesDetails": [{
                                            "Type": "TowelSheetsFee_Amt",
                                            "Amount": {
                                                "Value": "2.63",
                                                "Currency": "USD",
                                                "LocalCurrencyPrice": {
                                                    "Value": "2.00",
                                                    "Currency": "GBP"
                                                }
                                            }
                                        }
                                    ],
                                    "NightlyRates": [{
                                            "StayDate": "2022-09-19",
                                            "BaseRate": {
                                                "Value": 231.75,
                                                "Currency": "USD"
                                            }
                                        }, {
                                            "StayDate": "2022-09-20",
                                            "BaseRate": {
                                                "Value": 231.75,
                                                "Currency": "USD"
                                            }
                                        }, {
                                            "StayDate": "2022-09-21",
                                            "BaseRate": {
                                                "Value": 231.75,
                                                "Currency": "USD"
                                            }
                                        }, {
                                            "StayDate": "2022-09-22",
                                            "BaseRate": {
                                                "Value": 231.75,
                                                "Currency": "USD"
                                            }
                                        }, {
                                            "StayDate": "2022-09-23",
                                            "BaseRate": {
                                                "Value": 231.75,
                                                "Currency": "USD"
                                            }
                                        }, {
                                            "StayDate": "2022-09-24",
                                            "BaseRate": {
                                                "Value": 231.75,
                                                "Currency": "USD"
                                            }
                                        }
                                    ]
                                }
                            ]
                        },
                        "Promotions": [{
                                "Description": "Book early and save 15%",
                                "Amount": {
                                    "Value": "25.38",
                                    "Currency": "USD"
                                }
                            }, {
                                "Description": "Free breakfast for 3"
                            }
                        ],
                        "TaxesAndFeesInclusive": false,
                        "PaymentMethod": "Hotel",
                        "PaymentTime": "UponBooking",
                        "FullDepositUponBooking": true,
                        "PaymentSchedule": [{
                                "Due": "2022-09-13",
                                "Price": {
                                    "Value": "1104.88",
                                    "Currency": "USD"
                                }
                            }
                        ],
                        "ReserveWithDeposit": true,
                        "CancellationPolicy": {
                            "CancellableOnline": true,
                            "Refundable": true,
                            "FreeCancellation": false,
                            "CancellationPenaltyRules": [{
                                    "PenaltyNightCount": 1,
                                    "PenaltyStartDateTime": "2022-09-08T00:53:00-08:00",
                                    "PenaltyEndDateTime": "2022-09-19T16:00:00-08:00"
                                }
                            ]
                        }
                    }
                ],
                "Price": {
                    "BaseRate": {
                        "Value": 1390.5,
                        "Currency": "USD"
                    },
                    "TaxesAndFees": {
                        "Value": 228.9,
                        "Currency": "USD"
                    },
                    "TotalPrice": {
                        "Value": 1619.4,
                        "Currency": "USD"
                    },
                    "AvgNightlyRate": {
                        "Value": 231.75,
                        "Currency": "USD"
                    },
                    "HotelMandatoryFees": {
                        "Value": "2.63",
                        "Currency": "USD",
                        "LocalCurrencyPrice": {
                            "Value": "2.00",
                            "Currency": "GBP"
                        }
                    }
                },
                "AmountDueAtProperty": {
                    "Value": "514.52",
                    "Currency": "USD",
                    "LocalCurrencyPrice": {
                        "Value": "391.27",
                        "Currency": "GBP"
                    }
                },
                "Promotions": [{
                        "Description": "Book early and save 15%",
                        "Amount": {
                            "Value": "25.38",
                            "Currency": "USD"
                        }
                    }, {
                        "Description": "Free breakfast for 3"
                    }
                ],
                "Links": {
                    "ApiBooking": {
                        "Accept": "application/vnd.exp-hotel.v3+json",
                        "Method": "POST",
                        "Href": "https://apim.expedia.com/hotels/bookings/CgUyMDIzMBIyCgkyMDEzMDQ1OTYSCTIwOTc3MjcwOBoCMjQqCjIwMTctMTEtMTkyCjIwMTctMTEtMjUqAwoBMg?price=1619.40&currency=USD&locale=en_US"
                    }
                },
                "SmokingOption": "NonSmoking",
                "BedTypeOptions": [{
                        "Id": 14,
                        "Description": "1 king bed"
                    }
                ],
                "RoomOccupancyPolicy": {
                    "MaxGuestCount": 2,
                    "IncludedGuestCount": 2,
                    "MinCheckInAge": 19,
                    "MinGuestAge": 0,
                    "AgeClassRestrictions": [{
                            "AgeClass": "Adult",
                            "AgeMinimum": 18,
                            "MaxGuestCount": 2
                        }, {
                            "AgeClass": "Child",
                            "AgeMinimum": 0,
                            "AgeMaximum": 17,
                            "MaxGuestCount": 1
                        }
                    ]
                },
                "Amenities": [{
                        "Id": 4092,
                        "Name": "Square meters - 35"
                    }, {
                        "Id": 4093,
                        "Name": "Square feet - 377"
                    }
                ],
                "Media": [{
                        "Type": 1,
                        "Title": "Bathroom",
                        "Size": "t",
                        "Url": "https://images.trvl-media.com/hotels/1000000/30000/20300/20230/90646410_t.jpg"
                    }, {
                        "Title": "Guestroom",
                        "Size": "t",
                        "Url": "https://images.trvl-media.com/hotels/1000000/30000/20300/20230/20230_164_t.jpg"
                    },
                    {
                        "Type": 1,
                        "Title": "Guestroom",
                        "Size": "t",
                        "Url": "https://images.trvl-media.com/hotels/1000000/30000/20300/20230/6609a2e9_t.jpg"
                    }
                ]
            }
        ]
    }
}

Error Codes

Common Error Codes

HTTP Status CodeError CodeError ResponseCause
500APPLICATION_ERRORApplication error.Application error.
400INVALID_OFFERIDInvalid offerId. Malformed offerId detected.The offerId in the request URL was changed. Please use the one directly generated in Listings API.
400INVALID_IMAGE_SIZESInvalid imageSizes. Allowed values are t,s,b,y,z.The ImageSizes specified is invalid or contains invalid values.
400INVALID_INCLUDEInvalid includes. Allowed values are hotelamenities,roomamenities,hotelimages,roomimages.The includes specified is invalid or contains invalid values.
400UNSUPPORTED_CURRENCYThe currency is invalid. The requested currency is not supported.The given currency is not supported.
400INVALID_PRICEThe price is invalid. Allowed value is a positive number.Price is not a number
400INVALID_CLIENT_KEYInvalid client key: %s.Key in request header is invalid or too many Key in header.
400INVALID_ACCEPTPlease provide a valid Accept header.Accept in request header is invalid or too many Accepts in header.
400INVALID_PARTNER_TRANSACTION_IDPartner-Transaction-Id is missing.Partner-Transaction-Id in request header is empty.
400INVALID_LOCALEThe locale is invalid. The locale should be two-letter language code and two-letter region code connected with '_'.The format of Locale should be like en_US.
400INVALID_GROUPED_AMENITIESThe groupedAmenities is invalid. Allowed values are true and false.The groupedAmenities is invalid.
409NO_RESULTS_FOUNDSorry, your query appears to be correctly formatted, but the inventory for which you are seeking details is now unavailable.No hotel feedback when query via hotel detail API.

API details

Here, you can explore the endpoint definitions for this API, then go to the API Explorer to try out all the XAP endpoints, download OpenAPI specs, or download our Postman collections. Testing with one or all of these options will give you an understanding of how the examples and schema definitions compare to the actual output.


Did you find this page helpful?
How can we improve this content?
Thank you for helping us improve!