Lodging Rate Calendar API

Guidance and examples for accessing the Lodging Rate Calendar API

The Lodging Rate Calendar API will return the lowest rate plan for a range of days for one selected Expedia lodging property.

Endpoint

Method	Endpoint
GET	https://apim.expedia.com/hotels/rateCalendar

Required headers

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

Example Lodging Rate Calendar request

Request

https://apim.expedia.com/hotels/rateCalendar?ecomHotelId=7681&startDate=2022-09-01&endDate=2022-09-02&lengthOfStay=1&currency=USD

Response

{
    "TransactionId": "1e7abe05-c1e0-4347-81fa-caf508c558a6",
    "RateCalendars": [
        {
            "EcomHotelId": "7681",
            "RateCalendar": [
                {
                    "StayDate": "2022-09-02",
                    "Price": {
                        "Value": "69.14",
                        "Currency": "USD"
                    },
                    "PriceLevel": "LOW",
                    "Status": "AVAILABLE"
                },
                {
                    "StayDate": "2022-09-03",
                    "Price": {
                        "Value": "101.82",
                        "Currency": "USD"
                    },
                    "PriceLevel": "MEDIUM",
                    "Status": "AVAILABLE"
                }
            ]
        }
    ]
}

Error codes

Common error codes

HTTP status code	Error code	Error response	Cause
500	APPLICATION_ERROR	Application error.	Application error.
409	NO_RESULTS_FOUND	Sorry, your query appears to be correctly formatted, but the inventory for which you are seeking details is now unavailable.	No property found.
400	NO_RATE_CALENDAR_SEARCH_CRITERIA	No hotel search criteria specified. Available options are: [ecomHotelId, hcomHotelId].	No ecomHotelId or hcomHotelId in request parameter
400	INVALID_IMAGE_SIZES	Invalid imageSizes. Allowed values are %s.	The ImageSizes specified is invalid or contains invalid values.
400	COMBINED_RATE_CALENDAR_SEARCH_CRITERIA	Combined hotel search is not supported. Please specify either one of the following search criteria: [ecomHotelId, hcomHotelId].	Both of the ecomHotelId and hcomHotelId in request parameter
400	INVALID_ECOMHOTELID	The ecomHotelId is invalid. Please specify correct Ecom hotel id.	Invalid ecomHotelId
400	INVALID_HCOMHOTELID	The hcomHotelId is invalid. Please specify correct Hcom hotel id.	Invalid hcomHotelId
400	END_DATE_EARLIER_THAN_START_DATE	The endDate must not occur before startDate.	The endDate before the startDate in the request
400	MISSING_START_DATE_OR_END_DATE	Either startDate or endDate is missing. Please specify startDate and endDate together.	Missing startDate or endDate in the request
400	SEARCH_RANGE_IN_PAST	The startDate and endDate should not be in the past.	The starDate or endDate before the search date
400	SEARCH_RANGE_IN_INVALID_FORMAT	The startDate or endDate is invalid. The format should be 'YYYY-MM-DD	The format of startDate/endDate is invalid.
400	LENGTH_OF_STAY_INVALID	The lengthOfStay is invalid. Please specify an integer grater than 0.	The value of lengthOfStay is not positive integer
400	LENGTH_OF_STAY_OUT_OF_RANGE	The lengthOfStay is too large. Maximum length of stay is %d days.	The value of lengthOfStay is larger than the maximum value in config

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.