Booking Search

About 654 wordsAbout 2 min

2026-03-27

POST Booking Search

This API is used to retrieve booking information. It supports querying by multiple conditions such as booking ID, client reference, and check-in date.

⚠️ Important:
Only when the booking status (Status) returned by the Booking Search API is one of the following three values will the booking be considered to have reached its final status. Any other response result (such as an empty response, or a Status value other than 2, 3, or 4) will not be regarded as the final processing result of the booking:

Status = 2: Booking successfully confirmed (this is the only valid confirmation state)
Status = 3: Booking successfully canceled (this is the only valid cancellation state)
Status = 4: Booking failed (this is the only valid failure state)

Any other result (including empty responses or status values other than 2/3/4) should NOT be considered as a final booking status.

Endpoint

POST /booking/HotelBookingSearch?$format=json

Request Parameters

{
  "SearchBy": {
    "BookingID": "15631283819",
    "BookingInfo": {
      "ClientReference": ""
    }
  }
}

Field	Type	Required	Description
SearchBy	Object	Yes	Search conditions

Field	Type	Required	Description
BookingID	String	No	Booking ID
BookingInfo.ClientReference	String	No	Client reference number

Request Example

curl --location --request POST '{{domain}}/booking/HotelBookingSearch?$format=json' \
--header 'Authorization: PHT apikey={{api_key}},signature={{signature}},timestamp={{timestamp}}'  \
--header 'api_key: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "SearchBy": {
    "BookingID": "15631283819",
    "BookingInfo": {
      "ClientReference": ""
    }
  }
}'

Response Example

{
  "Success": {
    "BookingDetailsList": [
      {
        "BookingID": "15631283819",
        "Status": 2,
        "CheckInDate": "2025-12-28 00:00:00",
        "CheckOutDate": "2025-12-29 00:00:00",
        "OrderDate": "2025-11-11 15:23:56.473",
        "NumOfRooms": 1,
        "TotalPrice": 1293,
        "GuestList": [
          {
            "RoomNum": 1,
            "GuestInfo": [
              {
                "Name": {
                  "First": "李",
                  "Last": "四"
                },
                "IsAdult": true
              }
            ]
          }
        ],
        "Contact": {
          "Name": {
            "First": "Lucas",
            "Last": "li"
          },
          "Phone": "19909258553",
          "Email": "455407767@qq.com"
        },
        "ClientReference": "FKX-251100082",
        "Hotel": {
          "HotelID": 117274,
          "HotelName": "洲际酒店集团纽约巴克莱洲际酒店",
          "Destination": {
            "CityCode": "178293"
          },
          "TotalPrice": 1293,
          "RatePlanList": [
            {
              "RoomOccupancy": {
                "RoomNum": 1,
                "AdultCount": 2,
                "ChildCount": 0
              },
              "RoomTypeID": 5370256,
              "RatePlanID": "-5601198872135516182",
              "RatePlanName": "尊享房(大床)",
              "Currency": "USD",
              "TotalPrice": 1293,
              "PriceList": [
                {
                  "Price": 1293,
                  "StayDate": "2025-12-28 00:00:00"
                }
              ]
            }
          ],
          "CancellationPolicyList": [
            {
              "LocalFromDate": "2026-03-24T23:00:00+07:00",
              "Amount": 1293
            }
          ]
        }
      }
    ]
  }
}

Response Parameters

Field	Type	Required	Description
BookingID	String	Yes	Booking ID
Status	Number	Yes	Booking status
CheckInDate	DateTime	Yes	Check-in date
CheckOutDate	DateTime	Yes	Check-out date
OrderDate	DateTime	Yes	Booking creation time
NumOfRooms	Number	Yes	Number of rooms
TotalPrice	Decimal	Yes	Total price
GuestList	List	Yes	Guest information
Contact	Object	Yes	Contact information
ClientReference	String	No	Client reference
ConfirmationCode	String	No	Hotel confirmation code
Hotel	Object	Yes	Hotel information

GuestList

Field	Type	Required	Description
RoomNum	Number	Yes	Room number
GuestInfo	List	Yes	List of guests

GuestInfo

Field	Type	Required	Description
Name.First	String	No	First name
Name.Last	String	No	Last name
Gender	String	No	Gender
Phone	String	No	Phone number
Email	String	No	Email
Age	Number	No	Age
IsAdult	Boolean	Yes	Is adult

contact

Field	Type	Required	Description
Name.First	String	Yes	First name
Name.Last	String	Yes	Last name
Phone	String	Yes	Phone
Email	String	Yes	Email

Hotel

Field	Type	Required	Description
HotelID	Number	Yes	Hotel ID
HotelName	String	Yes	Hotel name
Destination	Object	No	Destination info
TotalPrice	Decimal	Yes	Total hotel price
RatePlanList	List	Yes	Rate plan information
CancellationPolicyList	List	No	Cancellation policies

CancellationPolicyList

Field	Type	Required	Description
LocalFromDate	String	No	Lcoal Hotel Time
Amount	Decimal	No	Penalty amount

RatePlanList(Core)

Field	Type	Required	Description
RoomOccupancy	Object	Yes	Occupancy info
RoomTypeID	Number	No	Room type ID
RoomName	String	No	Room name
RatePlanID	String	Yes	Rate plan ID
RatePlanName	String	Yes	Rate plan name
BedType	Number	No	Bed type
Currency	String	Yes	Currency
TotalPrice	Decimal	Yes	Total price
PriceList	List	Yes	Daily price list
MealType	Number	Recommended	Meal type
MealAmount	Number	Recommended	Number of meals

PriceList

Field	Type	Required	Description
Price	Decimal	Yes	Price
StayDate	DateTime	Yes	Stay date