Price Search

About 540 wordsAbout 2 min

2026-03-27

POST Price Search

This API is used to retrieve hotel pricing information based on a list of specified hotel IDs.

It supports returning real-time pricing and rate plan details, including daily prices, meal plans, cancellation policies, and more.

Endpoint

POST /rate/pricesearch?$format=json

Request Parameters

{
  "HotelIDList": [117274],
  "CheckInDate": "2026-04-15",
  "CheckOutDate": "2026-04-16",
  "LowestPriceOnly": false,
  "IsRealTime": {
    "RoomCount": 1,
    "Value": true
  },
  "RealTimeOccupancy": {
    "AdultCount": 2,
    "ChildCount": 0
  },
  "Currency": "USD",
  "Nationality": "CN"
}

Field	Type	Required	Description
HotelIDList	List	Yes	List of hotel IDs
CheckInDate	String	Yes	Check-in date
CheckOutDate	String	Yes	Check-out date
LowestPriceOnly	boolean	Yes	Whether to return only lowest prices
IsRealTime	Object	Yes	Real-time query configuration
RealTimeOccupancy	Object	Yes	Occupancy details for real-time
Currency	String	Yes	Currency code
Nationality	String	Yes	Nationality

IsRealTime

Field	Type	Required	Description
RoomCount	number	Yes	Number of rooms (used as a filter condition)
Value	boolean	Yes	Whether to enable real-time query

RealTimeOccupancy

Field	Type	Required	Description
AdultCount	number	Yes	Number of adults
ChildCount	number	Yes	Number of children

Request Example

curl --location --request POST '{{domain}}/rate/pricesearch?$format=json' \
--header 'Authorization: PHT apikey={{api_key}},signature={{signature}},timestamp={{timestamp}}'  \
--header 'api_key: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"HotelIDList": [117274],
"CheckInDate": "2026-04-15",
"CheckOutDate": "2026-04-16",
"LowestPriceOnly": false,
"IsRealTime": {
"RoomCount": 1,
"Value": true
},
"RealTimeOccupancy": {
"AdultCount": 2,
"ChildCount": 0
},
"Currency": "USD",
"Nationality": "CN"
}'

Response Example

{
  "Success": {
    "PriceDetails": {
      "CheckInDate": "2026-04-15 00:00:00",
      "CheckOutDate": "2026-04-16 00:00:00",
      "HotelList": [
        {
          "HotelID": 117274,
          "HotelName": "洲际酒店集团纽约巴克莱洲际酒店(InterContinental New York Barclay by IHG)",
          "Destination": { "CityCode": "178293" },
          "RatePlanList": [
            {
              "RoomOccupancy": {
                "RoomNum": 1,
                "AdultCount": 2,
                "ChildCount": 0
              },
              "RoomTypeID": 10200440,
              "RoomName": "1 King Classic",
              "RatePlanID": "-2413223621322697309",
              "RatePlanName": "CLASSIC KING",
              "BedType": 73,
              "Currency": "USD",
              "TotalPrice": 409,
              "PriceList": [
                {
                  "Price": 409,
                  "StayDate": "2026-04-15 00:00:00",
                  "MealType": 1,
                  "MealAmount": 0
                }
              ],
              "RatePlanCancellationPolicyList": [
                { "LocalFromDate": "2026-03-24T23:00:00+07:00", "Amount": 409 }
              ]
            },
            ...
          ]
        }
      ]
    }
  }
}

Response Parameters

Field	Type	Required	Description
CheckInDate	DateTime	Yes	Check-in date
CheckOutDate	DateTime	Yes	Check-out date
HotelList	List	Yes	List of hotels

HotelList

Field	Type	Required	Description
HotelID	number	Yes	Hotel ID
HotelName	String	Yes	Hotel name
Destination	Object	No	Destination information
RatePlanList	List	Yes	Rate plan collection

Destination

Field	Type	Required	Description
CityCode	String	No	City code

RatePlanList (Core)

Field	Type	Required	Description
RoomTypeID	number	Yes	Room type ID
RoomName	String	Yes	Room name
RatePlanID	String	Yes	Rate plan ID
RatePlanName	String	Yes	Rate plan name
BedType	number	No	Bed type ID
Currency	String	Yes	Currency
TotalPrice	Decimal	Yes	Total price (tax included)
PriceList	List	Yes	Daily price details
RatePlanCancellationPolicyList	List	No	Cancellation policies

RoomOccupancy

Field	Type	Required	Description
RoomNum	number	Yes	Number of rooms
AdultCount	number	Yes	Number of adults
ChildCount	number	Yes	Number of children

PriceList

Field	Type	Required	Description
Price	Decimal	Yes	Price per day
StayDate	DateTime	Yes	Stay date
MealType	number	Yes	Meal type
MealAmount	number	Yes	Number of meals

Cancellation Policy

Field	Type	Required	Description
LocalFromDate	String	No	LocalHotelTime
Amount	Decimal	No	Cancellation penalty