Retrieve Hotel Order
At this stage, it is assumed that you have successfully created a hotel booking session and obtained the necessary session identifier. The booking session allows you to perform various operations related to the management of hotel orders, such as retrieving booking details.
Get List of Hotel Bookings
Request
GET /hotel/list
Query Parameters
page: (number) The page number of the results, starting from1.provider: (string?) Filter the results by the provider of the booking.status: (ISSUED|CANCELLED?) Filter the results by the status of the booking.client-meta-[key]: (string?) Filter the results by the client meta data key-value pairs. Multiple keys can be provided by adding the key to the query parameter.
You can request a list of all hotel bookings that you have made. This endpoint will give you a shortened version of each booking. If you wish to retrieve all of the details about each booking, you can use the Retrieve Hotel Booking endpoint.
Response
GET /hotel/list
[
{
"session": {
"flow": "HOTEL_BOOKING",
"expireAt": "2025-10-19T00:00:00.000Z",
"createdAt": "2025-09-25T17:02:54.433Z",
"public": "1060616e-d352-4942-8c03-43698dd53adc"
},
"status": "ISSUED",
"locator": "J3ET8D",
"provider": "ZENTRUM",
"hotel": {
"hotel_information": {
"hotel_name": "Residence Inn by Marriott Lake Oswego",
"master_chain_name": "Marriott/Bonvoy Brands",
"master_chain_code": "EM",
"hero": {
"src": "https://i.travelapi.com/lodging/1000000/10000/6800/6773/97a2087c_z.jpg",
"alt": "Residence Inn by Marriott Lake Oswego"
}
}
},
"rooms": [
{
"type": {
"name": "Suite, 2 Bedrooms, Non Smoking, Fireplace",
"code": "7a16e419-e704-489f-99cb-899b57926d9c"
},
"bed_types": [
{
"type": " Queen Bed",
"count": 1
},
{
"type": " King Bed",
"count": 1
}
],
"max_occupancy": 2,
"rate": {
"rate_price": {
"average_nightly_rate": "546.50",
"average_nightly_rate_before_tax": "481.50",
"amount_after_tax": "2186.00",
"amount_before_tax": "1925.99",
"currency": "CAD"
},
"public": "344f9fbb-da9b-41f2-b3cd-c2d588adca0f"
},
"public": "924e799e-548f-4ece-a432-9f1268bdd0b7"
}
],
"createdAt": "2025-09-25T17:02:54.456Z",
"public": "dad0ae99-2b16-49b9-9737-c9c61ca54dbd"
}
]status: (ISSUED|CANCELLED) The status of the hotel booking.locator: (string) The unique identifier for the entire booking. This may or may not be the same as the booking references, depending on the channel.pcc: (string?) The Pseudo City Code the booking was made with.provider: (SABRE|ZENTRUM) The source the booking was made through.hotel: (Hotel Order Hotel Minimal) Minimal hotel information for listing.rooms: (Array<Hotel Booking Room Details Minimal>) Minimal room information for listing purposes.session: (Session) Information about the long-lived booking session.
🛎 The endpoint currently does not include any metadata about the pagination. If the empty array is returned, you can assume that there are no more results to be fetched.
Possible Errors
| Status Code | Error | Reason | Reason Code |
|---|---|---|---|
| 401 | Unauthorized | Invalid or missing API key | |
| 404 | Invalid Key Exception | API key is invalid or inactive | ORX_INVALID_API_KEY |
| 400 | [Validation Error] | Invalid query parameters or search string | ORX_VALIDATION_EXCEPTION |
Requesting Hotel Booking Retrieve
Request
GET /hotel/[sessionId]/retrieve
This endpoint will provide you with the necessary information and details of the hotel booking associated with the specified booking session. By retrieving the hotel booking, you can access important information such as guest details, hotel information, room details, booking status, and any other relevant booking information.
Response
GET /hotel/[sessionId]/retrieve
{
"paymentAuthorization": {
"gateway": "stripe",
"threeDsResult": {
"authentication_flow": "challenge",
"version": "2.2.0"
},
"public": "a216b4ba-d160-4946-a12e-e0a6a8ea5680",
"createdAt": "2025-09-17T19:03:24.970Z"
},
"riskEvaluation": {
"riskLevel": "normal",
"riskScore": "40"
},
"status": "ISSUED",
"locator": "UDSDXT",
"provider": "ZENTRUM",
"hotel": {
"hotel_information": {
"hotel_name": "Heathman Hotel",
"reviews": null,
"distance": null,
"address": {
"address": "1001 SW Broadway",
"city_name": "Portland",
"city_code": null,
"postal_code": "97205",
"country_name": "United States Of America",
"country_code": "US",
"phone": [
"1-503-241-4100"
],
"fax": [],
"location": {
"latitude": "45.51737",
"longitude": "-122.68073"
}
},
"chain_code": "0",
"chain_name": "Independent",
"hotel_code": "3096",
"master_chain_name": null,
"master_chain_code": null,
"rating": "4.5",
"logo": null,
"hero": {
"src": "https://i.travelapi.com/lodging/1000000/10000/3100/3096/ad5f1204_z.jpg",
"alt": "Heathman Hotel"
},
"images": [],
"mapping": {
"mapper": "1",
"mapper_id": "39686895"
}
},
"check_in_information": {
"check_in": [
"2025-10-08 16:00:00",
"2025-10-09 03:00:00"
],
"check_out": [
"2025-10-12 12:00:00"
],
"instructions": [
"<ul> <li>Extra-person charges may apply and vary depending on property policy</li><li>Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges</li><li>Special requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteed</li><li>This property accepts credit cards and debit cards; cash is not accepted</li><li>This property uses a grey water recycling system</li><li>Please note that cultural norms and guest policies may differ by country and by property; the policies listed are provided by the property</li> </ul>"
],
"special_instructions": [
"Front desk staff will greet guests on arrival at the property."
]
},
"fees": null,
"hotel_amenities": [
"Number of bars/lounges - 1",
"Assistive listening devices available",
"Wheelchair accessible parking",
"Tours/ticket assistance",
"Fireplace in lobby",
"Eco-friendly toiletries",
"At least 80% of all lighting comes from LEDs",
"Eco-friendly cleaning products provided",
"Recycling",
"LED light bulbs",
"Vegan menu options available",
"No accessible shuttle",
"Vegetarian menu options available",
"Wheelchair-accessible on-site restaurant",
"Multilingual staff",
"Conference center"
],
"descriptions": [
{
"title": "amenities",
"text": "Enjoy recreational amenities such as a 24-hour fitness center and bicycles to rent. Additional amenities at this hotel include complimentary wireless internet access, concierge services, and a fireplace in the lobby."
}
],
"policies": [
{
"title": "know_before_you_go",
"text": " The property has connecting/adjoining rooms, which are subject to availability and can be requested by contacting the property using the number on the booking confirmation. The property allows pets in specific rooms only and has other pet restrictions (surcharges apply and can be found in the Fees section). Guests can arrange to bring pets by contacting the property directly, using the contact information on the booking confirmation. A car is not required for transportation to and from this property. Contactless check-in and contactless check-out are available.This property welcomes guests of all sexual orientations and gender identities (LGBTQ+ friendly). "
}
]
},
"loyalty_program": null,
"references": [
{
"source": "EBF",
"code": "7319662851358"
},
{
"source": "ZENTRUM",
"code": "UDSDXT"
}
],
"disclaimers": [
"Your reservation is confirmed, and payment will be collected by the property at check-in."
],
"rooms": [
{
"type": {
"name": "Heathman King",
"code": "4835ca3f-6f63-4519-b518-5bf2eb1eaf1b"
},
"bed_types": [
{
"type": " King Bed",
"count": 1
}
],
"max_occupancy": 2,
"non_smoking": false,
"amenities": [
"Digital TV service",
"Electric kettle",
"Limited housekeeping",
"In-room climate control (air conditioning)",
"Blackout drapes/curtains",
"In-room safe (laptop compatible)",
"Designer toiletries"
],
"images": [],
"expireAt": "2025-10-19T00:00:00.000Z",
"rate": {
"rate_description": {
"cancellation": {
"refundable": true,
"penalties": [
{
"amount": "0.00",
"currency": "CAD",
"deadline": "2025-10-08T21:59:00.000000Z",
"percentage": null
},
{
"amount": "333.75",
"currency": "CAD",
"deadline": "2025-10-09T22:00:00.000000Z",
"percentage": null
}
]
},
"start_date": "2025-10-08",
"end_date": "2025-10-12",
"tax_inclusive": false,
"number_of_nights": 4,
"refundable": true,
"commissionable": true,
"discount_codes": [],
"pay_at_hotel": true,
"payment_owner": "VENDOR"
},
"rate_price": {
"fees": {
"total": "0",
"description": null,
"breakdown": []
},
"taxes": {
"total": "212.21",
"description": {
"text": "This charge includes estimated amounts the travel service provider (i.e. hotel, car rental company) pays for their taxes, and/or taxes that we pay, to taxing authorities on your booking (including but not limited to sales, occupancy, and value added tax). This amount may also include any amounts charged to us for resort fees, cleaning fees, and other fees and/or a fee we, the hotel supplier and/or the site you booked on, retain as part of the compensation for our and/or their services, which varies based on factors such as location, the amount, and how you booked. For more details, please see the terms and conditions.",
"title": "Taxes and Fees",
"link": null,
"link_text": null
},
"breakdown": [
{
"amount": 184.14,
"text": "Tax and service fee"
},
{
"amount": 28.07,
"text": "Property fee"
}
]
},
"commission": {
"type": "FIXED",
"amount": "110.25"
},
"average_nightly_rate": "333.75",
"average_nightly_rate_before_tax": "280.70",
"amount_after_tax": "1335.01",
"amount_before_tax": "1122.80",
"currency": "CAD"
},
"local_rate_price": null,
"public": "86473cf0-3c4b-4e20-89f2-582d82ad67b0",
"expireAt": "2025-10-19T00:00:00.000Z",
"createdAt": "2025-09-24T21:43:59.298Z",
"updatedAt": "2025-09-24T21:43:59.298Z"
},
"public": "ea4e3a8b-b77a-4745-bae6-067351233276",
"createdAt": "2025-09-24T21:43:59.307Z",
"updatedAt": "2025-09-24T21:43:59.307Z"
}
],
"passengers": [
{
"personal_info": {
"date_of_birth": "2001-05-05",
"first_name": "John",
"last_name": "Doe",
"middle_name": "",
"gender": "X"
},
"phone_number": "+16047372334",
"email": "john@ndcsolutionsinc.com",
"createdAt": "2025-09-24T21:41:56.641Z",
"public": "c81f5642-fca2-446a-bce2-6366d42c3355",
"expireAt": "2025-10-19T00:00:00.000Z",
"code": "ADT"
},
{
"createdAt": "2025-09-24T21:41:56.642Z",
"public": "13ca2164-aa88-4019-80b0-61b61cd8a5b4",
"expireAt": "2025-10-19T00:00:00.000Z",
"code": "CHD"
}
],
"createdAt": "2025-09-24T21:43:59.292Z",
"updatedAt": "2025-09-24T21:43:59.292Z",
"expireAt": "2025-10-19T00:00:00.000Z",
"public": "0bb10a79-0d4b-4840-ab78-633bfd2b745e"
}status: (ISSUED|CANCELLED) The status of the hotel booking.locator: (string) The unique identifier for the entire booking. This may or may not be the same as the booking references, depending on the channel.provider: (SABRE|ZENTRUM) The source the booking was made through.hotel: (Hotel Order Hotel) Complete hotel information and details.loyalty_program: (string?) Loyalty program information if applicable.references: (Array<Booking Reference>?) Booking reference codes from various systems.disclaimers: (Array<string>?) Important disclaimers and terms.rooms: (Array<Hotel Booking Room Details>) Detailed information about booked rooms.passengers: (Array<Passenger Information>) Guest information for the booking.paymentAuthorization: (Payment Authorization?) Payment authorization details.riskEvaluation: (Risk Evaluation?) Risk assessment information.
Possible Errors
| Status Code | Error | Reason | Reason Code |
|---|---|---|---|
| 401 | Unauthorized | Invalid or missing API key | |
| 404 | Invalid Key Exception | API key is invalid or inactive | ORX_INVALID_API_KEY |
| 404 | [Session Not Found] | The specified session ID does not exist or has expired | ORX_SESSION_NOT_FOUND |
| 400 | [Validation Error] | Invalid query parameters or search string | ORX_VALIDATION_EXCEPTION |
| 404 | Booking Not Found | A hotel booking with the given session id cannot be found | ORX_BOOKING_NOT_FOUND |