POST Query Order

POST /v1.0/query

Request Parameters

{
  "bookingReferenceId": "86621248",
  "referenceId": ""
}

Name	Type	Required	Description
bookingReferenceId	string	No	Customer order reference ID
referenceId	string	No	Phoentrix order ID. Either bookingReferenceId or referenceId must be provided

Request Example

curl --location --request POST '{{domain}}/v1.0/query' \
--header 'Authorization: PHT apikey={{api_key}},signature={{signature}},timestamp={{timestamp}}'  \
--header 'api_key: {{api_key}}' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--data-raw '{
    "bookingReferenceId":"86621248",
    "referenceId":""
}'

Response Example

{
  "responseStatus": "SUCCESS",
  "version": "v1.0",
  "remark": "Successful",
  "referenceId": "230600170",
  "bookingReferenceId": "86621263",
  "orderStatus": "BOOK_SUCCESS",
  "checkIn": "2023-07-26",
  "checkOut": "2023-07-28",
  "hotel": "420032",
  "roomCode": "2535250",
  "boardCode": "",
  "quantity": 1,
  "totalPrice": 1212.4,
  "currency": "USD",
  "guests": {
    "guestName": [
      {
        "firstName": "yong",
        "lastName": "li"
      }
    ],
    "email": "lucas.li@phoentrix.com",
    "phone": "13845678123"
  }
}

Field	Type	Required	Description
responseStatus	string	Yes	Status
version	string	Yes	API version
remark	string	No	Additional remarks
referenceId	string	Yes	Phoentrix order ID
bookingReferenceId	string	Yes	Customer order reference ID
orderStatus	string	Yes	Order status: BOOK_SUCCESS: Success CANCEL_SUCCESS: Cancelled BOOKING: Pending confirmation BOOK_FAIL: Failed
checkIn	string	Yes	Check-in date
checkOut	string	Yes	Check-out date
hotel	string	Yes	Hotel ID
roomCode	string	Yes	Room code
boardCode	string	Yes	Meal plan code
quantity	int	Yes	Number of rooms
totalPrice	decimal	Yes	Total price
currency	string	Yes	Currency
guests	object	Yes	Guest information
phone	string	Yes	Contact phone
email	string	Yes	Contact email
guestName	List	Yes	Guest list
firstName	string	Yes	First name
lastName	string	Yes	Last name

Status Codes

Code	Description
SUCCESS	Success
NO_FIND	No data found
NO_SUPPLIER_ORDER	Supplier order not found
UNAUTHORIZED	Authentication failed
SUPPLIER_SERVER_ERROR	System or supplier error

Previous pageCancel